@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +108 -1199
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
- package/sdk/application/Content/ContentApplicationClient.js +43 -1065
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- 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 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- 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 +157 -30
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
- 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 +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1985 -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 +178 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -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 +122 -191
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
- package/sdk/platform/Content/ContentPlatformModel.js +514 -487
- 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 +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- 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 +424 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
- package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +145 -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 +132 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- 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 +10 -7
- 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 +795 -7
- 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/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- 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/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- 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]
|
|
@@ -178,7 +184,7 @@ const Joi = require("joi");
|
|
|
178
184
|
*/
|
|
179
185
|
|
|
180
186
|
/**
|
|
181
|
-
* @typedef
|
|
187
|
+
* @typedef BlogGetDetails
|
|
182
188
|
* @property {BlogSchema[]} [items]
|
|
183
189
|
* @property {Page} [page]
|
|
184
190
|
* @property {BlogFilters} [filters]
|
|
@@ -276,7 +282,7 @@ const Joi = require("joi");
|
|
|
276
282
|
*/
|
|
277
283
|
|
|
278
284
|
/**
|
|
279
|
-
* @typedef
|
|
285
|
+
* @typedef BlogPayload
|
|
280
286
|
* @property {string} [application]
|
|
281
287
|
* @property {Object} [_custom_json]
|
|
282
288
|
* @property {Author} [author]
|
|
@@ -364,24 +370,6 @@ const Joi = require("joi");
|
|
|
364
370
|
* @property {string} [end]
|
|
365
371
|
*/
|
|
366
372
|
|
|
367
|
-
/**
|
|
368
|
-
* @typedef ConfigurationSchema
|
|
369
|
-
* @property {number} [sleep_time]
|
|
370
|
-
* @property {boolean} [start_on_launch]
|
|
371
|
-
* @property {number} [duration]
|
|
372
|
-
* @property {string} [slide_direction]
|
|
373
|
-
*/
|
|
374
|
-
|
|
375
|
-
/**
|
|
376
|
-
* @typedef SlideshowMedia
|
|
377
|
-
* @property {string} [type]
|
|
378
|
-
* @property {string} [url]
|
|
379
|
-
* @property {string} [bg_color]
|
|
380
|
-
* @property {number} [duration]
|
|
381
|
-
* @property {boolean} [auto_decide_duration]
|
|
382
|
-
* @property {Action} [action]
|
|
383
|
-
*/
|
|
384
|
-
|
|
385
373
|
/**
|
|
386
374
|
* @typedef UpdateHandpickedSchema
|
|
387
375
|
* @property {HandpickedTagSchema} [tag]
|
|
@@ -445,7 +433,7 @@ const Joi = require("joi");
|
|
|
445
433
|
*/
|
|
446
434
|
|
|
447
435
|
/**
|
|
448
|
-
* @typedef
|
|
436
|
+
* @typedef TagDeleteSuccessDetails
|
|
449
437
|
* @property {boolean} [success]
|
|
450
438
|
*/
|
|
451
439
|
|
|
@@ -576,7 +564,7 @@ const Joi = require("joi");
|
|
|
576
564
|
*/
|
|
577
565
|
|
|
578
566
|
/**
|
|
579
|
-
* @typedef
|
|
567
|
+
* @typedef LandingPageGetDetails
|
|
580
568
|
* @property {LandingPageSchema[]} [items]
|
|
581
569
|
* @property {Page} [page]
|
|
582
570
|
*/
|
|
@@ -595,12 +583,12 @@ const Joi = require("joi");
|
|
|
595
583
|
*/
|
|
596
584
|
|
|
597
585
|
/**
|
|
598
|
-
* @typedef
|
|
586
|
+
* @typedef DefaultNavigationDetails
|
|
599
587
|
* @property {NavigationSchema[]} [items]
|
|
600
588
|
*/
|
|
601
589
|
|
|
602
590
|
/**
|
|
603
|
-
* @typedef
|
|
591
|
+
* @typedef NavigationGetDetails
|
|
604
592
|
* @property {NavigationSchema[]} [items]
|
|
605
593
|
* @property {Page} [page]
|
|
606
594
|
*/
|
|
@@ -627,7 +615,7 @@ const Joi = require("joi");
|
|
|
627
615
|
*/
|
|
628
616
|
|
|
629
617
|
/**
|
|
630
|
-
* @typedef
|
|
618
|
+
* @typedef NavigationPayload
|
|
631
619
|
* @property {string} [name]
|
|
632
620
|
* @property {string} [slug]
|
|
633
621
|
* @property {string[]} [platform]
|
|
@@ -636,7 +624,7 @@ const Joi = require("joi");
|
|
|
636
624
|
*/
|
|
637
625
|
|
|
638
626
|
/**
|
|
639
|
-
* @typedef
|
|
627
|
+
* @typedef PageGetDetails
|
|
640
628
|
* @property {PageSchema[]} [items]
|
|
641
629
|
* @property {Page} [page]
|
|
642
630
|
*/
|
|
@@ -693,7 +681,7 @@ const Joi = require("joi");
|
|
|
693
681
|
*/
|
|
694
682
|
|
|
695
683
|
/**
|
|
696
|
-
* @typedef
|
|
684
|
+
* @typedef PagePayload
|
|
697
685
|
* @property {CronSchedule} [_schedule]
|
|
698
686
|
* @property {string} [application]
|
|
699
687
|
* @property {Author} [author]
|
|
@@ -718,7 +706,7 @@ const Joi = require("joi");
|
|
|
718
706
|
*/
|
|
719
707
|
|
|
720
708
|
/**
|
|
721
|
-
* @typedef
|
|
709
|
+
* @typedef PagePublishPayload
|
|
722
710
|
* @property {boolean} [publish]
|
|
723
711
|
*/
|
|
724
712
|
|
|
@@ -729,35 +717,6 @@ const Joi = require("joi");
|
|
|
729
717
|
* @property {string} [application_id]
|
|
730
718
|
*/
|
|
731
719
|
|
|
732
|
-
/**
|
|
733
|
-
* @typedef SlideshowGetResponse
|
|
734
|
-
* @property {SlideshowSchema[]} [items]
|
|
735
|
-
* @property {Page} [page]
|
|
736
|
-
*/
|
|
737
|
-
|
|
738
|
-
/**
|
|
739
|
-
* @typedef SlideshowSchema
|
|
740
|
-
* @property {string} [_id]
|
|
741
|
-
* @property {string} [slug]
|
|
742
|
-
* @property {DateMeta} [date_meta]
|
|
743
|
-
* @property {string} [application]
|
|
744
|
-
* @property {string} [platform]
|
|
745
|
-
* @property {ConfigurationSchema} [configuration]
|
|
746
|
-
* @property {SlideshowMedia[]} [media]
|
|
747
|
-
* @property {boolean} [active]
|
|
748
|
-
* @property {boolean} [archived]
|
|
749
|
-
* @property {Object} [_custom_json]
|
|
750
|
-
*/
|
|
751
|
-
|
|
752
|
-
/**
|
|
753
|
-
* @typedef SlideshowRequest
|
|
754
|
-
* @property {string} [slug]
|
|
755
|
-
* @property {string} [platform]
|
|
756
|
-
* @property {ConfigurationSchema} [configuration]
|
|
757
|
-
* @property {SlideshowMedia} [media]
|
|
758
|
-
* @property {boolean} [active]
|
|
759
|
-
*/
|
|
760
|
-
|
|
761
720
|
/**
|
|
762
721
|
* @typedef Support
|
|
763
722
|
* @property {boolean} [created]
|
|
@@ -841,100 +800,116 @@ const Joi = require("joi");
|
|
|
841
800
|
|
|
842
801
|
/**
|
|
843
802
|
* @typedef FieldValidations
|
|
844
|
-
* @property {string} [name]
|
|
845
|
-
* @property {string} [type]
|
|
803
|
+
* @property {string} [name] - Name of validation
|
|
804
|
+
* @property {string} [type] - Type of validation
|
|
846
805
|
* @property {Object} [value]
|
|
847
806
|
*/
|
|
848
807
|
|
|
849
808
|
/**
|
|
850
809
|
* @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]
|
|
810
|
+
* @property {string} [id] - Unique system generated id
|
|
811
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
812
|
+
* @property {string} [name] - Name of custom field
|
|
813
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
814
|
+
* @property {string} [slug] - Slug of custom field
|
|
815
|
+
* @property {string} [description] - Description of custom field definition
|
|
816
|
+
* @property {string} [type] - Data type of custom field
|
|
817
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
818
|
+
* multivalued or not
|
|
819
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
820
|
+
* @property {string} [company_id] - Id of company
|
|
821
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
822
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
823
|
+
* @property {string} [type_name] - Type of type field
|
|
824
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
870
825
|
*/
|
|
871
826
|
|
|
872
827
|
/**
|
|
873
828
|
* @typedef CustomFieldDefinitionsSchema
|
|
874
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
829
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
875
830
|
* @property {Page} [page]
|
|
876
831
|
*/
|
|
877
832
|
|
|
878
833
|
/**
|
|
879
834
|
* @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]
|
|
835
|
+
* @property {string} [type] - Data type of custom field
|
|
836
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
837
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
838
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
839
|
+
* multi valued or not
|
|
840
|
+
* @property {string} [name] - Name of custom field definition
|
|
841
|
+
* @property {string} [description] - Description of a custom field definition
|
|
842
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
888
843
|
*/
|
|
889
844
|
|
|
890
845
|
/**
|
|
891
846
|
* @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 {
|
|
847
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
848
|
+
* @property {string} [type] - Data type of custom field
|
|
849
|
+
* @property {string} [description] - Description of custom field
|
|
850
|
+
* @property {string} [name] - Name of custom field
|
|
851
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
852
|
+
* valued or not
|
|
853
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
854
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
855
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
856
|
+
* custom field
|
|
900
857
|
* @property {string} [action]
|
|
901
858
|
*/
|
|
902
859
|
|
|
903
860
|
/**
|
|
904
861
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
905
|
-
* @property {string} [
|
|
906
|
-
* @property {string} [
|
|
907
|
-
* @property {string} [
|
|
908
|
-
*
|
|
862
|
+
* @property {string} [description] - Description of custom object definiton
|
|
863
|
+
* @property {string} [name] - Name of custom object definition
|
|
864
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
865
|
+
* display key in
|
|
909
866
|
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
910
867
|
*/
|
|
911
868
|
|
|
912
869
|
/**
|
|
913
870
|
* @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]
|
|
871
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
872
|
+
* @property {string} [name] - Name of custom field
|
|
873
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
874
|
+
* @property {string} [slug] - Slug of custom field
|
|
875
|
+
* @property {string} [description] - Description regarding custom field
|
|
876
|
+
* @property {string} [type] - Data type of custom field
|
|
877
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
878
|
+
* multi valued or not
|
|
879
|
+
* @property {string} [company_id] - Company Identifer
|
|
880
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
881
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
882
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
883
|
+
* @property {string} [id] - Unique system generated id
|
|
929
884
|
* @property {Object[]} [validations]
|
|
930
|
-
* @property {string} [created_at]
|
|
931
|
-
* @property {string} [updated_at]
|
|
885
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
886
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
887
|
+
*/
|
|
888
|
+
|
|
889
|
+
/**
|
|
890
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
891
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
892
|
+
* @property {string} [name] - Name of meta field
|
|
893
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
894
|
+
* @property {string} [slug] - Slug of meta field
|
|
895
|
+
* @property {string} [description] - Description regarding meta field
|
|
896
|
+
* @property {string} [type] - Data type of meta field
|
|
897
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
898
|
+
* multi valued or not
|
|
899
|
+
* @property {string} [company_id] - Company Identifer
|
|
900
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
901
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
902
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
903
|
+
* @property {string} [id] - Unique system generated id
|
|
904
|
+
* @property {Object[]} [validations]
|
|
905
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
906
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
932
907
|
*/
|
|
933
908
|
|
|
934
909
|
/**
|
|
935
910
|
* @typedef CustomDataDeleteSchema
|
|
936
|
-
* @property {boolean} [success]
|
|
937
|
-
* @property {string} [message]
|
|
911
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
912
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
938
913
|
*/
|
|
939
914
|
|
|
940
915
|
/**
|
|
@@ -944,23 +919,20 @@ const Joi = require("joi");
|
|
|
944
919
|
|
|
945
920
|
/**
|
|
946
921
|
* @typedef CustomFieldSchema
|
|
947
|
-
* @property {string} [
|
|
948
|
-
* @property {string} [namespace]
|
|
949
|
-
* @property {string} [
|
|
950
|
-
* @property {string} [resource]
|
|
951
|
-
* @property {string} [creator]
|
|
922
|
+
* @property {string} [id] - Unique system generated id
|
|
923
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
924
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
925
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
952
926
|
* @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]
|
|
927
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
928
|
+
* @property {string} [type] - Data type of custom field
|
|
929
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
930
|
+
* @property {string} [company_id] - Identifer for a company
|
|
958
931
|
* @property {boolean} [has_invalid_values]
|
|
959
932
|
* @property {Object[]} [invalid_value_errors]
|
|
960
|
-
* @property {
|
|
961
|
-
* @property {
|
|
962
|
-
* @property {string} [
|
|
963
|
-
* @property {string} [updated_at]
|
|
933
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
934
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
935
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
964
936
|
*/
|
|
965
937
|
|
|
966
938
|
/**
|
|
@@ -969,6 +941,12 @@ const Joi = require("joi");
|
|
|
969
941
|
* @property {Page} [page]
|
|
970
942
|
*/
|
|
971
943
|
|
|
944
|
+
/**
|
|
945
|
+
* @typedef CustomFieldsDeleteSchema
|
|
946
|
+
* @property {boolean} [success]
|
|
947
|
+
* @property {string} [message]
|
|
948
|
+
*/
|
|
949
|
+
|
|
972
950
|
/**
|
|
973
951
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
974
952
|
* @property {CustomFieldSchema[]} [items]
|
|
@@ -977,7 +955,9 @@ const Joi = require("joi");
|
|
|
977
955
|
/**
|
|
978
956
|
* @typedef CustomField
|
|
979
957
|
* @property {Object[]} [value]
|
|
980
|
-
* @property {string} [
|
|
958
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
959
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
960
|
+
* creating a custom field definition
|
|
981
961
|
*/
|
|
982
962
|
|
|
983
963
|
/**
|
|
@@ -987,161 +967,156 @@ const Joi = require("joi");
|
|
|
987
967
|
|
|
988
968
|
/**
|
|
989
969
|
* @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]
|
|
970
|
+
* @property {string} [id] - Unique system generated id
|
|
971
|
+
* @property {string} [company_id] - Identifer for a company
|
|
972
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
973
|
+
* @property {string} [status] - Status of custom object
|
|
974
|
+
* @property {string} [type] - Slug of custom object definition
|
|
975
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
976
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
977
|
+
* custom object
|
|
978
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
1001
979
|
*/
|
|
1002
980
|
|
|
1003
981
|
/**
|
|
1004
982
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
1005
|
-
* @property {string} [type]
|
|
1006
|
-
* @property {string} [
|
|
1007
|
-
* @property {string} [
|
|
1008
|
-
* @property {string} [
|
|
1009
|
-
* @property {
|
|
983
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
984
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
985
|
+
* @property {string} [description] - Description of custom object definition
|
|
986
|
+
* @property {string} [name] - Name of custom object
|
|
987
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
988
|
+
* for displaying custom object
|
|
989
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
990
|
+
* of custom field definitions belonging to this custom object definition
|
|
1010
991
|
*/
|
|
1011
992
|
|
|
1012
993
|
/**
|
|
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]
|
|
994
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
995
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
996
|
+
* @property {string} [name] - Display name of custom object definition
|
|
997
|
+
* @property {string} [type] - Type of custom object definiton
|
|
998
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
999
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
1000
|
+
* @property {string} [description] - Description of custom object definition
|
|
1001
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
1002
|
+
* Custom fields inside custom objects
|
|
1044
1003
|
*/
|
|
1045
1004
|
|
|
1046
1005
|
/**
|
|
1047
1006
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
1048
|
-
* @property {boolean} [success]
|
|
1049
|
-
* @property {string} [message]
|
|
1007
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
1008
|
+
* @property {string} [message] - Response message when custom object definition
|
|
1009
|
+
* is deleted.
|
|
1050
1010
|
*/
|
|
1051
1011
|
|
|
1052
1012
|
/**
|
|
1053
|
-
* @typedef
|
|
1054
|
-
* @property {string} [url]
|
|
1055
|
-
* @property {number} [total_records]
|
|
1013
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
1014
|
+
* @property {string} [url] - Signed url of csv
|
|
1015
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
1056
1016
|
*/
|
|
1057
1017
|
|
|
1058
1018
|
/**
|
|
1059
|
-
* @typedef
|
|
1060
|
-
* @property {string} [
|
|
1061
|
-
* @property {string} [name]
|
|
1062
|
-
* @property {string} [type]
|
|
1019
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
1020
|
+
* @property {string} [id] - Unique system generated id
|
|
1021
|
+
* @property {string} [name] - Name of custom object
|
|
1022
|
+
* @property {string} [type] - Type of custom object entry
|
|
1063
1023
|
*/
|
|
1064
1024
|
|
|
1065
1025
|
/**
|
|
1066
1026
|
* @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]
|
|
1027
|
+
* @property {string} [id] - Unique system generated id
|
|
1028
|
+
* @property {string} [status] - Status of custom object
|
|
1029
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
1030
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
1031
|
+
* @property {string} [display_name] - Display name of custom object
|
|
1032
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1033
|
+
* @property {number} [references] - References of the custom object entry
|
|
1074
1034
|
*/
|
|
1075
1035
|
|
|
1076
1036
|
/**
|
|
1077
1037
|
* @typedef CustomObjectsSchema
|
|
1078
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
1038
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
1039
|
+
* object entries
|
|
1079
1040
|
* @property {Page} [page]
|
|
1080
1041
|
*/
|
|
1081
1042
|
|
|
1082
1043
|
/**
|
|
1083
|
-
* @typedef
|
|
1084
|
-
* @property {string} [
|
|
1085
|
-
* @property {string} [
|
|
1086
|
-
* @property {
|
|
1087
|
-
* @property {
|
|
1088
|
-
* @property {string} [
|
|
1044
|
+
* @typedef CustomObjectFieldDefinition
|
|
1045
|
+
* @property {string} [id] - Unique system generate id
|
|
1046
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1047
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1048
|
+
* @property {Object[]} [value] - Value of custom field
|
|
1049
|
+
* @property {string} [type] - Data type of the custom field
|
|
1089
1050
|
*/
|
|
1090
1051
|
|
|
1091
1052
|
/**
|
|
1092
|
-
* @typedef
|
|
1093
|
-
* @property {string} [
|
|
1094
|
-
* @property {string} [status]
|
|
1095
|
-
* @property {string} [display_name]
|
|
1096
|
-
* @property {
|
|
1097
|
-
* @property {Object[]} [references]
|
|
1098
|
-
*
|
|
1053
|
+
* @typedef CustomObjectBySlugSchema
|
|
1054
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
1055
|
+
* @property {string} [status] - Status of Custom Object
|
|
1056
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
1057
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1058
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
1059
|
+
* used as a custom field
|
|
1060
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
1061
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
1062
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
1063
|
+
* inside the custom object
|
|
1099
1064
|
*/
|
|
1100
1065
|
|
|
1101
1066
|
/**
|
|
1102
1067
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
1103
|
-
* @property {string} [message]
|
|
1104
|
-
* @property {string} [task_id]
|
|
1068
|
+
* @property {string} [message] - Message for the user
|
|
1069
|
+
* @property {string} [task_id] - Identifer for a task
|
|
1105
1070
|
*/
|
|
1106
1071
|
|
|
1107
1072
|
/**
|
|
1108
1073
|
* @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]
|
|
1074
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
1075
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
1076
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
1077
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
1078
|
+
*/
|
|
1079
|
+
|
|
1080
|
+
/**
|
|
1081
|
+
* @typedef JobSchema
|
|
1082
|
+
* @property {string} [id] - Unique system generated id
|
|
1083
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
1084
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
1085
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1086
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1087
|
+
* @property {string} [company_id] - Company Identifer
|
|
1088
|
+
* @property {string} [status] - Status of job
|
|
1089
|
+
* @property {string} [action_type] - Type of job
|
|
1090
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1091
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1092
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1093
|
+
* @property {number} [error_count] - Number of items in error
|
|
1094
|
+
* @property {number} [success_count] - Number of successful items
|
|
1095
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1096
|
+
* @property {CustomObjectMetaSchema} [meta]
|
|
1097
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1098
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1099
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1100
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
1113
1101
|
*/
|
|
1114
1102
|
|
|
1115
1103
|
/**
|
|
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]
|
|
1104
|
+
* @typedef CustomFieldBulkEntry
|
|
1105
|
+
* @property {JobSchema[]} [items]
|
|
1106
|
+
* @property {Page} [page]
|
|
1137
1107
|
*/
|
|
1138
1108
|
|
|
1139
1109
|
/**
|
|
1140
1110
|
* @typedef CustomObjectBulkEntry
|
|
1141
|
-
* @property {
|
|
1111
|
+
* @property {JobSchema[]} [items]
|
|
1142
1112
|
* @property {Page} [page]
|
|
1143
1113
|
*/
|
|
1144
1114
|
|
|
1115
|
+
/**
|
|
1116
|
+
* @typedef MetafieldTypesSchema
|
|
1117
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1118
|
+
*/
|
|
1119
|
+
|
|
1145
1120
|
/**
|
|
1146
1121
|
* @typedef CustomFieldTypeSchema
|
|
1147
1122
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1157,6 +1132,8 @@ const Joi = require("joi");
|
|
|
1157
1132
|
* @property {Url} [url]
|
|
1158
1133
|
* @property {Metaobject} [metaobject]
|
|
1159
1134
|
* @property {Product} [product]
|
|
1135
|
+
* @property {HTML} [html]
|
|
1136
|
+
* @property {Duration} [duration]
|
|
1160
1137
|
*/
|
|
1161
1138
|
|
|
1162
1139
|
/**
|
|
@@ -1179,130 +1156,164 @@ const Joi = require("joi");
|
|
|
1179
1156
|
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1180
1157
|
*/
|
|
1181
1158
|
|
|
1159
|
+
/**
|
|
1160
|
+
* @typedef Duration
|
|
1161
|
+
* @property {string} [name] - Name data type of custom field
|
|
1162
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1163
|
+
* @property {string} [type] - Type of custom field
|
|
1164
|
+
* @property {string} [category] - Category of custom field
|
|
1165
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1166
|
+
* validations available for the field
|
|
1167
|
+
*/
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* @typedef HTML
|
|
1171
|
+
* @property {string} [name] - Name data type of custom field
|
|
1172
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1173
|
+
* @property {string} [type] - Type of custom field
|
|
1174
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1175
|
+
* validations available for the field
|
|
1176
|
+
*/
|
|
1177
|
+
|
|
1182
1178
|
/**
|
|
1183
1179
|
* @typedef StringSingleLine
|
|
1184
|
-
* @property {string} [name]
|
|
1185
|
-
* @property {boolean} [list_enabled]
|
|
1186
|
-
* @property {string} [category]
|
|
1187
|
-
* @property {string} [type]
|
|
1188
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1180
|
+
* @property {string} [name] - Name data type of custom field
|
|
1181
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1182
|
+
* @property {string} [category] - Category of custom field
|
|
1183
|
+
* @property {string} [type] - Type of custom field
|
|
1184
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1185
|
+
* validations available for the field
|
|
1189
1186
|
*/
|
|
1190
1187
|
|
|
1191
1188
|
/**
|
|
1192
1189
|
* @typedef StringMultiLine
|
|
1193
|
-
* @property {string} [name]
|
|
1194
|
-
* @property {boolean} [list_enabled]
|
|
1195
|
-
* @property {string} [category]
|
|
1196
|
-
* @property {string} [type]
|
|
1197
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1190
|
+
* @property {string} [name] - Name data type of custom field
|
|
1191
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1192
|
+
* @property {string} [category] - Category of custom field
|
|
1193
|
+
* @property {string} [type] - Type of custom field
|
|
1194
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1195
|
+
* validations available for the field
|
|
1198
1196
|
*/
|
|
1199
1197
|
|
|
1200
1198
|
/**
|
|
1201
1199
|
* @typedef Dropdown
|
|
1202
|
-
* @property {string} [name]
|
|
1203
|
-
* @property {boolean} [list_enabled]
|
|
1204
|
-
* @property {string} [category]
|
|
1205
|
-
* @property {string} [type]
|
|
1206
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1200
|
+
* @property {string} [name] - Name data type of custom field
|
|
1201
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1202
|
+
* @property {string} [category] - Category of custom field
|
|
1203
|
+
* @property {string} [type] - Category of custom field
|
|
1204
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1205
|
+
* validations available for the field
|
|
1207
1206
|
*/
|
|
1208
1207
|
|
|
1209
1208
|
/**
|
|
1210
1209
|
* @typedef Integer
|
|
1211
|
-
* @property {string} [name]
|
|
1212
|
-
* @property {boolean} [list_enabled]
|
|
1213
|
-
* @property {string} [type]
|
|
1214
|
-
* @property {string} [category]
|
|
1215
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1210
|
+
* @property {string} [name] - Name data type of custom field
|
|
1211
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1212
|
+
* @property {string} [type] - Type of custom field
|
|
1213
|
+
* @property {string} [category] - Category of custom field
|
|
1214
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1215
|
+
* validations available for the field
|
|
1216
1216
|
*/
|
|
1217
1217
|
|
|
1218
1218
|
/**
|
|
1219
1219
|
* @typedef FloatType
|
|
1220
|
-
* @property {string} [name]
|
|
1221
|
-
* @property {boolean} [list_enabled]
|
|
1222
|
-
* @property {string} [type]
|
|
1223
|
-
* @property {string} [category]
|
|
1224
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1220
|
+
* @property {string} [name] - Name data type of custom field
|
|
1221
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1222
|
+
* @property {string} [type] - Type of custom field
|
|
1223
|
+
* @property {string} [category] - Category of custom field
|
|
1224
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1225
|
+
* validations available for the field
|
|
1225
1226
|
*/
|
|
1226
1227
|
|
|
1227
1228
|
/**
|
|
1228
1229
|
* @typedef BooleanType
|
|
1229
|
-
* @property {string} [name]
|
|
1230
|
-
* @property {string} [category]
|
|
1231
|
-
* @property {boolean} [list_enabled]
|
|
1232
|
-
* @property {string} [type]
|
|
1233
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1230
|
+
* @property {string} [name] - Name data type of custom field
|
|
1231
|
+
* @property {string} [category] - Category of custom field
|
|
1232
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1233
|
+
* @property {string} [type] - Category of custom field
|
|
1234
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1235
|
+
* validations available for the field
|
|
1234
1236
|
*/
|
|
1235
1237
|
|
|
1236
1238
|
/**
|
|
1237
1239
|
* @typedef Date
|
|
1238
|
-
* @property {string} [name]
|
|
1239
|
-
* @property {boolean} [list_enabled]
|
|
1240
|
-
* @property {string} [category]
|
|
1241
|
-
* @property {string} [type]
|
|
1242
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1240
|
+
* @property {string} [name] - Name data type of custom field
|
|
1241
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1242
|
+
* @property {string} [category] - Category of custom field
|
|
1243
|
+
* @property {string} [type] - Type of custom field
|
|
1244
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1245
|
+
* validations available for the field
|
|
1243
1246
|
*/
|
|
1244
1247
|
|
|
1245
1248
|
/**
|
|
1246
1249
|
* @typedef Datetime
|
|
1247
|
-
* @property {string} [name]
|
|
1248
|
-
* @property {string} [category]
|
|
1249
|
-
* @property {boolean} [list_enabled]
|
|
1250
|
-
* @property {string} [type]
|
|
1251
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1250
|
+
* @property {string} [name] - Name data type of custom field
|
|
1251
|
+
* @property {string} [category] - Category of custom field
|
|
1252
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1253
|
+
* @property {string} [type] - Type of custom field
|
|
1254
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1255
|
+
* validations available for the field
|
|
1252
1256
|
*/
|
|
1253
1257
|
|
|
1254
1258
|
/**
|
|
1255
1259
|
* @typedef Json
|
|
1256
|
-
* @property {string} [name]
|
|
1257
|
-
* @property {boolean} [list_enabled]
|
|
1258
|
-
* @property {string} [category]
|
|
1259
|
-
* @property {string} [type]
|
|
1260
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1260
|
+
* @property {string} [name] - Name data type of custom field
|
|
1261
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1262
|
+
* @property {string} [category] - Category of custom field
|
|
1263
|
+
* @property {string} [type] - Type of custom field
|
|
1264
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1265
|
+
* validations available for the field
|
|
1261
1266
|
*/
|
|
1262
1267
|
|
|
1263
1268
|
/**
|
|
1264
1269
|
* @typedef File
|
|
1265
|
-
* @property {string} [name]
|
|
1266
|
-
* @property {string} [category]
|
|
1267
|
-
* @property {boolean} [list_enabled]
|
|
1268
|
-
* @property {string} [type]
|
|
1270
|
+
* @property {string} [name] - Name data type of custom field
|
|
1271
|
+
* @property {string} [category] - Category of custom field
|
|
1272
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1273
|
+
* @property {string} [type] - Type of custom field
|
|
1269
1274
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1270
1275
|
*/
|
|
1271
1276
|
|
|
1272
1277
|
/**
|
|
1273
1278
|
* @typedef Url
|
|
1274
|
-
* @property {string} [name]
|
|
1275
|
-
* @property {boolean} [list_enabled]
|
|
1276
|
-
* @property {string} [type]
|
|
1277
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1279
|
+
* @property {string} [name] - Name data type of custom field
|
|
1280
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1281
|
+
* @property {string} [type] - Type of custom field
|
|
1282
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1283
|
+
* validations available for the field
|
|
1278
1284
|
*/
|
|
1279
1285
|
|
|
1280
1286
|
/**
|
|
1281
1287
|
* @typedef Metaobject
|
|
1282
|
-
* @property {string} [name]
|
|
1283
|
-
* @property {boolean} [list_enabled]
|
|
1284
|
-
*
|
|
1285
|
-
* @property {string} [
|
|
1288
|
+
* @property {string} [name] - Name of Custom Object
|
|
1289
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1290
|
+
* multiple list items
|
|
1291
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1292
|
+
* Custom Object belongs to
|
|
1293
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1286
1294
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1287
1295
|
*/
|
|
1288
1296
|
|
|
1289
1297
|
/**
|
|
1290
1298
|
* @typedef Product
|
|
1291
|
-
* @property {string} [name]
|
|
1292
|
-
* @property {boolean} [list_enabled]
|
|
1293
|
-
*
|
|
1294
|
-
* @property {string} [
|
|
1299
|
+
* @property {string} [name] - Name of Product
|
|
1300
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1301
|
+
* multiple list items
|
|
1302
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1303
|
+
* Product is associated with
|
|
1304
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1295
1305
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1296
1306
|
*/
|
|
1297
1307
|
|
|
1298
1308
|
/**
|
|
1299
1309
|
* @typedef CustomObjectEntry
|
|
1300
|
-
* @property {string} [
|
|
1301
|
-
* @property {string} [name]
|
|
1302
|
-
* @property {string} [type]
|
|
1303
|
-
* @property {string} [updated_at]
|
|
1304
|
-
* @property {number} [entries_count]
|
|
1305
|
-
*
|
|
1310
|
+
* @property {string} [id] - Unique system generated id
|
|
1311
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1312
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1313
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1314
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1315
|
+
* Object definition
|
|
1316
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1306
1317
|
*/
|
|
1307
1318
|
|
|
1308
1319
|
/**
|
|
@@ -1313,21 +1324,33 @@ const Joi = require("joi");
|
|
|
1313
1324
|
|
|
1314
1325
|
/**
|
|
1315
1326
|
* @typedef CustomObjectEntryFieldSchema
|
|
1316
|
-
* @property {string} [
|
|
1317
|
-
* @property {
|
|
1327
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1328
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1329
|
+
*/
|
|
1330
|
+
|
|
1331
|
+
/**
|
|
1332
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1333
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1334
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1318
1335
|
*/
|
|
1319
1336
|
|
|
1320
1337
|
/**
|
|
1321
1338
|
* @typedef CustomObjectRequestSchema
|
|
1322
|
-
* @property {string} [status]
|
|
1323
|
-
* @property {string} [
|
|
1324
|
-
* @property {CustomObjectEntryFieldSchema[]} [fields]
|
|
1339
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1340
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1341
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1342
|
+
*/
|
|
1343
|
+
|
|
1344
|
+
/**
|
|
1345
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1346
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1347
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1325
1348
|
*/
|
|
1326
1349
|
|
|
1327
1350
|
/**
|
|
1328
1351
|
* @typedef CustomObjectBulkSchema
|
|
1329
|
-
* @property {string} [url]
|
|
1330
|
-
* @property {number} [total_records]
|
|
1352
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1353
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1331
1354
|
*/
|
|
1332
1355
|
|
|
1333
1356
|
/**
|
|
@@ -1392,6 +1415,14 @@ const Joi = require("joi");
|
|
|
1392
1415
|
*/
|
|
1393
1416
|
|
|
1394
1417
|
class ContentPlatformModel {
|
|
1418
|
+
/** @returns {ValidationError} */
|
|
1419
|
+
static ValidationError() {
|
|
1420
|
+
return Joi.object({
|
|
1421
|
+
message: Joi.string().allow("").required(),
|
|
1422
|
+
field: Joi.string().allow("").required(),
|
|
1423
|
+
});
|
|
1424
|
+
}
|
|
1425
|
+
|
|
1395
1426
|
/** @returns {GenerateSEOContent} */
|
|
1396
1427
|
static GenerateSEOContent() {
|
|
1397
1428
|
return Joi.object({
|
|
@@ -1613,8 +1644,8 @@ class ContentPlatformModel {
|
|
|
1613
1644
|
});
|
|
1614
1645
|
}
|
|
1615
1646
|
|
|
1616
|
-
/** @returns {
|
|
1617
|
-
static
|
|
1647
|
+
/** @returns {BlogGetDetails} */
|
|
1648
|
+
static BlogGetDetails() {
|
|
1618
1649
|
return Joi.object({
|
|
1619
1650
|
items: Joi.array().items(ContentPlatformModel.BlogSchema()),
|
|
1620
1651
|
page: ContentPlatformModel.Page(),
|
|
@@ -1659,7 +1690,7 @@ class ContentPlatformModel {
|
|
|
1659
1690
|
static BlogSchema() {
|
|
1660
1691
|
return Joi.object({
|
|
1661
1692
|
_id: Joi.string().allow(""),
|
|
1662
|
-
_custom_json: Joi.any(),
|
|
1693
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1663
1694
|
application: Joi.string().allow(""),
|
|
1664
1695
|
archived: Joi.boolean(),
|
|
1665
1696
|
author: ContentPlatformModel.Author(),
|
|
@@ -1737,11 +1768,11 @@ class ContentPlatformModel {
|
|
|
1737
1768
|
});
|
|
1738
1769
|
}
|
|
1739
1770
|
|
|
1740
|
-
/** @returns {
|
|
1741
|
-
static
|
|
1771
|
+
/** @returns {BlogPayload} */
|
|
1772
|
+
static BlogPayload() {
|
|
1742
1773
|
return Joi.object({
|
|
1743
1774
|
application: Joi.string().allow(""),
|
|
1744
|
-
_custom_json: Joi.any(),
|
|
1775
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1745
1776
|
author: ContentPlatformModel.Author(),
|
|
1746
1777
|
content: Joi.array().items(ContentPlatformModel.ResourceContent()),
|
|
1747
1778
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -1846,28 +1877,6 @@ class ContentPlatformModel {
|
|
|
1846
1877
|
});
|
|
1847
1878
|
}
|
|
1848
1879
|
|
|
1849
|
-
/** @returns {ConfigurationSchema} */
|
|
1850
|
-
static ConfigurationSchema() {
|
|
1851
|
-
return Joi.object({
|
|
1852
|
-
sleep_time: Joi.number(),
|
|
1853
|
-
start_on_launch: Joi.boolean(),
|
|
1854
|
-
duration: Joi.number(),
|
|
1855
|
-
slide_direction: Joi.string().allow(""),
|
|
1856
|
-
});
|
|
1857
|
-
}
|
|
1858
|
-
|
|
1859
|
-
/** @returns {SlideshowMedia} */
|
|
1860
|
-
static SlideshowMedia() {
|
|
1861
|
-
return Joi.object({
|
|
1862
|
-
type: Joi.string().allow(""),
|
|
1863
|
-
url: Joi.string().allow(""),
|
|
1864
|
-
bg_color: Joi.string().allow(""),
|
|
1865
|
-
duration: Joi.number(),
|
|
1866
|
-
auto_decide_duration: Joi.boolean(),
|
|
1867
|
-
action: ContentPlatformModel.Action(),
|
|
1868
|
-
});
|
|
1869
|
-
}
|
|
1870
|
-
|
|
1871
1880
|
/** @returns {UpdateHandpickedSchema} */
|
|
1872
1881
|
static UpdateHandpickedSchema() {
|
|
1873
1882
|
return Joi.object({
|
|
@@ -1879,7 +1888,7 @@ class ContentPlatformModel {
|
|
|
1879
1888
|
static HandpickedTagSchema() {
|
|
1880
1889
|
return Joi.object({
|
|
1881
1890
|
position: Joi.string().allow(""),
|
|
1882
|
-
attributes: Joi.any(),
|
|
1891
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
1883
1892
|
name: Joi.string().allow(""),
|
|
1884
1893
|
url: Joi.string().allow(""),
|
|
1885
1894
|
type: Joi.string().allow(""),
|
|
@@ -1904,7 +1913,7 @@ class ContentPlatformModel {
|
|
|
1904
1913
|
type: Joi.string().allow(""),
|
|
1905
1914
|
url: Joi.string().allow(""),
|
|
1906
1915
|
position: Joi.string().allow(""),
|
|
1907
|
-
attributes: Joi.any(),
|
|
1916
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
1908
1917
|
pages: Joi.array().items(Joi.any()),
|
|
1909
1918
|
content: Joi.string().allow(""),
|
|
1910
1919
|
});
|
|
@@ -1946,8 +1955,8 @@ class ContentPlatformModel {
|
|
|
1946
1955
|
});
|
|
1947
1956
|
}
|
|
1948
1957
|
|
|
1949
|
-
/** @returns {
|
|
1950
|
-
static
|
|
1958
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
1959
|
+
static TagDeleteSuccessDetails() {
|
|
1951
1960
|
return Joi.object({
|
|
1952
1961
|
success: Joi.boolean(),
|
|
1953
1962
|
});
|
|
@@ -1963,7 +1972,7 @@ class ContentPlatformModel {
|
|
|
1963
1972
|
info: Joi.string().allow(""),
|
|
1964
1973
|
request_id: Joi.string().allow(""),
|
|
1965
1974
|
stack_trace: Joi.string().allow(""),
|
|
1966
|
-
meta: Joi.any(),
|
|
1975
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1967
1976
|
});
|
|
1968
1977
|
}
|
|
1969
1978
|
|
|
@@ -1985,7 +1994,7 @@ class ContentPlatformModel {
|
|
|
1985
1994
|
slug: Joi.string().allow(""),
|
|
1986
1995
|
application: Joi.string().allow(""),
|
|
1987
1996
|
icon_url: Joi.string().allow(""),
|
|
1988
|
-
_custom_json: Joi.any(),
|
|
1997
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1989
1998
|
});
|
|
1990
1999
|
}
|
|
1991
2000
|
|
|
@@ -2019,7 +2028,7 @@ class ContentPlatformModel {
|
|
|
2019
2028
|
slug: Joi.string().allow(""),
|
|
2020
2029
|
application: Joi.string().allow(""),
|
|
2021
2030
|
icon_url: Joi.string().allow(""),
|
|
2022
|
-
_custom_json: Joi.any(),
|
|
2031
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2023
2032
|
});
|
|
2024
2033
|
}
|
|
2025
2034
|
|
|
@@ -2113,8 +2122,8 @@ class ContentPlatformModel {
|
|
|
2113
2122
|
});
|
|
2114
2123
|
}
|
|
2115
2124
|
|
|
2116
|
-
/** @returns {
|
|
2117
|
-
static
|
|
2125
|
+
/** @returns {LandingPageGetDetails} */
|
|
2126
|
+
static LandingPageGetDetails() {
|
|
2118
2127
|
return Joi.object({
|
|
2119
2128
|
items: Joi.array().items(ContentPlatformModel.LandingPageSchema()),
|
|
2120
2129
|
page: ContentPlatformModel.Page(),
|
|
@@ -2132,19 +2141,19 @@ class ContentPlatformModel {
|
|
|
2132
2141
|
_id: Joi.string().allow(""),
|
|
2133
2142
|
application: Joi.string().allow(""),
|
|
2134
2143
|
archived: Joi.boolean(),
|
|
2135
|
-
_custom_json: Joi.any(),
|
|
2144
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2136
2145
|
});
|
|
2137
2146
|
}
|
|
2138
2147
|
|
|
2139
|
-
/** @returns {
|
|
2140
|
-
static
|
|
2148
|
+
/** @returns {DefaultNavigationDetails} */
|
|
2149
|
+
static DefaultNavigationDetails() {
|
|
2141
2150
|
return Joi.object({
|
|
2142
2151
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2143
2152
|
});
|
|
2144
2153
|
}
|
|
2145
2154
|
|
|
2146
|
-
/** @returns {
|
|
2147
|
-
static
|
|
2155
|
+
/** @returns {NavigationGetDetails} */
|
|
2156
|
+
static NavigationGetDetails() {
|
|
2148
2157
|
return Joi.object({
|
|
2149
2158
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2150
2159
|
page: ContentPlatformModel.Page(),
|
|
@@ -2176,8 +2185,8 @@ class ContentPlatformModel {
|
|
|
2176
2185
|
});
|
|
2177
2186
|
}
|
|
2178
2187
|
|
|
2179
|
-
/** @returns {
|
|
2180
|
-
static
|
|
2188
|
+
/** @returns {NavigationPayload} */
|
|
2189
|
+
static NavigationPayload() {
|
|
2181
2190
|
return Joi.object({
|
|
2182
2191
|
name: Joi.string().allow(""),
|
|
2183
2192
|
slug: Joi.string().allow(""),
|
|
@@ -2187,8 +2196,8 @@ class ContentPlatformModel {
|
|
|
2187
2196
|
});
|
|
2188
2197
|
}
|
|
2189
2198
|
|
|
2190
|
-
/** @returns {
|
|
2191
|
-
static
|
|
2199
|
+
/** @returns {PageGetDetails} */
|
|
2200
|
+
static PageGetDetails() {
|
|
2192
2201
|
return Joi.object({
|
|
2193
2202
|
items: Joi.array().items(ContentPlatformModel.PageSchema()),
|
|
2194
2203
|
page: ContentPlatformModel.Page(),
|
|
@@ -2234,7 +2243,7 @@ class ContentPlatformModel {
|
|
|
2234
2243
|
feature_image: ContentPlatformModel.Asset(),
|
|
2235
2244
|
page_meta: Joi.array().items(Joi.any()),
|
|
2236
2245
|
_schedule: ContentPlatformModel.ScheduleSchema(),
|
|
2237
|
-
_custom_json: Joi.any(),
|
|
2246
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2238
2247
|
orientation: Joi.string().allow(""),
|
|
2239
2248
|
platform: Joi.string().allow(""),
|
|
2240
2249
|
published: Joi.boolean(),
|
|
@@ -2243,7 +2252,7 @@ class ContentPlatformModel {
|
|
|
2243
2252
|
title: Joi.string().allow(""),
|
|
2244
2253
|
type: Joi.string().allow(""),
|
|
2245
2254
|
seo: ContentPlatformModel.SEO(),
|
|
2246
|
-
visibility: Joi.any(),
|
|
2255
|
+
visibility: Joi.object().pattern(/\S/, Joi.any()),
|
|
2247
2256
|
archived: Joi.boolean(),
|
|
2248
2257
|
});
|
|
2249
2258
|
}
|
|
@@ -2255,13 +2264,13 @@ class ContentPlatformModel {
|
|
|
2255
2264
|
});
|
|
2256
2265
|
}
|
|
2257
2266
|
|
|
2258
|
-
/** @returns {
|
|
2259
|
-
static
|
|
2267
|
+
/** @returns {PagePayload} */
|
|
2268
|
+
static PagePayload() {
|
|
2260
2269
|
return Joi.object({
|
|
2261
2270
|
_schedule: ContentPlatformModel.CronSchedule(),
|
|
2262
2271
|
application: Joi.string().allow(""),
|
|
2263
2272
|
author: ContentPlatformModel.Author(),
|
|
2264
|
-
_custom_json: Joi.any(),
|
|
2273
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2265
2274
|
orientation: Joi.string().allow(""),
|
|
2266
2275
|
content: Joi.array().items(Joi.any()),
|
|
2267
2276
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -2284,8 +2293,8 @@ class ContentPlatformModel {
|
|
|
2284
2293
|
});
|
|
2285
2294
|
}
|
|
2286
2295
|
|
|
2287
|
-
/** @returns {
|
|
2288
|
-
static
|
|
2296
|
+
/** @returns {PagePublishPayload} */
|
|
2297
|
+
static PagePublishPayload() {
|
|
2289
2298
|
return Joi.object({
|
|
2290
2299
|
publish: Joi.boolean(),
|
|
2291
2300
|
});
|
|
@@ -2300,41 +2309,6 @@ class ContentPlatformModel {
|
|
|
2300
2309
|
});
|
|
2301
2310
|
}
|
|
2302
2311
|
|
|
2303
|
-
/** @returns {SlideshowGetResponse} */
|
|
2304
|
-
static SlideshowGetResponse() {
|
|
2305
|
-
return Joi.object({
|
|
2306
|
-
items: Joi.array().items(ContentPlatformModel.SlideshowSchema()),
|
|
2307
|
-
page: ContentPlatformModel.Page(),
|
|
2308
|
-
});
|
|
2309
|
-
}
|
|
2310
|
-
|
|
2311
|
-
/** @returns {SlideshowSchema} */
|
|
2312
|
-
static SlideshowSchema() {
|
|
2313
|
-
return Joi.object({
|
|
2314
|
-
_id: Joi.string().allow(""),
|
|
2315
|
-
slug: Joi.string().allow(""),
|
|
2316
|
-
date_meta: ContentPlatformModel.DateMeta(),
|
|
2317
|
-
application: Joi.string().allow(""),
|
|
2318
|
-
platform: Joi.string().allow(""),
|
|
2319
|
-
configuration: ContentPlatformModel.ConfigurationSchema(),
|
|
2320
|
-
media: Joi.array().items(ContentPlatformModel.SlideshowMedia()),
|
|
2321
|
-
active: Joi.boolean(),
|
|
2322
|
-
archived: Joi.boolean(),
|
|
2323
|
-
_custom_json: Joi.any(),
|
|
2324
|
-
});
|
|
2325
|
-
}
|
|
2326
|
-
|
|
2327
|
-
/** @returns {SlideshowRequest} */
|
|
2328
|
-
static SlideshowRequest() {
|
|
2329
|
-
return Joi.object({
|
|
2330
|
-
slug: Joi.string().allow(""),
|
|
2331
|
-
platform: Joi.string().allow(""),
|
|
2332
|
-
configuration: ContentPlatformModel.ConfigurationSchema(),
|
|
2333
|
-
media: ContentPlatformModel.SlideshowMedia(),
|
|
2334
|
-
active: Joi.boolean(),
|
|
2335
|
-
});
|
|
2336
|
-
}
|
|
2337
|
-
|
|
2338
2312
|
/** @returns {Support} */
|
|
2339
2313
|
static Support() {
|
|
2340
2314
|
return Joi.object({
|
|
@@ -2407,7 +2381,7 @@ class ContentPlatformModel {
|
|
|
2407
2381
|
sub_type: Joi.string().allow(""),
|
|
2408
2382
|
_id: Joi.string().allow(""),
|
|
2409
2383
|
position: Joi.string().allow(""),
|
|
2410
|
-
attributes: Joi.any(),
|
|
2384
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2411
2385
|
content: Joi.string().allow(""),
|
|
2412
2386
|
pages: Joi.array().items(Joi.any()),
|
|
2413
2387
|
__source: ContentPlatformModel.TagSourceSchema(),
|
|
@@ -2450,23 +2424,18 @@ class ContentPlatformModel {
|
|
|
2450
2424
|
/** @returns {FieldDefinitionSchema} */
|
|
2451
2425
|
static FieldDefinitionSchema() {
|
|
2452
2426
|
return Joi.object({
|
|
2453
|
-
|
|
2454
|
-
creator: Joi.string().allow(""),
|
|
2427
|
+
id: Joi.string().allow(""),
|
|
2455
2428
|
resource: Joi.string().allow(""),
|
|
2456
2429
|
name: Joi.string().allow(""),
|
|
2457
2430
|
namespace: Joi.string().allow(""),
|
|
2458
|
-
|
|
2431
|
+
slug: Joi.string().allow(""),
|
|
2459
2432
|
description: Joi.string().allow(""),
|
|
2460
2433
|
type: Joi.string().allow(""),
|
|
2461
2434
|
multi_value: Joi.boolean(),
|
|
2462
2435
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2463
2436
|
company_id: Joi.string().allow(""),
|
|
2464
|
-
created_by: Joi.string().allow(""),
|
|
2465
|
-
updated_by: Joi.string().allow(""),
|
|
2466
2437
|
required: Joi.boolean(),
|
|
2467
2438
|
is_deleted: Joi.boolean(),
|
|
2468
|
-
created_at: Joi.string().allow(""),
|
|
2469
|
-
updated_at: Joi.string().allow(""),
|
|
2470
2439
|
type_name: Joi.string().allow(""),
|
|
2471
2440
|
invalid_fields_count: Joi.number(),
|
|
2472
2441
|
});
|
|
@@ -2483,9 +2452,8 @@ class ContentPlatformModel {
|
|
|
2483
2452
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2484
2453
|
static CustomFieldDefinitionRequestSchema() {
|
|
2485
2454
|
return Joi.object({
|
|
2486
|
-
resource: Joi.string().allow(""),
|
|
2487
2455
|
type: Joi.string().allow(""),
|
|
2488
|
-
|
|
2456
|
+
slug: Joi.string().allow(""),
|
|
2489
2457
|
namespace: Joi.string().allow(""),
|
|
2490
2458
|
multi_value: Joi.boolean(),
|
|
2491
2459
|
name: Joi.string().allow(""),
|
|
@@ -2503,7 +2471,7 @@ class ContentPlatformModel {
|
|
|
2503
2471
|
name: Joi.string().allow(""),
|
|
2504
2472
|
multi_value: Joi.boolean(),
|
|
2505
2473
|
required: Joi.boolean(),
|
|
2506
|
-
|
|
2474
|
+
slug: Joi.string().allow(""),
|
|
2507
2475
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2508
2476
|
action: Joi.string().allow(""),
|
|
2509
2477
|
});
|
|
@@ -2512,7 +2480,6 @@ class ContentPlatformModel {
|
|
|
2512
2480
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2513
2481
|
static CustomObjectDefinitionUpdateRequestSchema() {
|
|
2514
2482
|
return Joi.object({
|
|
2515
|
-
type: Joi.string().allow(""),
|
|
2516
2483
|
description: Joi.string().allow(""),
|
|
2517
2484
|
name: Joi.string().allow(""),
|
|
2518
2485
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2525,21 +2492,39 @@ class ContentPlatformModel {
|
|
|
2525
2492
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2526
2493
|
static CustomFieldDefinitionDetailResSchema() {
|
|
2527
2494
|
return Joi.object({
|
|
2528
|
-
creator: Joi.string().allow(""),
|
|
2529
2495
|
resource: Joi.string().allow(""),
|
|
2530
2496
|
name: Joi.string().allow(""),
|
|
2531
2497
|
namespace: Joi.string().allow(""),
|
|
2532
|
-
|
|
2498
|
+
slug: Joi.string().allow(""),
|
|
2533
2499
|
description: Joi.string().allow(""),
|
|
2534
2500
|
type: Joi.string().allow(""),
|
|
2535
2501
|
multi_value: Joi.boolean(),
|
|
2536
2502
|
company_id: Joi.string().allow(""),
|
|
2537
2503
|
application_id: Joi.string().allow(""),
|
|
2538
|
-
created_by: Joi.string().allow(""),
|
|
2539
|
-
updated_by: Joi.string().allow(""),
|
|
2540
2504
|
required: Joi.boolean(),
|
|
2541
2505
|
is_deleted: Joi.boolean(),
|
|
2542
|
-
|
|
2506
|
+
id: Joi.string().allow(""),
|
|
2507
|
+
validations: Joi.array().items(Joi.any()),
|
|
2508
|
+
created_at: Joi.string().allow(""),
|
|
2509
|
+
updated_at: Joi.string().allow(""),
|
|
2510
|
+
});
|
|
2511
|
+
}
|
|
2512
|
+
|
|
2513
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
2514
|
+
static MetaFieldDefinitionDetailResSchema() {
|
|
2515
|
+
return Joi.object({
|
|
2516
|
+
resource: Joi.string().allow(""),
|
|
2517
|
+
name: Joi.string().allow(""),
|
|
2518
|
+
namespace: Joi.string().allow(""),
|
|
2519
|
+
slug: Joi.string().allow(""),
|
|
2520
|
+
description: Joi.string().allow(""),
|
|
2521
|
+
type: Joi.string().allow(""),
|
|
2522
|
+
multi_value: Joi.boolean(),
|
|
2523
|
+
company_id: Joi.string().allow(""),
|
|
2524
|
+
application_id: Joi.string().allow(""),
|
|
2525
|
+
required: Joi.boolean(),
|
|
2526
|
+
is_deleted: Joi.boolean(),
|
|
2527
|
+
id: Joi.string().allow(""),
|
|
2543
2528
|
validations: Joi.array().items(Joi.any()),
|
|
2544
2529
|
created_at: Joi.string().allow(""),
|
|
2545
2530
|
updated_at: Joi.string().allow(""),
|
|
@@ -2564,20 +2549,17 @@ class ContentPlatformModel {
|
|
|
2564
2549
|
/** @returns {CustomFieldSchema} */
|
|
2565
2550
|
static CustomFieldSchema() {
|
|
2566
2551
|
return Joi.object({
|
|
2567
|
-
|
|
2552
|
+
id: Joi.string().allow(""),
|
|
2568
2553
|
namespace: Joi.string().allow(""),
|
|
2569
|
-
|
|
2554
|
+
slug: Joi.string().allow(""),
|
|
2570
2555
|
resource: Joi.string().allow(""),
|
|
2571
|
-
creator: Joi.string().allow(""),
|
|
2572
2556
|
value: Joi.array().items(ContentPlatformModel.CustomFieldValue()),
|
|
2573
|
-
|
|
2557
|
+
resource_slug: Joi.string().allow(""),
|
|
2574
2558
|
type: Joi.string().allow(""),
|
|
2575
2559
|
multi_value: Joi.boolean(),
|
|
2576
2560
|
company_id: Joi.string().allow(""),
|
|
2577
|
-
definition_id: Joi.string().allow(""),
|
|
2578
2561
|
has_invalid_values: Joi.boolean(),
|
|
2579
2562
|
invalid_value_errors: Joi.array().items(Joi.any()),
|
|
2580
|
-
created_by: Joi.string().allow(""),
|
|
2581
2563
|
is_deleted: Joi.boolean(),
|
|
2582
2564
|
created_at: Joi.string().allow(""),
|
|
2583
2565
|
updated_at: Joi.string().allow(""),
|
|
@@ -2592,6 +2574,14 @@ class ContentPlatformModel {
|
|
|
2592
2574
|
});
|
|
2593
2575
|
}
|
|
2594
2576
|
|
|
2577
|
+
/** @returns {CustomFieldsDeleteSchema} */
|
|
2578
|
+
static CustomFieldsDeleteSchema() {
|
|
2579
|
+
return Joi.object({
|
|
2580
|
+
success: Joi.boolean(),
|
|
2581
|
+
message: Joi.string().allow(""),
|
|
2582
|
+
});
|
|
2583
|
+
}
|
|
2584
|
+
|
|
2595
2585
|
/** @returns {CustomFieldsResponseByResourceIdSchema} */
|
|
2596
2586
|
static CustomFieldsResponseByResourceIdSchema() {
|
|
2597
2587
|
return Joi.object({
|
|
@@ -2603,7 +2593,8 @@ class ContentPlatformModel {
|
|
|
2603
2593
|
static CustomField() {
|
|
2604
2594
|
return Joi.object({
|
|
2605
2595
|
value: Joi.array().items(Joi.any()),
|
|
2606
|
-
|
|
2596
|
+
namespace: Joi.string().allow(""),
|
|
2597
|
+
slug: Joi.string().allow(""),
|
|
2607
2598
|
});
|
|
2608
2599
|
}
|
|
2609
2600
|
|
|
@@ -2617,16 +2608,13 @@ class ContentPlatformModel {
|
|
|
2617
2608
|
/** @returns {CustomObjectSchema} */
|
|
2618
2609
|
static CustomObjectSchema() {
|
|
2619
2610
|
return Joi.object({
|
|
2620
|
-
|
|
2621
|
-
creator: Joi.string().allow(""),
|
|
2611
|
+
id: Joi.string().allow(""),
|
|
2622
2612
|
company_id: Joi.string().allow(""),
|
|
2623
2613
|
application_id: Joi.string().allow(""),
|
|
2624
|
-
created_by: Joi.string().allow(""),
|
|
2625
|
-
updated_by: Joi.string().allow(""),
|
|
2626
2614
|
status: Joi.string().allow(""),
|
|
2627
2615
|
type: Joi.string().allow(""),
|
|
2616
|
+
definition_slug: Joi.string().allow(""),
|
|
2628
2617
|
display_name: Joi.string().allow(""),
|
|
2629
|
-
definition_id: Joi.string().allow(""),
|
|
2630
2618
|
fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
|
|
2631
2619
|
});
|
|
2632
2620
|
}
|
|
@@ -2635,6 +2623,7 @@ class ContentPlatformModel {
|
|
|
2635
2623
|
static CustomObjectDefinitionRequestSchema() {
|
|
2636
2624
|
return Joi.object({
|
|
2637
2625
|
type: Joi.string().allow(""),
|
|
2626
|
+
definition_slug: Joi.string().allow(""),
|
|
2638
2627
|
description: Joi.string().allow(""),
|
|
2639
2628
|
name: Joi.string().allow(""),
|
|
2640
2629
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2644,42 +2633,17 @@ class ContentPlatformModel {
|
|
|
2644
2633
|
});
|
|
2645
2634
|
}
|
|
2646
2635
|
|
|
2647
|
-
/** @returns {
|
|
2648
|
-
static
|
|
2649
|
-
return Joi.object({
|
|
2650
|
-
creator: Joi.string().allow(""),
|
|
2651
|
-
resource: Joi.string().allow(""),
|
|
2652
|
-
name: Joi.string().allow(""),
|
|
2653
|
-
namespace: Joi.string().allow(""),
|
|
2654
|
-
key: Joi.string().allow(""),
|
|
2655
|
-
description: Joi.string().allow(""),
|
|
2656
|
-
type: Joi.string().allow(""),
|
|
2657
|
-
multi_value: Joi.boolean(),
|
|
2658
|
-
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2659
|
-
company_id: Joi.string().allow(""),
|
|
2660
|
-
created_by: Joi.string().allow(""),
|
|
2661
|
-
metaobject_definition_id: Joi.string().allow(""),
|
|
2662
|
-
required: Joi.boolean(),
|
|
2663
|
-
is_deleted: Joi.boolean(),
|
|
2664
|
-
_id: Joi.string().allow(""),
|
|
2665
|
-
created_at: Joi.string().allow(""),
|
|
2666
|
-
updated_at: Joi.string().allow(""),
|
|
2667
|
-
});
|
|
2668
|
-
}
|
|
2669
|
-
|
|
2670
|
-
/** @returns {CustomObjectDefinitionSchema} */
|
|
2671
|
-
static CustomObjectDefinitionSchema() {
|
|
2636
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
2637
|
+
static CustomObjectDefinitionSlugSchema() {
|
|
2672
2638
|
return Joi.object({
|
|
2673
|
-
|
|
2639
|
+
id: Joi.string().allow(""),
|
|
2674
2640
|
name: Joi.string().allow(""),
|
|
2675
2641
|
type: Joi.string().allow(""),
|
|
2642
|
+
definition_slug: Joi.string().allow(""),
|
|
2676
2643
|
display_name_key: Joi.string().allow(""),
|
|
2677
2644
|
description: Joi.string().allow(""),
|
|
2678
|
-
creator: Joi.string().allow(""),
|
|
2679
|
-
created_by: Joi.string().allow(""),
|
|
2680
|
-
updated_by: Joi.string().allow(""),
|
|
2681
2645
|
field_definitions: Joi.array().items(
|
|
2682
|
-
ContentPlatformModel.
|
|
2646
|
+
ContentPlatformModel.CustomFieldDefinitionDetailResSchema()
|
|
2683
2647
|
),
|
|
2684
2648
|
});
|
|
2685
2649
|
}
|
|
@@ -2692,18 +2656,18 @@ class ContentPlatformModel {
|
|
|
2692
2656
|
});
|
|
2693
2657
|
}
|
|
2694
2658
|
|
|
2695
|
-
/** @returns {
|
|
2696
|
-
static
|
|
2659
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
2660
|
+
static CustomObjectEntryBulkUploadDetails() {
|
|
2697
2661
|
return Joi.object({
|
|
2698
2662
|
url: Joi.string().allow(""),
|
|
2699
2663
|
total_records: Joi.number(),
|
|
2700
2664
|
});
|
|
2701
2665
|
}
|
|
2702
2666
|
|
|
2703
|
-
/** @returns {
|
|
2704
|
-
static
|
|
2667
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
2668
|
+
static CustomObjectListItemDefinitionModel() {
|
|
2705
2669
|
return Joi.object({
|
|
2706
|
-
|
|
2670
|
+
id: Joi.string().allow(""),
|
|
2707
2671
|
name: Joi.string().allow(""),
|
|
2708
2672
|
type: Joi.string().allow(""),
|
|
2709
2673
|
});
|
|
@@ -2712,12 +2676,12 @@ class ContentPlatformModel {
|
|
|
2712
2676
|
/** @returns {CustomObjectListItemSchema} */
|
|
2713
2677
|
static CustomObjectListItemSchema() {
|
|
2714
2678
|
return Joi.object({
|
|
2715
|
-
|
|
2716
|
-
definition_id: Joi.string().allow(""),
|
|
2679
|
+
id: Joi.string().allow(""),
|
|
2717
2680
|
status: Joi.string().allow(""),
|
|
2681
|
+
created_at: Joi.string().allow(""),
|
|
2718
2682
|
updated_at: Joi.string().allow(""),
|
|
2719
2683
|
display_name: Joi.string().allow(""),
|
|
2720
|
-
definition: ContentPlatformModel.
|
|
2684
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
2721
2685
|
references: Joi.number(),
|
|
2722
2686
|
});
|
|
2723
2687
|
}
|
|
@@ -2732,26 +2696,30 @@ class ContentPlatformModel {
|
|
|
2732
2696
|
});
|
|
2733
2697
|
}
|
|
2734
2698
|
|
|
2735
|
-
/** @returns {
|
|
2736
|
-
static
|
|
2699
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
2700
|
+
static CustomObjectFieldDefinition() {
|
|
2737
2701
|
return Joi.object({
|
|
2738
|
-
|
|
2739
|
-
|
|
2702
|
+
id: Joi.string().allow(""),
|
|
2703
|
+
slug: Joi.string().allow(""),
|
|
2704
|
+
namespace: Joi.string().allow(""),
|
|
2740
2705
|
value: Joi.array().items(Joi.any()),
|
|
2741
2706
|
type: Joi.string().allow(""),
|
|
2742
|
-
definition_id: Joi.string().allow(""),
|
|
2743
2707
|
});
|
|
2744
2708
|
}
|
|
2745
2709
|
|
|
2746
|
-
/** @returns {
|
|
2747
|
-
static
|
|
2710
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
2711
|
+
static CustomObjectBySlugSchema() {
|
|
2748
2712
|
return Joi.object({
|
|
2749
|
-
|
|
2713
|
+
id: Joi.string().allow(""),
|
|
2750
2714
|
status: Joi.string().allow(""),
|
|
2751
2715
|
display_name: Joi.string().allow(""),
|
|
2752
|
-
definition: ContentPlatformModel.
|
|
2716
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
2753
2717
|
references: Joi.array().items(Joi.any()),
|
|
2754
|
-
|
|
2718
|
+
slug: Joi.string().allow(""),
|
|
2719
|
+
definition_slug: Joi.string().allow(""),
|
|
2720
|
+
fields: Joi.array().items(
|
|
2721
|
+
ContentPlatformModel.CustomObjectFieldDefinition()
|
|
2722
|
+
),
|
|
2755
2723
|
});
|
|
2756
2724
|
}
|
|
2757
2725
|
|
|
@@ -2773,17 +2741,15 @@ class ContentPlatformModel {
|
|
|
2773
2741
|
});
|
|
2774
2742
|
}
|
|
2775
2743
|
|
|
2776
|
-
/** @returns {
|
|
2777
|
-
static
|
|
2744
|
+
/** @returns {JobSchema} */
|
|
2745
|
+
static JobSchema() {
|
|
2778
2746
|
return Joi.object({
|
|
2779
|
-
|
|
2747
|
+
id: Joi.string().allow(""),
|
|
2780
2748
|
jobs: Joi.array().items(Joi.string().allow("")),
|
|
2781
2749
|
finished_jobs: Joi.array().items(Joi.string().allow("")),
|
|
2782
2750
|
error_jobs: Joi.array().items(Joi.string().allow("")),
|
|
2783
2751
|
errors_occured: Joi.array().items(Joi.string().allow("")),
|
|
2784
2752
|
company_id: Joi.string().allow(""),
|
|
2785
|
-
creator: Joi.string().allow(""),
|
|
2786
|
-
url: Joi.string().allow(""),
|
|
2787
2753
|
status: Joi.string().allow(""),
|
|
2788
2754
|
action_type: Joi.string().allow(""),
|
|
2789
2755
|
entity: Joi.string().allow(""),
|
|
@@ -2796,17 +2762,33 @@ class ContentPlatformModel {
|
|
|
2796
2762
|
created_by: Joi.string().allow(""),
|
|
2797
2763
|
created_at: Joi.string().allow(""),
|
|
2798
2764
|
updated_at: Joi.string().allow(""),
|
|
2765
|
+
application_id: Joi.string().allow(""),
|
|
2766
|
+
});
|
|
2767
|
+
}
|
|
2768
|
+
|
|
2769
|
+
/** @returns {CustomFieldBulkEntry} */
|
|
2770
|
+
static CustomFieldBulkEntry() {
|
|
2771
|
+
return Joi.object({
|
|
2772
|
+
items: Joi.array().items(ContentPlatformModel.JobSchema()),
|
|
2773
|
+
page: ContentPlatformModel.Page(),
|
|
2799
2774
|
});
|
|
2800
2775
|
}
|
|
2801
2776
|
|
|
2802
2777
|
/** @returns {CustomObjectBulkEntry} */
|
|
2803
2778
|
static CustomObjectBulkEntry() {
|
|
2804
2779
|
return Joi.object({
|
|
2805
|
-
items: Joi.array().items(ContentPlatformModel.
|
|
2780
|
+
items: Joi.array().items(ContentPlatformModel.JobSchema()),
|
|
2806
2781
|
page: ContentPlatformModel.Page(),
|
|
2807
2782
|
});
|
|
2808
2783
|
}
|
|
2809
2784
|
|
|
2785
|
+
/** @returns {MetafieldTypesSchema} */
|
|
2786
|
+
static MetafieldTypesSchema() {
|
|
2787
|
+
return Joi.object({
|
|
2788
|
+
metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
|
|
2789
|
+
});
|
|
2790
|
+
}
|
|
2791
|
+
|
|
2810
2792
|
/** @returns {CustomFieldTypeSchema} */
|
|
2811
2793
|
static CustomFieldTypeSchema() {
|
|
2812
2794
|
return Joi.object({
|
|
@@ -2823,6 +2805,8 @@ class ContentPlatformModel {
|
|
|
2823
2805
|
url: ContentPlatformModel.Url(),
|
|
2824
2806
|
metaobject: ContentPlatformModel.Metaobject(),
|
|
2825
2807
|
product: ContentPlatformModel.Product(),
|
|
2808
|
+
html: ContentPlatformModel.HTML(),
|
|
2809
|
+
duration: ContentPlatformModel.Duration(),
|
|
2826
2810
|
});
|
|
2827
2811
|
}
|
|
2828
2812
|
|
|
@@ -2854,6 +2838,31 @@ class ContentPlatformModel {
|
|
|
2854
2838
|
});
|
|
2855
2839
|
}
|
|
2856
2840
|
|
|
2841
|
+
/** @returns {Duration} */
|
|
2842
|
+
static Duration() {
|
|
2843
|
+
return Joi.object({
|
|
2844
|
+
name: Joi.string().allow(""),
|
|
2845
|
+
list_enabled: Joi.boolean(),
|
|
2846
|
+
type: Joi.string().allow(""),
|
|
2847
|
+
category: Joi.string().allow(""),
|
|
2848
|
+
supported_validations: Joi.array().items(
|
|
2849
|
+
ContentPlatformModel.SupportedValidationsSchema()
|
|
2850
|
+
),
|
|
2851
|
+
});
|
|
2852
|
+
}
|
|
2853
|
+
|
|
2854
|
+
/** @returns {HTML} */
|
|
2855
|
+
static HTML() {
|
|
2856
|
+
return Joi.object({
|
|
2857
|
+
name: Joi.string().allow(""),
|
|
2858
|
+
list_enabled: Joi.boolean(),
|
|
2859
|
+
type: Joi.string().allow(""),
|
|
2860
|
+
supported_validations: Joi.array().items(
|
|
2861
|
+
ContentPlatformModel.SupportedValidationsSchema()
|
|
2862
|
+
),
|
|
2863
|
+
});
|
|
2864
|
+
}
|
|
2865
|
+
|
|
2857
2866
|
/** @returns {StringSingleLine} */
|
|
2858
2867
|
static StringSingleLine() {
|
|
2859
2868
|
return Joi.object({
|
|
@@ -3025,7 +3034,7 @@ class ContentPlatformModel {
|
|
|
3025
3034
|
/** @returns {CustomObjectEntry} */
|
|
3026
3035
|
static CustomObjectEntry() {
|
|
3027
3036
|
return Joi.object({
|
|
3028
|
-
|
|
3037
|
+
id: Joi.string().allow(""),
|
|
3029
3038
|
name: Joi.string().allow(""),
|
|
3030
3039
|
type: Joi.string().allow(""),
|
|
3031
3040
|
updated_at: Joi.string().allow(""),
|
|
@@ -3045,8 +3054,16 @@ class ContentPlatformModel {
|
|
|
3045
3054
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
3046
3055
|
static CustomObjectEntryFieldSchema() {
|
|
3047
3056
|
return Joi.object({
|
|
3048
|
-
|
|
3049
|
-
|
|
3057
|
+
namespace: Joi.string().allow(""),
|
|
3058
|
+
slug: Joi.string().allow(""),
|
|
3059
|
+
});
|
|
3060
|
+
}
|
|
3061
|
+
|
|
3062
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3063
|
+
static CustomObjectEntryFieldSchemaWithoutID() {
|
|
3064
|
+
return Joi.object({
|
|
3065
|
+
slug: Joi.string().allow(""),
|
|
3066
|
+
value: Joi.any(),
|
|
3050
3067
|
});
|
|
3051
3068
|
}
|
|
3052
3069
|
|
|
@@ -3054,13 +3071,23 @@ class ContentPlatformModel {
|
|
|
3054
3071
|
static CustomObjectRequestSchema() {
|
|
3055
3072
|
return Joi.object({
|
|
3056
3073
|
status: Joi.string().allow(""),
|
|
3057
|
-
|
|
3074
|
+
slug: Joi.string().allow(""),
|
|
3058
3075
|
fields: Joi.array().items(
|
|
3059
3076
|
ContentPlatformModel.CustomObjectEntryFieldSchema()
|
|
3060
3077
|
),
|
|
3061
3078
|
});
|
|
3062
3079
|
}
|
|
3063
3080
|
|
|
3081
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3082
|
+
static CustomObjectRequestSchemaWithoutId() {
|
|
3083
|
+
return Joi.object({
|
|
3084
|
+
status: Joi.string().allow(""),
|
|
3085
|
+
fields: Joi.array().items(
|
|
3086
|
+
ContentPlatformModel.CustomObjectEntryFieldSchemaWithoutID()
|
|
3087
|
+
),
|
|
3088
|
+
});
|
|
3089
|
+
}
|
|
3090
|
+
|
|
3064
3091
|
/** @returns {CustomObjectBulkSchema} */
|
|
3065
3092
|
static CustomObjectBulkSchema() {
|
|
3066
3093
|
return Joi.object({
|