@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- 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 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- 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 +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- 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 +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -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]
|
|
@@ -93,7 +99,7 @@ const Joi = require("joi");
|
|
|
93
99
|
* @typedef SEOSchemaMarkupTemplate
|
|
94
100
|
* @property {string} [id]
|
|
95
101
|
* @property {string} [title]
|
|
96
|
-
* @property {
|
|
102
|
+
* @property {PageType} [page_type]
|
|
97
103
|
* @property {string} [schema]
|
|
98
104
|
* @property {string} [description]
|
|
99
105
|
* @property {boolean} [active]
|
|
@@ -106,7 +112,7 @@ const Joi = require("joi");
|
|
|
106
112
|
/**
|
|
107
113
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
108
114
|
* @property {string} [title]
|
|
109
|
-
* @property {
|
|
115
|
+
* @property {PageType} [page_type]
|
|
110
116
|
* @property {string} [schema]
|
|
111
117
|
* @property {string} [description]
|
|
112
118
|
* @property {Object} [target_json]
|
|
@@ -157,7 +163,7 @@ const Joi = require("joi");
|
|
|
157
163
|
|
|
158
164
|
/**
|
|
159
165
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
160
|
-
* @property {
|
|
166
|
+
* @property {PageType} [page_type]
|
|
161
167
|
* @property {string} [schema]
|
|
162
168
|
* @property {Object} [target_json]
|
|
163
169
|
*/
|
|
@@ -178,7 +184,7 @@ const Joi = require("joi");
|
|
|
178
184
|
*/
|
|
179
185
|
|
|
180
186
|
/**
|
|
181
|
-
* @typedef
|
|
187
|
+
* @typedef BlogGetDetails
|
|
182
188
|
* @property {BlogSchema[]} [items]
|
|
183
189
|
* @property {Page} [page]
|
|
184
190
|
* @property {BlogFilters} [filters]
|
|
@@ -206,7 +212,7 @@ const Joi = require("joi");
|
|
|
206
212
|
* @typedef Author
|
|
207
213
|
* @property {string} [designation]
|
|
208
214
|
* @property {string} [id]
|
|
209
|
-
* @property {string} [name]
|
|
215
|
+
* @property {string} [name] - Name of the author
|
|
210
216
|
*/
|
|
211
217
|
|
|
212
218
|
/**
|
|
@@ -276,7 +282,7 @@ const Joi = require("joi");
|
|
|
276
282
|
*/
|
|
277
283
|
|
|
278
284
|
/**
|
|
279
|
-
* @typedef
|
|
285
|
+
* @typedef BlogPayload
|
|
280
286
|
* @property {string} [application]
|
|
281
287
|
* @property {Object} [_custom_json]
|
|
282
288
|
* @property {Author} [author]
|
|
@@ -364,24 +370,6 @@ const Joi = require("joi");
|
|
|
364
370
|
* @property {string} [end]
|
|
365
371
|
*/
|
|
366
372
|
|
|
367
|
-
/**
|
|
368
|
-
* @typedef ConfigurationSchema
|
|
369
|
-
* @property {number} [sleep_time]
|
|
370
|
-
* @property {boolean} [start_on_launch]
|
|
371
|
-
* @property {number} [duration]
|
|
372
|
-
* @property {string} [slide_direction]
|
|
373
|
-
*/
|
|
374
|
-
|
|
375
|
-
/**
|
|
376
|
-
* @typedef SlideshowMedia
|
|
377
|
-
* @property {string} [type]
|
|
378
|
-
* @property {string} [url]
|
|
379
|
-
* @property {string} [bg_color]
|
|
380
|
-
* @property {number} [duration]
|
|
381
|
-
* @property {boolean} [auto_decide_duration]
|
|
382
|
-
* @property {Action} [action]
|
|
383
|
-
*/
|
|
384
|
-
|
|
385
373
|
/**
|
|
386
374
|
* @typedef UpdateHandpickedSchema
|
|
387
375
|
* @property {HandpickedTagSchema} [tag]
|
|
@@ -389,36 +377,88 @@ const Joi = require("joi");
|
|
|
389
377
|
|
|
390
378
|
/**
|
|
391
379
|
* @typedef HandpickedTagSchema
|
|
392
|
-
* @property {string} [position]
|
|
393
|
-
*
|
|
394
|
-
* @property {
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
*
|
|
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.
|
|
403
|
+
* @property {TemplateSchema} [template]
|
|
399
404
|
*/
|
|
400
405
|
|
|
401
406
|
/**
|
|
402
407
|
* @typedef RemoveHandpickedSchema
|
|
403
|
-
* @property {string[]} [tags]
|
|
408
|
+
* @property {string[]} [tags] - A list of tag IDs to remove from the system.
|
|
404
409
|
*/
|
|
405
410
|
|
|
406
411
|
/**
|
|
407
412
|
* @typedef CreateTagSchema
|
|
408
|
-
* @property {string} [name]
|
|
409
|
-
*
|
|
410
|
-
* @property {string} [
|
|
411
|
-
*
|
|
412
|
-
* @property {string} [
|
|
413
|
-
* @property {string} [
|
|
414
|
-
*
|
|
415
|
-
* @property {
|
|
416
|
-
*
|
|
413
|
+
* @property {string} [name] - The name of the tag to be created, used for
|
|
414
|
+
* identification purposes.
|
|
415
|
+
* @property {string} [sub_type] - Indicates if the tag is external (linked) or
|
|
416
|
+
* inline (embedded within the page).
|
|
417
|
+
* @property {string} [_id] - The unique identifier for the tag.
|
|
418
|
+
* @property {string} [type] - The type of the tag, either JavaScript ('js') or
|
|
419
|
+
* CSS ('css').
|
|
420
|
+
* @property {string} [url] - The external URL pointing to the script or
|
|
421
|
+
* stylesheet resource.
|
|
422
|
+
* @property {string} [position] - The position on the webpage where the tag
|
|
423
|
+
* will be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
424
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
425
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
426
|
+
* tag type for example:
|
|
427
|
+
*
|
|
428
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
429
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
430
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
431
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
432
|
+
*
|
|
433
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
434
|
+
* third-party tag can be injected or supported.
|
|
435
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be
|
|
436
|
+
* injected or active.
|
|
437
|
+
* @property {string} [content] - The inline content for tags of type 'inline'
|
|
438
|
+
* (e.g., JavaScript or CSS code).
|
|
439
|
+
* @property {TemplateSchema} [template]
|
|
440
|
+
*/
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* @typedef TemplateSchema
|
|
444
|
+
* @property {string} [template_id] - Unique identifier for the template linked
|
|
445
|
+
* to the tag.
|
|
446
|
+
* @property {string} [template_version] - Version number of the template used
|
|
447
|
+
* for configuration.
|
|
448
|
+
* @property {TemplateField[]} [template_fields] - List of dynamic key-value
|
|
449
|
+
* pairs defining configuration fields for third-party integrations or custom settings.
|
|
450
|
+
*/
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* @typedef TemplateField
|
|
454
|
+
* @property {string} [key] - Field name representing the configuration key.
|
|
455
|
+
* @property {string} [value] - Value assigned to the configuration field.
|
|
417
456
|
*/
|
|
418
457
|
|
|
419
458
|
/**
|
|
420
459
|
* @typedef CreateTagRequestSchema
|
|
421
|
-
* @property {CreateTagSchema[]} [tags]
|
|
460
|
+
* @property {CreateTagSchema[]} [tags] - A list of tags to be created or
|
|
461
|
+
* updated, each containing details such as name, type, and attributes.
|
|
422
462
|
*/
|
|
423
463
|
|
|
424
464
|
/**
|
|
@@ -433,6 +473,62 @@ const Joi = require("joi");
|
|
|
433
473
|
* @property {string} [_id]
|
|
434
474
|
*/
|
|
435
475
|
|
|
476
|
+
/**
|
|
477
|
+
* @typedef TagsTemplateSchema
|
|
478
|
+
* @property {TagTemplateItem[]} [items] - Array of tag template objects.
|
|
479
|
+
*/
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* @typedef TagTemplateItem
|
|
483
|
+
* @property {string} [template_name] - Static name of the tag template (e.g.,
|
|
484
|
+
* gtm, ga4, metaPixel, sentry).
|
|
485
|
+
* @property {string} [type] - Script type.
|
|
486
|
+
* @property {string} [sub_type] - Script loading subtype.
|
|
487
|
+
* @property {string} [position] - Where the script should be injected.
|
|
488
|
+
* @property {string[]} [pages] - List of page types where the tag should be active.
|
|
489
|
+
* @property {Object} [attributes] - HTML attributes to apply on the script tag.
|
|
490
|
+
* @property {string[]} [compatible_engines] - List of compatible UI frameworks.
|
|
491
|
+
* @property {Object} [field_mappings] - Maps UI field names to backend keys.
|
|
492
|
+
* @property {TemplateLayout} [layout]
|
|
493
|
+
* @property {string} [name] - Human-readable name of the template.
|
|
494
|
+
* @property {string} [path] - URL-safe path or slug for the template.
|
|
495
|
+
* @property {string} [description] - Explains the purpose or behavior of the template.
|
|
496
|
+
* @property {string} [image] - URL to an icon or image for the template.
|
|
497
|
+
* @property {string} [note] - Helpful guidance for configuring the template.
|
|
498
|
+
* @property {string} [template_id] - Unique template identifier.
|
|
499
|
+
* @property {string} [template_version] - Version of this template.
|
|
500
|
+
* @property {string} [category] - Functional category of the template.
|
|
501
|
+
* @property {FieldDefinition[]} [fields] - Array of field definitions for
|
|
502
|
+
* template configuration.
|
|
503
|
+
* @property {string} [script] - JavaScript snippet or template script code.
|
|
504
|
+
*/
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* @typedef TemplateLayout
|
|
508
|
+
* @property {number} [columns]
|
|
509
|
+
* @property {string} [gap]
|
|
510
|
+
* @property {boolean} [responsive]
|
|
511
|
+
*/
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* @typedef FieldDefinition
|
|
515
|
+
* @property {string} [name] - Field key used in templates and mappings.
|
|
516
|
+
* @property {string} [type] - Input type (e.g., text, boolean, array, note).
|
|
517
|
+
* @property {string} [label]
|
|
518
|
+
* @property {string} [placeholder]
|
|
519
|
+
* @property {boolean} [required]
|
|
520
|
+
* @property {string} [size] - Visual width in the form layout.
|
|
521
|
+
* @property {string} [description]
|
|
522
|
+
* @property {FieldValidation} [validation]
|
|
523
|
+
* @property {Object} [events] - Optional client-side events configuration.
|
|
524
|
+
*/
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* @typedef FieldValidation
|
|
528
|
+
* @property {string} [pattern] - Regex pattern used for validation.
|
|
529
|
+
* @property {string} [message] - Error message shown when validation fails.
|
|
530
|
+
*/
|
|
531
|
+
|
|
436
532
|
/**
|
|
437
533
|
* @typedef DataLoaderSourceSchema
|
|
438
534
|
* @property {string} [type]
|
|
@@ -445,8 +541,9 @@ const Joi = require("joi");
|
|
|
445
541
|
*/
|
|
446
542
|
|
|
447
543
|
/**
|
|
448
|
-
* @typedef
|
|
449
|
-
* @property {boolean} [success]
|
|
544
|
+
* @typedef TagDeleteSuccessDetails
|
|
545
|
+
* @property {boolean} [success] - Indicates whether the tag removal operation
|
|
546
|
+
* was successful.
|
|
450
547
|
*/
|
|
451
548
|
|
|
452
549
|
/**
|
|
@@ -566,17 +663,18 @@ const Joi = require("joi");
|
|
|
566
663
|
|
|
567
664
|
/**
|
|
568
665
|
* @typedef Page
|
|
569
|
-
* @property {number} [item_total] - The total number of items
|
|
666
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
570
667
|
* @property {string} [next_id] - The identifier for the next page.
|
|
571
668
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
572
669
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
573
670
|
* @property {number} [current] - The current page number.
|
|
574
|
-
* @property {string} type - The type of the page,
|
|
671
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
575
672
|
* @property {number} [size] - The number of items per page.
|
|
673
|
+
* @property {number} [page_size] - The number of items per page.
|
|
576
674
|
*/
|
|
577
675
|
|
|
578
676
|
/**
|
|
579
|
-
* @typedef
|
|
677
|
+
* @typedef LandingPageGetDetails
|
|
580
678
|
* @property {LandingPageSchema[]} [items]
|
|
581
679
|
* @property {Page} [page]
|
|
582
680
|
*/
|
|
@@ -595,12 +693,12 @@ const Joi = require("joi");
|
|
|
595
693
|
*/
|
|
596
694
|
|
|
597
695
|
/**
|
|
598
|
-
* @typedef
|
|
696
|
+
* @typedef DefaultNavigationDetails
|
|
599
697
|
* @property {NavigationSchema[]} [items]
|
|
600
698
|
*/
|
|
601
699
|
|
|
602
700
|
/**
|
|
603
|
-
* @typedef
|
|
701
|
+
* @typedef NavigationGetDetails
|
|
604
702
|
* @property {NavigationSchema[]} [items]
|
|
605
703
|
* @property {Page} [page]
|
|
606
704
|
*/
|
|
@@ -627,7 +725,7 @@ const Joi = require("joi");
|
|
|
627
725
|
*/
|
|
628
726
|
|
|
629
727
|
/**
|
|
630
|
-
* @typedef
|
|
728
|
+
* @typedef NavigationPayload
|
|
631
729
|
* @property {string} [name]
|
|
632
730
|
* @property {string} [slug]
|
|
633
731
|
* @property {string[]} [platform]
|
|
@@ -636,7 +734,7 @@ const Joi = require("joi");
|
|
|
636
734
|
*/
|
|
637
735
|
|
|
638
736
|
/**
|
|
639
|
-
* @typedef
|
|
737
|
+
* @typedef PageGetDetails
|
|
640
738
|
* @property {PageSchema[]} [items]
|
|
641
739
|
* @property {Page} [page]
|
|
642
740
|
*/
|
|
@@ -693,7 +791,7 @@ const Joi = require("joi");
|
|
|
693
791
|
*/
|
|
694
792
|
|
|
695
793
|
/**
|
|
696
|
-
* @typedef
|
|
794
|
+
* @typedef PagePayload
|
|
697
795
|
* @property {CronSchedule} [_schedule]
|
|
698
796
|
* @property {string} [application]
|
|
699
797
|
* @property {Author} [author]
|
|
@@ -718,7 +816,7 @@ const Joi = require("joi");
|
|
|
718
816
|
*/
|
|
719
817
|
|
|
720
818
|
/**
|
|
721
|
-
* @typedef
|
|
819
|
+
* @typedef PagePublishPayload
|
|
722
820
|
* @property {boolean} [publish]
|
|
723
821
|
*/
|
|
724
822
|
|
|
@@ -729,35 +827,6 @@ const Joi = require("joi");
|
|
|
729
827
|
* @property {string} [application_id]
|
|
730
828
|
*/
|
|
731
829
|
|
|
732
|
-
/**
|
|
733
|
-
* @typedef SlideshowGetResponse
|
|
734
|
-
* @property {SlideshowSchema[]} [items]
|
|
735
|
-
* @property {Page} [page]
|
|
736
|
-
*/
|
|
737
|
-
|
|
738
|
-
/**
|
|
739
|
-
* @typedef SlideshowSchema
|
|
740
|
-
* @property {string} [_id]
|
|
741
|
-
* @property {string} [slug]
|
|
742
|
-
* @property {DateMeta} [date_meta]
|
|
743
|
-
* @property {string} [application]
|
|
744
|
-
* @property {string} [platform]
|
|
745
|
-
* @property {ConfigurationSchema} [configuration]
|
|
746
|
-
* @property {SlideshowMedia[]} [media]
|
|
747
|
-
* @property {boolean} [active]
|
|
748
|
-
* @property {boolean} [archived]
|
|
749
|
-
* @property {Object} [_custom_json]
|
|
750
|
-
*/
|
|
751
|
-
|
|
752
|
-
/**
|
|
753
|
-
* @typedef SlideshowRequest
|
|
754
|
-
* @property {string} [slug]
|
|
755
|
-
* @property {string} [platform]
|
|
756
|
-
* @property {ConfigurationSchema} [configuration]
|
|
757
|
-
* @property {SlideshowMedia} [media]
|
|
758
|
-
* @property {boolean} [active]
|
|
759
|
-
*/
|
|
760
|
-
|
|
761
830
|
/**
|
|
762
831
|
* @typedef Support
|
|
763
832
|
* @property {boolean} [created]
|
|
@@ -802,29 +871,48 @@ const Joi = require("joi");
|
|
|
802
871
|
|
|
803
872
|
/**
|
|
804
873
|
* @typedef TagsSchema
|
|
805
|
-
* @property {string} [application]
|
|
806
|
-
* @property {string} [_id]
|
|
807
|
-
* @property {
|
|
874
|
+
* @property {string} [application] - The ID of the application that owns the tags.
|
|
875
|
+
* @property {string} [_id] - The unique identifier for the tag set.
|
|
876
|
+
* @property {string} [company] - The ID of the company associated with this tags.
|
|
877
|
+
* @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
|
|
878
|
+
* or stylesheets) that are configured for the application.
|
|
808
879
|
*/
|
|
809
880
|
|
|
810
881
|
/**
|
|
811
882
|
* @typedef TagSchema
|
|
812
|
-
* @property {string} [name]
|
|
813
|
-
* @property {string} [url]
|
|
814
|
-
*
|
|
815
|
-
* @property {string} [
|
|
816
|
-
*
|
|
817
|
-
* @property {string} [
|
|
818
|
-
*
|
|
819
|
-
* @property {string} [
|
|
820
|
-
* @property {
|
|
883
|
+
* @property {string} [name] - The name of the tag used to identify it.
|
|
884
|
+
* @property {string} [url] - The URL where the external tag resource (such as a
|
|
885
|
+
* script or stylesheet) is located.
|
|
886
|
+
* @property {string} [type] - Specifies whether the tag is a JavaScript ('js')
|
|
887
|
+
* or CSS ('css') tag.
|
|
888
|
+
* @property {string} [sub_type] - Indicates whether the tag is an external
|
|
889
|
+
* resource (external) or inline content (inline).
|
|
890
|
+
* @property {string} [_id] - The unique identifier for the tag in the system.
|
|
891
|
+
* @property {string} [position] - The position within the page where the tag
|
|
892
|
+
* should be injected.
|
|
893
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
894
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
895
|
+
* tag type for example:
|
|
896
|
+
*
|
|
897
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
898
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
899
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
900
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
901
|
+
*
|
|
902
|
+
* @property {string} [content] - Content of the tag if it is inline, such as
|
|
903
|
+
* JavaScript or CSS code.
|
|
904
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
905
|
+
* third-party tag can be injected or supported.
|
|
906
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be active.
|
|
821
907
|
* @property {TagSourceSchema} [__source]
|
|
908
|
+
* @property {TemplateSchema} [template]
|
|
822
909
|
*/
|
|
823
910
|
|
|
824
911
|
/**
|
|
825
912
|
* @typedef TagSourceSchema
|
|
826
|
-
* @property {string} [type]
|
|
827
|
-
* @property {string} [id]
|
|
913
|
+
* @property {string} [type] - The type of source, such as 'extension'
|
|
914
|
+
* @property {string} [id] - The identifier of the source that created or
|
|
915
|
+
* provided the tag.
|
|
828
916
|
*/
|
|
829
917
|
|
|
830
918
|
/**
|
|
@@ -841,100 +929,116 @@ const Joi = require("joi");
|
|
|
841
929
|
|
|
842
930
|
/**
|
|
843
931
|
* @typedef FieldValidations
|
|
844
|
-
* @property {string} [name]
|
|
845
|
-
* @property {string} [type]
|
|
932
|
+
* @property {string} [name] - Name of validation
|
|
933
|
+
* @property {string} [type] - Type of validation
|
|
846
934
|
* @property {Object} [value]
|
|
847
935
|
*/
|
|
848
936
|
|
|
849
937
|
/**
|
|
850
938
|
* @typedef FieldDefinitionSchema
|
|
851
|
-
* @property {string} [
|
|
852
|
-
* @property {string} [
|
|
853
|
-
* @property {string} [
|
|
854
|
-
* @property {string} [
|
|
855
|
-
* @property {string} [
|
|
856
|
-
* @property {string} [
|
|
857
|
-
* @property {string} [
|
|
858
|
-
* @property {
|
|
859
|
-
*
|
|
860
|
-
* @property {FieldValidations[]} [validations]
|
|
861
|
-
* @property {string} [company_id]
|
|
862
|
-
* @property {
|
|
863
|
-
* @property {
|
|
864
|
-
* @property {
|
|
865
|
-
* @property {
|
|
866
|
-
* @property {string} [created_at]
|
|
867
|
-
* @property {string} [updated_at]
|
|
868
|
-
* @property {string} [type_name]
|
|
869
|
-
* @property {number} [invalid_fields_count]
|
|
939
|
+
* @property {string} [id] - Unique system generated id
|
|
940
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
941
|
+
* @property {string} [name] - Name of custom field
|
|
942
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
943
|
+
* @property {string} [slug] - Slug of custom field
|
|
944
|
+
* @property {string} [description] - Description of custom field definition
|
|
945
|
+
* @property {string} [type] - Data type of custom field
|
|
946
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
947
|
+
* multivalued or not
|
|
948
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
949
|
+
* @property {string} [company_id] - Id of company
|
|
950
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
951
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
952
|
+
* @property {string} [type_name] - Type of type field
|
|
953
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
870
954
|
*/
|
|
871
955
|
|
|
872
956
|
/**
|
|
873
957
|
* @typedef CustomFieldDefinitionsSchema
|
|
874
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
958
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
875
959
|
* @property {Page} [page]
|
|
876
960
|
*/
|
|
877
961
|
|
|
878
962
|
/**
|
|
879
963
|
* @typedef CustomFieldDefinitionRequestSchema
|
|
880
|
-
* @property {string} [
|
|
881
|
-
* @property {string} [
|
|
882
|
-
* @property {string} [
|
|
883
|
-
* @property {
|
|
884
|
-
*
|
|
885
|
-
* @property {string} [name]
|
|
886
|
-
* @property {string} [description]
|
|
887
|
-
* @property {FieldValidations[]} [validations]
|
|
964
|
+
* @property {string} [type] - Data type of custom field
|
|
965
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
966
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
967
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
968
|
+
* multi valued or not
|
|
969
|
+
* @property {string} [name] - Name of custom field definition
|
|
970
|
+
* @property {string} [description] - Description of a custom field definition
|
|
971
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
888
972
|
*/
|
|
889
973
|
|
|
890
974
|
/**
|
|
891
975
|
* @typedef CustomObjectCustomFieldDefinitions
|
|
892
|
-
* @property {string} [id]
|
|
893
|
-
* @property {string} [type]
|
|
894
|
-
* @property {string} [description]
|
|
895
|
-
* @property {string} [name]
|
|
896
|
-
* @property {boolean} [multi_value]
|
|
897
|
-
*
|
|
898
|
-
* @property {
|
|
899
|
-
* @property {
|
|
976
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
977
|
+
* @property {string} [type] - Data type of custom field
|
|
978
|
+
* @property {string} [description] - Description of custom field
|
|
979
|
+
* @property {string} [name] - Name of custom field
|
|
980
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
981
|
+
* valued or not
|
|
982
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
983
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
984
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
985
|
+
* custom field
|
|
900
986
|
* @property {string} [action]
|
|
901
987
|
*/
|
|
902
988
|
|
|
903
989
|
/**
|
|
904
990
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
905
|
-
* @property {string} [
|
|
906
|
-
* @property {string} [
|
|
907
|
-
* @property {string} [
|
|
908
|
-
*
|
|
991
|
+
* @property {string} [description] - Description of custom object definiton
|
|
992
|
+
* @property {string} [name] - Name of custom object definition
|
|
993
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
994
|
+
* display key in
|
|
909
995
|
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
910
996
|
*/
|
|
911
997
|
|
|
912
998
|
/**
|
|
913
999
|
* @typedef CustomFieldDefinitionDetailResSchema
|
|
914
|
-
* @property {string} [
|
|
915
|
-
* @property {string} [
|
|
916
|
-
* @property {string} [
|
|
917
|
-
* @property {string} [
|
|
918
|
-
* @property {string} [
|
|
919
|
-
* @property {string} [
|
|
920
|
-
* @property {
|
|
921
|
-
*
|
|
922
|
-
* @property {string} [company_id]
|
|
923
|
-
* @property {string} [application_id]
|
|
924
|
-
* @property {
|
|
925
|
-
* @property {
|
|
926
|
-
* @property {
|
|
927
|
-
* @property {boolean} [is_deleted]
|
|
928
|
-
* @property {string} [_id]
|
|
1000
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
1001
|
+
* @property {string} [name] - Name of custom field
|
|
1002
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
1003
|
+
* @property {string} [slug] - Slug of custom field
|
|
1004
|
+
* @property {string} [description] - Description regarding custom field
|
|
1005
|
+
* @property {string} [type] - Data type of custom field
|
|
1006
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
1007
|
+
* multi valued or not
|
|
1008
|
+
* @property {string} [company_id] - Company Identifer
|
|
1009
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
1010
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
1011
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
1012
|
+
* @property {string} [id] - Unique system generated id
|
|
929
1013
|
* @property {Object[]} [validations]
|
|
930
|
-
* @property {string} [created_at]
|
|
931
|
-
* @property {string} [updated_at]
|
|
1014
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
1015
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
1016
|
+
*/
|
|
1017
|
+
|
|
1018
|
+
/**
|
|
1019
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
1020
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
1021
|
+
* @property {string} [name] - Name of meta field
|
|
1022
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
1023
|
+
* @property {string} [slug] - Slug of meta field
|
|
1024
|
+
* @property {string} [description] - Description regarding meta field
|
|
1025
|
+
* @property {string} [type] - Data type of meta field
|
|
1026
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
1027
|
+
* multi valued or not
|
|
1028
|
+
* @property {string} [company_id] - Company Identifer
|
|
1029
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
1030
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
1031
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
1032
|
+
* @property {string} [id] - Unique system generated id
|
|
1033
|
+
* @property {Object[]} [validations]
|
|
1034
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
1035
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
932
1036
|
*/
|
|
933
1037
|
|
|
934
1038
|
/**
|
|
935
1039
|
* @typedef CustomDataDeleteSchema
|
|
936
|
-
* @property {boolean} [success]
|
|
937
|
-
* @property {string} [message]
|
|
1040
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
1041
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
938
1042
|
*/
|
|
939
1043
|
|
|
940
1044
|
/**
|
|
@@ -944,23 +1048,20 @@ const Joi = require("joi");
|
|
|
944
1048
|
|
|
945
1049
|
/**
|
|
946
1050
|
* @typedef CustomFieldSchema
|
|
947
|
-
* @property {string} [
|
|
948
|
-
* @property {string} [namespace]
|
|
949
|
-
* @property {string} [
|
|
950
|
-
* @property {string} [resource]
|
|
951
|
-
* @property {string} [creator]
|
|
1051
|
+
* @property {string} [id] - Unique system generated id
|
|
1052
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1053
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1054
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
952
1055
|
* @property {CustomFieldValue[]} [value]
|
|
953
|
-
* @property {string} [
|
|
954
|
-
* @property {string} [type]
|
|
955
|
-
* @property {boolean} [multi_value]
|
|
956
|
-
* @property {string} [company_id]
|
|
957
|
-
* @property {string} [definition_id]
|
|
1056
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
1057
|
+
* @property {string} [type] - Data type of custom field
|
|
1058
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
1059
|
+
* @property {string} [company_id] - Identifer for a company
|
|
958
1060
|
* @property {boolean} [has_invalid_values]
|
|
959
1061
|
* @property {Object[]} [invalid_value_errors]
|
|
960
|
-
* @property {
|
|
961
|
-
* @property {
|
|
962
|
-
* @property {string} [
|
|
963
|
-
* @property {string} [updated_at]
|
|
1062
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
1063
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
1064
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
964
1065
|
*/
|
|
965
1066
|
|
|
966
1067
|
/**
|
|
@@ -969,6 +1070,12 @@ const Joi = require("joi");
|
|
|
969
1070
|
* @property {Page} [page]
|
|
970
1071
|
*/
|
|
971
1072
|
|
|
1073
|
+
/**
|
|
1074
|
+
* @typedef CustomFieldsDeleteSchema
|
|
1075
|
+
* @property {boolean} [success]
|
|
1076
|
+
* @property {string} [message]
|
|
1077
|
+
*/
|
|
1078
|
+
|
|
972
1079
|
/**
|
|
973
1080
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
974
1081
|
* @property {CustomFieldSchema[]} [items]
|
|
@@ -977,7 +1084,9 @@ const Joi = require("joi");
|
|
|
977
1084
|
/**
|
|
978
1085
|
* @typedef CustomField
|
|
979
1086
|
* @property {Object[]} [value]
|
|
980
|
-
* @property {string} [
|
|
1087
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
1088
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
1089
|
+
* creating a custom field definition
|
|
981
1090
|
*/
|
|
982
1091
|
|
|
983
1092
|
/**
|
|
@@ -987,161 +1096,156 @@ const Joi = require("joi");
|
|
|
987
1096
|
|
|
988
1097
|
/**
|
|
989
1098
|
* @typedef CustomObjectSchema
|
|
990
|
-
* @property {string} [
|
|
991
|
-
* @property {string} [
|
|
992
|
-
* @property {string} [
|
|
993
|
-
* @property {string} [
|
|
994
|
-
* @property {string} [
|
|
995
|
-
* @property {string} [
|
|
996
|
-
* @property {string} [
|
|
997
|
-
*
|
|
998
|
-
* @property {
|
|
999
|
-
* @property {string} [definition_id]
|
|
1000
|
-
* @property {CustomFieldSchema[]} [fields]
|
|
1099
|
+
* @property {string} [id] - Unique system generated id
|
|
1100
|
+
* @property {string} [company_id] - Identifer for a company
|
|
1101
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
1102
|
+
* @property {string} [status] - Status of custom object
|
|
1103
|
+
* @property {string} [type] - Slug of custom object definition
|
|
1104
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
1105
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
1106
|
+
* custom object
|
|
1107
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
1001
1108
|
*/
|
|
1002
1109
|
|
|
1003
1110
|
/**
|
|
1004
1111
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
1005
|
-
* @property {string} [type]
|
|
1006
|
-
* @property {string} [
|
|
1007
|
-
* @property {string} [
|
|
1008
|
-
* @property {string} [
|
|
1009
|
-
* @property {
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
* @typedef CustomObjectCustomFieldDefinitionResSchema
|
|
1014
|
-
* @property {string} [creator]
|
|
1015
|
-
* @property {string} [resource]
|
|
1016
|
-
* @property {string} [name]
|
|
1017
|
-
* @property {string} [namespace]
|
|
1018
|
-
* @property {string} [key]
|
|
1019
|
-
* @property {string} [description]
|
|
1020
|
-
* @property {string} [type]
|
|
1021
|
-
* @property {boolean} [multi_value]
|
|
1022
|
-
* @property {FieldValidations[]} [validations]
|
|
1023
|
-
* @property {string} [company_id]
|
|
1024
|
-
* @property {string} [created_by]
|
|
1025
|
-
* @property {string} [metaobject_definition_id]
|
|
1026
|
-
* @property {boolean} [required]
|
|
1027
|
-
* @property {boolean} [is_deleted]
|
|
1028
|
-
* @property {string} [_id]
|
|
1029
|
-
* @property {string} [created_at]
|
|
1030
|
-
* @property {string} [updated_at]
|
|
1112
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
1113
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
1114
|
+
* @property {string} [description] - Description of custom object definition
|
|
1115
|
+
* @property {string} [name] - Name of custom object
|
|
1116
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
1117
|
+
* for displaying custom object
|
|
1118
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
1119
|
+
* of custom field definitions belonging to this custom object definition
|
|
1031
1120
|
*/
|
|
1032
1121
|
|
|
1033
1122
|
/**
|
|
1034
|
-
* @typedef
|
|
1035
|
-
* @property {string} [
|
|
1036
|
-
* @property {string} [name]
|
|
1037
|
-
* @property {string} [type]
|
|
1038
|
-
* @property {string} [
|
|
1039
|
-
* @property {string} [
|
|
1040
|
-
* @property {string} [
|
|
1041
|
-
* @property {
|
|
1042
|
-
*
|
|
1043
|
-
* @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
|
|
1123
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
1124
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
1125
|
+
* @property {string} [name] - Display name of custom object definition
|
|
1126
|
+
* @property {string} [type] - Type of custom object definiton
|
|
1127
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
1128
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
1129
|
+
* @property {string} [description] - Description of custom object definition
|
|
1130
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
1131
|
+
* Custom fields inside custom objects
|
|
1044
1132
|
*/
|
|
1045
1133
|
|
|
1046
1134
|
/**
|
|
1047
1135
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
1048
|
-
* @property {boolean} [success]
|
|
1049
|
-
* @property {string} [message]
|
|
1136
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
1137
|
+
* @property {string} [message] - Response message when custom object definition
|
|
1138
|
+
* is deleted.
|
|
1050
1139
|
*/
|
|
1051
1140
|
|
|
1052
1141
|
/**
|
|
1053
|
-
* @typedef
|
|
1054
|
-
* @property {string} [url]
|
|
1055
|
-
* @property {number} [total_records]
|
|
1142
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
1143
|
+
* @property {string} [url] - Signed url of csv
|
|
1144
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
1056
1145
|
*/
|
|
1057
1146
|
|
|
1058
1147
|
/**
|
|
1059
|
-
* @typedef
|
|
1060
|
-
* @property {string} [
|
|
1061
|
-
* @property {string} [name]
|
|
1062
|
-
* @property {string} [type]
|
|
1148
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
1149
|
+
* @property {string} [id] - Unique system generated id
|
|
1150
|
+
* @property {string} [name] - Name of custom object
|
|
1151
|
+
* @property {string} [type] - Type of custom object entry
|
|
1063
1152
|
*/
|
|
1064
1153
|
|
|
1065
1154
|
/**
|
|
1066
1155
|
* @typedef CustomObjectListItemSchema
|
|
1067
|
-
* @property {string} [
|
|
1068
|
-
* @property {string} [
|
|
1069
|
-
* @property {string} [
|
|
1070
|
-
* @property {string} [updated_at]
|
|
1071
|
-
* @property {string} [display_name]
|
|
1072
|
-
* @property {
|
|
1073
|
-
* @property {number} [references]
|
|
1156
|
+
* @property {string} [id] - Unique system generated id
|
|
1157
|
+
* @property {string} [status] - Status of custom object
|
|
1158
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
1159
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
1160
|
+
* @property {string} [display_name] - Display name of custom object
|
|
1161
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1162
|
+
* @property {number} [references] - References of the custom object entry
|
|
1074
1163
|
*/
|
|
1075
1164
|
|
|
1076
1165
|
/**
|
|
1077
1166
|
* @typedef CustomObjectsSchema
|
|
1078
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
1167
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
1168
|
+
* object entries
|
|
1079
1169
|
* @property {Page} [page]
|
|
1080
1170
|
*/
|
|
1081
1171
|
|
|
1082
1172
|
/**
|
|
1083
|
-
* @typedef
|
|
1084
|
-
* @property {string} [
|
|
1085
|
-
* @property {string} [
|
|
1086
|
-
* @property {
|
|
1087
|
-
* @property {
|
|
1088
|
-
* @property {string} [
|
|
1173
|
+
* @typedef CustomObjectFieldDefinition
|
|
1174
|
+
* @property {string} [id] - Unique system generate id
|
|
1175
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1176
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1177
|
+
* @property {Object[]} [value] - Value of custom field
|
|
1178
|
+
* @property {string} [type] - Data type of the custom field
|
|
1089
1179
|
*/
|
|
1090
1180
|
|
|
1091
1181
|
/**
|
|
1092
|
-
* @typedef
|
|
1093
|
-
* @property {string} [
|
|
1094
|
-
* @property {string} [status]
|
|
1095
|
-
* @property {string} [display_name]
|
|
1096
|
-
* @property {
|
|
1097
|
-
* @property {Object[]} [references]
|
|
1098
|
-
*
|
|
1182
|
+
* @typedef CustomObjectBySlugSchema
|
|
1183
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
1184
|
+
* @property {string} [status] - Status of Custom Object
|
|
1185
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
1186
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1187
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
1188
|
+
* used as a custom field
|
|
1189
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
1190
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
1191
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
1192
|
+
* inside the custom object
|
|
1099
1193
|
*/
|
|
1100
1194
|
|
|
1101
1195
|
/**
|
|
1102
1196
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
1103
|
-
* @property {string} [message]
|
|
1104
|
-
* @property {string} [task_id]
|
|
1197
|
+
* @property {string} [message] - Message for the user
|
|
1198
|
+
* @property {string} [task_id] - Identifer for a task
|
|
1105
1199
|
*/
|
|
1106
1200
|
|
|
1107
1201
|
/**
|
|
1108
1202
|
* @typedef CustomObjectMetaSchema
|
|
1109
|
-
* @property {number} [mo_total_count]
|
|
1110
|
-
* @property {number} [mo_success_count]
|
|
1111
|
-
* @property {number} [mo_error_count]
|
|
1112
|
-
* @property {string} [mo_defintion_type]
|
|
1203
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
1204
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
1205
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
1206
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
1207
|
+
*/
|
|
1208
|
+
|
|
1209
|
+
/**
|
|
1210
|
+
* @typedef JobSchema
|
|
1211
|
+
* @property {string} [id] - Unique system generated id
|
|
1212
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
1213
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
1214
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1215
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1216
|
+
* @property {string} [company_id] - Company Identifer
|
|
1217
|
+
* @property {string} [status] - Status of job
|
|
1218
|
+
* @property {string} [action_type] - Type of job
|
|
1219
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1220
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1221
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1222
|
+
* @property {number} [error_count] - Number of items in error
|
|
1223
|
+
* @property {number} [success_count] - Number of successful items
|
|
1224
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1225
|
+
* @property {CustomObjectMetaSchema} [meta]
|
|
1226
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1227
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1228
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1229
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
1113
1230
|
*/
|
|
1114
1231
|
|
|
1115
1232
|
/**
|
|
1116
|
-
* @typedef
|
|
1117
|
-
* @property {
|
|
1118
|
-
* @property {
|
|
1119
|
-
* @property {string[]} [finished_jobs]
|
|
1120
|
-
* @property {string[]} [error_jobs]
|
|
1121
|
-
* @property {string[]} [errors_occured]
|
|
1122
|
-
* @property {string} [company_id]
|
|
1123
|
-
* @property {string} [creator]
|
|
1124
|
-
* @property {string} [url]
|
|
1125
|
-
* @property {string} [status]
|
|
1126
|
-
* @property {string} [action_type]
|
|
1127
|
-
* @property {string} [entity]
|
|
1128
|
-
* @property {string} [error_url]
|
|
1129
|
-
* @property {number} [finished_count]
|
|
1130
|
-
* @property {number} [error_count]
|
|
1131
|
-
* @property {number} [success_count]
|
|
1132
|
-
* @property {number} [total_jobs]
|
|
1133
|
-
* @property {CustomObjectMetaSchema} [meta]
|
|
1134
|
-
* @property {string} [created_by]
|
|
1135
|
-
* @property {string} [created_at]
|
|
1136
|
-
* @property {string} [updated_at]
|
|
1233
|
+
* @typedef CustomFieldBulkEntry
|
|
1234
|
+
* @property {JobSchema[]} [items]
|
|
1235
|
+
* @property {Page} [page]
|
|
1137
1236
|
*/
|
|
1138
1237
|
|
|
1139
1238
|
/**
|
|
1140
1239
|
* @typedef CustomObjectBulkEntry
|
|
1141
|
-
* @property {
|
|
1240
|
+
* @property {JobSchema[]} [items]
|
|
1142
1241
|
* @property {Page} [page]
|
|
1143
1242
|
*/
|
|
1144
1243
|
|
|
1244
|
+
/**
|
|
1245
|
+
* @typedef MetafieldTypesSchema
|
|
1246
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1247
|
+
*/
|
|
1248
|
+
|
|
1145
1249
|
/**
|
|
1146
1250
|
* @typedef CustomFieldTypeSchema
|
|
1147
1251
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1157,6 +1261,8 @@ const Joi = require("joi");
|
|
|
1157
1261
|
* @property {Url} [url]
|
|
1158
1262
|
* @property {Metaobject} [metaobject]
|
|
1159
1263
|
* @property {Product} [product]
|
|
1264
|
+
* @property {HTML} [html]
|
|
1265
|
+
* @property {Duration} [duration]
|
|
1160
1266
|
*/
|
|
1161
1267
|
|
|
1162
1268
|
/**
|
|
@@ -1179,130 +1285,164 @@ const Joi = require("joi");
|
|
|
1179
1285
|
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1180
1286
|
*/
|
|
1181
1287
|
|
|
1288
|
+
/**
|
|
1289
|
+
* @typedef Duration
|
|
1290
|
+
* @property {string} [name] - Name data type of custom field
|
|
1291
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1292
|
+
* @property {string} [type] - Type of custom field
|
|
1293
|
+
* @property {string} [category] - Category of custom field
|
|
1294
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1295
|
+
* validations available for the field
|
|
1296
|
+
*/
|
|
1297
|
+
|
|
1298
|
+
/**
|
|
1299
|
+
* @typedef HTML
|
|
1300
|
+
* @property {string} [name] - Name data type of custom field
|
|
1301
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1302
|
+
* @property {string} [type] - Type of custom field
|
|
1303
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1304
|
+
* validations available for the field
|
|
1305
|
+
*/
|
|
1306
|
+
|
|
1182
1307
|
/**
|
|
1183
1308
|
* @typedef StringSingleLine
|
|
1184
|
-
* @property {string} [name]
|
|
1185
|
-
* @property {boolean} [list_enabled]
|
|
1186
|
-
* @property {string} [category]
|
|
1187
|
-
* @property {string} [type]
|
|
1188
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1309
|
+
* @property {string} [name] - Name data type of custom field
|
|
1310
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1311
|
+
* @property {string} [category] - Category of custom field
|
|
1312
|
+
* @property {string} [type] - Type of custom field
|
|
1313
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1314
|
+
* validations available for the field
|
|
1189
1315
|
*/
|
|
1190
1316
|
|
|
1191
1317
|
/**
|
|
1192
1318
|
* @typedef StringMultiLine
|
|
1193
|
-
* @property {string} [name]
|
|
1194
|
-
* @property {boolean} [list_enabled]
|
|
1195
|
-
* @property {string} [category]
|
|
1196
|
-
* @property {string} [type]
|
|
1197
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1319
|
+
* @property {string} [name] - Name data type of custom field
|
|
1320
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1321
|
+
* @property {string} [category] - Category of custom field
|
|
1322
|
+
* @property {string} [type] - Type of custom field
|
|
1323
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1324
|
+
* validations available for the field
|
|
1198
1325
|
*/
|
|
1199
1326
|
|
|
1200
1327
|
/**
|
|
1201
1328
|
* @typedef Dropdown
|
|
1202
|
-
* @property {string} [name]
|
|
1203
|
-
* @property {boolean} [list_enabled]
|
|
1204
|
-
* @property {string} [category]
|
|
1205
|
-
* @property {string} [type]
|
|
1206
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1329
|
+
* @property {string} [name] - Name data type of custom field
|
|
1330
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1331
|
+
* @property {string} [category] - Category of custom field
|
|
1332
|
+
* @property {string} [type] - Category of custom field
|
|
1333
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1334
|
+
* validations available for the field
|
|
1207
1335
|
*/
|
|
1208
1336
|
|
|
1209
1337
|
/**
|
|
1210
1338
|
* @typedef Integer
|
|
1211
|
-
* @property {string} [name]
|
|
1212
|
-
* @property {boolean} [list_enabled]
|
|
1213
|
-
* @property {string} [type]
|
|
1214
|
-
* @property {string} [category]
|
|
1215
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1339
|
+
* @property {string} [name] - Name data type of custom field
|
|
1340
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1341
|
+
* @property {string} [type] - Type of custom field
|
|
1342
|
+
* @property {string} [category] - Category of custom field
|
|
1343
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1344
|
+
* validations available for the field
|
|
1216
1345
|
*/
|
|
1217
1346
|
|
|
1218
1347
|
/**
|
|
1219
1348
|
* @typedef FloatType
|
|
1220
|
-
* @property {string} [name]
|
|
1221
|
-
* @property {boolean} [list_enabled]
|
|
1222
|
-
* @property {string} [type]
|
|
1223
|
-
* @property {string} [category]
|
|
1224
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1349
|
+
* @property {string} [name] - Name data type of custom field
|
|
1350
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1351
|
+
* @property {string} [type] - Type of custom field
|
|
1352
|
+
* @property {string} [category] - Category of custom field
|
|
1353
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1354
|
+
* validations available for the field
|
|
1225
1355
|
*/
|
|
1226
1356
|
|
|
1227
1357
|
/**
|
|
1228
1358
|
* @typedef BooleanType
|
|
1229
|
-
* @property {string} [name]
|
|
1230
|
-
* @property {string} [category]
|
|
1231
|
-
* @property {boolean} [list_enabled]
|
|
1232
|
-
* @property {string} [type]
|
|
1233
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1359
|
+
* @property {string} [name] - Name data type of custom field
|
|
1360
|
+
* @property {string} [category] - Category of custom field
|
|
1361
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1362
|
+
* @property {string} [type] - Category of custom field
|
|
1363
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1364
|
+
* validations available for the field
|
|
1234
1365
|
*/
|
|
1235
1366
|
|
|
1236
1367
|
/**
|
|
1237
1368
|
* @typedef Date
|
|
1238
|
-
* @property {string} [name]
|
|
1239
|
-
* @property {boolean} [list_enabled]
|
|
1240
|
-
* @property {string} [category]
|
|
1241
|
-
* @property {string} [type]
|
|
1242
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1369
|
+
* @property {string} [name] - Name data type of custom field
|
|
1370
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1371
|
+
* @property {string} [category] - Category of custom field
|
|
1372
|
+
* @property {string} [type] - Type of custom field
|
|
1373
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1374
|
+
* validations available for the field
|
|
1243
1375
|
*/
|
|
1244
1376
|
|
|
1245
1377
|
/**
|
|
1246
1378
|
* @typedef Datetime
|
|
1247
|
-
* @property {string} [name]
|
|
1248
|
-
* @property {string} [category]
|
|
1249
|
-
* @property {boolean} [list_enabled]
|
|
1250
|
-
* @property {string} [type]
|
|
1251
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1379
|
+
* @property {string} [name] - Name data type of custom field
|
|
1380
|
+
* @property {string} [category] - Category of custom field
|
|
1381
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1382
|
+
* @property {string} [type] - Type of custom field
|
|
1383
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1384
|
+
* validations available for the field
|
|
1252
1385
|
*/
|
|
1253
1386
|
|
|
1254
1387
|
/**
|
|
1255
1388
|
* @typedef Json
|
|
1256
|
-
* @property {string} [name]
|
|
1257
|
-
* @property {boolean} [list_enabled]
|
|
1258
|
-
* @property {string} [category]
|
|
1259
|
-
* @property {string} [type]
|
|
1260
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1389
|
+
* @property {string} [name] - Name data type of custom field
|
|
1390
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1391
|
+
* @property {string} [category] - Category of custom field
|
|
1392
|
+
* @property {string} [type] - Type of custom field
|
|
1393
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1394
|
+
* validations available for the field
|
|
1261
1395
|
*/
|
|
1262
1396
|
|
|
1263
1397
|
/**
|
|
1264
1398
|
* @typedef File
|
|
1265
|
-
* @property {string} [name]
|
|
1266
|
-
* @property {string} [category]
|
|
1267
|
-
* @property {boolean} [list_enabled]
|
|
1268
|
-
* @property {string} [type]
|
|
1399
|
+
* @property {string} [name] - Name data type of custom field
|
|
1400
|
+
* @property {string} [category] - Category of custom field
|
|
1401
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1402
|
+
* @property {string} [type] - Type of custom field
|
|
1269
1403
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1270
1404
|
*/
|
|
1271
1405
|
|
|
1272
1406
|
/**
|
|
1273
1407
|
* @typedef Url
|
|
1274
|
-
* @property {string} [name]
|
|
1275
|
-
* @property {boolean} [list_enabled]
|
|
1276
|
-
* @property {string} [type]
|
|
1277
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1408
|
+
* @property {string} [name] - Name data type of custom field
|
|
1409
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1410
|
+
* @property {string} [type] - Type of custom field
|
|
1411
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1412
|
+
* validations available for the field
|
|
1278
1413
|
*/
|
|
1279
1414
|
|
|
1280
1415
|
/**
|
|
1281
1416
|
* @typedef Metaobject
|
|
1282
|
-
* @property {string} [name]
|
|
1283
|
-
* @property {boolean} [list_enabled]
|
|
1284
|
-
*
|
|
1285
|
-
* @property {string} [
|
|
1417
|
+
* @property {string} [name] - Name of Custom Object
|
|
1418
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1419
|
+
* multiple list items
|
|
1420
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1421
|
+
* Custom Object belongs to
|
|
1422
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1286
1423
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1287
1424
|
*/
|
|
1288
1425
|
|
|
1289
1426
|
/**
|
|
1290
1427
|
* @typedef Product
|
|
1291
|
-
* @property {string} [name]
|
|
1292
|
-
* @property {boolean} [list_enabled]
|
|
1293
|
-
*
|
|
1294
|
-
* @property {string} [
|
|
1428
|
+
* @property {string} [name] - Name of Product
|
|
1429
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1430
|
+
* multiple list items
|
|
1431
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1432
|
+
* Product is associated with
|
|
1433
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1295
1434
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1296
1435
|
*/
|
|
1297
1436
|
|
|
1298
1437
|
/**
|
|
1299
1438
|
* @typedef CustomObjectEntry
|
|
1300
|
-
* @property {string} [
|
|
1301
|
-
* @property {string} [name]
|
|
1302
|
-
* @property {string} [type]
|
|
1303
|
-
* @property {string} [updated_at]
|
|
1304
|
-
* @property {number} [entries_count]
|
|
1305
|
-
*
|
|
1439
|
+
* @property {string} [id] - Unique system generated id
|
|
1440
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1441
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1442
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1443
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1444
|
+
* Object definition
|
|
1445
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1306
1446
|
*/
|
|
1307
1447
|
|
|
1308
1448
|
/**
|
|
@@ -1313,21 +1453,33 @@ const Joi = require("joi");
|
|
|
1313
1453
|
|
|
1314
1454
|
/**
|
|
1315
1455
|
* @typedef CustomObjectEntryFieldSchema
|
|
1316
|
-
* @property {string} [
|
|
1317
|
-
* @property {
|
|
1456
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1457
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1458
|
+
*/
|
|
1459
|
+
|
|
1460
|
+
/**
|
|
1461
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1462
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1463
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1318
1464
|
*/
|
|
1319
1465
|
|
|
1320
1466
|
/**
|
|
1321
1467
|
* @typedef CustomObjectRequestSchema
|
|
1322
|
-
* @property {string} [status]
|
|
1323
|
-
* @property {string} [
|
|
1324
|
-
* @property {CustomObjectEntryFieldSchema[]} [fields]
|
|
1468
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1469
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1470
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1471
|
+
*/
|
|
1472
|
+
|
|
1473
|
+
/**
|
|
1474
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1475
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1476
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1325
1477
|
*/
|
|
1326
1478
|
|
|
1327
1479
|
/**
|
|
1328
1480
|
* @typedef CustomObjectBulkSchema
|
|
1329
|
-
* @property {string} [url]
|
|
1330
|
-
* @property {number} [total_records]
|
|
1481
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1482
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1331
1483
|
*/
|
|
1332
1484
|
|
|
1333
1485
|
/**
|
|
@@ -1338,39 +1490,322 @@ const Joi = require("joi");
|
|
|
1338
1490
|
* @property {PageType} type
|
|
1339
1491
|
*/
|
|
1340
1492
|
|
|
1341
|
-
/**
|
|
1493
|
+
/**
|
|
1494
|
+
* @typedef TranslateUiLabels
|
|
1495
|
+
* @property {string} [_id] - Unique identifier assigned to the Translate Ui Labels entry
|
|
1496
|
+
* @property {string} [company_id] - Identifier linking the resource to a
|
|
1497
|
+
* specific company within the platform
|
|
1498
|
+
* @property {string} [application_id] - Reference to the application where this
|
|
1499
|
+
* Translate Ui Labels is utilized
|
|
1500
|
+
* @property {string} [template_theme_id] - Links the resource to a specific
|
|
1501
|
+
* template theme configuration
|
|
1502
|
+
* @property {string} [theme_id] - Associates the resource with a particular
|
|
1503
|
+
* theme implementation
|
|
1504
|
+
* @property {string} [locale] - Specifies the language and region format for
|
|
1505
|
+
* the resource content
|
|
1506
|
+
* @property {Object} [resource] - Contains the actual resource data and
|
|
1507
|
+
* configuration settings
|
|
1508
|
+
* @property {string} [type] - Categorizes the resource type for proper handling
|
|
1509
|
+
* and processing
|
|
1510
|
+
*/
|
|
1342
1511
|
|
|
1343
1512
|
/**
|
|
1344
|
-
* @typedef
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1348
|
-
*
|
|
1349
|
-
*
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
*
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
1356
|
-
*
|
|
1357
|
-
*
|
|
1358
|
-
*
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
*
|
|
1363
|
-
*
|
|
1364
|
-
*
|
|
1365
|
-
*
|
|
1513
|
+
* @typedef TranslateUiLabelsCreate
|
|
1514
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1515
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1516
|
+
* @property {string} [locale] - Locale
|
|
1517
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1518
|
+
* @property {string} [type] - Resource type
|
|
1519
|
+
*/
|
|
1520
|
+
|
|
1521
|
+
/**
|
|
1522
|
+
* @typedef StaticResourceUpdate
|
|
1523
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1524
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1525
|
+
* @property {string} [locale] - Locale
|
|
1526
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1527
|
+
* @property {string} [type] - Resource type
|
|
1528
|
+
*/
|
|
1529
|
+
|
|
1530
|
+
/**
|
|
1531
|
+
* @typedef TranslateUiLabelsPage
|
|
1532
|
+
* @property {TranslateUiLabels[]} [items] - List of items containing all the
|
|
1533
|
+
* static info data.
|
|
1534
|
+
* @property {Page} [page]
|
|
1535
|
+
*/
|
|
1536
|
+
|
|
1537
|
+
/**
|
|
1538
|
+
* @typedef Error
|
|
1539
|
+
* @property {string} [error] - Detailed message explaining the error that occurred
|
|
1540
|
+
*/
|
|
1541
|
+
|
|
1542
|
+
/**
|
|
1543
|
+
* @typedef Meta
|
|
1544
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1545
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1546
|
+
* this resource
|
|
1547
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1548
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1549
|
+
*/
|
|
1550
|
+
|
|
1551
|
+
/**
|
|
1552
|
+
* @typedef CompanyLanguage
|
|
1553
|
+
* @property {string} [_id] - Unique identifier for the company language setting
|
|
1554
|
+
* @property {string} company_id - Identifier of the company this language
|
|
1555
|
+
* configuration belongs to
|
|
1556
|
+
* @property {string} [locale] - Language code following ISO standards for this
|
|
1557
|
+
* company setting
|
|
1558
|
+
* @property {string} [name] - Display name of the language for company usage
|
|
1559
|
+
* @property {string} [direction] - Text direction setting for company content
|
|
1560
|
+
* in this language
|
|
1561
|
+
* @property {boolean} [is_default] - Indicates if this is the default language
|
|
1562
|
+
* for the company
|
|
1563
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1564
|
+
* English for easy reference and display at the website.
|
|
1565
|
+
*/
|
|
1566
|
+
|
|
1567
|
+
/**
|
|
1568
|
+
* @typedef CompanyLanguageCreate
|
|
1569
|
+
* @property {string[]} locales - List of language codes to be added to company
|
|
1570
|
+
* configuration
|
|
1571
|
+
*/
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
* @typedef CompanyLanguageUpdate
|
|
1575
|
+
* @property {boolean} is_default - Sets the specified language as the company default
|
|
1576
|
+
*/
|
|
1577
|
+
|
|
1578
|
+
/**
|
|
1579
|
+
* @typedef ApplicationLanguage
|
|
1580
|
+
* @property {string} [_id] - Unique identifier for the application language setting
|
|
1581
|
+
* @property {string} company_id - Identifier of the company this application belongs to
|
|
1582
|
+
* @property {string} application_id - Unique identifier of the application
|
|
1583
|
+
* using this language
|
|
1584
|
+
* @property {string} locale - Language code following ISO standards for this application
|
|
1585
|
+
* @property {string} name - Display name of the language for application usage
|
|
1586
|
+
* @property {string} direction - Specifies the text direction for displaying
|
|
1587
|
+
* application content, either left-to-right (ltr) or right-to-left (rtl)
|
|
1588
|
+
* @property {boolean} is_default - Indicates if this is the default language
|
|
1589
|
+
* for the application
|
|
1590
|
+
* @property {boolean} published - Indicates whether this language is currently
|
|
1591
|
+
* active and visible within the storefront.
|
|
1592
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1593
|
+
* English for easy reference and display at the website.
|
|
1594
|
+
*/
|
|
1595
|
+
|
|
1596
|
+
/**
|
|
1597
|
+
* @typedef unPublishApplicationLanguage
|
|
1598
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1599
|
+
*/
|
|
1600
|
+
|
|
1601
|
+
/**
|
|
1602
|
+
* @typedef ApplicationLanguageCreate
|
|
1603
|
+
* @property {string[]} locales - List of language codes to be added to
|
|
1604
|
+
* application configuration
|
|
1605
|
+
*/
|
|
1606
|
+
|
|
1607
|
+
/**
|
|
1608
|
+
* @typedef ApplicationLanguageUpdate
|
|
1609
|
+
* @property {boolean} is_default - Sets the specified language as the application default
|
|
1610
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1611
|
+
*/
|
|
1612
|
+
|
|
1613
|
+
/**
|
|
1614
|
+
* @typedef TranslatableResource
|
|
1615
|
+
* @property {string} [_id] - Unique identifier for the translatable resource
|
|
1616
|
+
* @property {string} type - Categorizes the type of content that can be translated
|
|
1617
|
+
* @property {string} name - Display name of the translatable resource
|
|
1618
|
+
* @property {string} description - Detailed explanation of the translatable resource
|
|
1619
|
+
* @property {string} schema_type - Defines the processing type for the
|
|
1620
|
+
* translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
|
|
1621
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1622
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1623
|
+
* this resource
|
|
1624
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1625
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1626
|
+
* @property {TranslatableSection} [section_id]
|
|
1627
|
+
*/
|
|
1628
|
+
|
|
1629
|
+
/**
|
|
1630
|
+
* @typedef ResourceDefinition
|
|
1631
|
+
* @property {string} [_id] - Unique identifier for the resource definition
|
|
1632
|
+
* @property {string} translatable_resource_id - Reference to the associated
|
|
1633
|
+
* translatable resource
|
|
1634
|
+
* @property {ResourceJsonSchema} [json_schema]
|
|
1635
|
+
* @property {ResourceUISchema} [ui_schema]
|
|
1636
|
+
* @property {ResourceBulkDetails} [bulk_details]
|
|
1637
|
+
*/
|
|
1638
|
+
|
|
1639
|
+
/**
|
|
1640
|
+
* @typedef ResourceJsonSchema
|
|
1641
|
+
* @property {string} [schema]
|
|
1642
|
+
* @property {ResourceJsonSchemaType} [type]
|
|
1643
|
+
*/
|
|
1644
|
+
|
|
1645
|
+
/**
|
|
1646
|
+
* @typedef ResourceJsonSchemaType
|
|
1647
|
+
* @property {Author} [author]
|
|
1648
|
+
* @property {Title} [title]
|
|
1649
|
+
* @property {FeatureImage} [feature_image]
|
|
1650
|
+
*/
|
|
1651
|
+
|
|
1652
|
+
/**
|
|
1653
|
+
* @typedef ResourceUISchema
|
|
1654
|
+
* @property {Author} [author]
|
|
1655
|
+
* @property {Title} [title]
|
|
1656
|
+
* @property {FeatureImage} [feature_image]
|
|
1657
|
+
* @property {SeoTranslate} [seo]
|
|
1658
|
+
*/
|
|
1659
|
+
|
|
1660
|
+
/**
|
|
1661
|
+
* @typedef ResourceBulkDetails
|
|
1662
|
+
* @property {string[]} [fields]
|
|
1663
|
+
*/
|
|
1664
|
+
|
|
1665
|
+
/**
|
|
1666
|
+
* @typedef Title
|
|
1667
|
+
* @property {string} [ui_widget]
|
|
1668
|
+
* @property {boolean} [ui_description]
|
|
1669
|
+
*/
|
|
1670
|
+
|
|
1671
|
+
/**
|
|
1672
|
+
* @typedef FeatureImage
|
|
1673
|
+
* @property {string} [secure_url] - URL of the secure image
|
|
1674
|
+
*/
|
|
1675
|
+
|
|
1676
|
+
/**
|
|
1677
|
+
* @typedef SeoTranslate
|
|
1678
|
+
* @property {Title} [title]
|
|
1679
|
+
* @property {string} [description]
|
|
1680
|
+
* @property {string} [canonical_url]
|
|
1681
|
+
* @property {MetaTag[]} [meta_tags]
|
|
1682
|
+
*/
|
|
1683
|
+
|
|
1684
|
+
/**
|
|
1685
|
+
* @typedef MetaTag
|
|
1686
|
+
* @property {string} [title] - Title of the meta tag
|
|
1687
|
+
* @property {MetaTagItem[]} [items]
|
|
1688
|
+
*/
|
|
1689
|
+
|
|
1690
|
+
/**
|
|
1691
|
+
* @typedef MetaTagItem
|
|
1692
|
+
* @property {string} [key] - Key of the meta tag item
|
|
1693
|
+
* @property {string} [value] - Value of the meta tag item
|
|
1694
|
+
*/
|
|
1695
|
+
|
|
1696
|
+
/**
|
|
1697
|
+
* @typedef ResourceTranslation
|
|
1698
|
+
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1699
|
+
* @property {string} [locale] - Language code for this translation
|
|
1700
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1701
|
+
*/
|
|
1702
|
+
|
|
1703
|
+
/**
|
|
1704
|
+
* @typedef TranslationSeo
|
|
1705
|
+
* @property {string} [title] - Translated SEO title
|
|
1706
|
+
* @property {string[]} [breadcrumbs] - List of translated breadcrumbs
|
|
1707
|
+
* @property {string[]} [meta_tags] - List of translated meta tags
|
|
1708
|
+
* @property {string} [canonical_url] - Translated canonical URL
|
|
1709
|
+
* @property {string} [description] - Translated SEO description
|
|
1710
|
+
*/
|
|
1711
|
+
|
|
1712
|
+
/**
|
|
1713
|
+
* @typedef ResourceTranslationList
|
|
1714
|
+
* @property {ResourceTranslationCreate[]} [items]
|
|
1715
|
+
*/
|
|
1716
|
+
|
|
1717
|
+
/**
|
|
1718
|
+
* @typedef ResourceTranslationCreate
|
|
1719
|
+
* @property {string} [type] - Type of content being translated
|
|
1720
|
+
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1721
|
+
* @property {string} [locale] - Target language code for the translation
|
|
1722
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1723
|
+
*/
|
|
1724
|
+
|
|
1725
|
+
/**
|
|
1726
|
+
* @typedef ResourceTranslationUpdate
|
|
1727
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1728
|
+
*/
|
|
1729
|
+
|
|
1730
|
+
/**
|
|
1731
|
+
* @typedef TranslatableSection
|
|
1732
|
+
* @property {string} [_id] - Unique identifier for the translatable section
|
|
1733
|
+
* @property {string} [name] - Display name of the section
|
|
1734
|
+
* @property {string} [description] - Detailed explanation of the section's purpose
|
|
1735
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1736
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1737
|
+
* this resource
|
|
1738
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1739
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1740
|
+
*/
|
|
1741
|
+
|
|
1742
|
+
/**
|
|
1743
|
+
* @typedef Metrics
|
|
1744
|
+
* @property {number} [total] - Total number of translation operations attempted
|
|
1745
|
+
* @property {number} [success] - Number of successful translation operations
|
|
1746
|
+
* @property {number} [failed] - Number of failed translation operations
|
|
1747
|
+
*/
|
|
1748
|
+
|
|
1749
|
+
/**
|
|
1750
|
+
* @typedef ResourceTranslationUpsertItem
|
|
1751
|
+
* @property {string} [message] - Status message for the translation operation
|
|
1752
|
+
* @property {ResourceTranslationCreate} [data]
|
|
1753
|
+
*/
|
|
1754
|
+
|
|
1755
|
+
/**
|
|
1756
|
+
* @typedef ResourceTranslationBulkUpsert
|
|
1757
|
+
* @property {Metrics} [metrics]
|
|
1758
|
+
* @property {ResourceTranslationUpsertItem[]} [failed_items] - List of failed
|
|
1759
|
+
* translation operations
|
|
1760
|
+
* @property {ResourceTranslationUpsertItem[]} [updated_items] - List of
|
|
1761
|
+
* successful translation operations
|
|
1762
|
+
*/
|
|
1763
|
+
|
|
1764
|
+
/**
|
|
1765
|
+
* @typedef StandardError
|
|
1766
|
+
* @property {string} message - A brief description of the error.
|
|
1767
|
+
*/
|
|
1768
|
+
|
|
1769
|
+
/**
|
|
1770
|
+
* @typedef OperationResponseSchema
|
|
1771
|
+
* @property {boolean} success - Indicates if the operation was successful
|
|
1772
|
+
* @property {string} [message] - Optional message providing additional
|
|
1773
|
+
* information about the operation
|
|
1774
|
+
*/
|
|
1775
|
+
|
|
1776
|
+
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
* @typedef {| "about-us"
|
|
1780
|
+
* | "addresses"
|
|
1781
|
+
* | "blog"
|
|
1782
|
+
* | "brands"
|
|
1783
|
+
* | "cards"
|
|
1784
|
+
* | "cart"
|
|
1785
|
+
* | "categories"
|
|
1786
|
+
* | "brand"
|
|
1787
|
+
* | "category"
|
|
1788
|
+
* | "collection"
|
|
1789
|
+
* | "collections"
|
|
1790
|
+
* | "custom"
|
|
1791
|
+
* | "contact-us"
|
|
1792
|
+
* | "external"
|
|
1793
|
+
* | "faq"
|
|
1794
|
+
* | "freshchat"
|
|
1795
|
+
* | "home"
|
|
1796
|
+
* | "notification-settings"
|
|
1797
|
+
* | "orders"
|
|
1798
|
+
* | "page"
|
|
1799
|
+
* | "policy"
|
|
1800
|
+
* | "product"
|
|
1366
1801
|
* | "product-request"
|
|
1367
1802
|
* | "products"
|
|
1368
1803
|
* | "profile"
|
|
1369
1804
|
* | "profile-order-shipment"
|
|
1370
1805
|
* | "profile-basic"
|
|
1371
1806
|
* | "profile-company"
|
|
1372
|
-
* | "profile-
|
|
1373
|
-
* | "profile-
|
|
1807
|
+
* | "profile-email"
|
|
1808
|
+
* | "profile-phone"
|
|
1374
1809
|
* | "rate-us"
|
|
1375
1810
|
* | "refer-earn"
|
|
1376
1811
|
* | "settings"
|
|
@@ -1388,10 +1823,21 @@ const Joi = require("joi");
|
|
|
1388
1823
|
* | "shipping-policy"
|
|
1389
1824
|
* | "return-policy"
|
|
1390
1825
|
* | "order-status"
|
|
1391
|
-
* | "locate-us"
|
|
1826
|
+
* | "locate-us"
|
|
1827
|
+
* | "single-page-checkout"
|
|
1828
|
+
* | "request-reattempt"
|
|
1829
|
+
* | "files"} PageType
|
|
1392
1830
|
*/
|
|
1393
1831
|
|
|
1394
1832
|
class ContentPlatformModel {
|
|
1833
|
+
/** @returns {ValidationError} */
|
|
1834
|
+
static ValidationError() {
|
|
1835
|
+
return Joi.object({
|
|
1836
|
+
message: Joi.string().allow("").required(),
|
|
1837
|
+
field: Joi.string().allow("").required(),
|
|
1838
|
+
});
|
|
1839
|
+
}
|
|
1840
|
+
|
|
1395
1841
|
/** @returns {GenerateSEOContent} */
|
|
1396
1842
|
static GenerateSEOContent() {
|
|
1397
1843
|
return Joi.object({
|
|
@@ -1508,7 +1954,7 @@ class ContentPlatformModel {
|
|
|
1508
1954
|
return Joi.object({
|
|
1509
1955
|
id: Joi.string().allow(""),
|
|
1510
1956
|
title: Joi.string().allow(""),
|
|
1511
|
-
page_type:
|
|
1957
|
+
page_type: ContentPlatformModel.PageType(),
|
|
1512
1958
|
schema: Joi.string().allow(""),
|
|
1513
1959
|
description: Joi.string().allow(""),
|
|
1514
1960
|
active: Joi.boolean(),
|
|
@@ -1523,7 +1969,7 @@ class ContentPlatformModel {
|
|
|
1523
1969
|
static SEOSchemaMarkupTemplateRequestBody() {
|
|
1524
1970
|
return Joi.object({
|
|
1525
1971
|
title: Joi.string().allow(""),
|
|
1526
|
-
page_type:
|
|
1972
|
+
page_type: ContentPlatformModel.PageType(),
|
|
1527
1973
|
schema: Joi.string().allow(""),
|
|
1528
1974
|
description: Joi.string().allow(""),
|
|
1529
1975
|
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -1588,7 +2034,7 @@ class ContentPlatformModel {
|
|
|
1588
2034
|
/** @returns {DefaultSEOSchemaMarkupTemplate} */
|
|
1589
2035
|
static DefaultSEOSchemaMarkupTemplate() {
|
|
1590
2036
|
return Joi.object({
|
|
1591
|
-
page_type:
|
|
2037
|
+
page_type: ContentPlatformModel.PageType(),
|
|
1592
2038
|
schema: Joi.string().allow(""),
|
|
1593
2039
|
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1594
2040
|
});
|
|
@@ -1613,8 +2059,8 @@ class ContentPlatformModel {
|
|
|
1613
2059
|
});
|
|
1614
2060
|
}
|
|
1615
2061
|
|
|
1616
|
-
/** @returns {
|
|
1617
|
-
static
|
|
2062
|
+
/** @returns {BlogGetDetails} */
|
|
2063
|
+
static BlogGetDetails() {
|
|
1618
2064
|
return Joi.object({
|
|
1619
2065
|
items: Joi.array().items(ContentPlatformModel.BlogSchema()),
|
|
1620
2066
|
page: ContentPlatformModel.Page(),
|
|
@@ -1659,7 +2105,7 @@ class ContentPlatformModel {
|
|
|
1659
2105
|
static BlogSchema() {
|
|
1660
2106
|
return Joi.object({
|
|
1661
2107
|
_id: Joi.string().allow(""),
|
|
1662
|
-
_custom_json: Joi.any(),
|
|
2108
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1663
2109
|
application: Joi.string().allow(""),
|
|
1664
2110
|
archived: Joi.boolean(),
|
|
1665
2111
|
author: ContentPlatformModel.Author(),
|
|
@@ -1737,11 +2183,11 @@ class ContentPlatformModel {
|
|
|
1737
2183
|
});
|
|
1738
2184
|
}
|
|
1739
2185
|
|
|
1740
|
-
/** @returns {
|
|
1741
|
-
static
|
|
2186
|
+
/** @returns {BlogPayload} */
|
|
2187
|
+
static BlogPayload() {
|
|
1742
2188
|
return Joi.object({
|
|
1743
2189
|
application: Joi.string().allow(""),
|
|
1744
|
-
_custom_json: Joi.any(),
|
|
2190
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1745
2191
|
author: ContentPlatformModel.Author(),
|
|
1746
2192
|
content: Joi.array().items(ContentPlatformModel.ResourceContent()),
|
|
1747
2193
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -1846,28 +2292,6 @@ class ContentPlatformModel {
|
|
|
1846
2292
|
});
|
|
1847
2293
|
}
|
|
1848
2294
|
|
|
1849
|
-
/** @returns {ConfigurationSchema} */
|
|
1850
|
-
static ConfigurationSchema() {
|
|
1851
|
-
return Joi.object({
|
|
1852
|
-
sleep_time: Joi.number(),
|
|
1853
|
-
start_on_launch: Joi.boolean(),
|
|
1854
|
-
duration: Joi.number(),
|
|
1855
|
-
slide_direction: Joi.string().allow(""),
|
|
1856
|
-
});
|
|
1857
|
-
}
|
|
1858
|
-
|
|
1859
|
-
/** @returns {SlideshowMedia} */
|
|
1860
|
-
static SlideshowMedia() {
|
|
1861
|
-
return Joi.object({
|
|
1862
|
-
type: Joi.string().allow(""),
|
|
1863
|
-
url: Joi.string().allow(""),
|
|
1864
|
-
bg_color: Joi.string().allow(""),
|
|
1865
|
-
duration: Joi.number(),
|
|
1866
|
-
auto_decide_duration: Joi.boolean(),
|
|
1867
|
-
action: ContentPlatformModel.Action(),
|
|
1868
|
-
});
|
|
1869
|
-
}
|
|
1870
|
-
|
|
1871
2295
|
/** @returns {UpdateHandpickedSchema} */
|
|
1872
2296
|
static UpdateHandpickedSchema() {
|
|
1873
2297
|
return Joi.object({
|
|
@@ -1879,12 +2303,14 @@ class ContentPlatformModel {
|
|
|
1879
2303
|
static HandpickedTagSchema() {
|
|
1880
2304
|
return Joi.object({
|
|
1881
2305
|
position: Joi.string().allow(""),
|
|
1882
|
-
attributes: Joi.any(),
|
|
2306
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2307
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
1883
2308
|
name: Joi.string().allow(""),
|
|
1884
2309
|
url: Joi.string().allow(""),
|
|
1885
2310
|
type: Joi.string().allow(""),
|
|
1886
2311
|
sub_type: Joi.string().allow(""),
|
|
1887
2312
|
content: Joi.string().allow(""),
|
|
2313
|
+
template: ContentPlatformModel.TemplateSchema(),
|
|
1888
2314
|
});
|
|
1889
2315
|
}
|
|
1890
2316
|
|
|
@@ -1904,9 +2330,28 @@ class ContentPlatformModel {
|
|
|
1904
2330
|
type: Joi.string().allow(""),
|
|
1905
2331
|
url: Joi.string().allow(""),
|
|
1906
2332
|
position: Joi.string().allow(""),
|
|
1907
|
-
attributes: Joi.any(),
|
|
2333
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2334
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
1908
2335
|
pages: Joi.array().items(Joi.any()),
|
|
1909
2336
|
content: Joi.string().allow(""),
|
|
2337
|
+
template: ContentPlatformModel.TemplateSchema(),
|
|
2338
|
+
});
|
|
2339
|
+
}
|
|
2340
|
+
|
|
2341
|
+
/** @returns {TemplateSchema} */
|
|
2342
|
+
static TemplateSchema() {
|
|
2343
|
+
return Joi.object({
|
|
2344
|
+
template_id: Joi.string().allow(""),
|
|
2345
|
+
template_version: Joi.string().allow(""),
|
|
2346
|
+
template_fields: Joi.array().items(ContentPlatformModel.TemplateField()),
|
|
2347
|
+
});
|
|
2348
|
+
}
|
|
2349
|
+
|
|
2350
|
+
/** @returns {TemplateField} */
|
|
2351
|
+
static TemplateField() {
|
|
2352
|
+
return Joi.object({
|
|
2353
|
+
key: Joi.string().allow(""),
|
|
2354
|
+
value: Joi.string().allow(""),
|
|
1910
2355
|
});
|
|
1911
2356
|
}
|
|
1912
2357
|
|
|
@@ -1931,6 +2376,70 @@ class ContentPlatformModel {
|
|
|
1931
2376
|
});
|
|
1932
2377
|
}
|
|
1933
2378
|
|
|
2379
|
+
/** @returns {TagsTemplateSchema} */
|
|
2380
|
+
static TagsTemplateSchema() {
|
|
2381
|
+
return Joi.object({
|
|
2382
|
+
items: Joi.array().items(ContentPlatformModel.TagTemplateItem()),
|
|
2383
|
+
});
|
|
2384
|
+
}
|
|
2385
|
+
|
|
2386
|
+
/** @returns {TagTemplateItem} */
|
|
2387
|
+
static TagTemplateItem() {
|
|
2388
|
+
return Joi.object({
|
|
2389
|
+
template_name: Joi.string().allow(""),
|
|
2390
|
+
type: Joi.string().allow(""),
|
|
2391
|
+
sub_type: Joi.string().allow(""),
|
|
2392
|
+
position: Joi.string().allow(""),
|
|
2393
|
+
pages: Joi.array().items(Joi.string().allow("")),
|
|
2394
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2395
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
2396
|
+
field_mappings: Joi.object().pattern(/\S/, Joi.any()),
|
|
2397
|
+
layout: ContentPlatformModel.TemplateLayout(),
|
|
2398
|
+
name: Joi.string().allow(""),
|
|
2399
|
+
path: Joi.string().allow(""),
|
|
2400
|
+
description: Joi.string().allow(""),
|
|
2401
|
+
image: Joi.string().allow(""),
|
|
2402
|
+
note: Joi.string().allow(""),
|
|
2403
|
+
template_id: Joi.string().allow(""),
|
|
2404
|
+
template_version: Joi.string().allow(""),
|
|
2405
|
+
category: Joi.string().allow(""),
|
|
2406
|
+
fields: Joi.array().items(ContentPlatformModel.FieldDefinition()),
|
|
2407
|
+
script: Joi.string().allow(""),
|
|
2408
|
+
});
|
|
2409
|
+
}
|
|
2410
|
+
|
|
2411
|
+
/** @returns {TemplateLayout} */
|
|
2412
|
+
static TemplateLayout() {
|
|
2413
|
+
return Joi.object({
|
|
2414
|
+
columns: Joi.number(),
|
|
2415
|
+
gap: Joi.string().allow(""),
|
|
2416
|
+
responsive: Joi.boolean(),
|
|
2417
|
+
});
|
|
2418
|
+
}
|
|
2419
|
+
|
|
2420
|
+
/** @returns {FieldDefinition} */
|
|
2421
|
+
static FieldDefinition() {
|
|
2422
|
+
return Joi.object({
|
|
2423
|
+
name: Joi.string().allow(""),
|
|
2424
|
+
type: Joi.string().allow(""),
|
|
2425
|
+
label: Joi.string().allow(""),
|
|
2426
|
+
placeholder: Joi.string().allow(""),
|
|
2427
|
+
required: Joi.boolean(),
|
|
2428
|
+
size: Joi.string().allow(""),
|
|
2429
|
+
description: Joi.string().allow(""),
|
|
2430
|
+
validation: ContentPlatformModel.FieldValidation(),
|
|
2431
|
+
events: Joi.object().pattern(/\S/, Joi.any()),
|
|
2432
|
+
});
|
|
2433
|
+
}
|
|
2434
|
+
|
|
2435
|
+
/** @returns {FieldValidation} */
|
|
2436
|
+
static FieldValidation() {
|
|
2437
|
+
return Joi.object({
|
|
2438
|
+
pattern: Joi.string().allow(""),
|
|
2439
|
+
message: Joi.string().allow(""),
|
|
2440
|
+
});
|
|
2441
|
+
}
|
|
2442
|
+
|
|
1934
2443
|
/** @returns {DataLoaderSourceSchema} */
|
|
1935
2444
|
static DataLoaderSourceSchema() {
|
|
1936
2445
|
return Joi.object({
|
|
@@ -1946,8 +2455,8 @@ class ContentPlatformModel {
|
|
|
1946
2455
|
});
|
|
1947
2456
|
}
|
|
1948
2457
|
|
|
1949
|
-
/** @returns {
|
|
1950
|
-
static
|
|
2458
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
2459
|
+
static TagDeleteSuccessDetails() {
|
|
1951
2460
|
return Joi.object({
|
|
1952
2461
|
success: Joi.boolean(),
|
|
1953
2462
|
});
|
|
@@ -1963,7 +2472,7 @@ class ContentPlatformModel {
|
|
|
1963
2472
|
info: Joi.string().allow(""),
|
|
1964
2473
|
request_id: Joi.string().allow(""),
|
|
1965
2474
|
stack_trace: Joi.string().allow(""),
|
|
1966
|
-
meta: Joi.any(),
|
|
2475
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1967
2476
|
});
|
|
1968
2477
|
}
|
|
1969
2478
|
|
|
@@ -1985,7 +2494,7 @@ class ContentPlatformModel {
|
|
|
1985
2494
|
slug: Joi.string().allow(""),
|
|
1986
2495
|
application: Joi.string().allow(""),
|
|
1987
2496
|
icon_url: Joi.string().allow(""),
|
|
1988
|
-
_custom_json: Joi.any(),
|
|
2497
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1989
2498
|
});
|
|
1990
2499
|
}
|
|
1991
2500
|
|
|
@@ -2019,7 +2528,7 @@ class ContentPlatformModel {
|
|
|
2019
2528
|
slug: Joi.string().allow(""),
|
|
2020
2529
|
application: Joi.string().allow(""),
|
|
2021
2530
|
icon_url: Joi.string().allow(""),
|
|
2022
|
-
_custom_json: Joi.any(),
|
|
2531
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2023
2532
|
});
|
|
2024
2533
|
}
|
|
2025
2534
|
|
|
@@ -2110,11 +2619,12 @@ class ContentPlatformModel {
|
|
|
2110
2619
|
current: Joi.number(),
|
|
2111
2620
|
type: Joi.string().allow("").required(),
|
|
2112
2621
|
size: Joi.number(),
|
|
2622
|
+
page_size: Joi.number(),
|
|
2113
2623
|
});
|
|
2114
2624
|
}
|
|
2115
2625
|
|
|
2116
|
-
/** @returns {
|
|
2117
|
-
static
|
|
2626
|
+
/** @returns {LandingPageGetDetails} */
|
|
2627
|
+
static LandingPageGetDetails() {
|
|
2118
2628
|
return Joi.object({
|
|
2119
2629
|
items: Joi.array().items(ContentPlatformModel.LandingPageSchema()),
|
|
2120
2630
|
page: ContentPlatformModel.Page(),
|
|
@@ -2132,19 +2642,19 @@ class ContentPlatformModel {
|
|
|
2132
2642
|
_id: Joi.string().allow(""),
|
|
2133
2643
|
application: Joi.string().allow(""),
|
|
2134
2644
|
archived: Joi.boolean(),
|
|
2135
|
-
_custom_json: Joi.any(),
|
|
2645
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2136
2646
|
});
|
|
2137
2647
|
}
|
|
2138
2648
|
|
|
2139
|
-
/** @returns {
|
|
2140
|
-
static
|
|
2649
|
+
/** @returns {DefaultNavigationDetails} */
|
|
2650
|
+
static DefaultNavigationDetails() {
|
|
2141
2651
|
return Joi.object({
|
|
2142
2652
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2143
2653
|
});
|
|
2144
2654
|
}
|
|
2145
2655
|
|
|
2146
|
-
/** @returns {
|
|
2147
|
-
static
|
|
2656
|
+
/** @returns {NavigationGetDetails} */
|
|
2657
|
+
static NavigationGetDetails() {
|
|
2148
2658
|
return Joi.object({
|
|
2149
2659
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2150
2660
|
page: ContentPlatformModel.Page(),
|
|
@@ -2176,8 +2686,8 @@ class ContentPlatformModel {
|
|
|
2176
2686
|
});
|
|
2177
2687
|
}
|
|
2178
2688
|
|
|
2179
|
-
/** @returns {
|
|
2180
|
-
static
|
|
2689
|
+
/** @returns {NavigationPayload} */
|
|
2690
|
+
static NavigationPayload() {
|
|
2181
2691
|
return Joi.object({
|
|
2182
2692
|
name: Joi.string().allow(""),
|
|
2183
2693
|
slug: Joi.string().allow(""),
|
|
@@ -2187,8 +2697,8 @@ class ContentPlatformModel {
|
|
|
2187
2697
|
});
|
|
2188
2698
|
}
|
|
2189
2699
|
|
|
2190
|
-
/** @returns {
|
|
2191
|
-
static
|
|
2700
|
+
/** @returns {PageGetDetails} */
|
|
2701
|
+
static PageGetDetails() {
|
|
2192
2702
|
return Joi.object({
|
|
2193
2703
|
items: Joi.array().items(ContentPlatformModel.PageSchema()),
|
|
2194
2704
|
page: ContentPlatformModel.Page(),
|
|
@@ -2234,7 +2744,7 @@ class ContentPlatformModel {
|
|
|
2234
2744
|
feature_image: ContentPlatformModel.Asset(),
|
|
2235
2745
|
page_meta: Joi.array().items(Joi.any()),
|
|
2236
2746
|
_schedule: ContentPlatformModel.ScheduleSchema(),
|
|
2237
|
-
_custom_json: Joi.any(),
|
|
2747
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2238
2748
|
orientation: Joi.string().allow(""),
|
|
2239
2749
|
platform: Joi.string().allow(""),
|
|
2240
2750
|
published: Joi.boolean(),
|
|
@@ -2243,7 +2753,7 @@ class ContentPlatformModel {
|
|
|
2243
2753
|
title: Joi.string().allow(""),
|
|
2244
2754
|
type: Joi.string().allow(""),
|
|
2245
2755
|
seo: ContentPlatformModel.SEO(),
|
|
2246
|
-
visibility: Joi.any(),
|
|
2756
|
+
visibility: Joi.object().pattern(/\S/, Joi.any()),
|
|
2247
2757
|
archived: Joi.boolean(),
|
|
2248
2758
|
});
|
|
2249
2759
|
}
|
|
@@ -2255,13 +2765,13 @@ class ContentPlatformModel {
|
|
|
2255
2765
|
});
|
|
2256
2766
|
}
|
|
2257
2767
|
|
|
2258
|
-
/** @returns {
|
|
2259
|
-
static
|
|
2768
|
+
/** @returns {PagePayload} */
|
|
2769
|
+
static PagePayload() {
|
|
2260
2770
|
return Joi.object({
|
|
2261
2771
|
_schedule: ContentPlatformModel.CronSchedule(),
|
|
2262
2772
|
application: Joi.string().allow(""),
|
|
2263
2773
|
author: ContentPlatformModel.Author(),
|
|
2264
|
-
_custom_json: Joi.any(),
|
|
2774
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2265
2775
|
orientation: Joi.string().allow(""),
|
|
2266
2776
|
content: Joi.array().items(Joi.any()),
|
|
2267
2777
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -2284,8 +2794,8 @@ class ContentPlatformModel {
|
|
|
2284
2794
|
});
|
|
2285
2795
|
}
|
|
2286
2796
|
|
|
2287
|
-
/** @returns {
|
|
2288
|
-
static
|
|
2797
|
+
/** @returns {PagePublishPayload} */
|
|
2798
|
+
static PagePublishPayload() {
|
|
2289
2799
|
return Joi.object({
|
|
2290
2800
|
publish: Joi.boolean(),
|
|
2291
2801
|
});
|
|
@@ -2300,41 +2810,6 @@ class ContentPlatformModel {
|
|
|
2300
2810
|
});
|
|
2301
2811
|
}
|
|
2302
2812
|
|
|
2303
|
-
/** @returns {SlideshowGetResponse} */
|
|
2304
|
-
static SlideshowGetResponse() {
|
|
2305
|
-
return Joi.object({
|
|
2306
|
-
items: Joi.array().items(ContentPlatformModel.SlideshowSchema()),
|
|
2307
|
-
page: ContentPlatformModel.Page(),
|
|
2308
|
-
});
|
|
2309
|
-
}
|
|
2310
|
-
|
|
2311
|
-
/** @returns {SlideshowSchema} */
|
|
2312
|
-
static SlideshowSchema() {
|
|
2313
|
-
return Joi.object({
|
|
2314
|
-
_id: Joi.string().allow(""),
|
|
2315
|
-
slug: Joi.string().allow(""),
|
|
2316
|
-
date_meta: ContentPlatformModel.DateMeta(),
|
|
2317
|
-
application: Joi.string().allow(""),
|
|
2318
|
-
platform: Joi.string().allow(""),
|
|
2319
|
-
configuration: ContentPlatformModel.ConfigurationSchema(),
|
|
2320
|
-
media: Joi.array().items(ContentPlatformModel.SlideshowMedia()),
|
|
2321
|
-
active: Joi.boolean(),
|
|
2322
|
-
archived: Joi.boolean(),
|
|
2323
|
-
_custom_json: Joi.any(),
|
|
2324
|
-
});
|
|
2325
|
-
}
|
|
2326
|
-
|
|
2327
|
-
/** @returns {SlideshowRequest} */
|
|
2328
|
-
static SlideshowRequest() {
|
|
2329
|
-
return Joi.object({
|
|
2330
|
-
slug: Joi.string().allow(""),
|
|
2331
|
-
platform: Joi.string().allow(""),
|
|
2332
|
-
configuration: ContentPlatformModel.ConfigurationSchema(),
|
|
2333
|
-
media: ContentPlatformModel.SlideshowMedia(),
|
|
2334
|
-
active: Joi.boolean(),
|
|
2335
|
-
});
|
|
2336
|
-
}
|
|
2337
|
-
|
|
2338
2813
|
/** @returns {Support} */
|
|
2339
2814
|
static Support() {
|
|
2340
2815
|
return Joi.object({
|
|
@@ -2394,6 +2869,7 @@ class ContentPlatformModel {
|
|
|
2394
2869
|
return Joi.object({
|
|
2395
2870
|
application: Joi.string().allow(""),
|
|
2396
2871
|
_id: Joi.string().allow(""),
|
|
2872
|
+
company: Joi.string().allow(""),
|
|
2397
2873
|
tags: Joi.array().items(ContentPlatformModel.TagSchema()),
|
|
2398
2874
|
});
|
|
2399
2875
|
}
|
|
@@ -2407,10 +2883,12 @@ class ContentPlatformModel {
|
|
|
2407
2883
|
sub_type: Joi.string().allow(""),
|
|
2408
2884
|
_id: Joi.string().allow(""),
|
|
2409
2885
|
position: Joi.string().allow(""),
|
|
2410
|
-
attributes: Joi.any(),
|
|
2886
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2411
2887
|
content: Joi.string().allow(""),
|
|
2888
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
2412
2889
|
pages: Joi.array().items(Joi.any()),
|
|
2413
2890
|
__source: ContentPlatformModel.TagSourceSchema(),
|
|
2891
|
+
template: ContentPlatformModel.TemplateSchema(),
|
|
2414
2892
|
});
|
|
2415
2893
|
}
|
|
2416
2894
|
|
|
@@ -2450,23 +2928,18 @@ class ContentPlatformModel {
|
|
|
2450
2928
|
/** @returns {FieldDefinitionSchema} */
|
|
2451
2929
|
static FieldDefinitionSchema() {
|
|
2452
2930
|
return Joi.object({
|
|
2453
|
-
|
|
2454
|
-
creator: Joi.string().allow(""),
|
|
2931
|
+
id: Joi.string().allow(""),
|
|
2455
2932
|
resource: Joi.string().allow(""),
|
|
2456
2933
|
name: Joi.string().allow(""),
|
|
2457
2934
|
namespace: Joi.string().allow(""),
|
|
2458
|
-
|
|
2935
|
+
slug: Joi.string().allow(""),
|
|
2459
2936
|
description: Joi.string().allow(""),
|
|
2460
2937
|
type: Joi.string().allow(""),
|
|
2461
2938
|
multi_value: Joi.boolean(),
|
|
2462
2939
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2463
2940
|
company_id: Joi.string().allow(""),
|
|
2464
|
-
created_by: Joi.string().allow(""),
|
|
2465
|
-
updated_by: Joi.string().allow(""),
|
|
2466
2941
|
required: Joi.boolean(),
|
|
2467
2942
|
is_deleted: Joi.boolean(),
|
|
2468
|
-
created_at: Joi.string().allow(""),
|
|
2469
|
-
updated_at: Joi.string().allow(""),
|
|
2470
2943
|
type_name: Joi.string().allow(""),
|
|
2471
2944
|
invalid_fields_count: Joi.number(),
|
|
2472
2945
|
});
|
|
@@ -2483,9 +2956,8 @@ class ContentPlatformModel {
|
|
|
2483
2956
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2484
2957
|
static CustomFieldDefinitionRequestSchema() {
|
|
2485
2958
|
return Joi.object({
|
|
2486
|
-
resource: Joi.string().allow(""),
|
|
2487
2959
|
type: Joi.string().allow(""),
|
|
2488
|
-
|
|
2960
|
+
slug: Joi.string().allow(""),
|
|
2489
2961
|
namespace: Joi.string().allow(""),
|
|
2490
2962
|
multi_value: Joi.boolean(),
|
|
2491
2963
|
name: Joi.string().allow(""),
|
|
@@ -2503,7 +2975,7 @@ class ContentPlatformModel {
|
|
|
2503
2975
|
name: Joi.string().allow(""),
|
|
2504
2976
|
multi_value: Joi.boolean(),
|
|
2505
2977
|
required: Joi.boolean(),
|
|
2506
|
-
|
|
2978
|
+
slug: Joi.string().allow(""),
|
|
2507
2979
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2508
2980
|
action: Joi.string().allow(""),
|
|
2509
2981
|
});
|
|
@@ -2512,7 +2984,6 @@ class ContentPlatformModel {
|
|
|
2512
2984
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2513
2985
|
static CustomObjectDefinitionUpdateRequestSchema() {
|
|
2514
2986
|
return Joi.object({
|
|
2515
|
-
type: Joi.string().allow(""),
|
|
2516
2987
|
description: Joi.string().allow(""),
|
|
2517
2988
|
name: Joi.string().allow(""),
|
|
2518
2989
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2525,21 +2996,39 @@ class ContentPlatformModel {
|
|
|
2525
2996
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2526
2997
|
static CustomFieldDefinitionDetailResSchema() {
|
|
2527
2998
|
return Joi.object({
|
|
2528
|
-
creator: Joi.string().allow(""),
|
|
2529
2999
|
resource: Joi.string().allow(""),
|
|
2530
3000
|
name: Joi.string().allow(""),
|
|
2531
3001
|
namespace: Joi.string().allow(""),
|
|
2532
|
-
|
|
3002
|
+
slug: Joi.string().allow(""),
|
|
2533
3003
|
description: Joi.string().allow(""),
|
|
2534
3004
|
type: Joi.string().allow(""),
|
|
2535
3005
|
multi_value: Joi.boolean(),
|
|
2536
3006
|
company_id: Joi.string().allow(""),
|
|
2537
3007
|
application_id: Joi.string().allow(""),
|
|
2538
|
-
created_by: Joi.string().allow(""),
|
|
2539
|
-
updated_by: Joi.string().allow(""),
|
|
2540
3008
|
required: Joi.boolean(),
|
|
2541
3009
|
is_deleted: Joi.boolean(),
|
|
2542
|
-
|
|
3010
|
+
id: Joi.string().allow(""),
|
|
3011
|
+
validations: Joi.array().items(Joi.any()),
|
|
3012
|
+
created_at: Joi.string().allow(""),
|
|
3013
|
+
updated_at: Joi.string().allow(""),
|
|
3014
|
+
});
|
|
3015
|
+
}
|
|
3016
|
+
|
|
3017
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
3018
|
+
static MetaFieldDefinitionDetailResSchema() {
|
|
3019
|
+
return Joi.object({
|
|
3020
|
+
resource: Joi.string().allow(""),
|
|
3021
|
+
name: Joi.string().allow(""),
|
|
3022
|
+
namespace: Joi.string().allow(""),
|
|
3023
|
+
slug: Joi.string().allow(""),
|
|
3024
|
+
description: Joi.string().allow(""),
|
|
3025
|
+
type: Joi.string().allow(""),
|
|
3026
|
+
multi_value: Joi.boolean(),
|
|
3027
|
+
company_id: Joi.string().allow(""),
|
|
3028
|
+
application_id: Joi.string().allow(""),
|
|
3029
|
+
required: Joi.boolean(),
|
|
3030
|
+
is_deleted: Joi.boolean(),
|
|
3031
|
+
id: Joi.string().allow(""),
|
|
2543
3032
|
validations: Joi.array().items(Joi.any()),
|
|
2544
3033
|
created_at: Joi.string().allow(""),
|
|
2545
3034
|
updated_at: Joi.string().allow(""),
|
|
@@ -2564,20 +3053,17 @@ class ContentPlatformModel {
|
|
|
2564
3053
|
/** @returns {CustomFieldSchema} */
|
|
2565
3054
|
static CustomFieldSchema() {
|
|
2566
3055
|
return Joi.object({
|
|
2567
|
-
|
|
3056
|
+
id: Joi.string().allow(""),
|
|
2568
3057
|
namespace: Joi.string().allow(""),
|
|
2569
|
-
|
|
3058
|
+
slug: Joi.string().allow(""),
|
|
2570
3059
|
resource: Joi.string().allow(""),
|
|
2571
|
-
creator: Joi.string().allow(""),
|
|
2572
3060
|
value: Joi.array().items(ContentPlatformModel.CustomFieldValue()),
|
|
2573
|
-
|
|
3061
|
+
resource_slug: Joi.string().allow(""),
|
|
2574
3062
|
type: Joi.string().allow(""),
|
|
2575
3063
|
multi_value: Joi.boolean(),
|
|
2576
3064
|
company_id: Joi.string().allow(""),
|
|
2577
|
-
definition_id: Joi.string().allow(""),
|
|
2578
3065
|
has_invalid_values: Joi.boolean(),
|
|
2579
3066
|
invalid_value_errors: Joi.array().items(Joi.any()),
|
|
2580
|
-
created_by: Joi.string().allow(""),
|
|
2581
3067
|
is_deleted: Joi.boolean(),
|
|
2582
3068
|
created_at: Joi.string().allow(""),
|
|
2583
3069
|
updated_at: Joi.string().allow(""),
|
|
@@ -2592,6 +3078,14 @@ class ContentPlatformModel {
|
|
|
2592
3078
|
});
|
|
2593
3079
|
}
|
|
2594
3080
|
|
|
3081
|
+
/** @returns {CustomFieldsDeleteSchema} */
|
|
3082
|
+
static CustomFieldsDeleteSchema() {
|
|
3083
|
+
return Joi.object({
|
|
3084
|
+
success: Joi.boolean(),
|
|
3085
|
+
message: Joi.string().allow(""),
|
|
3086
|
+
});
|
|
3087
|
+
}
|
|
3088
|
+
|
|
2595
3089
|
/** @returns {CustomFieldsResponseByResourceIdSchema} */
|
|
2596
3090
|
static CustomFieldsResponseByResourceIdSchema() {
|
|
2597
3091
|
return Joi.object({
|
|
@@ -2603,7 +3097,8 @@ class ContentPlatformModel {
|
|
|
2603
3097
|
static CustomField() {
|
|
2604
3098
|
return Joi.object({
|
|
2605
3099
|
value: Joi.array().items(Joi.any()),
|
|
2606
|
-
|
|
3100
|
+
namespace: Joi.string().allow(""),
|
|
3101
|
+
slug: Joi.string().allow(""),
|
|
2607
3102
|
});
|
|
2608
3103
|
}
|
|
2609
3104
|
|
|
@@ -2617,16 +3112,13 @@ class ContentPlatformModel {
|
|
|
2617
3112
|
/** @returns {CustomObjectSchema} */
|
|
2618
3113
|
static CustomObjectSchema() {
|
|
2619
3114
|
return Joi.object({
|
|
2620
|
-
|
|
2621
|
-
creator: Joi.string().allow(""),
|
|
3115
|
+
id: Joi.string().allow(""),
|
|
2622
3116
|
company_id: Joi.string().allow(""),
|
|
2623
3117
|
application_id: Joi.string().allow(""),
|
|
2624
|
-
created_by: Joi.string().allow(""),
|
|
2625
|
-
updated_by: Joi.string().allow(""),
|
|
2626
3118
|
status: Joi.string().allow(""),
|
|
2627
3119
|
type: Joi.string().allow(""),
|
|
3120
|
+
definition_slug: Joi.string().allow(""),
|
|
2628
3121
|
display_name: Joi.string().allow(""),
|
|
2629
|
-
definition_id: Joi.string().allow(""),
|
|
2630
3122
|
fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
|
|
2631
3123
|
});
|
|
2632
3124
|
}
|
|
@@ -2635,6 +3127,7 @@ class ContentPlatformModel {
|
|
|
2635
3127
|
static CustomObjectDefinitionRequestSchema() {
|
|
2636
3128
|
return Joi.object({
|
|
2637
3129
|
type: Joi.string().allow(""),
|
|
3130
|
+
definition_slug: Joi.string().allow(""),
|
|
2638
3131
|
description: Joi.string().allow(""),
|
|
2639
3132
|
name: Joi.string().allow(""),
|
|
2640
3133
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2644,42 +3137,17 @@ class ContentPlatformModel {
|
|
|
2644
3137
|
});
|
|
2645
3138
|
}
|
|
2646
3139
|
|
|
2647
|
-
/** @returns {
|
|
2648
|
-
static
|
|
2649
|
-
return Joi.object({
|
|
2650
|
-
creator: Joi.string().allow(""),
|
|
2651
|
-
resource: Joi.string().allow(""),
|
|
2652
|
-
name: Joi.string().allow(""),
|
|
2653
|
-
namespace: Joi.string().allow(""),
|
|
2654
|
-
key: Joi.string().allow(""),
|
|
2655
|
-
description: Joi.string().allow(""),
|
|
2656
|
-
type: Joi.string().allow(""),
|
|
2657
|
-
multi_value: Joi.boolean(),
|
|
2658
|
-
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2659
|
-
company_id: Joi.string().allow(""),
|
|
2660
|
-
created_by: Joi.string().allow(""),
|
|
2661
|
-
metaobject_definition_id: Joi.string().allow(""),
|
|
2662
|
-
required: Joi.boolean(),
|
|
2663
|
-
is_deleted: Joi.boolean(),
|
|
2664
|
-
_id: Joi.string().allow(""),
|
|
2665
|
-
created_at: Joi.string().allow(""),
|
|
2666
|
-
updated_at: Joi.string().allow(""),
|
|
2667
|
-
});
|
|
2668
|
-
}
|
|
2669
|
-
|
|
2670
|
-
/** @returns {CustomObjectDefinitionSchema} */
|
|
2671
|
-
static CustomObjectDefinitionSchema() {
|
|
3140
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
3141
|
+
static CustomObjectDefinitionSlugSchema() {
|
|
2672
3142
|
return Joi.object({
|
|
2673
|
-
|
|
3143
|
+
id: Joi.string().allow(""),
|
|
2674
3144
|
name: Joi.string().allow(""),
|
|
2675
3145
|
type: Joi.string().allow(""),
|
|
3146
|
+
definition_slug: Joi.string().allow(""),
|
|
2676
3147
|
display_name_key: Joi.string().allow(""),
|
|
2677
3148
|
description: Joi.string().allow(""),
|
|
2678
|
-
creator: Joi.string().allow(""),
|
|
2679
|
-
created_by: Joi.string().allow(""),
|
|
2680
|
-
updated_by: Joi.string().allow(""),
|
|
2681
3149
|
field_definitions: Joi.array().items(
|
|
2682
|
-
ContentPlatformModel.
|
|
3150
|
+
ContentPlatformModel.CustomFieldDefinitionDetailResSchema()
|
|
2683
3151
|
),
|
|
2684
3152
|
});
|
|
2685
3153
|
}
|
|
@@ -2692,18 +3160,18 @@ class ContentPlatformModel {
|
|
|
2692
3160
|
});
|
|
2693
3161
|
}
|
|
2694
3162
|
|
|
2695
|
-
/** @returns {
|
|
2696
|
-
static
|
|
3163
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
3164
|
+
static CustomObjectEntryBulkUploadDetails() {
|
|
2697
3165
|
return Joi.object({
|
|
2698
3166
|
url: Joi.string().allow(""),
|
|
2699
3167
|
total_records: Joi.number(),
|
|
2700
3168
|
});
|
|
2701
3169
|
}
|
|
2702
3170
|
|
|
2703
|
-
/** @returns {
|
|
2704
|
-
static
|
|
3171
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
3172
|
+
static CustomObjectListItemDefinitionModel() {
|
|
2705
3173
|
return Joi.object({
|
|
2706
|
-
|
|
3174
|
+
id: Joi.string().allow(""),
|
|
2707
3175
|
name: Joi.string().allow(""),
|
|
2708
3176
|
type: Joi.string().allow(""),
|
|
2709
3177
|
});
|
|
@@ -2712,12 +3180,12 @@ class ContentPlatformModel {
|
|
|
2712
3180
|
/** @returns {CustomObjectListItemSchema} */
|
|
2713
3181
|
static CustomObjectListItemSchema() {
|
|
2714
3182
|
return Joi.object({
|
|
2715
|
-
|
|
2716
|
-
definition_id: Joi.string().allow(""),
|
|
3183
|
+
id: Joi.string().allow(""),
|
|
2717
3184
|
status: Joi.string().allow(""),
|
|
3185
|
+
created_at: Joi.string().allow(""),
|
|
2718
3186
|
updated_at: Joi.string().allow(""),
|
|
2719
3187
|
display_name: Joi.string().allow(""),
|
|
2720
|
-
definition: ContentPlatformModel.
|
|
3188
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
2721
3189
|
references: Joi.number(),
|
|
2722
3190
|
});
|
|
2723
3191
|
}
|
|
@@ -2732,26 +3200,30 @@ class ContentPlatformModel {
|
|
|
2732
3200
|
});
|
|
2733
3201
|
}
|
|
2734
3202
|
|
|
2735
|
-
/** @returns {
|
|
2736
|
-
static
|
|
3203
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
3204
|
+
static CustomObjectFieldDefinition() {
|
|
2737
3205
|
return Joi.object({
|
|
2738
|
-
|
|
2739
|
-
|
|
3206
|
+
id: Joi.string().allow(""),
|
|
3207
|
+
slug: Joi.string().allow(""),
|
|
3208
|
+
namespace: Joi.string().allow(""),
|
|
2740
3209
|
value: Joi.array().items(Joi.any()),
|
|
2741
3210
|
type: Joi.string().allow(""),
|
|
2742
|
-
definition_id: Joi.string().allow(""),
|
|
2743
3211
|
});
|
|
2744
3212
|
}
|
|
2745
3213
|
|
|
2746
|
-
/** @returns {
|
|
2747
|
-
static
|
|
3214
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
3215
|
+
static CustomObjectBySlugSchema() {
|
|
2748
3216
|
return Joi.object({
|
|
2749
|
-
|
|
3217
|
+
id: Joi.string().allow(""),
|
|
2750
3218
|
status: Joi.string().allow(""),
|
|
2751
3219
|
display_name: Joi.string().allow(""),
|
|
2752
|
-
definition: ContentPlatformModel.
|
|
3220
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
2753
3221
|
references: Joi.array().items(Joi.any()),
|
|
2754
|
-
|
|
3222
|
+
slug: Joi.string().allow(""),
|
|
3223
|
+
definition_slug: Joi.string().allow(""),
|
|
3224
|
+
fields: Joi.array().items(
|
|
3225
|
+
ContentPlatformModel.CustomObjectFieldDefinition()
|
|
3226
|
+
),
|
|
2755
3227
|
});
|
|
2756
3228
|
}
|
|
2757
3229
|
|
|
@@ -2773,17 +3245,15 @@ class ContentPlatformModel {
|
|
|
2773
3245
|
});
|
|
2774
3246
|
}
|
|
2775
3247
|
|
|
2776
|
-
/** @returns {
|
|
2777
|
-
static
|
|
3248
|
+
/** @returns {JobSchema} */
|
|
3249
|
+
static JobSchema() {
|
|
2778
3250
|
return Joi.object({
|
|
2779
|
-
|
|
3251
|
+
id: Joi.string().allow(""),
|
|
2780
3252
|
jobs: Joi.array().items(Joi.string().allow("")),
|
|
2781
3253
|
finished_jobs: Joi.array().items(Joi.string().allow("")),
|
|
2782
3254
|
error_jobs: Joi.array().items(Joi.string().allow("")),
|
|
2783
3255
|
errors_occured: Joi.array().items(Joi.string().allow("")),
|
|
2784
3256
|
company_id: Joi.string().allow(""),
|
|
2785
|
-
creator: Joi.string().allow(""),
|
|
2786
|
-
url: Joi.string().allow(""),
|
|
2787
3257
|
status: Joi.string().allow(""),
|
|
2788
3258
|
action_type: Joi.string().allow(""),
|
|
2789
3259
|
entity: Joi.string().allow(""),
|
|
@@ -2796,17 +3266,33 @@ class ContentPlatformModel {
|
|
|
2796
3266
|
created_by: Joi.string().allow(""),
|
|
2797
3267
|
created_at: Joi.string().allow(""),
|
|
2798
3268
|
updated_at: Joi.string().allow(""),
|
|
3269
|
+
application_id: Joi.string().allow(""),
|
|
3270
|
+
});
|
|
3271
|
+
}
|
|
3272
|
+
|
|
3273
|
+
/** @returns {CustomFieldBulkEntry} */
|
|
3274
|
+
static CustomFieldBulkEntry() {
|
|
3275
|
+
return Joi.object({
|
|
3276
|
+
items: Joi.array().items(ContentPlatformModel.JobSchema()),
|
|
3277
|
+
page: ContentPlatformModel.Page(),
|
|
2799
3278
|
});
|
|
2800
3279
|
}
|
|
2801
3280
|
|
|
2802
3281
|
/** @returns {CustomObjectBulkEntry} */
|
|
2803
3282
|
static CustomObjectBulkEntry() {
|
|
2804
3283
|
return Joi.object({
|
|
2805
|
-
items: Joi.array().items(ContentPlatformModel.
|
|
3284
|
+
items: Joi.array().items(ContentPlatformModel.JobSchema()),
|
|
2806
3285
|
page: ContentPlatformModel.Page(),
|
|
2807
3286
|
});
|
|
2808
3287
|
}
|
|
2809
3288
|
|
|
3289
|
+
/** @returns {MetafieldTypesSchema} */
|
|
3290
|
+
static MetafieldTypesSchema() {
|
|
3291
|
+
return Joi.object({
|
|
3292
|
+
metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
|
|
3293
|
+
});
|
|
3294
|
+
}
|
|
3295
|
+
|
|
2810
3296
|
/** @returns {CustomFieldTypeSchema} */
|
|
2811
3297
|
static CustomFieldTypeSchema() {
|
|
2812
3298
|
return Joi.object({
|
|
@@ -2823,6 +3309,8 @@ class ContentPlatformModel {
|
|
|
2823
3309
|
url: ContentPlatformModel.Url(),
|
|
2824
3310
|
metaobject: ContentPlatformModel.Metaobject(),
|
|
2825
3311
|
product: ContentPlatformModel.Product(),
|
|
3312
|
+
html: ContentPlatformModel.HTML(),
|
|
3313
|
+
duration: ContentPlatformModel.Duration(),
|
|
2826
3314
|
});
|
|
2827
3315
|
}
|
|
2828
3316
|
|
|
@@ -2854,6 +3342,31 @@ class ContentPlatformModel {
|
|
|
2854
3342
|
});
|
|
2855
3343
|
}
|
|
2856
3344
|
|
|
3345
|
+
/** @returns {Duration} */
|
|
3346
|
+
static Duration() {
|
|
3347
|
+
return Joi.object({
|
|
3348
|
+
name: Joi.string().allow(""),
|
|
3349
|
+
list_enabled: Joi.boolean(),
|
|
3350
|
+
type: Joi.string().allow(""),
|
|
3351
|
+
category: Joi.string().allow(""),
|
|
3352
|
+
supported_validations: Joi.array().items(
|
|
3353
|
+
ContentPlatformModel.SupportedValidationsSchema()
|
|
3354
|
+
),
|
|
3355
|
+
});
|
|
3356
|
+
}
|
|
3357
|
+
|
|
3358
|
+
/** @returns {HTML} */
|
|
3359
|
+
static HTML() {
|
|
3360
|
+
return Joi.object({
|
|
3361
|
+
name: Joi.string().allow(""),
|
|
3362
|
+
list_enabled: Joi.boolean(),
|
|
3363
|
+
type: Joi.string().allow(""),
|
|
3364
|
+
supported_validations: Joi.array().items(
|
|
3365
|
+
ContentPlatformModel.SupportedValidationsSchema()
|
|
3366
|
+
),
|
|
3367
|
+
});
|
|
3368
|
+
}
|
|
3369
|
+
|
|
2857
3370
|
/** @returns {StringSingleLine} */
|
|
2858
3371
|
static StringSingleLine() {
|
|
2859
3372
|
return Joi.object({
|
|
@@ -3025,7 +3538,7 @@ class ContentPlatformModel {
|
|
|
3025
3538
|
/** @returns {CustomObjectEntry} */
|
|
3026
3539
|
static CustomObjectEntry() {
|
|
3027
3540
|
return Joi.object({
|
|
3028
|
-
|
|
3541
|
+
id: Joi.string().allow(""),
|
|
3029
3542
|
name: Joi.string().allow(""),
|
|
3030
3543
|
type: Joi.string().allow(""),
|
|
3031
3544
|
updated_at: Joi.string().allow(""),
|
|
@@ -3045,8 +3558,16 @@ class ContentPlatformModel {
|
|
|
3045
3558
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
3046
3559
|
static CustomObjectEntryFieldSchema() {
|
|
3047
3560
|
return Joi.object({
|
|
3048
|
-
|
|
3049
|
-
|
|
3561
|
+
namespace: Joi.string().allow(""),
|
|
3562
|
+
slug: Joi.string().allow(""),
|
|
3563
|
+
});
|
|
3564
|
+
}
|
|
3565
|
+
|
|
3566
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3567
|
+
static CustomObjectEntryFieldSchemaWithoutID() {
|
|
3568
|
+
return Joi.object({
|
|
3569
|
+
slug: Joi.string().allow(""),
|
|
3570
|
+
value: Joi.any(),
|
|
3050
3571
|
});
|
|
3051
3572
|
}
|
|
3052
3573
|
|
|
@@ -3054,13 +3575,23 @@ class ContentPlatformModel {
|
|
|
3054
3575
|
static CustomObjectRequestSchema() {
|
|
3055
3576
|
return Joi.object({
|
|
3056
3577
|
status: Joi.string().allow(""),
|
|
3057
|
-
|
|
3578
|
+
slug: Joi.string().allow(""),
|
|
3058
3579
|
fields: Joi.array().items(
|
|
3059
3580
|
ContentPlatformModel.CustomObjectEntryFieldSchema()
|
|
3060
3581
|
),
|
|
3061
3582
|
});
|
|
3062
3583
|
}
|
|
3063
3584
|
|
|
3585
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3586
|
+
static CustomObjectRequestSchemaWithoutId() {
|
|
3587
|
+
return Joi.object({
|
|
3588
|
+
status: Joi.string().allow(""),
|
|
3589
|
+
fields: Joi.array().items(
|
|
3590
|
+
ContentPlatformModel.CustomObjectEntryFieldSchemaWithoutID()
|
|
3591
|
+
),
|
|
3592
|
+
});
|
|
3593
|
+
}
|
|
3594
|
+
|
|
3064
3595
|
/** @returns {CustomObjectBulkSchema} */
|
|
3065
3596
|
static CustomObjectBulkSchema() {
|
|
3066
3597
|
return Joi.object({
|
|
@@ -3085,6 +3616,337 @@ class ContentPlatformModel {
|
|
|
3085
3616
|
});
|
|
3086
3617
|
}
|
|
3087
3618
|
|
|
3619
|
+
/** @returns {TranslateUiLabels} */
|
|
3620
|
+
static TranslateUiLabels() {
|
|
3621
|
+
return Joi.object({
|
|
3622
|
+
_id: Joi.string().allow(""),
|
|
3623
|
+
company_id: Joi.string().allow(""),
|
|
3624
|
+
application_id: Joi.string().allow(""),
|
|
3625
|
+
template_theme_id: Joi.string().allow(""),
|
|
3626
|
+
theme_id: Joi.string().allow(""),
|
|
3627
|
+
locale: Joi.string().allow(""),
|
|
3628
|
+
resource: Joi.object().pattern(/\S/, Joi.any()),
|
|
3629
|
+
type: Joi.string().allow(""),
|
|
3630
|
+
});
|
|
3631
|
+
}
|
|
3632
|
+
|
|
3633
|
+
/** @returns {TranslateUiLabelsCreate} */
|
|
3634
|
+
static TranslateUiLabelsCreate() {
|
|
3635
|
+
return Joi.object({
|
|
3636
|
+
template_theme_id: Joi.string().allow(""),
|
|
3637
|
+
theme_id: Joi.string().allow(""),
|
|
3638
|
+
locale: Joi.string().allow(""),
|
|
3639
|
+
resource: Joi.object().pattern(/\S/, Joi.any()),
|
|
3640
|
+
type: Joi.string().allow(""),
|
|
3641
|
+
});
|
|
3642
|
+
}
|
|
3643
|
+
|
|
3644
|
+
/** @returns {StaticResourceUpdate} */
|
|
3645
|
+
static StaticResourceUpdate() {
|
|
3646
|
+
return Joi.object({
|
|
3647
|
+
template_theme_id: Joi.string().allow(""),
|
|
3648
|
+
theme_id: Joi.string().allow(""),
|
|
3649
|
+
locale: Joi.string().allow(""),
|
|
3650
|
+
resource: Joi.object().pattern(/\S/, Joi.any()),
|
|
3651
|
+
type: Joi.string().allow(""),
|
|
3652
|
+
});
|
|
3653
|
+
}
|
|
3654
|
+
|
|
3655
|
+
/** @returns {TranslateUiLabelsPage} */
|
|
3656
|
+
static TranslateUiLabelsPage() {
|
|
3657
|
+
return Joi.object({
|
|
3658
|
+
items: Joi.array().items(ContentPlatformModel.TranslateUiLabels()),
|
|
3659
|
+
page: ContentPlatformModel.Page(),
|
|
3660
|
+
});
|
|
3661
|
+
}
|
|
3662
|
+
|
|
3663
|
+
/** @returns {Error} */
|
|
3664
|
+
static Error() {
|
|
3665
|
+
return Joi.object({
|
|
3666
|
+
error: Joi.string().allow(""),
|
|
3667
|
+
});
|
|
3668
|
+
}
|
|
3669
|
+
|
|
3670
|
+
/** @returns {Meta} */
|
|
3671
|
+
static Meta() {
|
|
3672
|
+
return Joi.object({
|
|
3673
|
+
created_by: Joi.string().allow(""),
|
|
3674
|
+
modified_by: Joi.string().allow(""),
|
|
3675
|
+
created_on: Joi.string().allow(""),
|
|
3676
|
+
modified_on: Joi.string().allow(""),
|
|
3677
|
+
});
|
|
3678
|
+
}
|
|
3679
|
+
|
|
3680
|
+
/** @returns {CompanyLanguage} */
|
|
3681
|
+
static CompanyLanguage() {
|
|
3682
|
+
return Joi.object({
|
|
3683
|
+
_id: Joi.string().allow(""),
|
|
3684
|
+
company_id: Joi.string().allow("").required(),
|
|
3685
|
+
locale: Joi.string().allow(""),
|
|
3686
|
+
name: Joi.string().allow(""),
|
|
3687
|
+
direction: Joi.string().allow(""),
|
|
3688
|
+
is_default: Joi.boolean(),
|
|
3689
|
+
display_name: Joi.string().allow(""),
|
|
3690
|
+
});
|
|
3691
|
+
}
|
|
3692
|
+
|
|
3693
|
+
/** @returns {CompanyLanguageCreate} */
|
|
3694
|
+
static CompanyLanguageCreate() {
|
|
3695
|
+
return Joi.object({
|
|
3696
|
+
locales: Joi.array().items(Joi.string().allow("")).required(),
|
|
3697
|
+
});
|
|
3698
|
+
}
|
|
3699
|
+
|
|
3700
|
+
/** @returns {CompanyLanguageUpdate} */
|
|
3701
|
+
static CompanyLanguageUpdate() {
|
|
3702
|
+
return Joi.object({
|
|
3703
|
+
is_default: Joi.boolean().required(),
|
|
3704
|
+
});
|
|
3705
|
+
}
|
|
3706
|
+
|
|
3707
|
+
/** @returns {ApplicationLanguage} */
|
|
3708
|
+
static ApplicationLanguage() {
|
|
3709
|
+
return Joi.object({
|
|
3710
|
+
_id: Joi.string().allow(""),
|
|
3711
|
+
company_id: Joi.string().allow("").required(),
|
|
3712
|
+
application_id: Joi.string().allow("").required(),
|
|
3713
|
+
locale: Joi.string().allow("").required(),
|
|
3714
|
+
name: Joi.string().allow("").required(),
|
|
3715
|
+
direction: Joi.string().allow("").required(),
|
|
3716
|
+
is_default: Joi.boolean().required(),
|
|
3717
|
+
published: Joi.boolean().required(),
|
|
3718
|
+
display_name: Joi.string().allow(""),
|
|
3719
|
+
});
|
|
3720
|
+
}
|
|
3721
|
+
|
|
3722
|
+
/** @returns {unPublishApplicationLanguage} */
|
|
3723
|
+
static unPublishApplicationLanguage() {
|
|
3724
|
+
return Joi.object({
|
|
3725
|
+
published: Joi.boolean().required(),
|
|
3726
|
+
});
|
|
3727
|
+
}
|
|
3728
|
+
|
|
3729
|
+
/** @returns {ApplicationLanguageCreate} */
|
|
3730
|
+
static ApplicationLanguageCreate() {
|
|
3731
|
+
return Joi.object({
|
|
3732
|
+
locales: Joi.array().items(Joi.string().allow("")).required(),
|
|
3733
|
+
});
|
|
3734
|
+
}
|
|
3735
|
+
|
|
3736
|
+
/** @returns {ApplicationLanguageUpdate} */
|
|
3737
|
+
static ApplicationLanguageUpdate() {
|
|
3738
|
+
return Joi.object({
|
|
3739
|
+
is_default: Joi.boolean().required(),
|
|
3740
|
+
published: Joi.boolean().required(),
|
|
3741
|
+
});
|
|
3742
|
+
}
|
|
3743
|
+
|
|
3744
|
+
/** @returns {TranslatableResource} */
|
|
3745
|
+
static TranslatableResource() {
|
|
3746
|
+
return Joi.object({
|
|
3747
|
+
_id: Joi.string().allow(""),
|
|
3748
|
+
type: Joi.string().allow("").required(),
|
|
3749
|
+
name: Joi.string().allow("").required(),
|
|
3750
|
+
description: Joi.string().allow("").required(),
|
|
3751
|
+
schema_type: Joi.string().allow("").required(),
|
|
3752
|
+
created_by: Joi.string().allow(""),
|
|
3753
|
+
modified_by: Joi.string().allow(""),
|
|
3754
|
+
created_on: Joi.string().allow(""),
|
|
3755
|
+
modified_on: Joi.string().allow(""),
|
|
3756
|
+
section_id: ContentPlatformModel.TranslatableSection(),
|
|
3757
|
+
});
|
|
3758
|
+
}
|
|
3759
|
+
|
|
3760
|
+
/** @returns {ResourceDefinition} */
|
|
3761
|
+
static ResourceDefinition() {
|
|
3762
|
+
return Joi.object({
|
|
3763
|
+
_id: Joi.string().allow(""),
|
|
3764
|
+
translatable_resource_id: Joi.string().allow("").required(),
|
|
3765
|
+
json_schema: ContentPlatformModel.ResourceJsonSchema(),
|
|
3766
|
+
ui_schema: ContentPlatformModel.ResourceUISchema(),
|
|
3767
|
+
bulk_details: ContentPlatformModel.ResourceBulkDetails(),
|
|
3768
|
+
});
|
|
3769
|
+
}
|
|
3770
|
+
|
|
3771
|
+
/** @returns {ResourceJsonSchema} */
|
|
3772
|
+
static ResourceJsonSchema() {
|
|
3773
|
+
return Joi.object({
|
|
3774
|
+
schema: Joi.string().allow(""),
|
|
3775
|
+
type: ContentPlatformModel.ResourceJsonSchemaType(),
|
|
3776
|
+
}).allow(null);
|
|
3777
|
+
}
|
|
3778
|
+
|
|
3779
|
+
/** @returns {ResourceJsonSchemaType} */
|
|
3780
|
+
static ResourceJsonSchemaType() {
|
|
3781
|
+
return Joi.object({
|
|
3782
|
+
author: ContentPlatformModel.Author(),
|
|
3783
|
+
title: ContentPlatformModel.Title(),
|
|
3784
|
+
feature_image: ContentPlatformModel.FeatureImage(),
|
|
3785
|
+
});
|
|
3786
|
+
}
|
|
3787
|
+
|
|
3788
|
+
/** @returns {ResourceUISchema} */
|
|
3789
|
+
static ResourceUISchema() {
|
|
3790
|
+
return Joi.object({
|
|
3791
|
+
author: ContentPlatformModel.Author(),
|
|
3792
|
+
title: ContentPlatformModel.Title(),
|
|
3793
|
+
feature_image: ContentPlatformModel.FeatureImage(),
|
|
3794
|
+
seo: ContentPlatformModel.SeoTranslate(),
|
|
3795
|
+
}).allow(null);
|
|
3796
|
+
}
|
|
3797
|
+
|
|
3798
|
+
/** @returns {ResourceBulkDetails} */
|
|
3799
|
+
static ResourceBulkDetails() {
|
|
3800
|
+
return Joi.object({
|
|
3801
|
+
fields: Joi.array().items(Joi.string().allow("")),
|
|
3802
|
+
}).allow(null);
|
|
3803
|
+
}
|
|
3804
|
+
|
|
3805
|
+
/** @returns {Title} */
|
|
3806
|
+
static Title() {
|
|
3807
|
+
return Joi.object({
|
|
3808
|
+
ui_widget: Joi.string().allow(""),
|
|
3809
|
+
ui_description: Joi.boolean(),
|
|
3810
|
+
});
|
|
3811
|
+
}
|
|
3812
|
+
|
|
3813
|
+
/** @returns {FeatureImage} */
|
|
3814
|
+
static FeatureImage() {
|
|
3815
|
+
return Joi.object({
|
|
3816
|
+
secure_url: Joi.string().allow(""),
|
|
3817
|
+
});
|
|
3818
|
+
}
|
|
3819
|
+
|
|
3820
|
+
/** @returns {SeoTranslate} */
|
|
3821
|
+
static SeoTranslate() {
|
|
3822
|
+
return Joi.object({
|
|
3823
|
+
title: ContentPlatformModel.Title(),
|
|
3824
|
+
description: Joi.string().allow(""),
|
|
3825
|
+
canonical_url: Joi.string().allow(""),
|
|
3826
|
+
meta_tags: Joi.array().items(ContentPlatformModel.MetaTag()),
|
|
3827
|
+
});
|
|
3828
|
+
}
|
|
3829
|
+
|
|
3830
|
+
/** @returns {MetaTag} */
|
|
3831
|
+
static MetaTag() {
|
|
3832
|
+
return Joi.object({
|
|
3833
|
+
title: Joi.string().allow(""),
|
|
3834
|
+
items: Joi.array().items(ContentPlatformModel.MetaTagItem()),
|
|
3835
|
+
});
|
|
3836
|
+
}
|
|
3837
|
+
|
|
3838
|
+
/** @returns {MetaTagItem} */
|
|
3839
|
+
static MetaTagItem() {
|
|
3840
|
+
return Joi.object({
|
|
3841
|
+
key: Joi.string().allow(""),
|
|
3842
|
+
value: Joi.string().allow(""),
|
|
3843
|
+
});
|
|
3844
|
+
}
|
|
3845
|
+
|
|
3846
|
+
/** @returns {ResourceTranslation} */
|
|
3847
|
+
static ResourceTranslation() {
|
|
3848
|
+
return Joi.object({
|
|
3849
|
+
_id: Joi.string().allow(""),
|
|
3850
|
+
locale: Joi.string().allow(""),
|
|
3851
|
+
value: Joi.object().pattern(/\S/, Joi.any()),
|
|
3852
|
+
});
|
|
3853
|
+
}
|
|
3854
|
+
|
|
3855
|
+
/** @returns {TranslationSeo} */
|
|
3856
|
+
static TranslationSeo() {
|
|
3857
|
+
return Joi.object({
|
|
3858
|
+
title: Joi.string().allow(""),
|
|
3859
|
+
breadcrumbs: Joi.array().items(Joi.string().allow("")),
|
|
3860
|
+
meta_tags: Joi.array().items(Joi.string().allow("")),
|
|
3861
|
+
canonical_url: Joi.string().allow(""),
|
|
3862
|
+
description: Joi.string().allow(""),
|
|
3863
|
+
});
|
|
3864
|
+
}
|
|
3865
|
+
|
|
3866
|
+
/** @returns {ResourceTranslationList} */
|
|
3867
|
+
static ResourceTranslationList() {
|
|
3868
|
+
return Joi.object({
|
|
3869
|
+
items: Joi.array().items(
|
|
3870
|
+
ContentPlatformModel.ResourceTranslationCreate()
|
|
3871
|
+
),
|
|
3872
|
+
});
|
|
3873
|
+
}
|
|
3874
|
+
|
|
3875
|
+
/** @returns {ResourceTranslationCreate} */
|
|
3876
|
+
static ResourceTranslationCreate() {
|
|
3877
|
+
return Joi.object({
|
|
3878
|
+
type: Joi.string().allow(""),
|
|
3879
|
+
resource_id: Joi.string().allow(""),
|
|
3880
|
+
locale: Joi.string().allow(""),
|
|
3881
|
+
value: Joi.object().pattern(/\S/, Joi.any()),
|
|
3882
|
+
});
|
|
3883
|
+
}
|
|
3884
|
+
|
|
3885
|
+
/** @returns {ResourceTranslationUpdate} */
|
|
3886
|
+
static ResourceTranslationUpdate() {
|
|
3887
|
+
return Joi.object({
|
|
3888
|
+
value: Joi.object().pattern(/\S/, Joi.any()),
|
|
3889
|
+
});
|
|
3890
|
+
}
|
|
3891
|
+
|
|
3892
|
+
/** @returns {TranslatableSection} */
|
|
3893
|
+
static TranslatableSection() {
|
|
3894
|
+
return Joi.object({
|
|
3895
|
+
_id: Joi.string().allow(""),
|
|
3896
|
+
name: Joi.string().allow(""),
|
|
3897
|
+
description: Joi.string().allow(""),
|
|
3898
|
+
created_by: Joi.string().allow(""),
|
|
3899
|
+
modified_by: Joi.string().allow(""),
|
|
3900
|
+
created_on: Joi.string().allow(""),
|
|
3901
|
+
modified_on: Joi.string().allow(""),
|
|
3902
|
+
});
|
|
3903
|
+
}
|
|
3904
|
+
|
|
3905
|
+
/** @returns {Metrics} */
|
|
3906
|
+
static Metrics() {
|
|
3907
|
+
return Joi.object({
|
|
3908
|
+
total: Joi.number(),
|
|
3909
|
+
success: Joi.number(),
|
|
3910
|
+
failed: Joi.number(),
|
|
3911
|
+
});
|
|
3912
|
+
}
|
|
3913
|
+
|
|
3914
|
+
/** @returns {ResourceTranslationUpsertItem} */
|
|
3915
|
+
static ResourceTranslationUpsertItem() {
|
|
3916
|
+
return Joi.object({
|
|
3917
|
+
message: Joi.string().allow(""),
|
|
3918
|
+
data: ContentPlatformModel.ResourceTranslationCreate(),
|
|
3919
|
+
});
|
|
3920
|
+
}
|
|
3921
|
+
|
|
3922
|
+
/** @returns {ResourceTranslationBulkUpsert} */
|
|
3923
|
+
static ResourceTranslationBulkUpsert() {
|
|
3924
|
+
return Joi.object({
|
|
3925
|
+
metrics: ContentPlatformModel.Metrics(),
|
|
3926
|
+
failed_items: Joi.array().items(
|
|
3927
|
+
ContentPlatformModel.ResourceTranslationUpsertItem()
|
|
3928
|
+
),
|
|
3929
|
+
updated_items: Joi.array().items(
|
|
3930
|
+
ContentPlatformModel.ResourceTranslationUpsertItem()
|
|
3931
|
+
),
|
|
3932
|
+
});
|
|
3933
|
+
}
|
|
3934
|
+
|
|
3935
|
+
/** @returns {StandardError} */
|
|
3936
|
+
static StandardError() {
|
|
3937
|
+
return Joi.object({
|
|
3938
|
+
message: Joi.string().allow("").required(),
|
|
3939
|
+
});
|
|
3940
|
+
}
|
|
3941
|
+
|
|
3942
|
+
/** @returns {OperationResponseSchema} */
|
|
3943
|
+
static OperationResponseSchema() {
|
|
3944
|
+
return Joi.object({
|
|
3945
|
+
success: Joi.boolean().required(),
|
|
3946
|
+
message: Joi.string().allow(""),
|
|
3947
|
+
});
|
|
3948
|
+
}
|
|
3949
|
+
|
|
3088
3950
|
/**
|
|
3089
3951
|
* Enum: GenerationEntityType Used By: Content
|
|
3090
3952
|
*
|
|
@@ -3161,9 +4023,9 @@ class ContentPlatformModel {
|
|
|
3161
4023
|
|
|
3162
4024
|
"profile-company",
|
|
3163
4025
|
|
|
3164
|
-
"profile-
|
|
4026
|
+
"profile-email",
|
|
3165
4027
|
|
|
3166
|
-
"profile-
|
|
4028
|
+
"profile-phone",
|
|
3167
4029
|
|
|
3168
4030
|
"rate-us",
|
|
3169
4031
|
|
|
@@ -3199,7 +4061,13 @@ class ContentPlatformModel {
|
|
|
3199
4061
|
|
|
3200
4062
|
"order-status",
|
|
3201
4063
|
|
|
3202
|
-
"locate-us"
|
|
4064
|
+
"locate-us",
|
|
4065
|
+
|
|
4066
|
+
"single-page-checkout",
|
|
4067
|
+
|
|
4068
|
+
"request-reattempt",
|
|
4069
|
+
|
|
4070
|
+
"files"
|
|
3203
4071
|
);
|
|
3204
4072
|
}
|
|
3205
4073
|
}
|