@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -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]
|
|
@@ -60,8 +66,6 @@ const Joi = require("joi");
|
|
|
60
66
|
* @property {string} [app]
|
|
61
67
|
* @property {string} [_id]
|
|
62
68
|
* @property {string} [robots_txt]
|
|
63
|
-
* @property {boolean} [sitemap_enabled]
|
|
64
|
-
* @property {string} [additional_sitemap]
|
|
65
69
|
* @property {boolean} [cannonical_enabled]
|
|
66
70
|
* @property {CustomMetaTag[]} [custom_meta_tags]
|
|
67
71
|
* @property {Detail} [details]
|
|
@@ -178,7 +182,7 @@ const Joi = require("joi");
|
|
|
178
182
|
*/
|
|
179
183
|
|
|
180
184
|
/**
|
|
181
|
-
* @typedef
|
|
185
|
+
* @typedef BlogGetDetails
|
|
182
186
|
* @property {BlogSchema[]} [items]
|
|
183
187
|
* @property {Page} [page]
|
|
184
188
|
* @property {BlogFilters} [filters]
|
|
@@ -276,7 +280,57 @@ const Joi = require("joi");
|
|
|
276
280
|
*/
|
|
277
281
|
|
|
278
282
|
/**
|
|
279
|
-
* @typedef
|
|
283
|
+
* @typedef DefaultSitemapIndividualConfig
|
|
284
|
+
* @property {boolean} [enabled] - Whether sitemap configuration is enabled or
|
|
285
|
+
* not for this sitemap configuration
|
|
286
|
+
*/
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* @typedef DefaultSitemapConfig
|
|
290
|
+
* @property {DefaultSitemapIndividualConfig} [root]
|
|
291
|
+
* @property {DefaultSitemapIndividualConfig} [brand]
|
|
292
|
+
* @property {DefaultSitemapIndividualConfig} [collections]
|
|
293
|
+
* @property {DefaultSitemapIndividualConfig} [category_l1]
|
|
294
|
+
* @property {DefaultSitemapIndividualConfig} [category_l2]
|
|
295
|
+
* @property {DefaultSitemapIndividualConfig} [category_l3]
|
|
296
|
+
* @property {DefaultSitemapIndividualConfig} [pages]
|
|
297
|
+
* @property {DefaultSitemapIndividualConfig} [blog]
|
|
298
|
+
* @property {DefaultSitemapIndividualConfig} [section]
|
|
299
|
+
* @property {DefaultSitemapIndividualConfig} [faq]
|
|
300
|
+
* @property {DefaultSitemapIndividualConfig} [sitemap]
|
|
301
|
+
*/
|
|
302
|
+
|
|
303
|
+
/**
|
|
304
|
+
* @typedef SitemapConfigCreate
|
|
305
|
+
* @property {string} [name] - Unique identifier for the sitemap configuration
|
|
306
|
+
* @property {boolean} [is_active] - Indicates if the sitemap configuration is active
|
|
307
|
+
* @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
|
|
308
|
+
*/
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* @typedef SitemapConfig
|
|
312
|
+
* @property {string} [name] - Unique identifier for the sitemap configuration
|
|
313
|
+
* @property {boolean} [is_active] - Indicates if the sitemap configuration is
|
|
314
|
+
* active or not in storefront
|
|
315
|
+
* @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
|
|
316
|
+
* @property {string} [created_at] - Timestamp when the configuration was created
|
|
317
|
+
* @property {string} [updated_at] - Timestamp when the configuration was last updated
|
|
318
|
+
*/
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* @typedef SitemapConfigurationList
|
|
322
|
+
* @property {SitemapConfig[]} [items] - List of all Sitemap configurations
|
|
323
|
+
* @property {Page} [page]
|
|
324
|
+
*/
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* @typedef SitemapConfigUpdate
|
|
328
|
+
* @property {boolean} [is_active] - Indicates if the sitemap configuration is active
|
|
329
|
+
* @property {string} [sitemap] - XML string containing sitemap data
|
|
330
|
+
*/
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* @typedef BlogPayload
|
|
280
334
|
* @property {string} [application]
|
|
281
335
|
* @property {Object} [_custom_json]
|
|
282
336
|
* @property {Author} [author]
|
|
@@ -445,7 +499,7 @@ const Joi = require("joi");
|
|
|
445
499
|
*/
|
|
446
500
|
|
|
447
501
|
/**
|
|
448
|
-
* @typedef
|
|
502
|
+
* @typedef TagDeleteSuccessDetails
|
|
449
503
|
* @property {boolean} [success]
|
|
450
504
|
*/
|
|
451
505
|
|
|
@@ -576,7 +630,7 @@ const Joi = require("joi");
|
|
|
576
630
|
*/
|
|
577
631
|
|
|
578
632
|
/**
|
|
579
|
-
* @typedef
|
|
633
|
+
* @typedef LandingPageGetDetails
|
|
580
634
|
* @property {LandingPageSchema[]} [items]
|
|
581
635
|
* @property {Page} [page]
|
|
582
636
|
*/
|
|
@@ -595,12 +649,12 @@ const Joi = require("joi");
|
|
|
595
649
|
*/
|
|
596
650
|
|
|
597
651
|
/**
|
|
598
|
-
* @typedef
|
|
652
|
+
* @typedef DefaultNavigationDetails
|
|
599
653
|
* @property {NavigationSchema[]} [items]
|
|
600
654
|
*/
|
|
601
655
|
|
|
602
656
|
/**
|
|
603
|
-
* @typedef
|
|
657
|
+
* @typedef NavigationGetDetails
|
|
604
658
|
* @property {NavigationSchema[]} [items]
|
|
605
659
|
* @property {Page} [page]
|
|
606
660
|
*/
|
|
@@ -627,7 +681,7 @@ const Joi = require("joi");
|
|
|
627
681
|
*/
|
|
628
682
|
|
|
629
683
|
/**
|
|
630
|
-
* @typedef
|
|
684
|
+
* @typedef NavigationPayload
|
|
631
685
|
* @property {string} [name]
|
|
632
686
|
* @property {string} [slug]
|
|
633
687
|
* @property {string[]} [platform]
|
|
@@ -636,7 +690,7 @@ const Joi = require("joi");
|
|
|
636
690
|
*/
|
|
637
691
|
|
|
638
692
|
/**
|
|
639
|
-
* @typedef
|
|
693
|
+
* @typedef PageGetDetails
|
|
640
694
|
* @property {PageSchema[]} [items]
|
|
641
695
|
* @property {Page} [page]
|
|
642
696
|
*/
|
|
@@ -693,7 +747,7 @@ const Joi = require("joi");
|
|
|
693
747
|
*/
|
|
694
748
|
|
|
695
749
|
/**
|
|
696
|
-
* @typedef
|
|
750
|
+
* @typedef PagePayload
|
|
697
751
|
* @property {CronSchedule} [_schedule]
|
|
698
752
|
* @property {string} [application]
|
|
699
753
|
* @property {Author} [author]
|
|
@@ -718,7 +772,7 @@ const Joi = require("joi");
|
|
|
718
772
|
*/
|
|
719
773
|
|
|
720
774
|
/**
|
|
721
|
-
* @typedef
|
|
775
|
+
* @typedef PagePublishPayload
|
|
722
776
|
* @property {boolean} [publish]
|
|
723
777
|
*/
|
|
724
778
|
|
|
@@ -730,7 +784,7 @@ const Joi = require("joi");
|
|
|
730
784
|
*/
|
|
731
785
|
|
|
732
786
|
/**
|
|
733
|
-
* @typedef
|
|
787
|
+
* @typedef SlideshowGetDetails
|
|
734
788
|
* @property {SlideshowSchema[]} [items]
|
|
735
789
|
* @property {Page} [page]
|
|
736
790
|
*/
|
|
@@ -750,7 +804,7 @@ const Joi = require("joi");
|
|
|
750
804
|
*/
|
|
751
805
|
|
|
752
806
|
/**
|
|
753
|
-
* @typedef
|
|
807
|
+
* @typedef SlideshowPayload
|
|
754
808
|
* @property {string} [slug]
|
|
755
809
|
* @property {string} [platform]
|
|
756
810
|
* @property {ConfigurationSchema} [configuration]
|
|
@@ -841,100 +895,116 @@ const Joi = require("joi");
|
|
|
841
895
|
|
|
842
896
|
/**
|
|
843
897
|
* @typedef FieldValidations
|
|
844
|
-
* @property {string} [name]
|
|
845
|
-
* @property {string} [type]
|
|
898
|
+
* @property {string} [name] - Name of validation
|
|
899
|
+
* @property {string} [type] - Type of validation
|
|
846
900
|
* @property {Object} [value]
|
|
847
901
|
*/
|
|
848
902
|
|
|
849
903
|
/**
|
|
850
904
|
* @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]
|
|
905
|
+
* @property {string} [id] - Unique system generated id
|
|
906
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
907
|
+
* @property {string} [name] - Name of custom field
|
|
908
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
909
|
+
* @property {string} [slug] - Slug of custom field
|
|
910
|
+
* @property {string} [description] - Description of custom field definition
|
|
911
|
+
* @property {string} [type] - Data type of custom field
|
|
912
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
913
|
+
* multivalued or not
|
|
914
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
915
|
+
* @property {string} [company_id] - Id of company
|
|
916
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
917
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
918
|
+
* @property {string} [type_name] - Type of type field
|
|
919
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
870
920
|
*/
|
|
871
921
|
|
|
872
922
|
/**
|
|
873
923
|
* @typedef CustomFieldDefinitionsSchema
|
|
874
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
924
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
875
925
|
* @property {Page} [page]
|
|
876
926
|
*/
|
|
877
927
|
|
|
878
928
|
/**
|
|
879
929
|
* @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]
|
|
930
|
+
* @property {string} [type] - Data type of custom field
|
|
931
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
932
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
933
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
934
|
+
* multi valued or not
|
|
935
|
+
* @property {string} [name] - Name of custom field definition
|
|
936
|
+
* @property {string} [description] - Description of a custom field definition
|
|
937
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
888
938
|
*/
|
|
889
939
|
|
|
890
940
|
/**
|
|
891
941
|
* @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 {
|
|
942
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
943
|
+
* @property {string} [type] - Data type of custom field
|
|
944
|
+
* @property {string} [description] - Description of custom field
|
|
945
|
+
* @property {string} [name] - Name of custom field
|
|
946
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
947
|
+
* valued or not
|
|
948
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
949
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
950
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
951
|
+
* custom field
|
|
900
952
|
* @property {string} [action]
|
|
901
953
|
*/
|
|
902
954
|
|
|
903
955
|
/**
|
|
904
956
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
905
|
-
* @property {string} [
|
|
906
|
-
* @property {string} [
|
|
907
|
-
* @property {string} [
|
|
908
|
-
*
|
|
957
|
+
* @property {string} [description] - Description of custom object definiton
|
|
958
|
+
* @property {string} [name] - Name of custom object definition
|
|
959
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
960
|
+
* display key in
|
|
909
961
|
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
910
962
|
*/
|
|
911
963
|
|
|
912
964
|
/**
|
|
913
965
|
* @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]
|
|
966
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
967
|
+
* @property {string} [name] - Name of custom field
|
|
968
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
969
|
+
* @property {string} [slug] - Slug of custom field
|
|
970
|
+
* @property {string} [description] - Description regarding custom field
|
|
971
|
+
* @property {string} [type] - Data type of custom field
|
|
972
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
973
|
+
* multi valued or not
|
|
974
|
+
* @property {string} [company_id] - Company Identifer
|
|
975
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
976
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
977
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
978
|
+
* @property {string} [id] - Unique system generated id
|
|
929
979
|
* @property {Object[]} [validations]
|
|
930
|
-
* @property {string} [created_at]
|
|
931
|
-
* @property {string} [updated_at]
|
|
980
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
981
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
982
|
+
*/
|
|
983
|
+
|
|
984
|
+
/**
|
|
985
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
986
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
987
|
+
* @property {string} [name] - Name of meta field
|
|
988
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
989
|
+
* @property {string} [slug] - Slug of meta field
|
|
990
|
+
* @property {string} [description] - Description regarding meta field
|
|
991
|
+
* @property {string} [type] - Data type of meta field
|
|
992
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
993
|
+
* multi valued or not
|
|
994
|
+
* @property {string} [company_id] - Company Identifer
|
|
995
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
996
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
997
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
998
|
+
* @property {string} [id] - Unique system generated id
|
|
999
|
+
* @property {Object[]} [validations]
|
|
1000
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
1001
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
932
1002
|
*/
|
|
933
1003
|
|
|
934
1004
|
/**
|
|
935
1005
|
* @typedef CustomDataDeleteSchema
|
|
936
|
-
* @property {boolean} [success]
|
|
937
|
-
* @property {string} [message]
|
|
1006
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
1007
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
938
1008
|
*/
|
|
939
1009
|
|
|
940
1010
|
/**
|
|
@@ -944,23 +1014,20 @@ const Joi = require("joi");
|
|
|
944
1014
|
|
|
945
1015
|
/**
|
|
946
1016
|
* @typedef CustomFieldSchema
|
|
947
|
-
* @property {string} [
|
|
948
|
-
* @property {string} [namespace]
|
|
949
|
-
* @property {string} [
|
|
950
|
-
* @property {string} [resource]
|
|
951
|
-
* @property {string} [creator]
|
|
1017
|
+
* @property {string} [id] - Unique system generated id
|
|
1018
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1019
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1020
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
952
1021
|
* @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]
|
|
1022
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
1023
|
+
* @property {string} [type] - Data type of custom field
|
|
1024
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
1025
|
+
* @property {string} [company_id] - Identifer for a company
|
|
958
1026
|
* @property {boolean} [has_invalid_values]
|
|
959
1027
|
* @property {Object[]} [invalid_value_errors]
|
|
960
|
-
* @property {
|
|
961
|
-
* @property {
|
|
962
|
-
* @property {string} [
|
|
963
|
-
* @property {string} [updated_at]
|
|
1028
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
1029
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
1030
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
964
1031
|
*/
|
|
965
1032
|
|
|
966
1033
|
/**
|
|
@@ -969,6 +1036,12 @@ const Joi = require("joi");
|
|
|
969
1036
|
* @property {Page} [page]
|
|
970
1037
|
*/
|
|
971
1038
|
|
|
1039
|
+
/**
|
|
1040
|
+
* @typedef CustomFieldsDeleteSchema
|
|
1041
|
+
* @property {boolean} [success]
|
|
1042
|
+
* @property {string} [message]
|
|
1043
|
+
*/
|
|
1044
|
+
|
|
972
1045
|
/**
|
|
973
1046
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
974
1047
|
* @property {CustomFieldSchema[]} [items]
|
|
@@ -977,7 +1050,9 @@ const Joi = require("joi");
|
|
|
977
1050
|
/**
|
|
978
1051
|
* @typedef CustomField
|
|
979
1052
|
* @property {Object[]} [value]
|
|
980
|
-
* @property {string} [
|
|
1053
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
1054
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
1055
|
+
* creating a custom field definition
|
|
981
1056
|
*/
|
|
982
1057
|
|
|
983
1058
|
/**
|
|
@@ -987,161 +1062,156 @@ const Joi = require("joi");
|
|
|
987
1062
|
|
|
988
1063
|
/**
|
|
989
1064
|
* @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]
|
|
1065
|
+
* @property {string} [id] - Unique system generated id
|
|
1066
|
+
* @property {string} [company_id] - Identifer for a company
|
|
1067
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
1068
|
+
* @property {string} [status] - Status of custom object
|
|
1069
|
+
* @property {string} [type] - Slug of custom object definition
|
|
1070
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
1071
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
1072
|
+
* custom object
|
|
1073
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
1001
1074
|
*/
|
|
1002
1075
|
|
|
1003
1076
|
/**
|
|
1004
1077
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
1005
|
-
* @property {string} [type]
|
|
1006
|
-
* @property {string} [
|
|
1007
|
-
* @property {string} [
|
|
1008
|
-
* @property {string} [
|
|
1009
|
-
* @property {
|
|
1078
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
1079
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
1080
|
+
* @property {string} [description] - Description of custom object definition
|
|
1081
|
+
* @property {string} [name] - Name of custom object
|
|
1082
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
1083
|
+
* for displaying custom object
|
|
1084
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
1085
|
+
* of custom field definitions belonging to this custom object definition
|
|
1010
1086
|
*/
|
|
1011
1087
|
|
|
1012
1088
|
/**
|
|
1013
|
-
* @typedef
|
|
1014
|
-
* @property {string} [
|
|
1015
|
-
* @property {string} [
|
|
1016
|
-
* @property {string} [
|
|
1017
|
-
* @property {string} [
|
|
1018
|
-
* @property {string} [
|
|
1019
|
-
* @property {string} [description]
|
|
1020
|
-
* @property {
|
|
1021
|
-
*
|
|
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]
|
|
1031
|
-
*/
|
|
1032
|
-
|
|
1033
|
-
/**
|
|
1034
|
-
* @typedef CustomObjectDefinitionSchema
|
|
1035
|
-
* @property {string} [_id]
|
|
1036
|
-
* @property {string} [name]
|
|
1037
|
-
* @property {string} [type]
|
|
1038
|
-
* @property {string} [display_name_key]
|
|
1039
|
-
* @property {string} [description]
|
|
1040
|
-
* @property {string} [creator]
|
|
1041
|
-
* @property {string} [created_by]
|
|
1042
|
-
* @property {string} [updated_by]
|
|
1043
|
-
* @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
|
|
1089
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
1090
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
1091
|
+
* @property {string} [name] - Display name of custom object definition
|
|
1092
|
+
* @property {string} [type] - Type of custom object definiton
|
|
1093
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
1094
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
1095
|
+
* @property {string} [description] - Description of custom object definition
|
|
1096
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
1097
|
+
* Custom fields inside custom objects
|
|
1044
1098
|
*/
|
|
1045
1099
|
|
|
1046
1100
|
/**
|
|
1047
1101
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
1048
|
-
* @property {boolean} [success]
|
|
1049
|
-
* @property {string} [message]
|
|
1102
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
1103
|
+
* @property {string} [message] - Response message when custom object definition
|
|
1104
|
+
* is deleted.
|
|
1050
1105
|
*/
|
|
1051
1106
|
|
|
1052
1107
|
/**
|
|
1053
|
-
* @typedef
|
|
1054
|
-
* @property {string} [url]
|
|
1055
|
-
* @property {number} [total_records]
|
|
1108
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
1109
|
+
* @property {string} [url] - Signed url of csv
|
|
1110
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
1056
1111
|
*/
|
|
1057
1112
|
|
|
1058
1113
|
/**
|
|
1059
|
-
* @typedef
|
|
1060
|
-
* @property {string} [
|
|
1061
|
-
* @property {string} [name]
|
|
1062
|
-
* @property {string} [type]
|
|
1114
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
1115
|
+
* @property {string} [id] - Unique system generated id
|
|
1116
|
+
* @property {string} [name] - Name of custom object
|
|
1117
|
+
* @property {string} [type] - Type of custom object entry
|
|
1063
1118
|
*/
|
|
1064
1119
|
|
|
1065
1120
|
/**
|
|
1066
1121
|
* @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]
|
|
1122
|
+
* @property {string} [id] - Unique system generated id
|
|
1123
|
+
* @property {string} [status] - Status of custom object
|
|
1124
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
1125
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
1126
|
+
* @property {string} [display_name] - Display name of custom object
|
|
1127
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1128
|
+
* @property {number} [references] - References of the custom object entry
|
|
1074
1129
|
*/
|
|
1075
1130
|
|
|
1076
1131
|
/**
|
|
1077
1132
|
* @typedef CustomObjectsSchema
|
|
1078
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
1133
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
1134
|
+
* object entries
|
|
1079
1135
|
* @property {Page} [page]
|
|
1080
1136
|
*/
|
|
1081
1137
|
|
|
1082
1138
|
/**
|
|
1083
|
-
* @typedef
|
|
1084
|
-
* @property {string} [
|
|
1085
|
-
* @property {string} [
|
|
1086
|
-
* @property {
|
|
1087
|
-
* @property {
|
|
1088
|
-
* @property {string} [
|
|
1139
|
+
* @typedef CustomObjectFieldDefinition
|
|
1140
|
+
* @property {string} [id] - Unique system generate id
|
|
1141
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1142
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1143
|
+
* @property {Object[]} [value] - Value of custom field
|
|
1144
|
+
* @property {string} [type] - Data type of the custom field
|
|
1089
1145
|
*/
|
|
1090
1146
|
|
|
1091
1147
|
/**
|
|
1092
|
-
* @typedef
|
|
1093
|
-
* @property {string} [
|
|
1094
|
-
* @property {string} [status]
|
|
1095
|
-
* @property {string} [display_name]
|
|
1096
|
-
* @property {
|
|
1097
|
-
* @property {Object[]} [references]
|
|
1098
|
-
*
|
|
1148
|
+
* @typedef CustomObjectBySlugSchema
|
|
1149
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
1150
|
+
* @property {string} [status] - Status of Custom Object
|
|
1151
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
1152
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1153
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
1154
|
+
* used as a custom field
|
|
1155
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
1156
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
1157
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
1158
|
+
* inside the custom object
|
|
1099
1159
|
*/
|
|
1100
1160
|
|
|
1101
1161
|
/**
|
|
1102
1162
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
1103
|
-
* @property {string} [message]
|
|
1104
|
-
* @property {string} [task_id]
|
|
1163
|
+
* @property {string} [message] - Message for the user
|
|
1164
|
+
* @property {string} [task_id] - Identifer for a task
|
|
1105
1165
|
*/
|
|
1106
1166
|
|
|
1107
1167
|
/**
|
|
1108
1168
|
* @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]
|
|
1169
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
1170
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
1171
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
1172
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
1173
|
+
*/
|
|
1174
|
+
|
|
1175
|
+
/**
|
|
1176
|
+
* @typedef JobSchema
|
|
1177
|
+
* @property {string} [id] - Unique system generated id
|
|
1178
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
1179
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
1180
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1181
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1182
|
+
* @property {string} [company_id] - Company Identifer
|
|
1183
|
+
* @property {string} [status] - Status of job
|
|
1184
|
+
* @property {string} [action_type] - Type of job
|
|
1185
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1186
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1187
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1188
|
+
* @property {number} [error_count] - Number of items in error
|
|
1189
|
+
* @property {number} [success_count] - Number of successful items
|
|
1190
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1191
|
+
* @property {CustomObjectMetaSchema} [meta]
|
|
1192
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1193
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1194
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1195
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
1113
1196
|
*/
|
|
1114
1197
|
|
|
1115
1198
|
/**
|
|
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]
|
|
1199
|
+
* @typedef CustomFieldBulkEntry
|
|
1200
|
+
* @property {JobSchema[]} [items]
|
|
1201
|
+
* @property {Page} [page]
|
|
1137
1202
|
*/
|
|
1138
1203
|
|
|
1139
1204
|
/**
|
|
1140
1205
|
* @typedef CustomObjectBulkEntry
|
|
1141
|
-
* @property {
|
|
1206
|
+
* @property {JobSchema[]} [items]
|
|
1142
1207
|
* @property {Page} [page]
|
|
1143
1208
|
*/
|
|
1144
1209
|
|
|
1210
|
+
/**
|
|
1211
|
+
* @typedef MetafieldTypesSchema
|
|
1212
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1213
|
+
*/
|
|
1214
|
+
|
|
1145
1215
|
/**
|
|
1146
1216
|
* @typedef CustomFieldTypeSchema
|
|
1147
1217
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1157,6 +1227,8 @@ const Joi = require("joi");
|
|
|
1157
1227
|
* @property {Url} [url]
|
|
1158
1228
|
* @property {Metaobject} [metaobject]
|
|
1159
1229
|
* @property {Product} [product]
|
|
1230
|
+
* @property {HTML} [html]
|
|
1231
|
+
* @property {Duration} [duration]
|
|
1160
1232
|
*/
|
|
1161
1233
|
|
|
1162
1234
|
/**
|
|
@@ -1179,130 +1251,164 @@ const Joi = require("joi");
|
|
|
1179
1251
|
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1180
1252
|
*/
|
|
1181
1253
|
|
|
1254
|
+
/**
|
|
1255
|
+
* @typedef Duration
|
|
1256
|
+
* @property {string} [name] - Name data type of custom field
|
|
1257
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1258
|
+
* @property {string} [type] - Type of custom field
|
|
1259
|
+
* @property {string} [category] - Category of custom field
|
|
1260
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1261
|
+
* validations available for the field
|
|
1262
|
+
*/
|
|
1263
|
+
|
|
1264
|
+
/**
|
|
1265
|
+
* @typedef HTML
|
|
1266
|
+
* @property {string} [name] - Name data type of custom field
|
|
1267
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1268
|
+
* @property {string} [type] - Type of custom field
|
|
1269
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1270
|
+
* validations available for the field
|
|
1271
|
+
*/
|
|
1272
|
+
|
|
1182
1273
|
/**
|
|
1183
1274
|
* @typedef StringSingleLine
|
|
1184
|
-
* @property {string} [name]
|
|
1185
|
-
* @property {boolean} [list_enabled]
|
|
1186
|
-
* @property {string} [category]
|
|
1187
|
-
* @property {string} [type]
|
|
1188
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1275
|
+
* @property {string} [name] - Name data type of custom field
|
|
1276
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1277
|
+
* @property {string} [category] - Category of custom field
|
|
1278
|
+
* @property {string} [type] - Type of custom field
|
|
1279
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1280
|
+
* validations available for the field
|
|
1189
1281
|
*/
|
|
1190
1282
|
|
|
1191
1283
|
/**
|
|
1192
1284
|
* @typedef StringMultiLine
|
|
1193
|
-
* @property {string} [name]
|
|
1194
|
-
* @property {boolean} [list_enabled]
|
|
1195
|
-
* @property {string} [category]
|
|
1196
|
-
* @property {string} [type]
|
|
1197
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1285
|
+
* @property {string} [name] - Name data type of custom field
|
|
1286
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1287
|
+
* @property {string} [category] - Category of custom field
|
|
1288
|
+
* @property {string} [type] - Type of custom field
|
|
1289
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1290
|
+
* validations available for the field
|
|
1198
1291
|
*/
|
|
1199
1292
|
|
|
1200
1293
|
/**
|
|
1201
1294
|
* @typedef Dropdown
|
|
1202
|
-
* @property {string} [name]
|
|
1203
|
-
* @property {boolean} [list_enabled]
|
|
1204
|
-
* @property {string} [category]
|
|
1205
|
-
* @property {string} [type]
|
|
1206
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1295
|
+
* @property {string} [name] - Name data type of custom field
|
|
1296
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1297
|
+
* @property {string} [category] - Category of custom field
|
|
1298
|
+
* @property {string} [type] - Category of custom field
|
|
1299
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1300
|
+
* validations available for the field
|
|
1207
1301
|
*/
|
|
1208
1302
|
|
|
1209
1303
|
/**
|
|
1210
1304
|
* @typedef Integer
|
|
1211
|
-
* @property {string} [name]
|
|
1212
|
-
* @property {boolean} [list_enabled]
|
|
1213
|
-
* @property {string} [type]
|
|
1214
|
-
* @property {string} [category]
|
|
1215
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1305
|
+
* @property {string} [name] - Name data type of custom field
|
|
1306
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1307
|
+
* @property {string} [type] - Type of custom field
|
|
1308
|
+
* @property {string} [category] - Category of custom field
|
|
1309
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1310
|
+
* validations available for the field
|
|
1216
1311
|
*/
|
|
1217
1312
|
|
|
1218
1313
|
/**
|
|
1219
1314
|
* @typedef FloatType
|
|
1220
|
-
* @property {string} [name]
|
|
1221
|
-
* @property {boolean} [list_enabled]
|
|
1222
|
-
* @property {string} [type]
|
|
1223
|
-
* @property {string} [category]
|
|
1224
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1315
|
+
* @property {string} [name] - Name data type of custom field
|
|
1316
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1317
|
+
* @property {string} [type] - Type of custom field
|
|
1318
|
+
* @property {string} [category] - Category of custom field
|
|
1319
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1320
|
+
* validations available for the field
|
|
1225
1321
|
*/
|
|
1226
1322
|
|
|
1227
1323
|
/**
|
|
1228
1324
|
* @typedef BooleanType
|
|
1229
|
-
* @property {string} [name]
|
|
1230
|
-
* @property {string} [category]
|
|
1231
|
-
* @property {boolean} [list_enabled]
|
|
1232
|
-
* @property {string} [type]
|
|
1233
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1325
|
+
* @property {string} [name] - Name data type of custom field
|
|
1326
|
+
* @property {string} [category] - Category of custom field
|
|
1327
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1328
|
+
* @property {string} [type] - Category of custom field
|
|
1329
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1330
|
+
* validations available for the field
|
|
1234
1331
|
*/
|
|
1235
1332
|
|
|
1236
1333
|
/**
|
|
1237
1334
|
* @typedef Date
|
|
1238
|
-
* @property {string} [name]
|
|
1239
|
-
* @property {boolean} [list_enabled]
|
|
1240
|
-
* @property {string} [category]
|
|
1241
|
-
* @property {string} [type]
|
|
1242
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1335
|
+
* @property {string} [name] - Name data type of custom field
|
|
1336
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1337
|
+
* @property {string} [category] - Category of custom field
|
|
1338
|
+
* @property {string} [type] - Type of custom field
|
|
1339
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1340
|
+
* validations available for the field
|
|
1243
1341
|
*/
|
|
1244
1342
|
|
|
1245
1343
|
/**
|
|
1246
1344
|
* @typedef Datetime
|
|
1247
|
-
* @property {string} [name]
|
|
1248
|
-
* @property {string} [category]
|
|
1249
|
-
* @property {boolean} [list_enabled]
|
|
1250
|
-
* @property {string} [type]
|
|
1251
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1345
|
+
* @property {string} [name] - Name data type of custom field
|
|
1346
|
+
* @property {string} [category] - Category of custom field
|
|
1347
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1348
|
+
* @property {string} [type] - Type of custom field
|
|
1349
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1350
|
+
* validations available for the field
|
|
1252
1351
|
*/
|
|
1253
1352
|
|
|
1254
1353
|
/**
|
|
1255
1354
|
* @typedef Json
|
|
1256
|
-
* @property {string} [name]
|
|
1257
|
-
* @property {boolean} [list_enabled]
|
|
1258
|
-
* @property {string} [category]
|
|
1259
|
-
* @property {string} [type]
|
|
1260
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1355
|
+
* @property {string} [name] - Name data type of custom field
|
|
1356
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1357
|
+
* @property {string} [category] - Category of custom field
|
|
1358
|
+
* @property {string} [type] - Type of custom field
|
|
1359
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1360
|
+
* validations available for the field
|
|
1261
1361
|
*/
|
|
1262
1362
|
|
|
1263
1363
|
/**
|
|
1264
1364
|
* @typedef File
|
|
1265
|
-
* @property {string} [name]
|
|
1266
|
-
* @property {string} [category]
|
|
1267
|
-
* @property {boolean} [list_enabled]
|
|
1268
|
-
* @property {string} [type]
|
|
1365
|
+
* @property {string} [name] - Name data type of custom field
|
|
1366
|
+
* @property {string} [category] - Category of custom field
|
|
1367
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1368
|
+
* @property {string} [type] - Type of custom field
|
|
1269
1369
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1270
1370
|
*/
|
|
1271
1371
|
|
|
1272
1372
|
/**
|
|
1273
1373
|
* @typedef Url
|
|
1274
|
-
* @property {string} [name]
|
|
1275
|
-
* @property {boolean} [list_enabled]
|
|
1276
|
-
* @property {string} [type]
|
|
1277
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1374
|
+
* @property {string} [name] - Name data type of custom field
|
|
1375
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1376
|
+
* @property {string} [type] - Type of custom field
|
|
1377
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1378
|
+
* validations available for the field
|
|
1278
1379
|
*/
|
|
1279
1380
|
|
|
1280
1381
|
/**
|
|
1281
1382
|
* @typedef Metaobject
|
|
1282
|
-
* @property {string} [name]
|
|
1283
|
-
* @property {boolean} [list_enabled]
|
|
1284
|
-
*
|
|
1285
|
-
* @property {string} [
|
|
1383
|
+
* @property {string} [name] - Name of Custom Object
|
|
1384
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1385
|
+
* multiple list items
|
|
1386
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1387
|
+
* Custom Object belongs to
|
|
1388
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1286
1389
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1287
1390
|
*/
|
|
1288
1391
|
|
|
1289
1392
|
/**
|
|
1290
1393
|
* @typedef Product
|
|
1291
|
-
* @property {string} [name]
|
|
1292
|
-
* @property {boolean} [list_enabled]
|
|
1293
|
-
*
|
|
1294
|
-
* @property {string} [
|
|
1394
|
+
* @property {string} [name] - Name of Product
|
|
1395
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1396
|
+
* multiple list items
|
|
1397
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1398
|
+
* Product is associated with
|
|
1399
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1295
1400
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1296
1401
|
*/
|
|
1297
1402
|
|
|
1298
1403
|
/**
|
|
1299
1404
|
* @typedef CustomObjectEntry
|
|
1300
|
-
* @property {string} [
|
|
1301
|
-
* @property {string} [name]
|
|
1302
|
-
* @property {string} [type]
|
|
1303
|
-
* @property {string} [updated_at]
|
|
1304
|
-
* @property {number} [entries_count]
|
|
1305
|
-
*
|
|
1405
|
+
* @property {string} [id] - Unique system generated id
|
|
1406
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1407
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1408
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1409
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1410
|
+
* Object definition
|
|
1411
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1306
1412
|
*/
|
|
1307
1413
|
|
|
1308
1414
|
/**
|
|
@@ -1313,21 +1419,33 @@ const Joi = require("joi");
|
|
|
1313
1419
|
|
|
1314
1420
|
/**
|
|
1315
1421
|
* @typedef CustomObjectEntryFieldSchema
|
|
1316
|
-
* @property {string} [
|
|
1317
|
-
* @property {
|
|
1422
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1423
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1424
|
+
*/
|
|
1425
|
+
|
|
1426
|
+
/**
|
|
1427
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1428
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1429
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1318
1430
|
*/
|
|
1319
1431
|
|
|
1320
1432
|
/**
|
|
1321
1433
|
* @typedef CustomObjectRequestSchema
|
|
1322
|
-
* @property {string} [status]
|
|
1323
|
-
* @property {string} [
|
|
1324
|
-
* @property {CustomObjectEntryFieldSchema[]} [fields]
|
|
1434
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1435
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1436
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1437
|
+
*/
|
|
1438
|
+
|
|
1439
|
+
/**
|
|
1440
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1441
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1442
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1325
1443
|
*/
|
|
1326
1444
|
|
|
1327
1445
|
/**
|
|
1328
1446
|
* @typedef CustomObjectBulkSchema
|
|
1329
|
-
* @property {string} [url]
|
|
1330
|
-
* @property {number} [total_records]
|
|
1447
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1448
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1331
1449
|
*/
|
|
1332
1450
|
|
|
1333
1451
|
/**
|
|
@@ -1392,6 +1510,14 @@ const Joi = require("joi");
|
|
|
1392
1510
|
*/
|
|
1393
1511
|
|
|
1394
1512
|
class ContentPlatformModel {
|
|
1513
|
+
/** @returns {ValidationError} */
|
|
1514
|
+
static ValidationError() {
|
|
1515
|
+
return Joi.object({
|
|
1516
|
+
message: Joi.string().allow("").required(),
|
|
1517
|
+
field: Joi.string().allow("").required(),
|
|
1518
|
+
});
|
|
1519
|
+
}
|
|
1520
|
+
|
|
1395
1521
|
/** @returns {GenerateSEOContent} */
|
|
1396
1522
|
static GenerateSEOContent() {
|
|
1397
1523
|
return Joi.object({
|
|
@@ -1467,8 +1593,6 @@ class ContentPlatformModel {
|
|
|
1467
1593
|
app: Joi.string().allow(""),
|
|
1468
1594
|
_id: Joi.string().allow(""),
|
|
1469
1595
|
robots_txt: Joi.string().allow(""),
|
|
1470
|
-
sitemap_enabled: Joi.boolean(),
|
|
1471
|
-
additional_sitemap: Joi.string().allow(""),
|
|
1472
1596
|
cannonical_enabled: Joi.boolean(),
|
|
1473
1597
|
custom_meta_tags: Joi.array().items(ContentPlatformModel.CustomMetaTag()),
|
|
1474
1598
|
details: ContentPlatformModel.Detail(),
|
|
@@ -1613,8 +1737,8 @@ class ContentPlatformModel {
|
|
|
1613
1737
|
});
|
|
1614
1738
|
}
|
|
1615
1739
|
|
|
1616
|
-
/** @returns {
|
|
1617
|
-
static
|
|
1740
|
+
/** @returns {BlogGetDetails} */
|
|
1741
|
+
static BlogGetDetails() {
|
|
1618
1742
|
return Joi.object({
|
|
1619
1743
|
items: Joi.array().items(ContentPlatformModel.BlogSchema()),
|
|
1620
1744
|
page: ContentPlatformModel.Page(),
|
|
@@ -1659,7 +1783,7 @@ class ContentPlatformModel {
|
|
|
1659
1783
|
static BlogSchema() {
|
|
1660
1784
|
return Joi.object({
|
|
1661
1785
|
_id: Joi.string().allow(""),
|
|
1662
|
-
_custom_json: Joi.any(),
|
|
1786
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1663
1787
|
application: Joi.string().allow(""),
|
|
1664
1788
|
archived: Joi.boolean(),
|
|
1665
1789
|
author: ContentPlatformModel.Author(),
|
|
@@ -1737,11 +1861,71 @@ class ContentPlatformModel {
|
|
|
1737
1861
|
});
|
|
1738
1862
|
}
|
|
1739
1863
|
|
|
1740
|
-
/** @returns {
|
|
1741
|
-
static
|
|
1864
|
+
/** @returns {DefaultSitemapIndividualConfig} */
|
|
1865
|
+
static DefaultSitemapIndividualConfig() {
|
|
1866
|
+
return Joi.object({
|
|
1867
|
+
enabled: Joi.boolean(),
|
|
1868
|
+
});
|
|
1869
|
+
}
|
|
1870
|
+
|
|
1871
|
+
/** @returns {DefaultSitemapConfig} */
|
|
1872
|
+
static DefaultSitemapConfig() {
|
|
1873
|
+
return Joi.object({
|
|
1874
|
+
root: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1875
|
+
brand: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1876
|
+
collections: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1877
|
+
category_l1: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1878
|
+
category_l2: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1879
|
+
category_l3: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1880
|
+
pages: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1881
|
+
blog: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1882
|
+
section: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1883
|
+
faq: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1884
|
+
sitemap: ContentPlatformModel.DefaultSitemapIndividualConfig(),
|
|
1885
|
+
});
|
|
1886
|
+
}
|
|
1887
|
+
|
|
1888
|
+
/** @returns {SitemapConfigCreate} */
|
|
1889
|
+
static SitemapConfigCreate() {
|
|
1890
|
+
return Joi.object({
|
|
1891
|
+
name: Joi.string().allow(""),
|
|
1892
|
+
is_active: Joi.boolean(),
|
|
1893
|
+
sitemap: Joi.string().allow(""),
|
|
1894
|
+
});
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
/** @returns {SitemapConfig} */
|
|
1898
|
+
static SitemapConfig() {
|
|
1899
|
+
return Joi.object({
|
|
1900
|
+
name: Joi.string().allow(""),
|
|
1901
|
+
is_active: Joi.boolean(),
|
|
1902
|
+
sitemap: Joi.string().allow(""),
|
|
1903
|
+
created_at: Joi.string().allow(""),
|
|
1904
|
+
updated_at: Joi.string().allow(""),
|
|
1905
|
+
});
|
|
1906
|
+
}
|
|
1907
|
+
|
|
1908
|
+
/** @returns {SitemapConfigurationList} */
|
|
1909
|
+
static SitemapConfigurationList() {
|
|
1910
|
+
return Joi.object({
|
|
1911
|
+
items: Joi.array().items(ContentPlatformModel.SitemapConfig()),
|
|
1912
|
+
page: ContentPlatformModel.Page(),
|
|
1913
|
+
});
|
|
1914
|
+
}
|
|
1915
|
+
|
|
1916
|
+
/** @returns {SitemapConfigUpdate} */
|
|
1917
|
+
static SitemapConfigUpdate() {
|
|
1918
|
+
return Joi.object({
|
|
1919
|
+
is_active: Joi.boolean(),
|
|
1920
|
+
sitemap: Joi.string().allow(""),
|
|
1921
|
+
});
|
|
1922
|
+
}
|
|
1923
|
+
|
|
1924
|
+
/** @returns {BlogPayload} */
|
|
1925
|
+
static BlogPayload() {
|
|
1742
1926
|
return Joi.object({
|
|
1743
1927
|
application: Joi.string().allow(""),
|
|
1744
|
-
_custom_json: Joi.any(),
|
|
1928
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1745
1929
|
author: ContentPlatformModel.Author(),
|
|
1746
1930
|
content: Joi.array().items(ContentPlatformModel.ResourceContent()),
|
|
1747
1931
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -1879,7 +2063,7 @@ class ContentPlatformModel {
|
|
|
1879
2063
|
static HandpickedTagSchema() {
|
|
1880
2064
|
return Joi.object({
|
|
1881
2065
|
position: Joi.string().allow(""),
|
|
1882
|
-
attributes: Joi.any(),
|
|
2066
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
1883
2067
|
name: Joi.string().allow(""),
|
|
1884
2068
|
url: Joi.string().allow(""),
|
|
1885
2069
|
type: Joi.string().allow(""),
|
|
@@ -1904,7 +2088,7 @@ class ContentPlatformModel {
|
|
|
1904
2088
|
type: Joi.string().allow(""),
|
|
1905
2089
|
url: Joi.string().allow(""),
|
|
1906
2090
|
position: Joi.string().allow(""),
|
|
1907
|
-
attributes: Joi.any(),
|
|
2091
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
1908
2092
|
pages: Joi.array().items(Joi.any()),
|
|
1909
2093
|
content: Joi.string().allow(""),
|
|
1910
2094
|
});
|
|
@@ -1946,8 +2130,8 @@ class ContentPlatformModel {
|
|
|
1946
2130
|
});
|
|
1947
2131
|
}
|
|
1948
2132
|
|
|
1949
|
-
/** @returns {
|
|
1950
|
-
static
|
|
2133
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
2134
|
+
static TagDeleteSuccessDetails() {
|
|
1951
2135
|
return Joi.object({
|
|
1952
2136
|
success: Joi.boolean(),
|
|
1953
2137
|
});
|
|
@@ -1963,7 +2147,7 @@ class ContentPlatformModel {
|
|
|
1963
2147
|
info: Joi.string().allow(""),
|
|
1964
2148
|
request_id: Joi.string().allow(""),
|
|
1965
2149
|
stack_trace: Joi.string().allow(""),
|
|
1966
|
-
meta: Joi.any(),
|
|
2150
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1967
2151
|
});
|
|
1968
2152
|
}
|
|
1969
2153
|
|
|
@@ -1985,7 +2169,7 @@ class ContentPlatformModel {
|
|
|
1985
2169
|
slug: Joi.string().allow(""),
|
|
1986
2170
|
application: Joi.string().allow(""),
|
|
1987
2171
|
icon_url: Joi.string().allow(""),
|
|
1988
|
-
_custom_json: Joi.any(),
|
|
2172
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1989
2173
|
});
|
|
1990
2174
|
}
|
|
1991
2175
|
|
|
@@ -2019,7 +2203,7 @@ class ContentPlatformModel {
|
|
|
2019
2203
|
slug: Joi.string().allow(""),
|
|
2020
2204
|
application: Joi.string().allow(""),
|
|
2021
2205
|
icon_url: Joi.string().allow(""),
|
|
2022
|
-
_custom_json: Joi.any(),
|
|
2206
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2023
2207
|
});
|
|
2024
2208
|
}
|
|
2025
2209
|
|
|
@@ -2113,8 +2297,8 @@ class ContentPlatformModel {
|
|
|
2113
2297
|
});
|
|
2114
2298
|
}
|
|
2115
2299
|
|
|
2116
|
-
/** @returns {
|
|
2117
|
-
static
|
|
2300
|
+
/** @returns {LandingPageGetDetails} */
|
|
2301
|
+
static LandingPageGetDetails() {
|
|
2118
2302
|
return Joi.object({
|
|
2119
2303
|
items: Joi.array().items(ContentPlatformModel.LandingPageSchema()),
|
|
2120
2304
|
page: ContentPlatformModel.Page(),
|
|
@@ -2132,19 +2316,19 @@ class ContentPlatformModel {
|
|
|
2132
2316
|
_id: Joi.string().allow(""),
|
|
2133
2317
|
application: Joi.string().allow(""),
|
|
2134
2318
|
archived: Joi.boolean(),
|
|
2135
|
-
_custom_json: Joi.any(),
|
|
2319
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2136
2320
|
});
|
|
2137
2321
|
}
|
|
2138
2322
|
|
|
2139
|
-
/** @returns {
|
|
2140
|
-
static
|
|
2323
|
+
/** @returns {DefaultNavigationDetails} */
|
|
2324
|
+
static DefaultNavigationDetails() {
|
|
2141
2325
|
return Joi.object({
|
|
2142
2326
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2143
2327
|
});
|
|
2144
2328
|
}
|
|
2145
2329
|
|
|
2146
|
-
/** @returns {
|
|
2147
|
-
static
|
|
2330
|
+
/** @returns {NavigationGetDetails} */
|
|
2331
|
+
static NavigationGetDetails() {
|
|
2148
2332
|
return Joi.object({
|
|
2149
2333
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2150
2334
|
page: ContentPlatformModel.Page(),
|
|
@@ -2176,8 +2360,8 @@ class ContentPlatformModel {
|
|
|
2176
2360
|
});
|
|
2177
2361
|
}
|
|
2178
2362
|
|
|
2179
|
-
/** @returns {
|
|
2180
|
-
static
|
|
2363
|
+
/** @returns {NavigationPayload} */
|
|
2364
|
+
static NavigationPayload() {
|
|
2181
2365
|
return Joi.object({
|
|
2182
2366
|
name: Joi.string().allow(""),
|
|
2183
2367
|
slug: Joi.string().allow(""),
|
|
@@ -2187,8 +2371,8 @@ class ContentPlatformModel {
|
|
|
2187
2371
|
});
|
|
2188
2372
|
}
|
|
2189
2373
|
|
|
2190
|
-
/** @returns {
|
|
2191
|
-
static
|
|
2374
|
+
/** @returns {PageGetDetails} */
|
|
2375
|
+
static PageGetDetails() {
|
|
2192
2376
|
return Joi.object({
|
|
2193
2377
|
items: Joi.array().items(ContentPlatformModel.PageSchema()),
|
|
2194
2378
|
page: ContentPlatformModel.Page(),
|
|
@@ -2234,7 +2418,7 @@ class ContentPlatformModel {
|
|
|
2234
2418
|
feature_image: ContentPlatformModel.Asset(),
|
|
2235
2419
|
page_meta: Joi.array().items(Joi.any()),
|
|
2236
2420
|
_schedule: ContentPlatformModel.ScheduleSchema(),
|
|
2237
|
-
_custom_json: Joi.any(),
|
|
2421
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2238
2422
|
orientation: Joi.string().allow(""),
|
|
2239
2423
|
platform: Joi.string().allow(""),
|
|
2240
2424
|
published: Joi.boolean(),
|
|
@@ -2243,7 +2427,7 @@ class ContentPlatformModel {
|
|
|
2243
2427
|
title: Joi.string().allow(""),
|
|
2244
2428
|
type: Joi.string().allow(""),
|
|
2245
2429
|
seo: ContentPlatformModel.SEO(),
|
|
2246
|
-
visibility: Joi.any(),
|
|
2430
|
+
visibility: Joi.object().pattern(/\S/, Joi.any()),
|
|
2247
2431
|
archived: Joi.boolean(),
|
|
2248
2432
|
});
|
|
2249
2433
|
}
|
|
@@ -2255,13 +2439,13 @@ class ContentPlatformModel {
|
|
|
2255
2439
|
});
|
|
2256
2440
|
}
|
|
2257
2441
|
|
|
2258
|
-
/** @returns {
|
|
2259
|
-
static
|
|
2442
|
+
/** @returns {PagePayload} */
|
|
2443
|
+
static PagePayload() {
|
|
2260
2444
|
return Joi.object({
|
|
2261
2445
|
_schedule: ContentPlatformModel.CronSchedule(),
|
|
2262
2446
|
application: Joi.string().allow(""),
|
|
2263
2447
|
author: ContentPlatformModel.Author(),
|
|
2264
|
-
_custom_json: Joi.any(),
|
|
2448
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2265
2449
|
orientation: Joi.string().allow(""),
|
|
2266
2450
|
content: Joi.array().items(Joi.any()),
|
|
2267
2451
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -2284,8 +2468,8 @@ class ContentPlatformModel {
|
|
|
2284
2468
|
});
|
|
2285
2469
|
}
|
|
2286
2470
|
|
|
2287
|
-
/** @returns {
|
|
2288
|
-
static
|
|
2471
|
+
/** @returns {PagePublishPayload} */
|
|
2472
|
+
static PagePublishPayload() {
|
|
2289
2473
|
return Joi.object({
|
|
2290
2474
|
publish: Joi.boolean(),
|
|
2291
2475
|
});
|
|
@@ -2300,8 +2484,8 @@ class ContentPlatformModel {
|
|
|
2300
2484
|
});
|
|
2301
2485
|
}
|
|
2302
2486
|
|
|
2303
|
-
/** @returns {
|
|
2304
|
-
static
|
|
2487
|
+
/** @returns {SlideshowGetDetails} */
|
|
2488
|
+
static SlideshowGetDetails() {
|
|
2305
2489
|
return Joi.object({
|
|
2306
2490
|
items: Joi.array().items(ContentPlatformModel.SlideshowSchema()),
|
|
2307
2491
|
page: ContentPlatformModel.Page(),
|
|
@@ -2320,12 +2504,12 @@ class ContentPlatformModel {
|
|
|
2320
2504
|
media: Joi.array().items(ContentPlatformModel.SlideshowMedia()),
|
|
2321
2505
|
active: Joi.boolean(),
|
|
2322
2506
|
archived: Joi.boolean(),
|
|
2323
|
-
_custom_json: Joi.any(),
|
|
2507
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2324
2508
|
});
|
|
2325
2509
|
}
|
|
2326
2510
|
|
|
2327
|
-
/** @returns {
|
|
2328
|
-
static
|
|
2511
|
+
/** @returns {SlideshowPayload} */
|
|
2512
|
+
static SlideshowPayload() {
|
|
2329
2513
|
return Joi.object({
|
|
2330
2514
|
slug: Joi.string().allow(""),
|
|
2331
2515
|
platform: Joi.string().allow(""),
|
|
@@ -2407,7 +2591,7 @@ class ContentPlatformModel {
|
|
|
2407
2591
|
sub_type: Joi.string().allow(""),
|
|
2408
2592
|
_id: Joi.string().allow(""),
|
|
2409
2593
|
position: Joi.string().allow(""),
|
|
2410
|
-
attributes: Joi.any(),
|
|
2594
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2411
2595
|
content: Joi.string().allow(""),
|
|
2412
2596
|
pages: Joi.array().items(Joi.any()),
|
|
2413
2597
|
__source: ContentPlatformModel.TagSourceSchema(),
|
|
@@ -2450,23 +2634,18 @@ class ContentPlatformModel {
|
|
|
2450
2634
|
/** @returns {FieldDefinitionSchema} */
|
|
2451
2635
|
static FieldDefinitionSchema() {
|
|
2452
2636
|
return Joi.object({
|
|
2453
|
-
|
|
2454
|
-
creator: Joi.string().allow(""),
|
|
2637
|
+
id: Joi.string().allow(""),
|
|
2455
2638
|
resource: Joi.string().allow(""),
|
|
2456
2639
|
name: Joi.string().allow(""),
|
|
2457
2640
|
namespace: Joi.string().allow(""),
|
|
2458
|
-
|
|
2641
|
+
slug: Joi.string().allow(""),
|
|
2459
2642
|
description: Joi.string().allow(""),
|
|
2460
2643
|
type: Joi.string().allow(""),
|
|
2461
2644
|
multi_value: Joi.boolean(),
|
|
2462
2645
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2463
2646
|
company_id: Joi.string().allow(""),
|
|
2464
|
-
created_by: Joi.string().allow(""),
|
|
2465
|
-
updated_by: Joi.string().allow(""),
|
|
2466
2647
|
required: Joi.boolean(),
|
|
2467
2648
|
is_deleted: Joi.boolean(),
|
|
2468
|
-
created_at: Joi.string().allow(""),
|
|
2469
|
-
updated_at: Joi.string().allow(""),
|
|
2470
2649
|
type_name: Joi.string().allow(""),
|
|
2471
2650
|
invalid_fields_count: Joi.number(),
|
|
2472
2651
|
});
|
|
@@ -2483,9 +2662,8 @@ class ContentPlatformModel {
|
|
|
2483
2662
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2484
2663
|
static CustomFieldDefinitionRequestSchema() {
|
|
2485
2664
|
return Joi.object({
|
|
2486
|
-
resource: Joi.string().allow(""),
|
|
2487
2665
|
type: Joi.string().allow(""),
|
|
2488
|
-
|
|
2666
|
+
slug: Joi.string().allow(""),
|
|
2489
2667
|
namespace: Joi.string().allow(""),
|
|
2490
2668
|
multi_value: Joi.boolean(),
|
|
2491
2669
|
name: Joi.string().allow(""),
|
|
@@ -2503,7 +2681,7 @@ class ContentPlatformModel {
|
|
|
2503
2681
|
name: Joi.string().allow(""),
|
|
2504
2682
|
multi_value: Joi.boolean(),
|
|
2505
2683
|
required: Joi.boolean(),
|
|
2506
|
-
|
|
2684
|
+
slug: Joi.string().allow(""),
|
|
2507
2685
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2508
2686
|
action: Joi.string().allow(""),
|
|
2509
2687
|
});
|
|
@@ -2512,7 +2690,6 @@ class ContentPlatformModel {
|
|
|
2512
2690
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2513
2691
|
static CustomObjectDefinitionUpdateRequestSchema() {
|
|
2514
2692
|
return Joi.object({
|
|
2515
|
-
type: Joi.string().allow(""),
|
|
2516
2693
|
description: Joi.string().allow(""),
|
|
2517
2694
|
name: Joi.string().allow(""),
|
|
2518
2695
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2525,21 +2702,39 @@ class ContentPlatformModel {
|
|
|
2525
2702
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2526
2703
|
static CustomFieldDefinitionDetailResSchema() {
|
|
2527
2704
|
return Joi.object({
|
|
2528
|
-
creator: Joi.string().allow(""),
|
|
2529
2705
|
resource: Joi.string().allow(""),
|
|
2530
2706
|
name: Joi.string().allow(""),
|
|
2531
2707
|
namespace: Joi.string().allow(""),
|
|
2532
|
-
|
|
2708
|
+
slug: Joi.string().allow(""),
|
|
2533
2709
|
description: Joi.string().allow(""),
|
|
2534
2710
|
type: Joi.string().allow(""),
|
|
2535
2711
|
multi_value: Joi.boolean(),
|
|
2536
2712
|
company_id: Joi.string().allow(""),
|
|
2537
2713
|
application_id: Joi.string().allow(""),
|
|
2538
|
-
created_by: Joi.string().allow(""),
|
|
2539
|
-
updated_by: Joi.string().allow(""),
|
|
2540
2714
|
required: Joi.boolean(),
|
|
2541
2715
|
is_deleted: Joi.boolean(),
|
|
2542
|
-
|
|
2716
|
+
id: Joi.string().allow(""),
|
|
2717
|
+
validations: Joi.array().items(Joi.any()),
|
|
2718
|
+
created_at: Joi.string().allow(""),
|
|
2719
|
+
updated_at: Joi.string().allow(""),
|
|
2720
|
+
});
|
|
2721
|
+
}
|
|
2722
|
+
|
|
2723
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
2724
|
+
static MetaFieldDefinitionDetailResSchema() {
|
|
2725
|
+
return Joi.object({
|
|
2726
|
+
resource: Joi.string().allow(""),
|
|
2727
|
+
name: Joi.string().allow(""),
|
|
2728
|
+
namespace: Joi.string().allow(""),
|
|
2729
|
+
slug: Joi.string().allow(""),
|
|
2730
|
+
description: Joi.string().allow(""),
|
|
2731
|
+
type: Joi.string().allow(""),
|
|
2732
|
+
multi_value: Joi.boolean(),
|
|
2733
|
+
company_id: Joi.string().allow(""),
|
|
2734
|
+
application_id: Joi.string().allow(""),
|
|
2735
|
+
required: Joi.boolean(),
|
|
2736
|
+
is_deleted: Joi.boolean(),
|
|
2737
|
+
id: Joi.string().allow(""),
|
|
2543
2738
|
validations: Joi.array().items(Joi.any()),
|
|
2544
2739
|
created_at: Joi.string().allow(""),
|
|
2545
2740
|
updated_at: Joi.string().allow(""),
|
|
@@ -2564,20 +2759,17 @@ class ContentPlatformModel {
|
|
|
2564
2759
|
/** @returns {CustomFieldSchema} */
|
|
2565
2760
|
static CustomFieldSchema() {
|
|
2566
2761
|
return Joi.object({
|
|
2567
|
-
|
|
2762
|
+
id: Joi.string().allow(""),
|
|
2568
2763
|
namespace: Joi.string().allow(""),
|
|
2569
|
-
|
|
2764
|
+
slug: Joi.string().allow(""),
|
|
2570
2765
|
resource: Joi.string().allow(""),
|
|
2571
|
-
creator: Joi.string().allow(""),
|
|
2572
2766
|
value: Joi.array().items(ContentPlatformModel.CustomFieldValue()),
|
|
2573
|
-
|
|
2767
|
+
resource_slug: Joi.string().allow(""),
|
|
2574
2768
|
type: Joi.string().allow(""),
|
|
2575
2769
|
multi_value: Joi.boolean(),
|
|
2576
2770
|
company_id: Joi.string().allow(""),
|
|
2577
|
-
definition_id: Joi.string().allow(""),
|
|
2578
2771
|
has_invalid_values: Joi.boolean(),
|
|
2579
2772
|
invalid_value_errors: Joi.array().items(Joi.any()),
|
|
2580
|
-
created_by: Joi.string().allow(""),
|
|
2581
2773
|
is_deleted: Joi.boolean(),
|
|
2582
2774
|
created_at: Joi.string().allow(""),
|
|
2583
2775
|
updated_at: Joi.string().allow(""),
|
|
@@ -2592,6 +2784,14 @@ class ContentPlatformModel {
|
|
|
2592
2784
|
});
|
|
2593
2785
|
}
|
|
2594
2786
|
|
|
2787
|
+
/** @returns {CustomFieldsDeleteSchema} */
|
|
2788
|
+
static CustomFieldsDeleteSchema() {
|
|
2789
|
+
return Joi.object({
|
|
2790
|
+
success: Joi.boolean(),
|
|
2791
|
+
message: Joi.string().allow(""),
|
|
2792
|
+
});
|
|
2793
|
+
}
|
|
2794
|
+
|
|
2595
2795
|
/** @returns {CustomFieldsResponseByResourceIdSchema} */
|
|
2596
2796
|
static CustomFieldsResponseByResourceIdSchema() {
|
|
2597
2797
|
return Joi.object({
|
|
@@ -2603,7 +2803,8 @@ class ContentPlatformModel {
|
|
|
2603
2803
|
static CustomField() {
|
|
2604
2804
|
return Joi.object({
|
|
2605
2805
|
value: Joi.array().items(Joi.any()),
|
|
2606
|
-
|
|
2806
|
+
namespace: Joi.string().allow(""),
|
|
2807
|
+
slug: Joi.string().allow(""),
|
|
2607
2808
|
});
|
|
2608
2809
|
}
|
|
2609
2810
|
|
|
@@ -2617,16 +2818,13 @@ class ContentPlatformModel {
|
|
|
2617
2818
|
/** @returns {CustomObjectSchema} */
|
|
2618
2819
|
static CustomObjectSchema() {
|
|
2619
2820
|
return Joi.object({
|
|
2620
|
-
|
|
2621
|
-
creator: Joi.string().allow(""),
|
|
2821
|
+
id: Joi.string().allow(""),
|
|
2622
2822
|
company_id: Joi.string().allow(""),
|
|
2623
2823
|
application_id: Joi.string().allow(""),
|
|
2624
|
-
created_by: Joi.string().allow(""),
|
|
2625
|
-
updated_by: Joi.string().allow(""),
|
|
2626
2824
|
status: Joi.string().allow(""),
|
|
2627
2825
|
type: Joi.string().allow(""),
|
|
2826
|
+
definition_slug: Joi.string().allow(""),
|
|
2628
2827
|
display_name: Joi.string().allow(""),
|
|
2629
|
-
definition_id: Joi.string().allow(""),
|
|
2630
2828
|
fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
|
|
2631
2829
|
});
|
|
2632
2830
|
}
|
|
@@ -2635,6 +2833,7 @@ class ContentPlatformModel {
|
|
|
2635
2833
|
static CustomObjectDefinitionRequestSchema() {
|
|
2636
2834
|
return Joi.object({
|
|
2637
2835
|
type: Joi.string().allow(""),
|
|
2836
|
+
definition_slug: Joi.string().allow(""),
|
|
2638
2837
|
description: Joi.string().allow(""),
|
|
2639
2838
|
name: Joi.string().allow(""),
|
|
2640
2839
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2644,42 +2843,17 @@ class ContentPlatformModel {
|
|
|
2644
2843
|
});
|
|
2645
2844
|
}
|
|
2646
2845
|
|
|
2647
|
-
/** @returns {
|
|
2648
|
-
static
|
|
2846
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
2847
|
+
static CustomObjectDefinitionSlugSchema() {
|
|
2649
2848
|
return Joi.object({
|
|
2650
|
-
|
|
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() {
|
|
2672
|
-
return Joi.object({
|
|
2673
|
-
_id: Joi.string().allow(""),
|
|
2849
|
+
id: Joi.string().allow(""),
|
|
2674
2850
|
name: Joi.string().allow(""),
|
|
2675
2851
|
type: Joi.string().allow(""),
|
|
2852
|
+
definition_slug: Joi.string().allow(""),
|
|
2676
2853
|
display_name_key: Joi.string().allow(""),
|
|
2677
2854
|
description: Joi.string().allow(""),
|
|
2678
|
-
creator: Joi.string().allow(""),
|
|
2679
|
-
created_by: Joi.string().allow(""),
|
|
2680
|
-
updated_by: Joi.string().allow(""),
|
|
2681
2855
|
field_definitions: Joi.array().items(
|
|
2682
|
-
ContentPlatformModel.
|
|
2856
|
+
ContentPlatformModel.CustomFieldDefinitionDetailResSchema()
|
|
2683
2857
|
),
|
|
2684
2858
|
});
|
|
2685
2859
|
}
|
|
@@ -2692,18 +2866,18 @@ class ContentPlatformModel {
|
|
|
2692
2866
|
});
|
|
2693
2867
|
}
|
|
2694
2868
|
|
|
2695
|
-
/** @returns {
|
|
2696
|
-
static
|
|
2869
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
2870
|
+
static CustomObjectEntryBulkUploadDetails() {
|
|
2697
2871
|
return Joi.object({
|
|
2698
2872
|
url: Joi.string().allow(""),
|
|
2699
2873
|
total_records: Joi.number(),
|
|
2700
2874
|
});
|
|
2701
2875
|
}
|
|
2702
2876
|
|
|
2703
|
-
/** @returns {
|
|
2704
|
-
static
|
|
2877
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
2878
|
+
static CustomObjectListItemDefinitionModel() {
|
|
2705
2879
|
return Joi.object({
|
|
2706
|
-
|
|
2880
|
+
id: Joi.string().allow(""),
|
|
2707
2881
|
name: Joi.string().allow(""),
|
|
2708
2882
|
type: Joi.string().allow(""),
|
|
2709
2883
|
});
|
|
@@ -2712,12 +2886,12 @@ class ContentPlatformModel {
|
|
|
2712
2886
|
/** @returns {CustomObjectListItemSchema} */
|
|
2713
2887
|
static CustomObjectListItemSchema() {
|
|
2714
2888
|
return Joi.object({
|
|
2715
|
-
|
|
2716
|
-
definition_id: Joi.string().allow(""),
|
|
2889
|
+
id: Joi.string().allow(""),
|
|
2717
2890
|
status: Joi.string().allow(""),
|
|
2891
|
+
created_at: Joi.string().allow(""),
|
|
2718
2892
|
updated_at: Joi.string().allow(""),
|
|
2719
2893
|
display_name: Joi.string().allow(""),
|
|
2720
|
-
definition: ContentPlatformModel.
|
|
2894
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
2721
2895
|
references: Joi.number(),
|
|
2722
2896
|
});
|
|
2723
2897
|
}
|
|
@@ -2732,26 +2906,30 @@ class ContentPlatformModel {
|
|
|
2732
2906
|
});
|
|
2733
2907
|
}
|
|
2734
2908
|
|
|
2735
|
-
/** @returns {
|
|
2736
|
-
static
|
|
2909
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
2910
|
+
static CustomObjectFieldDefinition() {
|
|
2737
2911
|
return Joi.object({
|
|
2738
|
-
|
|
2739
|
-
|
|
2912
|
+
id: Joi.string().allow(""),
|
|
2913
|
+
slug: Joi.string().allow(""),
|
|
2914
|
+
namespace: Joi.string().allow(""),
|
|
2740
2915
|
value: Joi.array().items(Joi.any()),
|
|
2741
2916
|
type: Joi.string().allow(""),
|
|
2742
|
-
definition_id: Joi.string().allow(""),
|
|
2743
2917
|
});
|
|
2744
2918
|
}
|
|
2745
2919
|
|
|
2746
|
-
/** @returns {
|
|
2747
|
-
static
|
|
2920
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
2921
|
+
static CustomObjectBySlugSchema() {
|
|
2748
2922
|
return Joi.object({
|
|
2749
|
-
|
|
2923
|
+
id: Joi.string().allow(""),
|
|
2750
2924
|
status: Joi.string().allow(""),
|
|
2751
2925
|
display_name: Joi.string().allow(""),
|
|
2752
|
-
definition: ContentPlatformModel.
|
|
2926
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
2753
2927
|
references: Joi.array().items(Joi.any()),
|
|
2754
|
-
|
|
2928
|
+
slug: Joi.string().allow(""),
|
|
2929
|
+
definition_slug: Joi.string().allow(""),
|
|
2930
|
+
fields: Joi.array().items(
|
|
2931
|
+
ContentPlatformModel.CustomObjectFieldDefinition()
|
|
2932
|
+
),
|
|
2755
2933
|
});
|
|
2756
2934
|
}
|
|
2757
2935
|
|
|
@@ -2773,17 +2951,15 @@ class ContentPlatformModel {
|
|
|
2773
2951
|
});
|
|
2774
2952
|
}
|
|
2775
2953
|
|
|
2776
|
-
/** @returns {
|
|
2777
|
-
static
|
|
2954
|
+
/** @returns {JobSchema} */
|
|
2955
|
+
static JobSchema() {
|
|
2778
2956
|
return Joi.object({
|
|
2779
|
-
|
|
2957
|
+
id: Joi.string().allow(""),
|
|
2780
2958
|
jobs: Joi.array().items(Joi.string().allow("")),
|
|
2781
2959
|
finished_jobs: Joi.array().items(Joi.string().allow("")),
|
|
2782
2960
|
error_jobs: Joi.array().items(Joi.string().allow("")),
|
|
2783
2961
|
errors_occured: Joi.array().items(Joi.string().allow("")),
|
|
2784
2962
|
company_id: Joi.string().allow(""),
|
|
2785
|
-
creator: Joi.string().allow(""),
|
|
2786
|
-
url: Joi.string().allow(""),
|
|
2787
2963
|
status: Joi.string().allow(""),
|
|
2788
2964
|
action_type: Joi.string().allow(""),
|
|
2789
2965
|
entity: Joi.string().allow(""),
|
|
@@ -2796,17 +2972,33 @@ class ContentPlatformModel {
|
|
|
2796
2972
|
created_by: Joi.string().allow(""),
|
|
2797
2973
|
created_at: Joi.string().allow(""),
|
|
2798
2974
|
updated_at: Joi.string().allow(""),
|
|
2975
|
+
application_id: Joi.string().allow(""),
|
|
2976
|
+
});
|
|
2977
|
+
}
|
|
2978
|
+
|
|
2979
|
+
/** @returns {CustomFieldBulkEntry} */
|
|
2980
|
+
static CustomFieldBulkEntry() {
|
|
2981
|
+
return Joi.object({
|
|
2982
|
+
items: Joi.array().items(ContentPlatformModel.JobSchema()),
|
|
2983
|
+
page: ContentPlatformModel.Page(),
|
|
2799
2984
|
});
|
|
2800
2985
|
}
|
|
2801
2986
|
|
|
2802
2987
|
/** @returns {CustomObjectBulkEntry} */
|
|
2803
2988
|
static CustomObjectBulkEntry() {
|
|
2804
2989
|
return Joi.object({
|
|
2805
|
-
items: Joi.array().items(ContentPlatformModel.
|
|
2990
|
+
items: Joi.array().items(ContentPlatformModel.JobSchema()),
|
|
2806
2991
|
page: ContentPlatformModel.Page(),
|
|
2807
2992
|
});
|
|
2808
2993
|
}
|
|
2809
2994
|
|
|
2995
|
+
/** @returns {MetafieldTypesSchema} */
|
|
2996
|
+
static MetafieldTypesSchema() {
|
|
2997
|
+
return Joi.object({
|
|
2998
|
+
metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
|
|
2999
|
+
});
|
|
3000
|
+
}
|
|
3001
|
+
|
|
2810
3002
|
/** @returns {CustomFieldTypeSchema} */
|
|
2811
3003
|
static CustomFieldTypeSchema() {
|
|
2812
3004
|
return Joi.object({
|
|
@@ -2823,6 +3015,8 @@ class ContentPlatformModel {
|
|
|
2823
3015
|
url: ContentPlatformModel.Url(),
|
|
2824
3016
|
metaobject: ContentPlatformModel.Metaobject(),
|
|
2825
3017
|
product: ContentPlatformModel.Product(),
|
|
3018
|
+
html: ContentPlatformModel.HTML(),
|
|
3019
|
+
duration: ContentPlatformModel.Duration(),
|
|
2826
3020
|
});
|
|
2827
3021
|
}
|
|
2828
3022
|
|
|
@@ -2854,6 +3048,31 @@ class ContentPlatformModel {
|
|
|
2854
3048
|
});
|
|
2855
3049
|
}
|
|
2856
3050
|
|
|
3051
|
+
/** @returns {Duration} */
|
|
3052
|
+
static Duration() {
|
|
3053
|
+
return Joi.object({
|
|
3054
|
+
name: Joi.string().allow(""),
|
|
3055
|
+
list_enabled: Joi.boolean(),
|
|
3056
|
+
type: Joi.string().allow(""),
|
|
3057
|
+
category: Joi.string().allow(""),
|
|
3058
|
+
supported_validations: Joi.array().items(
|
|
3059
|
+
ContentPlatformModel.SupportedValidationsSchema()
|
|
3060
|
+
),
|
|
3061
|
+
});
|
|
3062
|
+
}
|
|
3063
|
+
|
|
3064
|
+
/** @returns {HTML} */
|
|
3065
|
+
static HTML() {
|
|
3066
|
+
return Joi.object({
|
|
3067
|
+
name: Joi.string().allow(""),
|
|
3068
|
+
list_enabled: Joi.boolean(),
|
|
3069
|
+
type: Joi.string().allow(""),
|
|
3070
|
+
supported_validations: Joi.array().items(
|
|
3071
|
+
ContentPlatformModel.SupportedValidationsSchema()
|
|
3072
|
+
),
|
|
3073
|
+
});
|
|
3074
|
+
}
|
|
3075
|
+
|
|
2857
3076
|
/** @returns {StringSingleLine} */
|
|
2858
3077
|
static StringSingleLine() {
|
|
2859
3078
|
return Joi.object({
|
|
@@ -3025,7 +3244,7 @@ class ContentPlatformModel {
|
|
|
3025
3244
|
/** @returns {CustomObjectEntry} */
|
|
3026
3245
|
static CustomObjectEntry() {
|
|
3027
3246
|
return Joi.object({
|
|
3028
|
-
|
|
3247
|
+
id: Joi.string().allow(""),
|
|
3029
3248
|
name: Joi.string().allow(""),
|
|
3030
3249
|
type: Joi.string().allow(""),
|
|
3031
3250
|
updated_at: Joi.string().allow(""),
|
|
@@ -3045,8 +3264,16 @@ class ContentPlatformModel {
|
|
|
3045
3264
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
3046
3265
|
static CustomObjectEntryFieldSchema() {
|
|
3047
3266
|
return Joi.object({
|
|
3048
|
-
|
|
3049
|
-
|
|
3267
|
+
namespace: Joi.string().allow(""),
|
|
3268
|
+
slug: Joi.string().allow(""),
|
|
3269
|
+
});
|
|
3270
|
+
}
|
|
3271
|
+
|
|
3272
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3273
|
+
static CustomObjectEntryFieldSchemaWithoutID() {
|
|
3274
|
+
return Joi.object({
|
|
3275
|
+
slug: Joi.string().allow(""),
|
|
3276
|
+
value: Joi.any(),
|
|
3050
3277
|
});
|
|
3051
3278
|
}
|
|
3052
3279
|
|
|
@@ -3054,13 +3281,23 @@ class ContentPlatformModel {
|
|
|
3054
3281
|
static CustomObjectRequestSchema() {
|
|
3055
3282
|
return Joi.object({
|
|
3056
3283
|
status: Joi.string().allow(""),
|
|
3057
|
-
|
|
3284
|
+
slug: Joi.string().allow(""),
|
|
3058
3285
|
fields: Joi.array().items(
|
|
3059
3286
|
ContentPlatformModel.CustomObjectEntryFieldSchema()
|
|
3060
3287
|
),
|
|
3061
3288
|
});
|
|
3062
3289
|
}
|
|
3063
3290
|
|
|
3291
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3292
|
+
static CustomObjectRequestSchemaWithoutId() {
|
|
3293
|
+
return Joi.object({
|
|
3294
|
+
status: Joi.string().allow(""),
|
|
3295
|
+
fields: Joi.array().items(
|
|
3296
|
+
ContentPlatformModel.CustomObjectEntryFieldSchemaWithoutID()
|
|
3297
|
+
),
|
|
3298
|
+
});
|
|
3299
|
+
}
|
|
3300
|
+
|
|
3064
3301
|
/** @returns {CustomObjectBulkSchema} */
|
|
3065
3302
|
static CustomObjectBulkSchema() {
|
|
3066
3303
|
return Joi.object({
|