@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -234
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4111 -9093
- package/sdk/platform/Order/OrderPlatformModel.js +3202 -4230
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +22 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +91 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +223 -59
- package/sdk/platform/User/UserPlatformModel.js +204 -65
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +434 -758
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,9 +1,4 @@
|
|
|
1
1
|
export = ContentPlatformModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef ValidationError
|
|
4
|
-
* @property {string} message - A brief description of the error encountered.
|
|
5
|
-
* @property {string} field - The field in the request that caused the error.
|
|
6
|
-
*/
|
|
7
2
|
/**
|
|
8
3
|
* @typedef GenerateSEOContent
|
|
9
4
|
* @property {string} [text]
|
|
@@ -27,6 +22,7 @@ export = ContentPlatformModel;
|
|
|
27
22
|
* @property {string} [_id]
|
|
28
23
|
* @property {string} [updated_at]
|
|
29
24
|
* @property {string} [created_at]
|
|
25
|
+
* @property {number} [__v]
|
|
30
26
|
*/
|
|
31
27
|
/**
|
|
32
28
|
* @typedef ApplicationLegalFAQ
|
|
@@ -41,7 +37,7 @@ export = ContentPlatformModel;
|
|
|
41
37
|
* @property {string} [redirect_to]
|
|
42
38
|
* @property {string} [updated_at]
|
|
43
39
|
* @property {string} [created_at]
|
|
44
|
-
* @property {
|
|
40
|
+
* @property {number} [__v]
|
|
45
41
|
*/
|
|
46
42
|
/**
|
|
47
43
|
* @typedef PathSourceSchema
|
|
@@ -54,8 +50,8 @@ export = ContentPlatformModel;
|
|
|
54
50
|
*/
|
|
55
51
|
/**
|
|
56
52
|
* @typedef SeoSchema
|
|
57
|
-
* @property {string} [app]
|
|
58
53
|
* @property {string} [_id]
|
|
54
|
+
* @property {string} [app]
|
|
59
55
|
* @property {string} [robots_txt]
|
|
60
56
|
* @property {boolean} [sitemap_enabled]
|
|
61
57
|
* @property {string} [additional_sitemap]
|
|
@@ -64,6 +60,8 @@ export = ContentPlatformModel;
|
|
|
64
60
|
* @property {Detail} [details]
|
|
65
61
|
* @property {string} [created_at]
|
|
66
62
|
* @property {string} [updated_at]
|
|
63
|
+
* @property {number} [__v]
|
|
64
|
+
* @property {SEOSitemap} [sitemap]
|
|
67
65
|
*/
|
|
68
66
|
/**
|
|
69
67
|
* @typedef CustomMetaTag
|
|
@@ -84,27 +82,50 @@ export = ContentPlatformModel;
|
|
|
84
82
|
*/
|
|
85
83
|
/**
|
|
86
84
|
* @typedef SEOSchemaMarkupTemplate
|
|
87
|
-
* @property {string} [
|
|
85
|
+
* @property {string} [_id]
|
|
88
86
|
* @property {string} [title]
|
|
89
87
|
* @property {string} [page_type]
|
|
90
88
|
* @property {string} [schema]
|
|
91
89
|
* @property {string} [description]
|
|
92
90
|
* @property {boolean} [active]
|
|
91
|
+
* @property {string} [application]
|
|
93
92
|
* @property {string} [created_at]
|
|
94
93
|
* @property {string} [updated_at]
|
|
95
|
-
* @property {string} [application]
|
|
96
94
|
* @property {Object} [target_json]
|
|
95
|
+
* @property {number} [__v]
|
|
97
96
|
*/
|
|
98
97
|
/**
|
|
99
98
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
100
99
|
* @property {string} [title]
|
|
101
100
|
* @property {string} [page_type]
|
|
102
|
-
* @property {string} [schema]
|
|
103
101
|
* @property {string} [description]
|
|
102
|
+
* @property {string} [schema]
|
|
104
103
|
* @property {Object} [target_json]
|
|
105
104
|
* @property {boolean} [active]
|
|
106
105
|
* @property {string} [created_at]
|
|
107
|
-
|
|
106
|
+
*/
|
|
107
|
+
/**
|
|
108
|
+
* @typedef DeletPathMappingSchema
|
|
109
|
+
* @property {string} [message]
|
|
110
|
+
* @property {PathMappingSchema} [data]
|
|
111
|
+
*/
|
|
112
|
+
/**
|
|
113
|
+
* @typedef CreatePathMappingSchema
|
|
114
|
+
* @property {string} [message]
|
|
115
|
+
* @property {PathMappingSchema} [data]
|
|
116
|
+
*/
|
|
117
|
+
/**
|
|
118
|
+
* @typedef GetAllPathMappingSchema
|
|
119
|
+
* @property {string} [message]
|
|
120
|
+
* @property {GetPathSchema} [data]
|
|
121
|
+
*/
|
|
122
|
+
/**
|
|
123
|
+
* @typedef GetPathSchema
|
|
124
|
+
* @property {PathMappingSchema[]} [docs]
|
|
125
|
+
* @property {number} [page]
|
|
126
|
+
* @property {number} [limit]
|
|
127
|
+
* @property {number} [pages]
|
|
128
|
+
* @property {number} [total]
|
|
108
129
|
*/
|
|
109
130
|
/**
|
|
110
131
|
* @typedef AnnouncementPageSchema
|
|
@@ -145,10 +166,10 @@ export = ContentPlatformModel;
|
|
|
145
166
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
146
167
|
* @property {string} [page_type]
|
|
147
168
|
* @property {string} [schema]
|
|
148
|
-
* @property {Object} [target_json]
|
|
149
169
|
*/
|
|
150
170
|
/**
|
|
151
171
|
* @typedef ScheduleSchema
|
|
172
|
+
* @property {boolean} [published]
|
|
152
173
|
* @property {string} [cron]
|
|
153
174
|
* @property {string} [start]
|
|
154
175
|
* @property {string} [end]
|
|
@@ -161,7 +182,7 @@ export = ContentPlatformModel;
|
|
|
161
182
|
* @property {string} [end]
|
|
162
183
|
*/
|
|
163
184
|
/**
|
|
164
|
-
* @typedef
|
|
185
|
+
* @typedef BlogGetResponse
|
|
165
186
|
* @property {BlogSchema[]} [items]
|
|
166
187
|
* @property {Page} [page]
|
|
167
188
|
* @property {BlogFilters} [filters]
|
|
@@ -205,6 +226,7 @@ export = ContentPlatformModel;
|
|
|
205
226
|
* @property {string} [title]
|
|
206
227
|
* @property {DateMeta} [date_meta]
|
|
207
228
|
* @property {string} [summary]
|
|
229
|
+
* @property {string} [status]
|
|
208
230
|
*/
|
|
209
231
|
/**
|
|
210
232
|
* @typedef SEO
|
|
@@ -213,7 +235,7 @@ export = ContentPlatformModel;
|
|
|
213
235
|
* @property {string} [title]
|
|
214
236
|
* @property {SEOMetaItem[]} [meta_tags]
|
|
215
237
|
* @property {SEOSitemap} [sitemap]
|
|
216
|
-
* @property {SEObreadcrumb[]} [
|
|
238
|
+
* @property {SEObreadcrumb[]} [breadcrumbs]
|
|
217
239
|
* @property {string} [canonical_url]
|
|
218
240
|
*/
|
|
219
241
|
/**
|
|
@@ -246,7 +268,7 @@ export = ContentPlatformModel;
|
|
|
246
268
|
* @property {string} [modified_on]
|
|
247
269
|
*/
|
|
248
270
|
/**
|
|
249
|
-
* @typedef
|
|
271
|
+
* @typedef BlogRequest
|
|
250
272
|
* @property {string} [application]
|
|
251
273
|
* @property {Object} [_custom_json]
|
|
252
274
|
* @property {Author} [author]
|
|
@@ -257,6 +279,7 @@ export = ContentPlatformModel;
|
|
|
257
279
|
* @property {string} [slug]
|
|
258
280
|
* @property {string[]} [tags]
|
|
259
281
|
* @property {string} [title]
|
|
282
|
+
* @property {string} [publish_date]
|
|
260
283
|
* @property {SEO} [seo]
|
|
261
284
|
* @property {string} [summary]
|
|
262
285
|
*/
|
|
@@ -270,6 +293,10 @@ export = ContentPlatformModel;
|
|
|
270
293
|
* @property {string} [message]
|
|
271
294
|
* @property {AdminAnnouncementSchema} [data]
|
|
272
295
|
*/
|
|
296
|
+
/**
|
|
297
|
+
* @typedef DataLoaderItemsResponseSchema
|
|
298
|
+
* @property {DataLoaderResponseSchema[]} [items]
|
|
299
|
+
*/
|
|
273
300
|
/**
|
|
274
301
|
* @typedef DataLoaderResponseSchema
|
|
275
302
|
* @property {string} [application]
|
|
@@ -281,11 +308,15 @@ export = ContentPlatformModel;
|
|
|
281
308
|
* @property {string} [type]
|
|
282
309
|
* @property {string} [url]
|
|
283
310
|
* @property {string} [content]
|
|
311
|
+
* @property {string} [created_at]
|
|
312
|
+
* @property {string} [modified_at]
|
|
313
|
+
* @property {number} [__v]
|
|
314
|
+
* @property {boolean} [is_selected]
|
|
284
315
|
* @property {DataLoaderSourceSchema} [__source]
|
|
285
316
|
*/
|
|
286
317
|
/**
|
|
287
318
|
* @typedef DataLoaderResetResponseSchema
|
|
288
|
-
* @property {boolean} [
|
|
319
|
+
* @property {boolean} [resetted]
|
|
289
320
|
*/
|
|
290
321
|
/**
|
|
291
322
|
* @typedef LocaleLanguage
|
|
@@ -310,13 +341,18 @@ export = ContentPlatformModel;
|
|
|
310
341
|
* @property {LocaleLanguage} [_locale_language]
|
|
311
342
|
* @property {string} [image]
|
|
312
343
|
* @property {string} [type]
|
|
313
|
-
* @property {Action} [action]
|
|
314
344
|
* @property {boolean} [active]
|
|
315
345
|
* @property {string} [display]
|
|
316
346
|
* @property {number} [sort_order]
|
|
317
347
|
* @property {CronBasedScheduleSchema} [schedule]
|
|
318
348
|
* @property {NavigationReference[]} [sub_navigation]
|
|
319
349
|
*/
|
|
350
|
+
/**
|
|
351
|
+
* @typedef AssignmentReference
|
|
352
|
+
* @property {string} [platform]
|
|
353
|
+
* @property {string} [orientation]
|
|
354
|
+
* @property {string} [position]
|
|
355
|
+
*/
|
|
320
356
|
/**
|
|
321
357
|
* @typedef CronBasedScheduleSchema
|
|
322
358
|
* @property {boolean} [enabled]
|
|
@@ -360,26 +396,47 @@ export = ContentPlatformModel;
|
|
|
360
396
|
*/
|
|
361
397
|
/**
|
|
362
398
|
* @typedef DataLoaderSchema
|
|
399
|
+
* @property {string} [_id]
|
|
400
|
+
* @property {string} [url]
|
|
401
|
+
* @property {string} [created_at]
|
|
402
|
+
* @property {string} [modified_at]
|
|
403
|
+
* @property {string} [application]
|
|
404
|
+
* @property {string} [company]
|
|
363
405
|
* @property {string} [name]
|
|
364
406
|
* @property {string} [service]
|
|
365
407
|
* @property {string} [operation_id]
|
|
408
|
+
* @property {boolean} [is_selected]
|
|
366
409
|
* @property {string} [type]
|
|
367
|
-
* @property {string} [url]
|
|
368
|
-
* @property {string} [content]
|
|
369
410
|
* @property {DataLoaderSourceSchema} [__source]
|
|
370
|
-
* @property {string} [_id]
|
|
371
411
|
*/
|
|
372
412
|
/**
|
|
373
413
|
* @typedef DataLoaderSourceSchema
|
|
374
414
|
* @property {string} [type]
|
|
375
415
|
* @property {string} [id]
|
|
376
416
|
*/
|
|
417
|
+
/**
|
|
418
|
+
* @typedef TagSpecSchema
|
|
419
|
+
* @property {string} [name]
|
|
420
|
+
* @property {string} [description]
|
|
421
|
+
*/
|
|
422
|
+
/**
|
|
423
|
+
* @typedef ServerSchema
|
|
424
|
+
* @property {string} [url]
|
|
425
|
+
*/
|
|
426
|
+
/**
|
|
427
|
+
* @typedef DataLoadersApiSpecSchema
|
|
428
|
+
* @property {Object} [info]
|
|
429
|
+
* @property {ServerSchema[]} [servers]
|
|
430
|
+
* @property {TagSpecSchema[]} [tags]
|
|
431
|
+
* @property {string} [openapi]
|
|
432
|
+
* @property {Object} [paths]
|
|
433
|
+
*/
|
|
377
434
|
/**
|
|
378
435
|
* @typedef DataLoadersSchema
|
|
379
436
|
* @property {DataLoaderSchema[]} [items]
|
|
380
437
|
*/
|
|
381
438
|
/**
|
|
382
|
-
* @typedef
|
|
439
|
+
* @typedef TagDeleteSuccessResponse
|
|
383
440
|
* @property {boolean} [success]
|
|
384
441
|
*/
|
|
385
442
|
/**
|
|
@@ -388,7 +445,6 @@ export = ContentPlatformModel;
|
|
|
388
445
|
* @property {number} [status]
|
|
389
446
|
* @property {string} [code]
|
|
390
447
|
* @property {string} [exception]
|
|
391
|
-
* @property {string} [info]
|
|
392
448
|
* @property {string} [request_id]
|
|
393
449
|
* @property {string} [stack_trace]
|
|
394
450
|
* @property {Object} [meta]
|
|
@@ -408,6 +464,7 @@ export = ContentPlatformModel;
|
|
|
408
464
|
* @property {string} [application]
|
|
409
465
|
* @property {string} [icon_url]
|
|
410
466
|
* @property {Object} [_custom_json]
|
|
467
|
+
* @property {number} [__v]
|
|
411
468
|
*/
|
|
412
469
|
/**
|
|
413
470
|
* @typedef ChildrenSchema
|
|
@@ -424,15 +481,15 @@ export = ContentPlatformModel;
|
|
|
424
481
|
*/
|
|
425
482
|
/**
|
|
426
483
|
* @typedef FAQCategorySchema
|
|
427
|
-
* @property {
|
|
484
|
+
* @property {string} [_id]
|
|
485
|
+
* @property {string} [application]
|
|
428
486
|
* @property {string} [title]
|
|
429
487
|
* @property {string} [description]
|
|
430
|
-
* @property {
|
|
431
|
-
* @property {string} [_id]
|
|
488
|
+
* @property {number} [index]
|
|
432
489
|
* @property {string} [slug]
|
|
433
|
-
* @property {
|
|
490
|
+
* @property {ChildrenSchema[]} [children]
|
|
434
491
|
* @property {string} [icon_url]
|
|
435
|
-
* @property {
|
|
492
|
+
* @property {number} [__v]
|
|
436
493
|
*/
|
|
437
494
|
/**
|
|
438
495
|
* @typedef FaqSchema
|
|
@@ -442,6 +499,7 @@ export = ContentPlatformModel;
|
|
|
442
499
|
* @property {string} [question]
|
|
443
500
|
* @property {string} [answer]
|
|
444
501
|
* @property {string[]} [tags]
|
|
502
|
+
* @property {number} [__v]
|
|
445
503
|
*/
|
|
446
504
|
/**
|
|
447
505
|
* @typedef FAQ
|
|
@@ -490,16 +548,16 @@ export = ContentPlatformModel;
|
|
|
490
548
|
* @property {number} [current] - The current page number.
|
|
491
549
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
492
550
|
* @property {number} [size] - The number of items per page.
|
|
551
|
+
* @property {number} [total] - Total number of items.
|
|
493
552
|
*/
|
|
494
553
|
/**
|
|
495
|
-
* @typedef
|
|
554
|
+
* @typedef LandingPageGetResponse
|
|
496
555
|
* @property {LandingPageSchema[]} [items]
|
|
497
556
|
* @property {Page} [page]
|
|
498
557
|
*/
|
|
499
558
|
/**
|
|
500
559
|
* @typedef LandingPageSchema
|
|
501
560
|
* @property {string} [slug]
|
|
502
|
-
* @property {Action} [action]
|
|
503
561
|
* @property {string[]} [platform]
|
|
504
562
|
* @property {CreatedBySchema} [created_by]
|
|
505
563
|
* @property {DateMeta} [date_meta]
|
|
@@ -507,13 +565,14 @@ export = ContentPlatformModel;
|
|
|
507
565
|
* @property {string} [application]
|
|
508
566
|
* @property {boolean} [archived]
|
|
509
567
|
* @property {Object} [_custom_json]
|
|
568
|
+
* @property {number} [__v]
|
|
510
569
|
*/
|
|
511
570
|
/**
|
|
512
|
-
* @typedef
|
|
571
|
+
* @typedef DefaultNavigationResponse
|
|
513
572
|
* @property {NavigationSchema[]} [items]
|
|
514
573
|
*/
|
|
515
574
|
/**
|
|
516
|
-
* @typedef
|
|
575
|
+
* @typedef NavigationGetResponse
|
|
517
576
|
* @property {NavigationSchema[]} [items]
|
|
518
577
|
* @property {Page} [page]
|
|
519
578
|
*/
|
|
@@ -535,17 +594,26 @@ export = ContentPlatformModel;
|
|
|
535
594
|
* @property {Orientation} [orientation]
|
|
536
595
|
* @property {number} [version]
|
|
537
596
|
* @property {NavigationReference[]} [navigation]
|
|
597
|
+
* @property {AssignmentReference[]} [assignments]
|
|
598
|
+
* @property {number} [__v]
|
|
538
599
|
*/
|
|
539
600
|
/**
|
|
540
|
-
* @typedef
|
|
601
|
+
* @typedef NavigationRequest
|
|
541
602
|
* @property {string} [name]
|
|
542
603
|
* @property {string} [slug]
|
|
543
604
|
* @property {string[]} [platform]
|
|
544
605
|
* @property {Orientation} [orientation]
|
|
606
|
+
* @property {NavigationAssignment[]} [assignments]
|
|
545
607
|
* @property {NavigationReference[]} [navigation]
|
|
546
608
|
*/
|
|
547
609
|
/**
|
|
548
|
-
* @typedef
|
|
610
|
+
* @typedef NavigationAssignment
|
|
611
|
+
* @property {string} [platform]
|
|
612
|
+
* @property {string} [orientation]
|
|
613
|
+
* @property {string} [position]
|
|
614
|
+
*/
|
|
615
|
+
/**
|
|
616
|
+
* @typedef PageGetResponse
|
|
549
617
|
* @property {PageSchema[]} [items]
|
|
550
618
|
* @property {Page} [page]
|
|
551
619
|
*/
|
|
@@ -565,44 +633,65 @@ export = ContentPlatformModel;
|
|
|
565
633
|
* @property {PageSpecParam[]} [params]
|
|
566
634
|
* @property {PageSpecParam[]} [query]
|
|
567
635
|
*/
|
|
636
|
+
/**
|
|
637
|
+
* @typedef PageResponseError
|
|
638
|
+
* @property {string} [errors]
|
|
639
|
+
*/
|
|
568
640
|
/**
|
|
569
641
|
* @typedef PageSchema
|
|
570
642
|
* @property {string} [_id]
|
|
571
643
|
* @property {string} [application]
|
|
572
|
-
* @property {string
|
|
573
|
-
*
|
|
574
|
-
* @property {
|
|
644
|
+
* @property {string} [platform]
|
|
645
|
+
* @property {string} [title]
|
|
646
|
+
* @property {string} [slug]
|
|
647
|
+
* @property {string} [type]
|
|
648
|
+
* @property {string[]} [tags]
|
|
575
649
|
* @property {string} [content_path]
|
|
650
|
+
* @property {string} [orientation]
|
|
651
|
+
* @property {string} [description]
|
|
652
|
+
* @property {boolean} [published]
|
|
576
653
|
* @property {CreatedBySchema} [created_by]
|
|
577
654
|
* @property {DateMeta} [date_meta]
|
|
578
|
-
* @property {string} [description]
|
|
579
655
|
* @property {Asset} [feature_image]
|
|
580
|
-
* @property {Object[]} [page_meta]
|
|
581
656
|
* @property {ScheduleSchema} [_schedule]
|
|
582
|
-
* @property {
|
|
583
|
-
* @property {string} [orientation]
|
|
584
|
-
* @property {string} [platform]
|
|
585
|
-
* @property {boolean} [published]
|
|
586
|
-
* @property {string} [slug]
|
|
587
|
-
* @property {string[]} [tags]
|
|
588
|
-
* @property {string} [title]
|
|
589
|
-
* @property {string} [type]
|
|
657
|
+
* @property {PageMeta[]} [page_meta]
|
|
590
658
|
* @property {SEO} [seo]
|
|
591
|
-
* @property {
|
|
659
|
+
* @property {string[]} [component_ids]
|
|
592
660
|
* @property {boolean} [archived]
|
|
661
|
+
* @property {number} [__v]
|
|
662
|
+
* @property {PageContent[]} [content]
|
|
663
|
+
* @property {SanitizedContent[]} [sanitized_content]
|
|
664
|
+
*/
|
|
665
|
+
/**
|
|
666
|
+
* @typedef SanitizedContent
|
|
667
|
+
* @property {string} [type]
|
|
668
|
+
* @property {string} [value]
|
|
669
|
+
*/
|
|
670
|
+
/**
|
|
671
|
+
* @typedef PageMeta
|
|
672
|
+
* @property {string} [key]
|
|
673
|
+
*/
|
|
674
|
+
/**
|
|
675
|
+
* @typedef PageContent
|
|
676
|
+
* @property {string} [type]
|
|
677
|
+
* @property {string} [value]
|
|
593
678
|
*/
|
|
594
679
|
/**
|
|
595
680
|
* @typedef CreatedBySchema
|
|
596
681
|
* @property {string} [id]
|
|
597
682
|
*/
|
|
598
683
|
/**
|
|
599
|
-
* @typedef
|
|
684
|
+
* @typedef PageRequestVisibility
|
|
685
|
+
* @property {boolean} [test]
|
|
686
|
+
*/
|
|
687
|
+
/**
|
|
688
|
+
* @typedef PageRequest
|
|
600
689
|
* @property {CronSchedule} [_schedule]
|
|
601
690
|
* @property {string} [application]
|
|
602
691
|
* @property {Author} [author]
|
|
603
692
|
* @property {Object} [_custom_json]
|
|
604
693
|
* @property {string} [orientation]
|
|
605
|
-
* @property {
|
|
694
|
+
* @property {PageContent[]} [content]
|
|
606
695
|
* @property {Asset} [feature_image]
|
|
607
696
|
* @property {boolean} [published]
|
|
608
697
|
* @property {string} [reading_time]
|
|
@@ -610,6 +699,10 @@ export = ContentPlatformModel;
|
|
|
610
699
|
* @property {string[]} [tags]
|
|
611
700
|
* @property {SEO} [seo]
|
|
612
701
|
* @property {string} [title]
|
|
702
|
+
* @property {string} [platform]
|
|
703
|
+
* @property {string} [type]
|
|
704
|
+
* @property {string} [description]
|
|
705
|
+
* @property {Object} [visibility] - Visibility of Page.
|
|
613
706
|
*/
|
|
614
707
|
/**
|
|
615
708
|
* @typedef CronSchedule
|
|
@@ -617,17 +710,38 @@ export = ContentPlatformModel;
|
|
|
617
710
|
* @property {string} [start]
|
|
618
711
|
* @property {string} [end]
|
|
619
712
|
* @property {number} [duration]
|
|
713
|
+
* @property {NextSchedule[]} [next_schedule]
|
|
620
714
|
*/
|
|
621
715
|
/**
|
|
622
|
-
* @typedef
|
|
716
|
+
* @typedef PagePublishRequest
|
|
623
717
|
* @property {boolean} [publish]
|
|
624
718
|
*/
|
|
625
719
|
/**
|
|
626
720
|
* @typedef PageMetaSchema
|
|
627
|
-
* @property {
|
|
628
|
-
* @property {
|
|
721
|
+
* @property {SystemPages[]} [system_pages]
|
|
722
|
+
* @property {CustomePages[]} [custom_pages]
|
|
629
723
|
* @property {string} [application_id]
|
|
630
724
|
*/
|
|
725
|
+
/**
|
|
726
|
+
* @typedef CustomePages
|
|
727
|
+
* @property {string} [display]
|
|
728
|
+
* @property {string} [slug]
|
|
729
|
+
*/
|
|
730
|
+
/**
|
|
731
|
+
* @typedef SystemPagesActionPage
|
|
732
|
+
* @property {string} [type]
|
|
733
|
+
*/
|
|
734
|
+
/**
|
|
735
|
+
* @typedef SystemPagesAction
|
|
736
|
+
* @property {SystemPagesActionPage} [page]
|
|
737
|
+
* @property {string} [type]
|
|
738
|
+
*/
|
|
739
|
+
/**
|
|
740
|
+
* @typedef SystemPages
|
|
741
|
+
* @property {string} [display]
|
|
742
|
+
* @property {SystemPagesAction} [action]
|
|
743
|
+
* @property {string} [page_type]
|
|
744
|
+
*/
|
|
631
745
|
/**
|
|
632
746
|
* @typedef Support
|
|
633
747
|
* @property {boolean} [created]
|
|
@@ -668,6 +782,8 @@ export = ContentPlatformModel;
|
|
|
668
782
|
* @typedef TagsSchema
|
|
669
783
|
* @property {string} [application]
|
|
670
784
|
* @property {string} [_id]
|
|
785
|
+
* @property {string} [company]
|
|
786
|
+
* @property {number} [__v]
|
|
671
787
|
* @property {TagSchema[]} [tags]
|
|
672
788
|
*/
|
|
673
789
|
/**
|
|
@@ -680,6 +796,7 @@ export = ContentPlatformModel;
|
|
|
680
796
|
* @property {string} [position]
|
|
681
797
|
* @property {Object} [attributes]
|
|
682
798
|
* @property {string} [content]
|
|
799
|
+
* @property {Object[]} [compatible_engines]
|
|
683
800
|
* @property {Object[]} [pages]
|
|
684
801
|
* @property {TagSourceSchema} [__source]
|
|
685
802
|
*/
|
|
@@ -700,129 +817,140 @@ export = ContentPlatformModel;
|
|
|
700
817
|
*/
|
|
701
818
|
/**
|
|
702
819
|
* @typedef FieldValidations
|
|
703
|
-
* @property {string} [name]
|
|
704
|
-
* @property {string} [type]
|
|
705
|
-
|
|
820
|
+
* @property {string} [name]
|
|
821
|
+
* @property {string} [type]
|
|
822
|
+
*/
|
|
823
|
+
/**
|
|
824
|
+
* @typedef ApplicationFieldDefinitionSchema
|
|
825
|
+
* @property {string} [_id]
|
|
826
|
+
* @property {string} [creator]
|
|
827
|
+
* @property {string} [resource]
|
|
828
|
+
* @property {string} [name]
|
|
829
|
+
* @property {string} [namespace]
|
|
830
|
+
* @property {string} [key]
|
|
831
|
+
* @property {string} [description]
|
|
832
|
+
* @property {string} [type]
|
|
833
|
+
* @property {boolean} [multi_value]
|
|
834
|
+
* @property {FieldValidations[]} [validations]
|
|
835
|
+
* @property {string} [company_id]
|
|
836
|
+
* @property {string} [created_by]
|
|
837
|
+
* @property {string} [updated_by]
|
|
838
|
+
* @property {boolean} [required]
|
|
839
|
+
* @property {boolean} [is_deleted]
|
|
840
|
+
* @property {string} [created_at]
|
|
841
|
+
* @property {string} [updated_at]
|
|
842
|
+
* @property {string} [type_name]
|
|
843
|
+
* @property {number} [invalid_fields_count]
|
|
844
|
+
* @property {string} [application_id]
|
|
706
845
|
*/
|
|
707
846
|
/**
|
|
708
847
|
* @typedef FieldDefinitionSchema
|
|
709
|
-
* @property {string} [
|
|
710
|
-
* @property {string} [
|
|
711
|
-
* @property {string} [
|
|
712
|
-
* @property {string} [
|
|
713
|
-
* @property {string} [
|
|
714
|
-
* @property {string} [
|
|
715
|
-
* @property {string} [
|
|
716
|
-
* @property {
|
|
717
|
-
*
|
|
718
|
-
* @property {FieldValidations[]} [validations]
|
|
719
|
-
* @property {string} [company_id]
|
|
720
|
-
* @property {
|
|
721
|
-
* @property {
|
|
722
|
-
* @property {
|
|
723
|
-
* @property {
|
|
848
|
+
* @property {string} [_id]
|
|
849
|
+
* @property {string} [creator]
|
|
850
|
+
* @property {string} [resource]
|
|
851
|
+
* @property {string} [name]
|
|
852
|
+
* @property {string} [namespace]
|
|
853
|
+
* @property {string} [key]
|
|
854
|
+
* @property {string} [description]
|
|
855
|
+
* @property {string} [type]
|
|
856
|
+
* @property {boolean} [multi_value]
|
|
857
|
+
* @property {FieldValidations[]} [validations]
|
|
858
|
+
* @property {string} [company_id]
|
|
859
|
+
* @property {string} [created_by]
|
|
860
|
+
* @property {string} [updated_by]
|
|
861
|
+
* @property {boolean} [required]
|
|
862
|
+
* @property {boolean} [is_deleted]
|
|
863
|
+
* @property {string} [created_at]
|
|
864
|
+
* @property {string} [updated_at]
|
|
865
|
+
* @property {string} [type_name]
|
|
866
|
+
* @property {number} [invalid_fields_count]
|
|
867
|
+
*/
|
|
868
|
+
/**
|
|
869
|
+
* @typedef ApplicationCustomFieldDefinitionsSchema
|
|
870
|
+
* @property {ApplicationFieldDefinitionSchema[]} [items]
|
|
871
|
+
* @property {Page} [page]
|
|
724
872
|
*/
|
|
725
873
|
/**
|
|
726
874
|
* @typedef CustomFieldDefinitionsSchema
|
|
727
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
875
|
+
* @property {FieldDefinitionSchema[]} [items]
|
|
728
876
|
* @property {Page} [page]
|
|
729
877
|
*/
|
|
730
878
|
/**
|
|
731
879
|
* @typedef CustomFieldDefinitionRequestSchema
|
|
732
|
-
* @property {string} [
|
|
733
|
-
* @property {string} [
|
|
734
|
-
* @property {string} [
|
|
735
|
-
* @property {
|
|
736
|
-
*
|
|
737
|
-
* @property {string} [name]
|
|
738
|
-
* @property {string} [description]
|
|
739
|
-
* @property {
|
|
880
|
+
* @property {string} [resource]
|
|
881
|
+
* @property {string} [type]
|
|
882
|
+
* @property {string} [key]
|
|
883
|
+
* @property {string} [namespace]
|
|
884
|
+
* @property {boolean} [multi_value]
|
|
885
|
+
* @property {string} [name]
|
|
886
|
+
* @property {string} [description]
|
|
887
|
+
* @property {string} [creator]
|
|
888
|
+
* @property {FieldValidations[]} [validations]
|
|
740
889
|
*/
|
|
741
890
|
/**
|
|
742
891
|
* @typedef CustomObjectCustomFieldDefinitions
|
|
743
|
-
* @property {string} [
|
|
744
|
-
* @property {string}
|
|
745
|
-
* @property {string} [description]
|
|
746
|
-
* @property {string} [name]
|
|
747
|
-
* @property {boolean} [multi_value]
|
|
748
|
-
*
|
|
749
|
-
* @property {
|
|
750
|
-
* @property {
|
|
751
|
-
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
752
|
-
* custom field
|
|
892
|
+
* @property {string} [_id]
|
|
893
|
+
* @property {string} type
|
|
894
|
+
* @property {string} [description]
|
|
895
|
+
* @property {string} [name]
|
|
896
|
+
* @property {boolean} [multi_value]
|
|
897
|
+
* @property {boolean} [required]
|
|
898
|
+
* @property {string} [key]
|
|
899
|
+
* @property {FieldValidations[]} [validations]
|
|
753
900
|
* @property {string} [action]
|
|
754
901
|
*/
|
|
755
902
|
/**
|
|
756
903
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
757
|
-
* @property {string} [
|
|
758
|
-
* @property {string} [
|
|
759
|
-
* @property {string} [
|
|
760
|
-
*
|
|
761
|
-
* @property {
|
|
904
|
+
* @property {string} [type]
|
|
905
|
+
* @property {string} [description]
|
|
906
|
+
* @property {string} [name]
|
|
907
|
+
* @property {string} [display_name_key]
|
|
908
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions]
|
|
762
909
|
*/
|
|
763
910
|
/**
|
|
764
911
|
* @typedef CustomFieldDefinitionDetailResSchema
|
|
765
|
-
* @property {string} [
|
|
766
|
-
* @property {string} [
|
|
767
|
-
* @property {string} [
|
|
768
|
-
* @property {string} [
|
|
769
|
-
* @property {string} [
|
|
770
|
-
* @property {string} [
|
|
771
|
-
* @property {
|
|
772
|
-
*
|
|
773
|
-
* @property {string} [company_id]
|
|
774
|
-
* @property {string} [application_id]
|
|
775
|
-
* @property {
|
|
776
|
-
* @property {
|
|
777
|
-
* @property {
|
|
778
|
-
* @property {
|
|
779
|
-
* @property {string} [
|
|
780
|
-
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
781
|
-
*/
|
|
782
|
-
/**
|
|
783
|
-
* @typedef MetaFieldDefinitionDetailResSchema
|
|
784
|
-
* @property {string} [resource] - Resource to which meta field is associated
|
|
785
|
-
* @property {string} [name] - Name of meta field
|
|
786
|
-
* @property {string} [namespace] - Namespace of meta field
|
|
787
|
-
* @property {string} [slug] - Slug of meta field
|
|
788
|
-
* @property {string} [description] - Description regarding meta field
|
|
789
|
-
* @property {string} [type] - Data type of meta field
|
|
790
|
-
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
791
|
-
* multi valued or not
|
|
792
|
-
* @property {string} [company_id] - Company Identifer
|
|
793
|
-
* @property {string} [application_id] - Sales channel identifier
|
|
794
|
-
* @property {boolean} [required] - Whether the field is required or not
|
|
795
|
-
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
796
|
-
* @property {string} [id] - Unique system generated id
|
|
912
|
+
* @property {string} [creator]
|
|
913
|
+
* @property {string} [resource]
|
|
914
|
+
* @property {string} [name]
|
|
915
|
+
* @property {string} [namespace]
|
|
916
|
+
* @property {string} [key]
|
|
917
|
+
* @property {string} [description]
|
|
918
|
+
* @property {string} [type]
|
|
919
|
+
* @property {boolean} [multi_value]
|
|
920
|
+
* @property {string} [company_id]
|
|
921
|
+
* @property {string} [application_id]
|
|
922
|
+
* @property {string} [created_by]
|
|
923
|
+
* @property {string} [updated_by]
|
|
924
|
+
* @property {boolean} [required]
|
|
925
|
+
* @property {boolean} [is_deleted]
|
|
926
|
+
* @property {string} [_id]
|
|
797
927
|
* @property {Object[]} [validations]
|
|
798
|
-
* @property {string} [created_at]
|
|
799
|
-
* @property {string} [updated_at]
|
|
928
|
+
* @property {string} [created_at]
|
|
929
|
+
* @property {string} [updated_at]
|
|
800
930
|
*/
|
|
801
931
|
/**
|
|
802
932
|
* @typedef CustomDataDeleteSchema
|
|
803
|
-
* @property {boolean} [success]
|
|
804
|
-
* @property {string} [message]
|
|
805
|
-
*/
|
|
806
|
-
/**
|
|
807
|
-
* @typedef CustomFieldValue
|
|
808
|
-
* @property {Object} [value]
|
|
933
|
+
* @property {boolean} [success]
|
|
934
|
+
* @property {string} [message]
|
|
809
935
|
*/
|
|
810
936
|
/**
|
|
811
937
|
* @typedef CustomFieldSchema
|
|
812
|
-
* @property {string} [
|
|
813
|
-
* @property {string} [namespace]
|
|
814
|
-
* @property {string} [
|
|
815
|
-
* @property {string} [resource]
|
|
816
|
-
* @property {
|
|
817
|
-
* @property {string} [
|
|
818
|
-
* @property {string}
|
|
819
|
-
* @property {boolean} [multi_value]
|
|
820
|
-
* @property {string} [company_id]
|
|
938
|
+
* @property {string} [_id]
|
|
939
|
+
* @property {string} [namespace]
|
|
940
|
+
* @property {string} [key]
|
|
941
|
+
* @property {string} [resource]
|
|
942
|
+
* @property {string} [creator]
|
|
943
|
+
* @property {string} [resource_id]
|
|
944
|
+
* @property {string} type
|
|
945
|
+
* @property {boolean} [multi_value]
|
|
946
|
+
* @property {string} [company_id]
|
|
947
|
+
* @property {string} [definition_id]
|
|
821
948
|
* @property {boolean} [has_invalid_values]
|
|
822
949
|
* @property {Object[]} [invalid_value_errors]
|
|
823
|
-
* @property {
|
|
824
|
-
* @property {
|
|
825
|
-
* @property {string} [
|
|
950
|
+
* @property {string} [created_by]
|
|
951
|
+
* @property {boolean} [is_deleted]
|
|
952
|
+
* @property {string} [created_at]
|
|
953
|
+
* @property {string} [updated_at]
|
|
826
954
|
*/
|
|
827
955
|
/**
|
|
828
956
|
* @typedef CustomFieldsResponseSchema
|
|
@@ -840,10 +968,7 @@ export = ContentPlatformModel;
|
|
|
840
968
|
*/
|
|
841
969
|
/**
|
|
842
970
|
* @typedef CustomField
|
|
843
|
-
* @property {
|
|
844
|
-
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
845
|
-
* @property {string} [slug] - This is the slug of custom field used while
|
|
846
|
-
* creating a custom field definition
|
|
971
|
+
* @property {string} [definition_id]
|
|
847
972
|
*/
|
|
848
973
|
/**
|
|
849
974
|
* @typedef CustomFieldRequestSchema
|
|
@@ -851,125 +976,155 @@ export = ContentPlatformModel;
|
|
|
851
976
|
*/
|
|
852
977
|
/**
|
|
853
978
|
* @typedef CustomObjectSchema
|
|
854
|
-
* @property {string} [
|
|
855
|
-
* @property {string} [
|
|
856
|
-
* @property {string} [
|
|
857
|
-
* @property {string} [
|
|
858
|
-
* @property {string} [
|
|
859
|
-
* @property {string} [
|
|
860
|
-
* @property {string} [
|
|
861
|
-
*
|
|
862
|
-
* @property {
|
|
979
|
+
* @property {string} [_id]
|
|
980
|
+
* @property {string} [creator]
|
|
981
|
+
* @property {string} [company_id]
|
|
982
|
+
* @property {string} [application_id]
|
|
983
|
+
* @property {string} [created_by]
|
|
984
|
+
* @property {string} [updated_by]
|
|
985
|
+
* @property {string} [status]
|
|
986
|
+
* @property {string} [slug]
|
|
987
|
+
* @property {string} [type]
|
|
988
|
+
* @property {string} [display_name]
|
|
989
|
+
* @property {string} [definition_id]
|
|
990
|
+
* @property {boolean} [is_deleted]
|
|
991
|
+
* @property {string} [created_at]
|
|
992
|
+
* @property {string} [updated_at]
|
|
993
|
+
* @property {CustomFieldSchema[]} [fields]
|
|
863
994
|
*/
|
|
864
995
|
/**
|
|
865
996
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
866
|
-
* @property {string} [type]
|
|
867
|
-
* @property {string} [
|
|
868
|
-
* @property {string} [
|
|
869
|
-
* @property {string} [
|
|
870
|
-
* @property {
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
*
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
* @
|
|
877
|
-
* @property {string} [
|
|
878
|
-
* @property {string} [
|
|
879
|
-
* @property {string} [
|
|
880
|
-
* @property {string}
|
|
881
|
-
* @property {
|
|
882
|
-
* @property {
|
|
883
|
-
* @property {
|
|
884
|
-
*
|
|
997
|
+
* @property {string} [type]
|
|
998
|
+
* @property {string} [description]
|
|
999
|
+
* @property {string} [name]
|
|
1000
|
+
* @property {string} [display_name_key]
|
|
1001
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
1002
|
+
*/
|
|
1003
|
+
/**
|
|
1004
|
+
* @typedef CustomObjectCustomFieldDefinitionResSchema
|
|
1005
|
+
* @property {string} [creator]
|
|
1006
|
+
* @property {string} [resource]
|
|
1007
|
+
* @property {string} [name]
|
|
1008
|
+
* @property {string} [namespace]
|
|
1009
|
+
* @property {string} [key]
|
|
1010
|
+
* @property {string} [description]
|
|
1011
|
+
* @property {string} type
|
|
1012
|
+
* @property {boolean} [multi_value]
|
|
1013
|
+
* @property {FieldValidations[]} [validations]
|
|
1014
|
+
* @property {string} [company_id]
|
|
1015
|
+
* @property {string} [created_by]
|
|
1016
|
+
* @property {string} [metaobject_definition_id]
|
|
1017
|
+
* @property {boolean} [required]
|
|
1018
|
+
* @property {boolean} [is_deleted]
|
|
1019
|
+
* @property {string} [_id]
|
|
1020
|
+
* @property {string} [created_at]
|
|
1021
|
+
* @property {string} [updated_at]
|
|
1022
|
+
* @property {string} [application_id]
|
|
1023
|
+
*/
|
|
1024
|
+
/**
|
|
1025
|
+
* @typedef CustomObjectDefinitionSchema
|
|
1026
|
+
* @property {string} [_id]
|
|
1027
|
+
* @property {string} [name]
|
|
1028
|
+
* @property {string} [type]
|
|
1029
|
+
* @property {string} [display_name_key]
|
|
1030
|
+
* @property {string} [description]
|
|
1031
|
+
* @property {string} [creator]
|
|
1032
|
+
* @property {string} [created_by]
|
|
1033
|
+
* @property {string} [updated_by]
|
|
1034
|
+
* @property {string} [application_id]
|
|
1035
|
+
* @property {string} [company_id]
|
|
1036
|
+
* @property {string} [created_at]
|
|
1037
|
+
* @property {string} [updated_at]
|
|
1038
|
+
* @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
|
|
885
1039
|
*/
|
|
886
1040
|
/**
|
|
887
1041
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
888
|
-
* @property {boolean} [success]
|
|
889
|
-
* @property {string} [message]
|
|
890
|
-
* is deleted.
|
|
1042
|
+
* @property {boolean} [success]
|
|
1043
|
+
* @property {string} [message]
|
|
891
1044
|
*/
|
|
892
1045
|
/**
|
|
893
|
-
* @typedef
|
|
894
|
-
* @property {string} [
|
|
895
|
-
* @property {
|
|
1046
|
+
* @typedef CustomObjectEntryBulkUploadResponse
|
|
1047
|
+
* @property {string} [message]
|
|
1048
|
+
* @property {string} [task_id]
|
|
896
1049
|
*/
|
|
897
1050
|
/**
|
|
898
|
-
* @typedef
|
|
899
|
-
* @property {string} [
|
|
900
|
-
* @property {string} [name]
|
|
901
|
-
* @property {string} [type]
|
|
1051
|
+
* @typedef CustomObjectListItemDefinationSchema
|
|
1052
|
+
* @property {string} [_id]
|
|
1053
|
+
* @property {string} [name]
|
|
1054
|
+
* @property {string} [type]
|
|
1055
|
+
* @property {string} [display_name_key]
|
|
902
1056
|
*/
|
|
903
1057
|
/**
|
|
904
1058
|
* @typedef CustomObjectListItemSchema
|
|
905
|
-
* @property {string} [
|
|
906
|
-
* @property {string} [
|
|
907
|
-
* @property {string} [
|
|
908
|
-
* @property {string} [
|
|
909
|
-
* @property {string} [
|
|
910
|
-
* @property {
|
|
911
|
-
* @property {
|
|
1059
|
+
* @property {string} [_id]
|
|
1060
|
+
* @property {string} [definition_id]
|
|
1061
|
+
* @property {string} [status]
|
|
1062
|
+
* @property {string} [slug]
|
|
1063
|
+
* @property {string} [updated_at]
|
|
1064
|
+
* @property {string} [display_name]
|
|
1065
|
+
* @property {CustomObjectListItemDefinationSchema} [definition]
|
|
1066
|
+
* @property {number} [references]
|
|
912
1067
|
*/
|
|
913
1068
|
/**
|
|
914
1069
|
* @typedef CustomObjectsSchema
|
|
915
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
916
|
-
* object entries
|
|
1070
|
+
* @property {CustomObjectListItemSchema[]} [items]
|
|
917
1071
|
* @property {Page} [page]
|
|
918
1072
|
*/
|
|
919
1073
|
/**
|
|
920
|
-
* @typedef
|
|
921
|
-
* @property {string} [
|
|
922
|
-
* @property {string} [
|
|
923
|
-
* @property {string} [
|
|
924
|
-
* @property {
|
|
925
|
-
|
|
1074
|
+
* @typedef CustomObjectFieldSchema
|
|
1075
|
+
* @property {string} [_id]
|
|
1076
|
+
* @property {string} [key]
|
|
1077
|
+
* @property {string} [type]
|
|
1078
|
+
* @property {string} [definition_id]
|
|
1079
|
+
*/
|
|
1080
|
+
/**
|
|
1081
|
+
* @typedef MetafieldTypesSchema
|
|
1082
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
926
1083
|
*/
|
|
927
1084
|
/**
|
|
928
|
-
* @typedef
|
|
929
|
-
* @property {string} [
|
|
930
|
-
* @property {string} [status]
|
|
931
|
-
* @property {string} [
|
|
932
|
-
* @property {
|
|
933
|
-
* @property {
|
|
934
|
-
*
|
|
935
|
-
* @property {
|
|
936
|
-
* @property {string} [definition_slug] - Slug of custom object definition
|
|
937
|
-
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
938
|
-
* inside the custom object
|
|
1085
|
+
* @typedef CustomObjectByIdSchema
|
|
1086
|
+
* @property {string} [_id]
|
|
1087
|
+
* @property {string} [status]
|
|
1088
|
+
* @property {string} [slug]
|
|
1089
|
+
* @property {string} [display_name]
|
|
1090
|
+
* @property {CustomObjectListItemDefinationSchema} [definition]
|
|
1091
|
+
* @property {Object[]} [references]
|
|
1092
|
+
* @property {CustomObjectFieldSchema[]} [fields]
|
|
939
1093
|
*/
|
|
940
1094
|
/**
|
|
941
1095
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
942
|
-
* @property {string} [message]
|
|
943
|
-
* @property {string} [task_id]
|
|
1096
|
+
* @property {string} [message]
|
|
1097
|
+
* @property {string} [task_id]
|
|
944
1098
|
*/
|
|
945
1099
|
/**
|
|
946
1100
|
* @typedef CustomObjectMetaSchema
|
|
947
|
-
* @property {number} [mo_total_count]
|
|
948
|
-
* @property {number} [mo_success_count]
|
|
949
|
-
* @property {number} [mo_error_count]
|
|
950
|
-
* @property {string} [mo_defintion_type]
|
|
1101
|
+
* @property {number} [mo_total_count]
|
|
1102
|
+
* @property {number} [mo_success_count]
|
|
1103
|
+
* @property {number} [mo_error_count]
|
|
1104
|
+
* @property {string} [mo_defintion_type]
|
|
951
1105
|
*/
|
|
952
1106
|
/**
|
|
953
1107
|
* @typedef JobSchema
|
|
954
|
-
* @property {string} [
|
|
955
|
-
* @property {string[]} [jobs]
|
|
956
|
-
* @property {string[]} [finished_jobs]
|
|
957
|
-
* @property {string[]} [error_jobs]
|
|
958
|
-
* @property {string[]} [errors_occured]
|
|
959
|
-
* @property {string} [company_id]
|
|
960
|
-
* @property {string} [
|
|
961
|
-
* @property {string} [
|
|
962
|
-
* @property {string} [
|
|
963
|
-
* @property {string} [
|
|
964
|
-
* @property {
|
|
965
|
-
* @property {number} [
|
|
966
|
-
* @property {number} [
|
|
967
|
-
* @property {number} [
|
|
1108
|
+
* @property {string} [_id]
|
|
1109
|
+
* @property {string[]} [jobs]
|
|
1110
|
+
* @property {string[]} [finished_jobs]
|
|
1111
|
+
* @property {string[]} [error_jobs]
|
|
1112
|
+
* @property {string[]} [errors_occured]
|
|
1113
|
+
* @property {string} [company_id]
|
|
1114
|
+
* @property {string} [creator]
|
|
1115
|
+
* @property {string} [status]
|
|
1116
|
+
* @property {string} [action_type]
|
|
1117
|
+
* @property {string} [entity]
|
|
1118
|
+
* @property {string} [error_url]
|
|
1119
|
+
* @property {number} [finished_count]
|
|
1120
|
+
* @property {number} [error_count]
|
|
1121
|
+
* @property {number} [success_count]
|
|
1122
|
+
* @property {number} [total_jobs]
|
|
968
1123
|
* @property {CustomObjectMetaSchema} [meta]
|
|
969
|
-
* @property {string} [created_by]
|
|
970
|
-
* @property {string} [created_at]
|
|
971
|
-
* @property {string} [updated_at]
|
|
972
|
-
* @property {string} [application_id]
|
|
1124
|
+
* @property {string} [created_by]
|
|
1125
|
+
* @property {string} [created_at]
|
|
1126
|
+
* @property {string} [updated_at]
|
|
1127
|
+
* @property {string} [application_id]
|
|
973
1128
|
*/
|
|
974
1129
|
/**
|
|
975
1130
|
* @typedef CustomFieldBulkEntry
|
|
@@ -981,10 +1136,6 @@ export = ContentPlatformModel;
|
|
|
981
1136
|
* @property {JobSchema[]} [items]
|
|
982
1137
|
* @property {Page} [page]
|
|
983
1138
|
*/
|
|
984
|
-
/**
|
|
985
|
-
* @typedef MetafieldTypesSchema
|
|
986
|
-
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
987
|
-
*/
|
|
988
1139
|
/**
|
|
989
1140
|
* @typedef CustomFieldTypeSchema
|
|
990
1141
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1003,166 +1154,140 @@ export = ContentPlatformModel;
|
|
|
1003
1154
|
* @property {HTML} [html]
|
|
1004
1155
|
* @property {Duration} [duration]
|
|
1005
1156
|
*/
|
|
1006
|
-
/**
|
|
1007
|
-
* @typedef SupportedValidationsMetaExampleSchema
|
|
1008
|
-
* @property {string} [name]
|
|
1009
|
-
* @property {string} [value]
|
|
1010
|
-
*/
|
|
1011
|
-
/**
|
|
1012
|
-
* @typedef SupportedValidationsMetaSchema
|
|
1013
|
-
* @property {SupportedValidationsMetaExampleSchema[]} [examples]
|
|
1014
|
-
*/
|
|
1015
1157
|
/**
|
|
1016
1158
|
* @typedef SupportedValidationsSchema
|
|
1017
1159
|
* @property {string} [name]
|
|
1018
1160
|
* @property {string} [type]
|
|
1019
1161
|
* @property {string} [display]
|
|
1020
1162
|
* @property {boolean} [required]
|
|
1021
|
-
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1022
1163
|
*/
|
|
1023
1164
|
/**
|
|
1024
1165
|
* @typedef Duration
|
|
1025
|
-
* @property {string} [name]
|
|
1026
|
-
* @property {boolean} [list_enabled]
|
|
1027
|
-
* @property {string} [type]
|
|
1028
|
-
* @property {string} [category]
|
|
1029
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1030
|
-
* validations available for the field
|
|
1166
|
+
* @property {string} [name]
|
|
1167
|
+
* @property {boolean} [list_enabled]
|
|
1168
|
+
* @property {string} [type]
|
|
1169
|
+
* @property {string} [category]
|
|
1170
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1031
1171
|
*/
|
|
1032
1172
|
/**
|
|
1033
1173
|
* @typedef HTML
|
|
1034
|
-
* @property {string} [name]
|
|
1035
|
-
* @property {boolean} [list_enabled]
|
|
1036
|
-
* @property {string} [type]
|
|
1037
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1038
|
-
* validations available for the field
|
|
1174
|
+
* @property {string} [name]
|
|
1175
|
+
* @property {boolean} [list_enabled]
|
|
1176
|
+
* @property {string} [type]
|
|
1177
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1039
1178
|
*/
|
|
1040
1179
|
/**
|
|
1041
1180
|
* @typedef StringSingleLine
|
|
1042
|
-
* @property {string} [name]
|
|
1043
|
-
* @property {boolean} [list_enabled]
|
|
1044
|
-
* @property {string} [category]
|
|
1045
|
-
* @property {string} [type]
|
|
1046
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
/**
|
|
1181
|
+
* @property {string} [name]
|
|
1182
|
+
* @property {boolean} [list_enabled]
|
|
1183
|
+
* @property {string} [category]
|
|
1184
|
+
* @property {string} [type]
|
|
1185
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1186
|
+
*/
|
|
1187
|
+
/**
|
|
1050
1188
|
* @typedef StringMultiLine
|
|
1051
|
-
* @property {string} [name]
|
|
1052
|
-
* @property {boolean} [list_enabled]
|
|
1053
|
-
* @property {string} [category]
|
|
1054
|
-
* @property {string} [type]
|
|
1055
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1056
|
-
* validations available for the field
|
|
1189
|
+
* @property {string} [name]
|
|
1190
|
+
* @property {boolean} [list_enabled]
|
|
1191
|
+
* @property {string} [category]
|
|
1192
|
+
* @property {string} [type]
|
|
1193
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1057
1194
|
*/
|
|
1058
1195
|
/**
|
|
1059
1196
|
* @typedef Dropdown
|
|
1060
|
-
* @property {string} [name]
|
|
1061
|
-
* @property {boolean} [list_enabled]
|
|
1062
|
-
* @property {string} [category]
|
|
1063
|
-
* @property {string} [type]
|
|
1064
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1065
|
-
* validations available for the field
|
|
1197
|
+
* @property {string} [name]
|
|
1198
|
+
* @property {boolean} [list_enabled]
|
|
1199
|
+
* @property {string} [category]
|
|
1200
|
+
* @property {string} [type]
|
|
1201
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1066
1202
|
*/
|
|
1067
1203
|
/**
|
|
1068
1204
|
* @typedef Integer
|
|
1069
|
-
* @property {string} [name]
|
|
1070
|
-
* @property {boolean} [list_enabled]
|
|
1071
|
-
* @property {string} [type]
|
|
1072
|
-
* @property {string} [category]
|
|
1073
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1074
|
-
* validations available for the field
|
|
1205
|
+
* @property {string} [name]
|
|
1206
|
+
* @property {boolean} [list_enabled]
|
|
1207
|
+
* @property {string} [type]
|
|
1208
|
+
* @property {string} [category]
|
|
1209
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1075
1210
|
*/
|
|
1076
1211
|
/**
|
|
1077
1212
|
* @typedef FloatType
|
|
1078
|
-
* @property {string} [name]
|
|
1079
|
-
* @property {boolean} [list_enabled]
|
|
1080
|
-
* @property {string} [type]
|
|
1081
|
-
* @property {string} [category]
|
|
1082
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1083
|
-
* validations available for the field
|
|
1213
|
+
* @property {string} [name]
|
|
1214
|
+
* @property {boolean} [list_enabled]
|
|
1215
|
+
* @property {string} [type]
|
|
1216
|
+
* @property {string} [category]
|
|
1217
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1084
1218
|
*/
|
|
1085
1219
|
/**
|
|
1086
1220
|
* @typedef BooleanType
|
|
1087
|
-
* @property {string} [name]
|
|
1088
|
-
* @property {string} [category]
|
|
1089
|
-
* @property {boolean} [list_enabled]
|
|
1090
|
-
* @property {string} [type]
|
|
1091
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1092
|
-
* validations available for the field
|
|
1221
|
+
* @property {string} [name]
|
|
1222
|
+
* @property {string} [category]
|
|
1223
|
+
* @property {boolean} [list_enabled]
|
|
1224
|
+
* @property {string} [type]
|
|
1225
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1093
1226
|
*/
|
|
1094
1227
|
/**
|
|
1095
1228
|
* @typedef Date
|
|
1096
|
-
* @property {string} [name]
|
|
1097
|
-
* @property {boolean} [list_enabled]
|
|
1098
|
-
* @property {string} [category]
|
|
1099
|
-
* @property {string} [type]
|
|
1100
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1101
|
-
* validations available for the field
|
|
1229
|
+
* @property {string} [name]
|
|
1230
|
+
* @property {boolean} [list_enabled]
|
|
1231
|
+
* @property {string} [category]
|
|
1232
|
+
* @property {string} [type]
|
|
1233
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1102
1234
|
*/
|
|
1103
1235
|
/**
|
|
1104
1236
|
* @typedef Datetime
|
|
1105
|
-
* @property {string} [name]
|
|
1106
|
-
* @property {string} [category]
|
|
1107
|
-
* @property {boolean} [list_enabled]
|
|
1108
|
-
* @property {string} [type]
|
|
1109
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1110
|
-
* validations available for the field
|
|
1237
|
+
* @property {string} [name]
|
|
1238
|
+
* @property {string} [category]
|
|
1239
|
+
* @property {boolean} [list_enabled]
|
|
1240
|
+
* @property {string} [type]
|
|
1241
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1111
1242
|
*/
|
|
1112
1243
|
/**
|
|
1113
1244
|
* @typedef Json
|
|
1114
|
-
* @property {string} [name]
|
|
1115
|
-
* @property {boolean} [list_enabled]
|
|
1116
|
-
* @property {string} [category]
|
|
1117
|
-
* @property {string} [type]
|
|
1118
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1119
|
-
* validations available for the field
|
|
1245
|
+
* @property {string} [name]
|
|
1246
|
+
* @property {boolean} [list_enabled]
|
|
1247
|
+
* @property {string} [category]
|
|
1248
|
+
* @property {string} [type]
|
|
1249
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1120
1250
|
*/
|
|
1121
1251
|
/**
|
|
1122
1252
|
* @typedef File
|
|
1123
|
-
* @property {string} [name]
|
|
1124
|
-
* @property {string} [category]
|
|
1125
|
-
* @property {boolean} [list_enabled]
|
|
1126
|
-
* @property {string} [type]
|
|
1253
|
+
* @property {string} [name]
|
|
1254
|
+
* @property {string} [category]
|
|
1255
|
+
* @property {boolean} [list_enabled]
|
|
1256
|
+
* @property {string} [type]
|
|
1127
1257
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1128
1258
|
*/
|
|
1129
1259
|
/**
|
|
1130
1260
|
* @typedef Url
|
|
1131
|
-
* @property {string} [name]
|
|
1132
|
-
* @property {boolean} [list_enabled]
|
|
1133
|
-
* @property {string} [type]
|
|
1134
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1135
|
-
* validations available for the field
|
|
1261
|
+
* @property {string} [name]
|
|
1262
|
+
* @property {boolean} [list_enabled]
|
|
1263
|
+
* @property {string} [type]
|
|
1264
|
+
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1136
1265
|
*/
|
|
1137
1266
|
/**
|
|
1138
1267
|
* @typedef Metaobject
|
|
1139
|
-
* @property {string} [name]
|
|
1140
|
-
* @property {boolean} [list_enabled]
|
|
1141
|
-
*
|
|
1142
|
-
* @property {string} [
|
|
1143
|
-
* Custom Object belongs to
|
|
1144
|
-
* @property {string} [type] - Type of Custom Object Definition
|
|
1268
|
+
* @property {string} [name]
|
|
1269
|
+
* @property {boolean} [list_enabled]
|
|
1270
|
+
* @property {string} [category]
|
|
1271
|
+
* @property {string} [type]
|
|
1145
1272
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1146
1273
|
*/
|
|
1147
1274
|
/**
|
|
1148
1275
|
* @typedef Product
|
|
1149
|
-
* @property {string} [name]
|
|
1150
|
-
* @property {boolean} [list_enabled]
|
|
1151
|
-
*
|
|
1152
|
-
* @property {string} [
|
|
1153
|
-
* Product is associated with
|
|
1154
|
-
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1276
|
+
* @property {string} [name]
|
|
1277
|
+
* @property {boolean} [list_enabled]
|
|
1278
|
+
* @property {string} [category]
|
|
1279
|
+
* @property {string} [type]
|
|
1155
1280
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1281
|
+
* @property {string[]} [scope]
|
|
1156
1282
|
*/
|
|
1157
1283
|
/**
|
|
1158
1284
|
* @typedef CustomObjectEntry
|
|
1159
|
-
* @property {string} [
|
|
1160
|
-
* @property {string} [name]
|
|
1161
|
-
* @property {string} [type]
|
|
1162
|
-
* @property {string} [updated_at]
|
|
1163
|
-
* @property {number} [entries_count]
|
|
1164
|
-
*
|
|
1165
|
-
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1285
|
+
* @property {string} [_id]
|
|
1286
|
+
* @property {string} [name]
|
|
1287
|
+
* @property {string} [type]
|
|
1288
|
+
* @property {string} [updated_at]
|
|
1289
|
+
* @property {number} [entries_count]
|
|
1290
|
+
* @property {number} [fields_count]
|
|
1166
1291
|
*/
|
|
1167
1292
|
/**
|
|
1168
1293
|
* @typedef CustomObjectDefinitionsSchema
|
|
@@ -1171,29 +1296,19 @@ export = ContentPlatformModel;
|
|
|
1171
1296
|
*/
|
|
1172
1297
|
/**
|
|
1173
1298
|
* @typedef CustomObjectEntryFieldSchema
|
|
1174
|
-
* @property {string} [
|
|
1175
|
-
* @property {string} [slug] - This is slug for a custom field definition
|
|
1176
|
-
*/
|
|
1177
|
-
/**
|
|
1178
|
-
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1179
|
-
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1180
|
-
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1299
|
+
* @property {string} [definition_id]
|
|
1181
1300
|
*/
|
|
1182
1301
|
/**
|
|
1183
1302
|
* @typedef CustomObjectRequestSchema
|
|
1184
|
-
* @property {string} [status]
|
|
1185
|
-
* @property {string} [slug]
|
|
1186
|
-
* @property {
|
|
1187
|
-
|
|
1188
|
-
/**
|
|
1189
|
-
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1190
|
-
* @property {string} [status] - Status of the custom object entry.
|
|
1191
|
-
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1303
|
+
* @property {string} [status]
|
|
1304
|
+
* @property {string} [slug]
|
|
1305
|
+
* @property {string} [definition_id]
|
|
1306
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields]
|
|
1192
1307
|
*/
|
|
1193
1308
|
/**
|
|
1194
1309
|
* @typedef CustomObjectBulkSchema
|
|
1195
|
-
* @property {string} [url]
|
|
1196
|
-
* @property {number} [total_records]
|
|
1310
|
+
* @property {string} [url]
|
|
1311
|
+
* @property {number} [total_records]
|
|
1197
1312
|
*/
|
|
1198
1313
|
/**
|
|
1199
1314
|
* @typedef ActionPage
|
|
@@ -1202,7 +1317,6 @@ export = ContentPlatformModel;
|
|
|
1202
1317
|
* @property {string} [url] - The URL for the action.
|
|
1203
1318
|
* @property {PageType} type
|
|
1204
1319
|
*/
|
|
1205
|
-
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
1206
1320
|
/**
|
|
1207
1321
|
* @typedef {| "about-us"
|
|
1208
1322
|
* | "addresses"
|
|
@@ -1256,20 +1370,8 @@ export = ContentPlatformModel;
|
|
|
1256
1370
|
declare class ContentPlatformModel {
|
|
1257
1371
|
}
|
|
1258
1372
|
declare namespace ContentPlatformModel {
|
|
1259
|
-
export {
|
|
1373
|
+
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, DeletPathMappingSchema, CreatePathMappingSchema, GetAllPathMappingSchema, GetPathSchema, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderItemsResponseSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, AssignmentReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, TagSpecSchema, ServerSchema, DataLoadersApiSpecSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, NavigationAssignment, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageResponseError, PageSchema, SanitizedContent, PageMeta, PageContent, CreatedBySchema, PageRequestVisibility, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, CustomePages, SystemPagesActionPage, SystemPagesAction, SystemPages, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, ApplicationFieldDefinitionSchema, FieldDefinitionSchema, ApplicationCustomFieldDefinitionsSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, MetafieldTypesSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, PageType };
|
|
1260
1374
|
}
|
|
1261
|
-
/** @returns {ValidationError} */
|
|
1262
|
-
declare function ValidationError(): ValidationError;
|
|
1263
|
-
type ValidationError = {
|
|
1264
|
-
/**
|
|
1265
|
-
* - A brief description of the error encountered.
|
|
1266
|
-
*/
|
|
1267
|
-
message: string;
|
|
1268
|
-
/**
|
|
1269
|
-
* - The field in the request that caused the error.
|
|
1270
|
-
*/
|
|
1271
|
-
field: string;
|
|
1272
|
-
};
|
|
1273
1375
|
/** @returns {GenerateSEOContent} */
|
|
1274
1376
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
1275
1377
|
type GenerateSEOContent = {
|
|
@@ -1296,6 +1398,7 @@ type ApplicationLegal = {
|
|
|
1296
1398
|
_id?: string;
|
|
1297
1399
|
updated_at?: string;
|
|
1298
1400
|
created_at?: string;
|
|
1401
|
+
__v?: number;
|
|
1299
1402
|
};
|
|
1300
1403
|
/** @returns {ApplicationLegalFAQ} */
|
|
1301
1404
|
declare function ApplicationLegalFAQ(): ApplicationLegalFAQ;
|
|
@@ -1312,7 +1415,7 @@ type PathMappingSchema = {
|
|
|
1312
1415
|
redirect_to?: string;
|
|
1313
1416
|
updated_at?: string;
|
|
1314
1417
|
created_at?: string;
|
|
1315
|
-
|
|
1418
|
+
__v?: number;
|
|
1316
1419
|
};
|
|
1317
1420
|
/** @returns {PathSourceSchema} */
|
|
1318
1421
|
declare function PathSourceSchema(): PathSourceSchema;
|
|
@@ -1328,8 +1431,8 @@ type SeoComponent = {
|
|
|
1328
1431
|
/** @returns {SeoSchema} */
|
|
1329
1432
|
declare function SeoSchema(): SeoSchema;
|
|
1330
1433
|
type SeoSchema = {
|
|
1331
|
-
app?: string;
|
|
1332
1434
|
_id?: string;
|
|
1435
|
+
app?: string;
|
|
1333
1436
|
robots_txt?: string;
|
|
1334
1437
|
sitemap_enabled?: boolean;
|
|
1335
1438
|
additional_sitemap?: string;
|
|
@@ -1338,6 +1441,8 @@ type SeoSchema = {
|
|
|
1338
1441
|
details?: Detail;
|
|
1339
1442
|
created_at?: string;
|
|
1340
1443
|
updated_at?: string;
|
|
1444
|
+
__v?: number;
|
|
1445
|
+
sitemap?: SEOSitemap;
|
|
1341
1446
|
};
|
|
1342
1447
|
/** @returns {CustomMetaTag} */
|
|
1343
1448
|
declare function CustomMetaTag(): CustomMetaTag;
|
|
@@ -1362,28 +1467,55 @@ type SeoSchemaComponent = {
|
|
|
1362
1467
|
/** @returns {SEOSchemaMarkupTemplate} */
|
|
1363
1468
|
declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
|
|
1364
1469
|
type SEOSchemaMarkupTemplate = {
|
|
1365
|
-
|
|
1470
|
+
_id?: string;
|
|
1366
1471
|
title?: string;
|
|
1367
1472
|
page_type?: string;
|
|
1368
1473
|
schema?: string;
|
|
1369
1474
|
description?: string;
|
|
1370
1475
|
active?: boolean;
|
|
1476
|
+
application?: string;
|
|
1371
1477
|
created_at?: string;
|
|
1372
1478
|
updated_at?: string;
|
|
1373
|
-
application?: string;
|
|
1374
1479
|
target_json?: any;
|
|
1480
|
+
__v?: number;
|
|
1375
1481
|
};
|
|
1376
1482
|
/** @returns {SEOSchemaMarkupTemplateRequestBody} */
|
|
1377
1483
|
declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
|
|
1378
1484
|
type SEOSchemaMarkupTemplateRequestBody = {
|
|
1379
1485
|
title?: string;
|
|
1380
1486
|
page_type?: string;
|
|
1381
|
-
schema?: string;
|
|
1382
1487
|
description?: string;
|
|
1488
|
+
schema?: string;
|
|
1383
1489
|
target_json?: any;
|
|
1384
1490
|
active?: boolean;
|
|
1385
1491
|
created_at?: string;
|
|
1386
|
-
|
|
1492
|
+
};
|
|
1493
|
+
/** @returns {DeletPathMappingSchema} */
|
|
1494
|
+
declare function DeletPathMappingSchema(): DeletPathMappingSchema;
|
|
1495
|
+
type DeletPathMappingSchema = {
|
|
1496
|
+
message?: string;
|
|
1497
|
+
data?: PathMappingSchema;
|
|
1498
|
+
};
|
|
1499
|
+
/** @returns {CreatePathMappingSchema} */
|
|
1500
|
+
declare function CreatePathMappingSchema(): CreatePathMappingSchema;
|
|
1501
|
+
type CreatePathMappingSchema = {
|
|
1502
|
+
message?: string;
|
|
1503
|
+
data?: PathMappingSchema;
|
|
1504
|
+
};
|
|
1505
|
+
/** @returns {GetAllPathMappingSchema} */
|
|
1506
|
+
declare function GetAllPathMappingSchema(): GetAllPathMappingSchema;
|
|
1507
|
+
type GetAllPathMappingSchema = {
|
|
1508
|
+
message?: string;
|
|
1509
|
+
data?: GetPathSchema;
|
|
1510
|
+
};
|
|
1511
|
+
/** @returns {GetPathSchema} */
|
|
1512
|
+
declare function GetPathSchema(): GetPathSchema;
|
|
1513
|
+
type GetPathSchema = {
|
|
1514
|
+
docs?: PathMappingSchema[];
|
|
1515
|
+
page?: number;
|
|
1516
|
+
limit?: number;
|
|
1517
|
+
pages?: number;
|
|
1518
|
+
total?: number;
|
|
1387
1519
|
};
|
|
1388
1520
|
/** @returns {AnnouncementPageSchema} */
|
|
1389
1521
|
declare function AnnouncementPageSchema(): AnnouncementPageSchema;
|
|
@@ -1430,11 +1562,11 @@ declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplat
|
|
|
1430
1562
|
type DefaultSEOSchemaMarkupTemplate = {
|
|
1431
1563
|
page_type?: string;
|
|
1432
1564
|
schema?: string;
|
|
1433
|
-
target_json?: any;
|
|
1434
1565
|
};
|
|
1435
1566
|
/** @returns {ScheduleSchema} */
|
|
1436
1567
|
declare function ScheduleSchema(): ScheduleSchema;
|
|
1437
1568
|
type ScheduleSchema = {
|
|
1569
|
+
published?: boolean;
|
|
1438
1570
|
cron?: string;
|
|
1439
1571
|
start?: string;
|
|
1440
1572
|
end?: string;
|
|
@@ -1447,9 +1579,9 @@ type NextSchedule = {
|
|
|
1447
1579
|
start?: string;
|
|
1448
1580
|
end?: string;
|
|
1449
1581
|
};
|
|
1450
|
-
/** @returns {
|
|
1451
|
-
declare function
|
|
1452
|
-
type
|
|
1582
|
+
/** @returns {BlogGetResponse} */
|
|
1583
|
+
declare function BlogGetResponse(): BlogGetResponse;
|
|
1584
|
+
type BlogGetResponse = {
|
|
1453
1585
|
items?: BlogSchema[];
|
|
1454
1586
|
page?: Page;
|
|
1455
1587
|
filters?: BlogFilters;
|
|
@@ -1498,6 +1630,7 @@ type BlogSchema = {
|
|
|
1498
1630
|
title?: string;
|
|
1499
1631
|
date_meta?: DateMeta;
|
|
1500
1632
|
summary?: string;
|
|
1633
|
+
status?: string;
|
|
1501
1634
|
};
|
|
1502
1635
|
/** @returns {SEO} */
|
|
1503
1636
|
declare function SEO(): SEO;
|
|
@@ -1507,7 +1640,7 @@ type SEO = {
|
|
|
1507
1640
|
title?: string;
|
|
1508
1641
|
meta_tags?: SEOMetaItem[];
|
|
1509
1642
|
sitemap?: SEOSitemap;
|
|
1510
|
-
|
|
1643
|
+
breadcrumbs?: SEObreadcrumb[];
|
|
1511
1644
|
canonical_url?: string;
|
|
1512
1645
|
};
|
|
1513
1646
|
/** @returns {SEOImage} */
|
|
@@ -1545,9 +1678,9 @@ type DateMeta = {
|
|
|
1545
1678
|
created_on?: string;
|
|
1546
1679
|
modified_on?: string;
|
|
1547
1680
|
};
|
|
1548
|
-
/** @returns {
|
|
1549
|
-
declare function
|
|
1550
|
-
type
|
|
1681
|
+
/** @returns {BlogRequest} */
|
|
1682
|
+
declare function BlogRequest(): BlogRequest;
|
|
1683
|
+
type BlogRequest = {
|
|
1551
1684
|
application?: string;
|
|
1552
1685
|
_custom_json?: any;
|
|
1553
1686
|
author?: Author;
|
|
@@ -1558,6 +1691,7 @@ type BlogPayload = {
|
|
|
1558
1691
|
slug?: string;
|
|
1559
1692
|
tags?: string[];
|
|
1560
1693
|
title?: string;
|
|
1694
|
+
publish_date?: string;
|
|
1561
1695
|
seo?: SEO;
|
|
1562
1696
|
summary?: string;
|
|
1563
1697
|
};
|
|
@@ -1573,6 +1707,11 @@ type CreateAnnouncementSchema = {
|
|
|
1573
1707
|
message?: string;
|
|
1574
1708
|
data?: AdminAnnouncementSchema;
|
|
1575
1709
|
};
|
|
1710
|
+
/** @returns {DataLoaderItemsResponseSchema} */
|
|
1711
|
+
declare function DataLoaderItemsResponseSchema(): DataLoaderItemsResponseSchema;
|
|
1712
|
+
type DataLoaderItemsResponseSchema = {
|
|
1713
|
+
items?: DataLoaderResponseSchema[];
|
|
1714
|
+
};
|
|
1576
1715
|
/** @returns {DataLoaderResponseSchema} */
|
|
1577
1716
|
declare function DataLoaderResponseSchema(): DataLoaderResponseSchema;
|
|
1578
1717
|
type DataLoaderResponseSchema = {
|
|
@@ -1585,12 +1724,16 @@ type DataLoaderResponseSchema = {
|
|
|
1585
1724
|
type?: string;
|
|
1586
1725
|
url?: string;
|
|
1587
1726
|
content?: string;
|
|
1727
|
+
created_at?: string;
|
|
1728
|
+
modified_at?: string;
|
|
1729
|
+
__v?: number;
|
|
1730
|
+
is_selected?: boolean;
|
|
1588
1731
|
__source?: DataLoaderSourceSchema;
|
|
1589
1732
|
};
|
|
1590
1733
|
/** @returns {DataLoaderResetResponseSchema} */
|
|
1591
1734
|
declare function DataLoaderResetResponseSchema(): DataLoaderResetResponseSchema;
|
|
1592
1735
|
type DataLoaderResetResponseSchema = {
|
|
1593
|
-
|
|
1736
|
+
resetted?: boolean;
|
|
1594
1737
|
};
|
|
1595
1738
|
/** @returns {LocaleLanguage} */
|
|
1596
1739
|
declare function LocaleLanguage(): LocaleLanguage;
|
|
@@ -1622,13 +1765,19 @@ type NavigationReference = {
|
|
|
1622
1765
|
_locale_language?: LocaleLanguage;
|
|
1623
1766
|
image?: string;
|
|
1624
1767
|
type?: string;
|
|
1625
|
-
action?: Action;
|
|
1626
1768
|
active?: boolean;
|
|
1627
1769
|
display?: string;
|
|
1628
1770
|
sort_order?: number;
|
|
1629
1771
|
schedule?: CronBasedScheduleSchema;
|
|
1630
1772
|
sub_navigation?: NavigationReference[];
|
|
1631
1773
|
};
|
|
1774
|
+
/** @returns {AssignmentReference} */
|
|
1775
|
+
declare function AssignmentReference(): AssignmentReference;
|
|
1776
|
+
type AssignmentReference = {
|
|
1777
|
+
platform?: string;
|
|
1778
|
+
orientation?: string;
|
|
1779
|
+
position?: string;
|
|
1780
|
+
};
|
|
1632
1781
|
/** @returns {CronBasedScheduleSchema} */
|
|
1633
1782
|
declare function CronBasedScheduleSchema(): CronBasedScheduleSchema;
|
|
1634
1783
|
type CronBasedScheduleSchema = {
|
|
@@ -1679,14 +1828,18 @@ type CreateTagRequestSchema = {
|
|
|
1679
1828
|
/** @returns {DataLoaderSchema} */
|
|
1680
1829
|
declare function DataLoaderSchema(): DataLoaderSchema;
|
|
1681
1830
|
type DataLoaderSchema = {
|
|
1831
|
+
_id?: string;
|
|
1832
|
+
url?: string;
|
|
1833
|
+
created_at?: string;
|
|
1834
|
+
modified_at?: string;
|
|
1835
|
+
application?: string;
|
|
1836
|
+
company?: string;
|
|
1682
1837
|
name?: string;
|
|
1683
1838
|
service?: string;
|
|
1684
1839
|
operation_id?: string;
|
|
1840
|
+
is_selected?: boolean;
|
|
1685
1841
|
type?: string;
|
|
1686
|
-
url?: string;
|
|
1687
|
-
content?: string;
|
|
1688
1842
|
__source?: DataLoaderSourceSchema;
|
|
1689
|
-
_id?: string;
|
|
1690
1843
|
};
|
|
1691
1844
|
/** @returns {DataLoaderSourceSchema} */
|
|
1692
1845
|
declare function DataLoaderSourceSchema(): DataLoaderSourceSchema;
|
|
@@ -1694,14 +1847,34 @@ type DataLoaderSourceSchema = {
|
|
|
1694
1847
|
type?: string;
|
|
1695
1848
|
id?: string;
|
|
1696
1849
|
};
|
|
1850
|
+
/** @returns {TagSpecSchema} */
|
|
1851
|
+
declare function TagSpecSchema(): TagSpecSchema;
|
|
1852
|
+
type TagSpecSchema = {
|
|
1853
|
+
name?: string;
|
|
1854
|
+
description?: string;
|
|
1855
|
+
};
|
|
1856
|
+
/** @returns {ServerSchema} */
|
|
1857
|
+
declare function ServerSchema(): ServerSchema;
|
|
1858
|
+
type ServerSchema = {
|
|
1859
|
+
url?: string;
|
|
1860
|
+
};
|
|
1861
|
+
/** @returns {DataLoadersApiSpecSchema} */
|
|
1862
|
+
declare function DataLoadersApiSpecSchema(): DataLoadersApiSpecSchema;
|
|
1863
|
+
type DataLoadersApiSpecSchema = {
|
|
1864
|
+
info?: any;
|
|
1865
|
+
servers?: ServerSchema[];
|
|
1866
|
+
tags?: TagSpecSchema[];
|
|
1867
|
+
openapi?: string;
|
|
1868
|
+
paths?: any;
|
|
1869
|
+
};
|
|
1697
1870
|
/** @returns {DataLoadersSchema} */
|
|
1698
1871
|
declare function DataLoadersSchema(): DataLoadersSchema;
|
|
1699
1872
|
type DataLoadersSchema = {
|
|
1700
1873
|
items?: DataLoaderSchema[];
|
|
1701
1874
|
};
|
|
1702
|
-
/** @returns {
|
|
1703
|
-
declare function
|
|
1704
|
-
type
|
|
1875
|
+
/** @returns {TagDeleteSuccessResponse} */
|
|
1876
|
+
declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
|
|
1877
|
+
type TagDeleteSuccessResponse = {
|
|
1705
1878
|
success?: boolean;
|
|
1706
1879
|
};
|
|
1707
1880
|
/** @returns {ContentAPIError} */
|
|
@@ -1711,7 +1884,6 @@ type ContentAPIError = {
|
|
|
1711
1884
|
status?: number;
|
|
1712
1885
|
code?: string;
|
|
1713
1886
|
exception?: string;
|
|
1714
|
-
info?: string;
|
|
1715
1887
|
request_id?: string;
|
|
1716
1888
|
stack_trace?: string;
|
|
1717
1889
|
meta?: any;
|
|
@@ -1733,6 +1905,7 @@ type CategorySchema = {
|
|
|
1733
1905
|
application?: string;
|
|
1734
1906
|
icon_url?: string;
|
|
1735
1907
|
_custom_json?: any;
|
|
1908
|
+
__v?: number;
|
|
1736
1909
|
};
|
|
1737
1910
|
/** @returns {ChildrenSchema} */
|
|
1738
1911
|
declare function ChildrenSchema(): ChildrenSchema;
|
|
@@ -1752,15 +1925,15 @@ type CategoryRequestSchema = {
|
|
|
1752
1925
|
/** @returns {FAQCategorySchema} */
|
|
1753
1926
|
declare function FAQCategorySchema(): FAQCategorySchema;
|
|
1754
1927
|
type FAQCategorySchema = {
|
|
1755
|
-
|
|
1928
|
+
_id?: string;
|
|
1929
|
+
application?: string;
|
|
1756
1930
|
title?: string;
|
|
1757
1931
|
description?: string;
|
|
1758
|
-
|
|
1759
|
-
_id?: string;
|
|
1932
|
+
index?: number;
|
|
1760
1933
|
slug?: string;
|
|
1761
|
-
|
|
1934
|
+
children?: ChildrenSchema[];
|
|
1762
1935
|
icon_url?: string;
|
|
1763
|
-
|
|
1936
|
+
__v?: number;
|
|
1764
1937
|
};
|
|
1765
1938
|
/** @returns {FaqSchema} */
|
|
1766
1939
|
declare function FaqSchema(): FaqSchema;
|
|
@@ -1771,6 +1944,7 @@ type FaqSchema = {
|
|
|
1771
1944
|
question?: string;
|
|
1772
1945
|
answer?: string;
|
|
1773
1946
|
tags?: string[];
|
|
1947
|
+
__v?: number;
|
|
1774
1948
|
};
|
|
1775
1949
|
/** @returns {FAQ} */
|
|
1776
1950
|
declare function FAQ(): FAQ;
|
|
@@ -1850,10 +2024,14 @@ type Page = {
|
|
|
1850
2024
|
* - The number of items per page.
|
|
1851
2025
|
*/
|
|
1852
2026
|
size?: number;
|
|
2027
|
+
/**
|
|
2028
|
+
* - Total number of items.
|
|
2029
|
+
*/
|
|
2030
|
+
total?: number;
|
|
1853
2031
|
};
|
|
1854
|
-
/** @returns {
|
|
1855
|
-
declare function
|
|
1856
|
-
type
|
|
2032
|
+
/** @returns {LandingPageGetResponse} */
|
|
2033
|
+
declare function LandingPageGetResponse(): LandingPageGetResponse;
|
|
2034
|
+
type LandingPageGetResponse = {
|
|
1857
2035
|
items?: LandingPageSchema[];
|
|
1858
2036
|
page?: Page;
|
|
1859
2037
|
};
|
|
@@ -1861,7 +2039,6 @@ type LandingPageGetDetails = {
|
|
|
1861
2039
|
declare function LandingPageSchema(): LandingPageSchema;
|
|
1862
2040
|
type LandingPageSchema = {
|
|
1863
2041
|
slug?: string;
|
|
1864
|
-
action?: Action;
|
|
1865
2042
|
platform?: string[];
|
|
1866
2043
|
created_by?: CreatedBySchema;
|
|
1867
2044
|
date_meta?: DateMeta;
|
|
@@ -1869,15 +2046,16 @@ type LandingPageSchema = {
|
|
|
1869
2046
|
application?: string;
|
|
1870
2047
|
archived?: boolean;
|
|
1871
2048
|
_custom_json?: any;
|
|
2049
|
+
__v?: number;
|
|
1872
2050
|
};
|
|
1873
|
-
/** @returns {
|
|
1874
|
-
declare function
|
|
1875
|
-
type
|
|
2051
|
+
/** @returns {DefaultNavigationResponse} */
|
|
2052
|
+
declare function DefaultNavigationResponse(): DefaultNavigationResponse;
|
|
2053
|
+
type DefaultNavigationResponse = {
|
|
1876
2054
|
items?: NavigationSchema[];
|
|
1877
2055
|
};
|
|
1878
|
-
/** @returns {
|
|
1879
|
-
declare function
|
|
1880
|
-
type
|
|
2056
|
+
/** @returns {NavigationGetResponse} */
|
|
2057
|
+
declare function NavigationGetResponse(): NavigationGetResponse;
|
|
2058
|
+
type NavigationGetResponse = {
|
|
1881
2059
|
items?: NavigationSchema[];
|
|
1882
2060
|
page?: Page;
|
|
1883
2061
|
};
|
|
@@ -1901,19 +2079,29 @@ type NavigationSchema = {
|
|
|
1901
2079
|
orientation?: Orientation;
|
|
1902
2080
|
version?: number;
|
|
1903
2081
|
navigation?: NavigationReference[];
|
|
2082
|
+
assignments?: AssignmentReference[];
|
|
2083
|
+
__v?: number;
|
|
1904
2084
|
};
|
|
1905
|
-
/** @returns {
|
|
1906
|
-
declare function
|
|
1907
|
-
type
|
|
2085
|
+
/** @returns {NavigationRequest} */
|
|
2086
|
+
declare function NavigationRequest(): NavigationRequest;
|
|
2087
|
+
type NavigationRequest = {
|
|
1908
2088
|
name?: string;
|
|
1909
2089
|
slug?: string;
|
|
1910
2090
|
platform?: string[];
|
|
1911
2091
|
orientation?: Orientation;
|
|
2092
|
+
assignments?: NavigationAssignment[];
|
|
1912
2093
|
navigation?: NavigationReference[];
|
|
1913
2094
|
};
|
|
1914
|
-
/** @returns {
|
|
1915
|
-
declare function
|
|
1916
|
-
type
|
|
2095
|
+
/** @returns {NavigationAssignment} */
|
|
2096
|
+
declare function NavigationAssignment(): NavigationAssignment;
|
|
2097
|
+
type NavigationAssignment = {
|
|
2098
|
+
platform?: string;
|
|
2099
|
+
orientation?: string;
|
|
2100
|
+
position?: string;
|
|
2101
|
+
};
|
|
2102
|
+
/** @returns {PageGetResponse} */
|
|
2103
|
+
declare function PageGetResponse(): PageGetResponse;
|
|
2104
|
+
type PageGetResponse = {
|
|
1917
2105
|
items?: PageSchema[];
|
|
1918
2106
|
page?: Page;
|
|
1919
2107
|
};
|
|
@@ -1936,50 +2124,73 @@ type PageSpecItem = {
|
|
|
1936
2124
|
params?: PageSpecParam[];
|
|
1937
2125
|
query?: PageSpecParam[];
|
|
1938
2126
|
};
|
|
2127
|
+
/** @returns {PageResponseError} */
|
|
2128
|
+
declare function PageResponseError(): PageResponseError;
|
|
2129
|
+
type PageResponseError = {
|
|
2130
|
+
errors?: string;
|
|
2131
|
+
};
|
|
1939
2132
|
/** @returns {PageSchema} */
|
|
1940
2133
|
declare function PageSchema(): PageSchema;
|
|
1941
2134
|
type PageSchema = {
|
|
1942
2135
|
_id?: string;
|
|
1943
2136
|
application?: string;
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
content?: any[];
|
|
2137
|
+
platform?: string;
|
|
2138
|
+
title?: string;
|
|
2139
|
+
slug?: string;
|
|
2140
|
+
type?: string;
|
|
2141
|
+
tags?: string[];
|
|
1950
2142
|
content_path?: string;
|
|
2143
|
+
orientation?: string;
|
|
2144
|
+
description?: string;
|
|
2145
|
+
published?: boolean;
|
|
1951
2146
|
created_by?: CreatedBySchema;
|
|
1952
2147
|
date_meta?: DateMeta;
|
|
1953
|
-
description?: string;
|
|
1954
2148
|
feature_image?: Asset;
|
|
1955
|
-
page_meta?: any[];
|
|
1956
2149
|
_schedule?: ScheduleSchema;
|
|
1957
|
-
|
|
1958
|
-
orientation?: string;
|
|
1959
|
-
platform?: string;
|
|
1960
|
-
published?: boolean;
|
|
1961
|
-
slug?: string;
|
|
1962
|
-
tags?: string[];
|
|
1963
|
-
title?: string;
|
|
1964
|
-
type?: string;
|
|
2150
|
+
page_meta?: PageMeta[];
|
|
1965
2151
|
seo?: SEO;
|
|
1966
|
-
|
|
2152
|
+
component_ids?: string[];
|
|
1967
2153
|
archived?: boolean;
|
|
2154
|
+
__v?: number;
|
|
2155
|
+
content?: PageContent[];
|
|
2156
|
+
sanitized_content?: SanitizedContent[];
|
|
2157
|
+
};
|
|
2158
|
+
/** @returns {SanitizedContent} */
|
|
2159
|
+
declare function SanitizedContent(): SanitizedContent;
|
|
2160
|
+
type SanitizedContent = {
|
|
2161
|
+
type?: string;
|
|
2162
|
+
value?: string;
|
|
2163
|
+
};
|
|
2164
|
+
/** @returns {PageMeta} */
|
|
2165
|
+
declare function PageMeta(): PageMeta;
|
|
2166
|
+
type PageMeta = {
|
|
2167
|
+
key?: string;
|
|
2168
|
+
};
|
|
2169
|
+
/** @returns {PageContent} */
|
|
2170
|
+
declare function PageContent(): PageContent;
|
|
2171
|
+
type PageContent = {
|
|
2172
|
+
type?: string;
|
|
2173
|
+
value?: string;
|
|
1968
2174
|
};
|
|
1969
2175
|
/** @returns {CreatedBySchema} */
|
|
1970
2176
|
declare function CreatedBySchema(): CreatedBySchema;
|
|
1971
2177
|
type CreatedBySchema = {
|
|
1972
2178
|
id?: string;
|
|
1973
2179
|
};
|
|
1974
|
-
/** @returns {
|
|
1975
|
-
declare function
|
|
1976
|
-
type
|
|
2180
|
+
/** @returns {PageRequestVisibility} */
|
|
2181
|
+
declare function PageRequestVisibility(): PageRequestVisibility;
|
|
2182
|
+
type PageRequestVisibility = {
|
|
2183
|
+
test?: boolean;
|
|
2184
|
+
};
|
|
2185
|
+
/** @returns {PageRequest} */
|
|
2186
|
+
declare function PageRequest(): PageRequest;
|
|
2187
|
+
type PageRequest = {
|
|
1977
2188
|
_schedule?: CronSchedule;
|
|
1978
2189
|
application?: string;
|
|
1979
2190
|
author?: Author;
|
|
1980
2191
|
_custom_json?: any;
|
|
1981
2192
|
orientation?: string;
|
|
1982
|
-
content?:
|
|
2193
|
+
content?: PageContent[];
|
|
1983
2194
|
feature_image?: Asset;
|
|
1984
2195
|
published?: boolean;
|
|
1985
2196
|
reading_time?: string;
|
|
@@ -1987,6 +2198,13 @@ type PagePayload = {
|
|
|
1987
2198
|
tags?: string[];
|
|
1988
2199
|
seo?: SEO;
|
|
1989
2200
|
title?: string;
|
|
2201
|
+
platform?: string;
|
|
2202
|
+
type?: string;
|
|
2203
|
+
description?: string;
|
|
2204
|
+
/**
|
|
2205
|
+
* - Visibility of Page.
|
|
2206
|
+
*/
|
|
2207
|
+
visibility?: any;
|
|
1990
2208
|
};
|
|
1991
2209
|
/** @returns {CronSchedule} */
|
|
1992
2210
|
declare function CronSchedule(): CronSchedule;
|
|
@@ -1995,19 +2213,44 @@ type CronSchedule = {
|
|
|
1995
2213
|
start?: string;
|
|
1996
2214
|
end?: string;
|
|
1997
2215
|
duration?: number;
|
|
2216
|
+
next_schedule?: NextSchedule[];
|
|
1998
2217
|
};
|
|
1999
|
-
/** @returns {
|
|
2000
|
-
declare function
|
|
2001
|
-
type
|
|
2218
|
+
/** @returns {PagePublishRequest} */
|
|
2219
|
+
declare function PagePublishRequest(): PagePublishRequest;
|
|
2220
|
+
type PagePublishRequest = {
|
|
2002
2221
|
publish?: boolean;
|
|
2003
2222
|
};
|
|
2004
2223
|
/** @returns {PageMetaSchema} */
|
|
2005
2224
|
declare function PageMetaSchema(): PageMetaSchema;
|
|
2006
2225
|
type PageMetaSchema = {
|
|
2007
|
-
system_pages?:
|
|
2008
|
-
custom_pages?:
|
|
2226
|
+
system_pages?: SystemPages[];
|
|
2227
|
+
custom_pages?: CustomePages[];
|
|
2009
2228
|
application_id?: string;
|
|
2010
2229
|
};
|
|
2230
|
+
/** @returns {CustomePages} */
|
|
2231
|
+
declare function CustomePages(): CustomePages;
|
|
2232
|
+
type CustomePages = {
|
|
2233
|
+
display?: string;
|
|
2234
|
+
slug?: string;
|
|
2235
|
+
};
|
|
2236
|
+
/** @returns {SystemPagesActionPage} */
|
|
2237
|
+
declare function SystemPagesActionPage(): SystemPagesActionPage;
|
|
2238
|
+
type SystemPagesActionPage = {
|
|
2239
|
+
type?: string;
|
|
2240
|
+
};
|
|
2241
|
+
/** @returns {SystemPagesAction} */
|
|
2242
|
+
declare function SystemPagesAction(): SystemPagesAction;
|
|
2243
|
+
type SystemPagesAction = {
|
|
2244
|
+
page?: SystemPagesActionPage;
|
|
2245
|
+
type?: string;
|
|
2246
|
+
};
|
|
2247
|
+
/** @returns {SystemPages} */
|
|
2248
|
+
declare function SystemPages(): SystemPages;
|
|
2249
|
+
type SystemPages = {
|
|
2250
|
+
display?: string;
|
|
2251
|
+
action?: SystemPagesAction;
|
|
2252
|
+
page_type?: string;
|
|
2253
|
+
};
|
|
2011
2254
|
/** @returns {Support} */
|
|
2012
2255
|
declare function Support(): Support;
|
|
2013
2256
|
type Support = {
|
|
@@ -2055,6 +2298,8 @@ declare function TagsSchema(): TagsSchema;
|
|
|
2055
2298
|
type TagsSchema = {
|
|
2056
2299
|
application?: string;
|
|
2057
2300
|
_id?: string;
|
|
2301
|
+
company?: string;
|
|
2302
|
+
__v?: number;
|
|
2058
2303
|
tags?: TagSchema[];
|
|
2059
2304
|
};
|
|
2060
2305
|
/** @returns {TagSchema} */
|
|
@@ -2068,6 +2313,7 @@ type TagSchema = {
|
|
|
2068
2313
|
position?: string;
|
|
2069
2314
|
attributes?: any;
|
|
2070
2315
|
content?: string;
|
|
2316
|
+
compatible_engines?: any[];
|
|
2071
2317
|
pages?: any[];
|
|
2072
2318
|
__source?: TagSourceSchema;
|
|
2073
2319
|
};
|
|
@@ -2101,366 +2347,149 @@ type ResourceSchema = {
|
|
|
2101
2347
|
/** @returns {FieldValidations} */
|
|
2102
2348
|
declare function FieldValidations(): FieldValidations;
|
|
2103
2349
|
type FieldValidations = {
|
|
2104
|
-
/**
|
|
2105
|
-
* - Name of validation
|
|
2106
|
-
*/
|
|
2107
2350
|
name?: string;
|
|
2108
|
-
/**
|
|
2109
|
-
* - Type of validation
|
|
2110
|
-
*/
|
|
2111
2351
|
type?: string;
|
|
2112
|
-
|
|
2352
|
+
};
|
|
2353
|
+
/** @returns {ApplicationFieldDefinitionSchema} */
|
|
2354
|
+
declare function ApplicationFieldDefinitionSchema(): ApplicationFieldDefinitionSchema;
|
|
2355
|
+
type ApplicationFieldDefinitionSchema = {
|
|
2356
|
+
_id?: string;
|
|
2357
|
+
creator?: string;
|
|
2358
|
+
resource?: string;
|
|
2359
|
+
name?: string;
|
|
2360
|
+
namespace?: string;
|
|
2361
|
+
key?: string;
|
|
2362
|
+
description?: string;
|
|
2363
|
+
type?: string;
|
|
2364
|
+
multi_value?: boolean;
|
|
2365
|
+
validations?: FieldValidations[];
|
|
2366
|
+
company_id?: string;
|
|
2367
|
+
created_by?: string;
|
|
2368
|
+
updated_by?: string;
|
|
2369
|
+
required?: boolean;
|
|
2370
|
+
is_deleted?: boolean;
|
|
2371
|
+
created_at?: string;
|
|
2372
|
+
updated_at?: string;
|
|
2373
|
+
type_name?: string;
|
|
2374
|
+
invalid_fields_count?: number;
|
|
2375
|
+
application_id?: string;
|
|
2113
2376
|
};
|
|
2114
2377
|
/** @returns {FieldDefinitionSchema} */
|
|
2115
2378
|
declare function FieldDefinitionSchema(): FieldDefinitionSchema;
|
|
2116
2379
|
type FieldDefinitionSchema = {
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
*/
|
|
2120
|
-
id?: string;
|
|
2121
|
-
/**
|
|
2122
|
-
* - Resource type to which custom field belongs
|
|
2123
|
-
*/
|
|
2380
|
+
_id?: string;
|
|
2381
|
+
creator?: string;
|
|
2124
2382
|
resource?: string;
|
|
2125
|
-
/**
|
|
2126
|
-
* - Name of custom field
|
|
2127
|
-
*/
|
|
2128
2383
|
name?: string;
|
|
2129
|
-
/**
|
|
2130
|
-
* - Namespace of custom field
|
|
2131
|
-
*/
|
|
2132
2384
|
namespace?: string;
|
|
2133
|
-
|
|
2134
|
-
* - Slug of custom field
|
|
2135
|
-
*/
|
|
2136
|
-
slug?: string;
|
|
2137
|
-
/**
|
|
2138
|
-
* - Description of custom field definition
|
|
2139
|
-
*/
|
|
2385
|
+
key?: string;
|
|
2140
2386
|
description?: string;
|
|
2141
|
-
/**
|
|
2142
|
-
* - Data type of custom field
|
|
2143
|
-
*/
|
|
2144
2387
|
type?: string;
|
|
2145
|
-
/**
|
|
2146
|
-
* - Flag to denote whether custom field is
|
|
2147
|
-
* multivalued or not
|
|
2148
|
-
*/
|
|
2149
2388
|
multi_value?: boolean;
|
|
2150
|
-
/**
|
|
2151
|
-
* - List of validations applied
|
|
2152
|
-
*/
|
|
2153
2389
|
validations?: FieldValidations[];
|
|
2154
|
-
/**
|
|
2155
|
-
* - Id of company
|
|
2156
|
-
*/
|
|
2157
2390
|
company_id?: string;
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
*/
|
|
2391
|
+
created_by?: string;
|
|
2392
|
+
updated_by?: string;
|
|
2161
2393
|
required?: boolean;
|
|
2162
|
-
/**
|
|
2163
|
-
* - Whether the custom field is deleted or not
|
|
2164
|
-
*/
|
|
2165
2394
|
is_deleted?: boolean;
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
*/
|
|
2395
|
+
created_at?: string;
|
|
2396
|
+
updated_at?: string;
|
|
2169
2397
|
type_name?: string;
|
|
2170
|
-
/**
|
|
2171
|
-
* - Count of invalid fields after validation
|
|
2172
|
-
*/
|
|
2173
2398
|
invalid_fields_count?: number;
|
|
2174
2399
|
};
|
|
2400
|
+
/** @returns {ApplicationCustomFieldDefinitionsSchema} */
|
|
2401
|
+
declare function ApplicationCustomFieldDefinitionsSchema(): ApplicationCustomFieldDefinitionsSchema;
|
|
2402
|
+
type ApplicationCustomFieldDefinitionsSchema = {
|
|
2403
|
+
items?: ApplicationFieldDefinitionSchema[];
|
|
2404
|
+
page?: Page;
|
|
2405
|
+
};
|
|
2175
2406
|
/** @returns {CustomFieldDefinitionsSchema} */
|
|
2176
2407
|
declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
|
|
2177
2408
|
type CustomFieldDefinitionsSchema = {
|
|
2178
|
-
/**
|
|
2179
|
-
* - List of custom field definitions
|
|
2180
|
-
*/
|
|
2181
2409
|
items?: FieldDefinitionSchema[];
|
|
2182
2410
|
page?: Page;
|
|
2183
2411
|
};
|
|
2184
2412
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2185
2413
|
declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
|
|
2186
2414
|
type CustomFieldDefinitionRequestSchema = {
|
|
2187
|
-
|
|
2188
|
-
* - Data type of custom field
|
|
2189
|
-
*/
|
|
2415
|
+
resource?: string;
|
|
2190
2416
|
type?: string;
|
|
2191
|
-
|
|
2192
|
-
* - Slug of custom field definition
|
|
2193
|
-
*/
|
|
2194
|
-
slug?: string;
|
|
2195
|
-
/**
|
|
2196
|
-
* - Namespace of custom field definition
|
|
2197
|
-
*/
|
|
2417
|
+
key?: string;
|
|
2198
2418
|
namespace?: string;
|
|
2199
|
-
/**
|
|
2200
|
-
* - Flag to denote whether custom field is
|
|
2201
|
-
* multi valued or not
|
|
2202
|
-
*/
|
|
2203
2419
|
multi_value?: boolean;
|
|
2204
|
-
/**
|
|
2205
|
-
* - Name of custom field definition
|
|
2206
|
-
*/
|
|
2207
2420
|
name?: string;
|
|
2208
|
-
/**
|
|
2209
|
-
* - Description of a custom field definition
|
|
2210
|
-
*/
|
|
2211
2421
|
description?: string;
|
|
2212
|
-
|
|
2213
|
-
* - Validations for a custom field
|
|
2214
|
-
*/
|
|
2422
|
+
creator?: string;
|
|
2215
2423
|
validations?: FieldValidations[];
|
|
2216
2424
|
};
|
|
2217
2425
|
/** @returns {CustomObjectCustomFieldDefinitions} */
|
|
2218
2426
|
declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
|
|
2219
2427
|
type CustomObjectCustomFieldDefinitions = {
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
*/
|
|
2223
|
-
id?: string;
|
|
2224
|
-
/**
|
|
2225
|
-
* - Data type of custom field
|
|
2226
|
-
*/
|
|
2227
|
-
type?: string;
|
|
2228
|
-
/**
|
|
2229
|
-
* - Description of custom field
|
|
2230
|
-
*/
|
|
2428
|
+
_id?: string;
|
|
2429
|
+
type: string;
|
|
2231
2430
|
description?: string;
|
|
2232
|
-
/**
|
|
2233
|
-
* - Name of custom field
|
|
2234
|
-
*/
|
|
2235
2431
|
name?: string;
|
|
2236
|
-
/**
|
|
2237
|
-
* - Flag to denote if cusom field is multi
|
|
2238
|
-
* valued or not
|
|
2239
|
-
*/
|
|
2240
2432
|
multi_value?: boolean;
|
|
2241
|
-
/**
|
|
2242
|
-
* - Whether the field is required or not
|
|
2243
|
-
*/
|
|
2244
2433
|
required?: boolean;
|
|
2245
|
-
|
|
2246
|
-
* - Slug of custom field definition
|
|
2247
|
-
*/
|
|
2248
|
-
slug?: string;
|
|
2249
|
-
/**
|
|
2250
|
-
* - Validations added against the
|
|
2251
|
-
* custom field
|
|
2252
|
-
*/
|
|
2434
|
+
key?: string;
|
|
2253
2435
|
validations?: FieldValidations[];
|
|
2254
2436
|
action?: string;
|
|
2255
2437
|
};
|
|
2256
2438
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2257
2439
|
declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
|
|
2258
2440
|
type CustomObjectDefinitionUpdateRequestSchema = {
|
|
2259
|
-
|
|
2260
|
-
* - Description of custom object definiton
|
|
2261
|
-
*/
|
|
2441
|
+
type?: string;
|
|
2262
2442
|
description?: string;
|
|
2263
|
-
/**
|
|
2264
|
-
* - Name of custom object definition
|
|
2265
|
-
*/
|
|
2266
2443
|
name?: string;
|
|
2267
|
-
/**
|
|
2268
|
-
* - Custom field slug which is used as a
|
|
2269
|
-
* display key in
|
|
2270
|
-
*/
|
|
2271
2444
|
display_name_key?: string;
|
|
2272
|
-
field_definitions?:
|
|
2445
|
+
field_definitions?: CustomFieldDefinitionDetailResSchema[];
|
|
2273
2446
|
};
|
|
2274
2447
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2275
2448
|
declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
|
|
2276
2449
|
type CustomFieldDefinitionDetailResSchema = {
|
|
2277
|
-
|
|
2278
|
-
* - Resource to which custom field is associated
|
|
2279
|
-
*/
|
|
2450
|
+
creator?: string;
|
|
2280
2451
|
resource?: string;
|
|
2281
|
-
/**
|
|
2282
|
-
* - Name of custom field
|
|
2283
|
-
*/
|
|
2284
2452
|
name?: string;
|
|
2285
|
-
/**
|
|
2286
|
-
* - Namespace of custom field
|
|
2287
|
-
*/
|
|
2288
2453
|
namespace?: string;
|
|
2289
|
-
|
|
2290
|
-
* - Slug of custom field
|
|
2291
|
-
*/
|
|
2292
|
-
slug?: string;
|
|
2293
|
-
/**
|
|
2294
|
-
* - Description regarding custom field
|
|
2295
|
-
*/
|
|
2296
|
-
description?: string;
|
|
2297
|
-
/**
|
|
2298
|
-
* - Data type of custom field
|
|
2299
|
-
*/
|
|
2300
|
-
type?: string;
|
|
2301
|
-
/**
|
|
2302
|
-
* - Flag to denote whether custom field is
|
|
2303
|
-
* multi valued or not
|
|
2304
|
-
*/
|
|
2305
|
-
multi_value?: boolean;
|
|
2306
|
-
/**
|
|
2307
|
-
* - Company Identifer
|
|
2308
|
-
*/
|
|
2309
|
-
company_id?: string;
|
|
2310
|
-
/**
|
|
2311
|
-
* - Sales channel identifier
|
|
2312
|
-
*/
|
|
2313
|
-
application_id?: string;
|
|
2314
|
-
/**
|
|
2315
|
-
* - Whether the customfield is required or not
|
|
2316
|
-
*/
|
|
2317
|
-
required?: boolean;
|
|
2318
|
-
/**
|
|
2319
|
-
* - Is custom field deleted
|
|
2320
|
-
*/
|
|
2321
|
-
is_deleted?: boolean;
|
|
2322
|
-
/**
|
|
2323
|
-
* - Unique system generated id
|
|
2324
|
-
*/
|
|
2325
|
-
id?: string;
|
|
2326
|
-
validations?: any[];
|
|
2327
|
-
/**
|
|
2328
|
-
* - Date time at which field was created
|
|
2329
|
-
*/
|
|
2330
|
-
created_at?: string;
|
|
2331
|
-
/**
|
|
2332
|
-
* - Date time at for a field's last modification
|
|
2333
|
-
*/
|
|
2334
|
-
updated_at?: string;
|
|
2335
|
-
};
|
|
2336
|
-
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
2337
|
-
declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
|
|
2338
|
-
type MetaFieldDefinitionDetailResSchema = {
|
|
2339
|
-
/**
|
|
2340
|
-
* - Resource to which meta field is associated
|
|
2341
|
-
*/
|
|
2342
|
-
resource?: string;
|
|
2343
|
-
/**
|
|
2344
|
-
* - Name of meta field
|
|
2345
|
-
*/
|
|
2346
|
-
name?: string;
|
|
2347
|
-
/**
|
|
2348
|
-
* - Namespace of meta field
|
|
2349
|
-
*/
|
|
2350
|
-
namespace?: string;
|
|
2351
|
-
/**
|
|
2352
|
-
* - Slug of meta field
|
|
2353
|
-
*/
|
|
2354
|
-
slug?: string;
|
|
2355
|
-
/**
|
|
2356
|
-
* - Description regarding meta field
|
|
2357
|
-
*/
|
|
2454
|
+
key?: string;
|
|
2358
2455
|
description?: string;
|
|
2359
|
-
/**
|
|
2360
|
-
* - Data type of meta field
|
|
2361
|
-
*/
|
|
2362
2456
|
type?: string;
|
|
2363
|
-
/**
|
|
2364
|
-
* - Flag to denote whether meta field is
|
|
2365
|
-
* multi valued or not
|
|
2366
|
-
*/
|
|
2367
2457
|
multi_value?: boolean;
|
|
2368
|
-
/**
|
|
2369
|
-
* - Company Identifer
|
|
2370
|
-
*/
|
|
2371
2458
|
company_id?: string;
|
|
2372
|
-
/**
|
|
2373
|
-
* - Sales channel identifier
|
|
2374
|
-
*/
|
|
2375
2459
|
application_id?: string;
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
*/
|
|
2460
|
+
created_by?: string;
|
|
2461
|
+
updated_by?: string;
|
|
2379
2462
|
required?: boolean;
|
|
2380
|
-
/**
|
|
2381
|
-
* - Is meta field deleted
|
|
2382
|
-
*/
|
|
2383
2463
|
is_deleted?: boolean;
|
|
2384
|
-
|
|
2385
|
-
* - Unique system generated id
|
|
2386
|
-
*/
|
|
2387
|
-
id?: string;
|
|
2464
|
+
_id?: string;
|
|
2388
2465
|
validations?: any[];
|
|
2389
|
-
/**
|
|
2390
|
-
* - Date time at which field was created
|
|
2391
|
-
*/
|
|
2392
2466
|
created_at?: string;
|
|
2393
|
-
/**
|
|
2394
|
-
* - Date time at for a field's last modification
|
|
2395
|
-
*/
|
|
2396
2467
|
updated_at?: string;
|
|
2397
2468
|
};
|
|
2398
2469
|
/** @returns {CustomDataDeleteSchema} */
|
|
2399
2470
|
declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
|
|
2400
2471
|
type CustomDataDeleteSchema = {
|
|
2401
|
-
/**
|
|
2402
|
-
* - Denotes the success of the delete operation
|
|
2403
|
-
*/
|
|
2404
2472
|
success?: boolean;
|
|
2405
|
-
/**
|
|
2406
|
-
* - Denotes the message of delete operation
|
|
2407
|
-
*/
|
|
2408
2473
|
message?: string;
|
|
2409
2474
|
};
|
|
2410
|
-
/** @returns {CustomFieldValue} */
|
|
2411
|
-
declare function CustomFieldValue(): CustomFieldValue;
|
|
2412
|
-
type CustomFieldValue = {
|
|
2413
|
-
value?: any;
|
|
2414
|
-
};
|
|
2415
2475
|
/** @returns {CustomFieldSchema} */
|
|
2416
2476
|
declare function CustomFieldSchema(): CustomFieldSchema;
|
|
2417
2477
|
type CustomFieldSchema = {
|
|
2418
|
-
|
|
2419
|
-
* - Unique system generated id
|
|
2420
|
-
*/
|
|
2421
|
-
id?: string;
|
|
2422
|
-
/**
|
|
2423
|
-
* - Namespace of custom field definition
|
|
2424
|
-
*/
|
|
2478
|
+
_id?: string;
|
|
2425
2479
|
namespace?: string;
|
|
2426
|
-
|
|
2427
|
-
* - Slug of custom field definition
|
|
2428
|
-
*/
|
|
2429
|
-
slug?: string;
|
|
2430
|
-
/**
|
|
2431
|
-
* - The resource for which custom field is being created
|
|
2432
|
-
*/
|
|
2480
|
+
key?: string;
|
|
2433
2481
|
resource?: string;
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
*/
|
|
2438
|
-
resource_slug?: string;
|
|
2439
|
-
/**
|
|
2440
|
-
* - Data type of custom field
|
|
2441
|
-
*/
|
|
2442
|
-
type?: string;
|
|
2443
|
-
/**
|
|
2444
|
-
* - Whether custom field is multi valued
|
|
2445
|
-
*/
|
|
2482
|
+
creator?: string;
|
|
2483
|
+
resource_id?: string;
|
|
2484
|
+
type: string;
|
|
2446
2485
|
multi_value?: boolean;
|
|
2447
|
-
/**
|
|
2448
|
-
* - Identifer for a company
|
|
2449
|
-
*/
|
|
2450
2486
|
company_id?: string;
|
|
2487
|
+
definition_id?: string;
|
|
2451
2488
|
has_invalid_values?: boolean;
|
|
2452
2489
|
invalid_value_errors?: any[];
|
|
2453
|
-
|
|
2454
|
-
* - Indicates whether custom field is deleted
|
|
2455
|
-
*/
|
|
2490
|
+
created_by?: string;
|
|
2456
2491
|
is_deleted?: boolean;
|
|
2457
|
-
/**
|
|
2458
|
-
* - Time at which customer field was created
|
|
2459
|
-
*/
|
|
2460
2492
|
created_at?: string;
|
|
2461
|
-
/**
|
|
2462
|
-
* - Time at which custom field was updated
|
|
2463
|
-
*/
|
|
2464
2493
|
updated_at?: string;
|
|
2465
2494
|
};
|
|
2466
2495
|
/** @returns {CustomFieldsResponseSchema} */
|
|
@@ -2483,16 +2512,7 @@ type CustomFieldsResponseByResourceIdSchema = {
|
|
|
2483
2512
|
/** @returns {CustomField} */
|
|
2484
2513
|
declare function CustomField(): CustomField;
|
|
2485
2514
|
type CustomField = {
|
|
2486
|
-
|
|
2487
|
-
/**
|
|
2488
|
-
* - This is the namespace to which custom field belongs
|
|
2489
|
-
*/
|
|
2490
|
-
namespace?: string;
|
|
2491
|
-
/**
|
|
2492
|
-
* - This is the slug of custom field used while
|
|
2493
|
-
* creating a custom field definition
|
|
2494
|
-
*/
|
|
2495
|
-
slug?: string;
|
|
2515
|
+
definition_id?: string;
|
|
2496
2516
|
};
|
|
2497
2517
|
/** @returns {CustomFieldRequestSchema} */
|
|
2498
2518
|
declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
|
|
@@ -2502,349 +2522,168 @@ type CustomFieldRequestSchema = {
|
|
|
2502
2522
|
/** @returns {CustomObjectSchema} */
|
|
2503
2523
|
declare function CustomObjectSchema(): CustomObjectSchema;
|
|
2504
2524
|
type CustomObjectSchema = {
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
*/
|
|
2508
|
-
id?: string;
|
|
2509
|
-
/**
|
|
2510
|
-
* - Identifer for a company
|
|
2511
|
-
*/
|
|
2525
|
+
_id?: string;
|
|
2526
|
+
creator?: string;
|
|
2512
2527
|
company_id?: string;
|
|
2513
|
-
/**
|
|
2514
|
-
* - Identifer for a sales channel
|
|
2515
|
-
*/
|
|
2516
2528
|
application_id?: string;
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
*/
|
|
2529
|
+
created_by?: string;
|
|
2530
|
+
updated_by?: string;
|
|
2520
2531
|
status?: string;
|
|
2521
|
-
|
|
2522
|
-
* - Slug of custom object definition
|
|
2523
|
-
*/
|
|
2532
|
+
slug?: string;
|
|
2524
2533
|
type?: string;
|
|
2525
|
-
/**
|
|
2526
|
-
* - Slug for custom object definition
|
|
2527
|
-
*/
|
|
2528
|
-
definition_slug?: string;
|
|
2529
|
-
/**
|
|
2530
|
-
* - Value of custom field used for displaying
|
|
2531
|
-
* custom object
|
|
2532
|
-
*/
|
|
2533
2534
|
display_name?: string;
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2535
|
+
definition_id?: string;
|
|
2536
|
+
is_deleted?: boolean;
|
|
2537
|
+
created_at?: string;
|
|
2538
|
+
updated_at?: string;
|
|
2537
2539
|
fields?: CustomFieldSchema[];
|
|
2538
2540
|
};
|
|
2539
2541
|
/** @returns {CustomObjectDefinitionRequestSchema} */
|
|
2540
2542
|
declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
|
|
2541
2543
|
type CustomObjectDefinitionRequestSchema = {
|
|
2542
|
-
/**
|
|
2543
|
-
* - Namespace/Slug of Custom object definition
|
|
2544
|
-
*/
|
|
2545
2544
|
type?: string;
|
|
2546
|
-
/**
|
|
2547
|
-
* - Unique slug for a custom object definition
|
|
2548
|
-
*/
|
|
2549
|
-
definition_slug?: string;
|
|
2550
|
-
/**
|
|
2551
|
-
* - Description of custom object definition
|
|
2552
|
-
*/
|
|
2553
2545
|
description?: string;
|
|
2554
|
-
/**
|
|
2555
|
-
* - Name of custom object
|
|
2556
|
-
*/
|
|
2557
2546
|
name?: string;
|
|
2558
|
-
/**
|
|
2559
|
-
* - Denotes which custom field to be used
|
|
2560
|
-
* for displaying custom object
|
|
2561
|
-
*/
|
|
2562
2547
|
display_name_key?: string;
|
|
2563
|
-
/**
|
|
2564
|
-
* - List
|
|
2565
|
-
* of custom field definitions belonging to this custom object definition
|
|
2566
|
-
*/
|
|
2567
2548
|
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2568
2549
|
};
|
|
2569
|
-
/** @returns {
|
|
2570
|
-
declare function
|
|
2571
|
-
type
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
|
|
2578
|
-
|
|
2550
|
+
/** @returns {CustomObjectCustomFieldDefinitionResSchema} */
|
|
2551
|
+
declare function CustomObjectCustomFieldDefinitionResSchema(): CustomObjectCustomFieldDefinitionResSchema;
|
|
2552
|
+
type CustomObjectCustomFieldDefinitionResSchema = {
|
|
2553
|
+
creator?: string;
|
|
2554
|
+
resource?: string;
|
|
2555
|
+
name?: string;
|
|
2556
|
+
namespace?: string;
|
|
2557
|
+
key?: string;
|
|
2558
|
+
description?: string;
|
|
2559
|
+
type: string;
|
|
2560
|
+
multi_value?: boolean;
|
|
2561
|
+
validations?: FieldValidations[];
|
|
2562
|
+
company_id?: string;
|
|
2563
|
+
created_by?: string;
|
|
2564
|
+
metaobject_definition_id?: string;
|
|
2565
|
+
required?: boolean;
|
|
2566
|
+
is_deleted?: boolean;
|
|
2567
|
+
_id?: string;
|
|
2568
|
+
created_at?: string;
|
|
2569
|
+
updated_at?: string;
|
|
2570
|
+
application_id?: string;
|
|
2571
|
+
};
|
|
2572
|
+
/** @returns {CustomObjectDefinitionSchema} */
|
|
2573
|
+
declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
|
|
2574
|
+
type CustomObjectDefinitionSchema = {
|
|
2575
|
+
_id?: string;
|
|
2579
2576
|
name?: string;
|
|
2580
|
-
/**
|
|
2581
|
-
* - Type of custom object definiton
|
|
2582
|
-
*/
|
|
2583
2577
|
type?: string;
|
|
2584
|
-
/**
|
|
2585
|
-
* - Slug of custom object definiton
|
|
2586
|
-
*/
|
|
2587
|
-
definition_slug?: string;
|
|
2588
|
-
/**
|
|
2589
|
-
* - Display name of custom object definition
|
|
2590
|
-
*/
|
|
2591
2578
|
display_name_key?: string;
|
|
2592
|
-
/**
|
|
2593
|
-
* - Description of custom object definition
|
|
2594
|
-
*/
|
|
2595
2579
|
description?: string;
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2580
|
+
creator?: string;
|
|
2581
|
+
created_by?: string;
|
|
2582
|
+
updated_by?: string;
|
|
2583
|
+
application_id?: string;
|
|
2584
|
+
company_id?: string;
|
|
2585
|
+
created_at?: string;
|
|
2586
|
+
updated_at?: string;
|
|
2587
|
+
field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
|
|
2601
2588
|
};
|
|
2602
2589
|
/** @returns {CustomObjectDefinitionDeleteResponseSchema} */
|
|
2603
2590
|
declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
|
|
2604
2591
|
type CustomObjectDefinitionDeleteResponseSchema = {
|
|
2605
|
-
/**
|
|
2606
|
-
* - Success status of delete custom object definition.
|
|
2607
|
-
*/
|
|
2608
2592
|
success?: boolean;
|
|
2609
|
-
/**
|
|
2610
|
-
* - Response message when custom object definition
|
|
2611
|
-
* is deleted.
|
|
2612
|
-
*/
|
|
2613
2593
|
message?: string;
|
|
2614
2594
|
};
|
|
2615
|
-
/** @returns {
|
|
2616
|
-
declare function
|
|
2617
|
-
type
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
*/
|
|
2621
|
-
url?: string;
|
|
2622
|
-
/**
|
|
2623
|
-
* - Total no of records in csv file
|
|
2624
|
-
*/
|
|
2625
|
-
total_records?: number;
|
|
2595
|
+
/** @returns {CustomObjectEntryBulkUploadResponse} */
|
|
2596
|
+
declare function CustomObjectEntryBulkUploadResponse(): CustomObjectEntryBulkUploadResponse;
|
|
2597
|
+
type CustomObjectEntryBulkUploadResponse = {
|
|
2598
|
+
message?: string;
|
|
2599
|
+
task_id?: string;
|
|
2626
2600
|
};
|
|
2627
|
-
/** @returns {
|
|
2628
|
-
declare function
|
|
2629
|
-
type
|
|
2630
|
-
|
|
2631
|
-
* - Unique system generated id
|
|
2632
|
-
*/
|
|
2633
|
-
id?: string;
|
|
2634
|
-
/**
|
|
2635
|
-
* - Name of custom object
|
|
2636
|
-
*/
|
|
2601
|
+
/** @returns {CustomObjectListItemDefinationSchema} */
|
|
2602
|
+
declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
|
|
2603
|
+
type CustomObjectListItemDefinationSchema = {
|
|
2604
|
+
_id?: string;
|
|
2637
2605
|
name?: string;
|
|
2638
|
-
/**
|
|
2639
|
-
* - Type of custom object entry
|
|
2640
|
-
*/
|
|
2641
2606
|
type?: string;
|
|
2607
|
+
display_name_key?: string;
|
|
2642
2608
|
};
|
|
2643
2609
|
/** @returns {CustomObjectListItemSchema} */
|
|
2644
2610
|
declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
|
|
2645
2611
|
type CustomObjectListItemSchema = {
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
*/
|
|
2649
|
-
id?: string;
|
|
2650
|
-
/**
|
|
2651
|
-
* - Status of custom object
|
|
2652
|
-
*/
|
|
2612
|
+
_id?: string;
|
|
2613
|
+
definition_id?: string;
|
|
2653
2614
|
status?: string;
|
|
2654
|
-
|
|
2655
|
-
* - Creation time of custom object document
|
|
2656
|
-
*/
|
|
2657
|
-
created_at?: string;
|
|
2658
|
-
/**
|
|
2659
|
-
* - Updation time of custom object document
|
|
2660
|
-
*/
|
|
2615
|
+
slug?: string;
|
|
2661
2616
|
updated_at?: string;
|
|
2662
|
-
/**
|
|
2663
|
-
* - Display name of custom object
|
|
2664
|
-
*/
|
|
2665
2617
|
display_name?: string;
|
|
2666
|
-
definition?:
|
|
2667
|
-
/**
|
|
2668
|
-
* - References of the custom object entry
|
|
2669
|
-
*/
|
|
2618
|
+
definition?: CustomObjectListItemDefinationSchema;
|
|
2670
2619
|
references?: number;
|
|
2671
2620
|
};
|
|
2672
2621
|
/** @returns {CustomObjectsSchema} */
|
|
2673
2622
|
declare function CustomObjectsSchema(): CustomObjectsSchema;
|
|
2674
2623
|
type CustomObjectsSchema = {
|
|
2675
|
-
/**
|
|
2676
|
-
* - List of paginated custom
|
|
2677
|
-
* object entries
|
|
2678
|
-
*/
|
|
2679
2624
|
items?: CustomObjectListItemSchema[];
|
|
2680
2625
|
page?: Page;
|
|
2681
2626
|
};
|
|
2682
|
-
/** @returns {
|
|
2683
|
-
declare function
|
|
2684
|
-
type
|
|
2685
|
-
|
|
2686
|
-
|
|
2687
|
-
*/
|
|
2688
|
-
id?: string;
|
|
2689
|
-
/**
|
|
2690
|
-
* - Slug of custom field definition
|
|
2691
|
-
*/
|
|
2692
|
-
slug?: string;
|
|
2693
|
-
/**
|
|
2694
|
-
* - Namespace of custom field definition
|
|
2695
|
-
*/
|
|
2696
|
-
namespace?: string;
|
|
2697
|
-
/**
|
|
2698
|
-
* - Value of custom field
|
|
2699
|
-
*/
|
|
2700
|
-
value?: any[];
|
|
2701
|
-
/**
|
|
2702
|
-
* - Data type of the custom field
|
|
2703
|
-
*/
|
|
2627
|
+
/** @returns {CustomObjectFieldSchema} */
|
|
2628
|
+
declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
|
|
2629
|
+
type CustomObjectFieldSchema = {
|
|
2630
|
+
_id?: string;
|
|
2631
|
+
key?: string;
|
|
2704
2632
|
type?: string;
|
|
2633
|
+
definition_id?: string;
|
|
2705
2634
|
};
|
|
2706
|
-
/** @returns {
|
|
2707
|
-
declare function
|
|
2708
|
-
type
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
*/
|
|
2635
|
+
/** @returns {MetafieldTypesSchema} */
|
|
2636
|
+
declare function MetafieldTypesSchema(): MetafieldTypesSchema;
|
|
2637
|
+
type MetafieldTypesSchema = {
|
|
2638
|
+
metafield_types?: CustomFieldTypeSchema;
|
|
2639
|
+
};
|
|
2640
|
+
/** @returns {CustomObjectByIdSchema} */
|
|
2641
|
+
declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
|
|
2642
|
+
type CustomObjectByIdSchema = {
|
|
2643
|
+
_id?: string;
|
|
2716
2644
|
status?: string;
|
|
2717
|
-
|
|
2718
|
-
* - Display name for the Custom Object
|
|
2719
|
-
*/
|
|
2645
|
+
slug?: string;
|
|
2720
2646
|
display_name?: string;
|
|
2721
|
-
definition?:
|
|
2722
|
-
/**
|
|
2723
|
-
* - Places where the custom object has been
|
|
2724
|
-
* used as a custom field
|
|
2725
|
-
*/
|
|
2647
|
+
definition?: CustomObjectListItemDefinationSchema;
|
|
2726
2648
|
references?: any[];
|
|
2727
|
-
|
|
2728
|
-
* - Slug of custom object entry
|
|
2729
|
-
*/
|
|
2730
|
-
slug?: string;
|
|
2731
|
-
/**
|
|
2732
|
-
* - Slug of custom object definition
|
|
2733
|
-
*/
|
|
2734
|
-
definition_slug?: string;
|
|
2735
|
-
/**
|
|
2736
|
-
* - List of custom fields
|
|
2737
|
-
* inside the custom object
|
|
2738
|
-
*/
|
|
2739
|
-
fields?: CustomObjectFieldDefinition[];
|
|
2649
|
+
fields?: CustomObjectFieldSchema[];
|
|
2740
2650
|
};
|
|
2741
2651
|
/** @returns {CustomObjectBulkEntryInitiateDownload} */
|
|
2742
2652
|
declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
|
|
2743
2653
|
type CustomObjectBulkEntryInitiateDownload = {
|
|
2744
|
-
/**
|
|
2745
|
-
* - Message for the user
|
|
2746
|
-
*/
|
|
2747
2654
|
message?: string;
|
|
2748
|
-
/**
|
|
2749
|
-
* - Identifer for a task
|
|
2750
|
-
*/
|
|
2751
2655
|
task_id?: string;
|
|
2752
2656
|
};
|
|
2753
2657
|
/** @returns {CustomObjectMetaSchema} */
|
|
2754
2658
|
declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
|
|
2755
2659
|
type CustomObjectMetaSchema = {
|
|
2756
|
-
/**
|
|
2757
|
-
* - Total number of entries in the bulk entry
|
|
2758
|
-
*/
|
|
2759
2660
|
mo_total_count?: number;
|
|
2760
|
-
/**
|
|
2761
|
-
* - Number of entries which were successful
|
|
2762
|
-
*/
|
|
2763
2661
|
mo_success_count?: number;
|
|
2764
|
-
/**
|
|
2765
|
-
* - Number of entries which were failed
|
|
2766
|
-
*/
|
|
2767
2662
|
mo_error_count?: number;
|
|
2768
|
-
/**
|
|
2769
|
-
* - Type of object
|
|
2770
|
-
*/
|
|
2771
2663
|
mo_defintion_type?: string;
|
|
2772
2664
|
};
|
|
2773
2665
|
/** @returns {JobSchema} */
|
|
2774
2666
|
declare function JobSchema(): JobSchema;
|
|
2775
2667
|
type JobSchema = {
|
|
2776
|
-
|
|
2777
|
-
* - Unique system generated id
|
|
2778
|
-
*/
|
|
2779
|
-
id?: string;
|
|
2780
|
-
/**
|
|
2781
|
-
* - List of total jobs
|
|
2782
|
-
*/
|
|
2668
|
+
_id?: string;
|
|
2783
2669
|
jobs?: string[];
|
|
2784
|
-
/**
|
|
2785
|
-
* - List of finished jobs
|
|
2786
|
-
*/
|
|
2787
2670
|
finished_jobs?: string[];
|
|
2788
|
-
/**
|
|
2789
|
-
* - List of jobs which resulted in an error
|
|
2790
|
-
*/
|
|
2791
2671
|
error_jobs?: string[];
|
|
2792
|
-
/**
|
|
2793
|
-
* - List of errors occurred in the job
|
|
2794
|
-
*/
|
|
2795
2672
|
errors_occured?: string[];
|
|
2796
|
-
/**
|
|
2797
|
-
* - Company Identifer
|
|
2798
|
-
*/
|
|
2799
2673
|
company_id?: string;
|
|
2800
|
-
|
|
2801
|
-
* - Status of job
|
|
2802
|
-
*/
|
|
2674
|
+
creator?: string;
|
|
2803
2675
|
status?: string;
|
|
2804
|
-
/**
|
|
2805
|
-
* - Type of job
|
|
2806
|
-
*/
|
|
2807
2676
|
action_type?: string;
|
|
2808
|
-
/**
|
|
2809
|
-
* - Entity against which job is running
|
|
2810
|
-
*/
|
|
2811
2677
|
entity?: string;
|
|
2812
|
-
/**
|
|
2813
|
-
* - URL which contains the file with errors
|
|
2814
|
-
*/
|
|
2815
2678
|
error_url?: string;
|
|
2816
|
-
/**
|
|
2817
|
-
* - Number of items successfully finished
|
|
2818
|
-
*/
|
|
2819
2679
|
finished_count?: number;
|
|
2820
|
-
/**
|
|
2821
|
-
* - Number of items in error
|
|
2822
|
-
*/
|
|
2823
2680
|
error_count?: number;
|
|
2824
|
-
/**
|
|
2825
|
-
* - Number of successful items
|
|
2826
|
-
*/
|
|
2827
2681
|
success_count?: number;
|
|
2828
|
-
/**
|
|
2829
|
-
* - Total number of jobs
|
|
2830
|
-
*/
|
|
2831
2682
|
total_jobs?: number;
|
|
2832
2683
|
meta?: CustomObjectMetaSchema;
|
|
2833
|
-
/**
|
|
2834
|
-
* - Source from where the bulk job is created
|
|
2835
|
-
*/
|
|
2836
2684
|
created_by?: string;
|
|
2837
|
-
/**
|
|
2838
|
-
* - Date/Time when the job was created
|
|
2839
|
-
*/
|
|
2840
2685
|
created_at?: string;
|
|
2841
|
-
/**
|
|
2842
|
-
* - Date/Time when the job was updated
|
|
2843
|
-
*/
|
|
2844
2686
|
updated_at?: string;
|
|
2845
|
-
/**
|
|
2846
|
-
* - Sales Channel Identifier
|
|
2847
|
-
*/
|
|
2848
2687
|
application_id?: string;
|
|
2849
2688
|
};
|
|
2850
2689
|
/** @returns {CustomFieldBulkEntry} */
|
|
@@ -2859,11 +2698,6 @@ type CustomObjectBulkEntry = {
|
|
|
2859
2698
|
items?: JobSchema[];
|
|
2860
2699
|
page?: Page;
|
|
2861
2700
|
};
|
|
2862
|
-
/** @returns {MetafieldTypesSchema} */
|
|
2863
|
-
declare function MetafieldTypesSchema(): MetafieldTypesSchema;
|
|
2864
|
-
type MetafieldTypesSchema = {
|
|
2865
|
-
metafield_types?: CustomFieldTypeSchema;
|
|
2866
|
-
};
|
|
2867
2701
|
/** @returns {CustomFieldTypeSchema} */
|
|
2868
2702
|
declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
|
|
2869
2703
|
type CustomFieldTypeSchema = {
|
|
@@ -2883,17 +2717,6 @@ type CustomFieldTypeSchema = {
|
|
|
2883
2717
|
html?: HTML;
|
|
2884
2718
|
duration?: Duration;
|
|
2885
2719
|
};
|
|
2886
|
-
/** @returns {SupportedValidationsMetaExampleSchema} */
|
|
2887
|
-
declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
|
|
2888
|
-
type SupportedValidationsMetaExampleSchema = {
|
|
2889
|
-
name?: string;
|
|
2890
|
-
value?: string;
|
|
2891
|
-
};
|
|
2892
|
-
/** @returns {SupportedValidationsMetaSchema} */
|
|
2893
|
-
declare function SupportedValidationsMetaSchema(): SupportedValidationsMetaSchema;
|
|
2894
|
-
type SupportedValidationsMetaSchema = {
|
|
2895
|
-
examples?: SupportedValidationsMetaExampleSchema[];
|
|
2896
|
-
};
|
|
2897
2720
|
/** @returns {SupportedValidationsSchema} */
|
|
2898
2721
|
declare function SupportedValidationsSchema(): SupportedValidationsSchema;
|
|
2899
2722
|
type SupportedValidationsSchema = {
|
|
@@ -2901,394 +2724,149 @@ type SupportedValidationsSchema = {
|
|
|
2901
2724
|
type?: string;
|
|
2902
2725
|
display?: string;
|
|
2903
2726
|
required?: boolean;
|
|
2904
|
-
meta?: SupportedValidationsMetaSchema;
|
|
2905
2727
|
};
|
|
2906
2728
|
/** @returns {Duration} */
|
|
2907
2729
|
declare function Duration(): Duration;
|
|
2908
2730
|
type Duration = {
|
|
2909
|
-
/**
|
|
2910
|
-
* - Name data type of custom field
|
|
2911
|
-
*/
|
|
2912
2731
|
name?: string;
|
|
2913
|
-
/**
|
|
2914
|
-
* - Flag for listing enabled or not
|
|
2915
|
-
*/
|
|
2916
2732
|
list_enabled?: boolean;
|
|
2917
|
-
/**
|
|
2918
|
-
* - Type of custom field
|
|
2919
|
-
*/
|
|
2920
2733
|
type?: string;
|
|
2921
|
-
/**
|
|
2922
|
-
* - Category of custom field
|
|
2923
|
-
*/
|
|
2924
2734
|
category?: string;
|
|
2925
|
-
/**
|
|
2926
|
-
* - List of
|
|
2927
|
-
* validations available for the field
|
|
2928
|
-
*/
|
|
2929
2735
|
supported_validations?: SupportedValidationsSchema[];
|
|
2930
2736
|
};
|
|
2931
2737
|
/** @returns {HTML} */
|
|
2932
2738
|
declare function HTML(): HTML;
|
|
2933
2739
|
type HTML = {
|
|
2934
|
-
/**
|
|
2935
|
-
* - Name data type of custom field
|
|
2936
|
-
*/
|
|
2937
2740
|
name?: string;
|
|
2938
|
-
/**
|
|
2939
|
-
* - Flag for listing enabled or not
|
|
2940
|
-
*/
|
|
2941
2741
|
list_enabled?: boolean;
|
|
2942
|
-
/**
|
|
2943
|
-
* - Type of custom field
|
|
2944
|
-
*/
|
|
2945
2742
|
type?: string;
|
|
2946
|
-
/**
|
|
2947
|
-
* - List of
|
|
2948
|
-
* validations available for the field
|
|
2949
|
-
*/
|
|
2950
2743
|
supported_validations?: SupportedValidationsSchema[];
|
|
2951
2744
|
};
|
|
2952
2745
|
/** @returns {StringSingleLine} */
|
|
2953
2746
|
declare function StringSingleLine(): StringSingleLine;
|
|
2954
2747
|
type StringSingleLine = {
|
|
2955
|
-
/**
|
|
2956
|
-
* - Name data type of custom field
|
|
2957
|
-
*/
|
|
2958
2748
|
name?: string;
|
|
2959
|
-
/**
|
|
2960
|
-
* - Flag for listing enabled or not
|
|
2961
|
-
*/
|
|
2962
2749
|
list_enabled?: boolean;
|
|
2963
|
-
/**
|
|
2964
|
-
* - Category of custom field
|
|
2965
|
-
*/
|
|
2966
2750
|
category?: string;
|
|
2967
|
-
/**
|
|
2968
|
-
* - Type of custom field
|
|
2969
|
-
*/
|
|
2970
2751
|
type?: string;
|
|
2971
|
-
/**
|
|
2972
|
-
* - List of
|
|
2973
|
-
* validations available for the field
|
|
2974
|
-
*/
|
|
2975
2752
|
supported_validations?: SupportedValidationsSchema[];
|
|
2976
2753
|
};
|
|
2977
2754
|
/** @returns {StringMultiLine} */
|
|
2978
2755
|
declare function StringMultiLine(): StringMultiLine;
|
|
2979
2756
|
type StringMultiLine = {
|
|
2980
|
-
/**
|
|
2981
|
-
* - Name data type of custom field
|
|
2982
|
-
*/
|
|
2983
2757
|
name?: string;
|
|
2984
|
-
/**
|
|
2985
|
-
* - Flag for listing enabled or not
|
|
2986
|
-
*/
|
|
2987
2758
|
list_enabled?: boolean;
|
|
2988
|
-
/**
|
|
2989
|
-
* - Category of custom field
|
|
2990
|
-
*/
|
|
2991
2759
|
category?: string;
|
|
2992
|
-
/**
|
|
2993
|
-
* - Type of custom field
|
|
2994
|
-
*/
|
|
2995
2760
|
type?: string;
|
|
2996
|
-
/**
|
|
2997
|
-
* - List of
|
|
2998
|
-
* validations available for the field
|
|
2999
|
-
*/
|
|
3000
2761
|
supported_validations?: SupportedValidationsSchema[];
|
|
3001
2762
|
};
|
|
3002
2763
|
/** @returns {Dropdown} */
|
|
3003
2764
|
declare function Dropdown(): Dropdown;
|
|
3004
2765
|
type Dropdown = {
|
|
3005
|
-
/**
|
|
3006
|
-
* - Name data type of custom field
|
|
3007
|
-
*/
|
|
3008
2766
|
name?: string;
|
|
3009
|
-
/**
|
|
3010
|
-
* - Flag for listing enabled or not
|
|
3011
|
-
*/
|
|
3012
2767
|
list_enabled?: boolean;
|
|
3013
|
-
/**
|
|
3014
|
-
* - Category of custom field
|
|
3015
|
-
*/
|
|
3016
2768
|
category?: string;
|
|
3017
|
-
/**
|
|
3018
|
-
* - Category of custom field
|
|
3019
|
-
*/
|
|
3020
2769
|
type?: string;
|
|
3021
|
-
/**
|
|
3022
|
-
* - List of
|
|
3023
|
-
* validations available for the field
|
|
3024
|
-
*/
|
|
3025
2770
|
supported_validations?: SupportedValidationsSchema[];
|
|
3026
2771
|
};
|
|
3027
2772
|
/** @returns {Integer} */
|
|
3028
2773
|
declare function Integer(): Integer;
|
|
3029
2774
|
type Integer = {
|
|
3030
|
-
/**
|
|
3031
|
-
* - Name data type of custom field
|
|
3032
|
-
*/
|
|
3033
2775
|
name?: string;
|
|
3034
|
-
/**
|
|
3035
|
-
* - Flag for listing enabled or not
|
|
3036
|
-
*/
|
|
3037
2776
|
list_enabled?: boolean;
|
|
3038
|
-
/**
|
|
3039
|
-
* - Type of custom field
|
|
3040
|
-
*/
|
|
3041
2777
|
type?: string;
|
|
3042
|
-
/**
|
|
3043
|
-
* - Category of custom field
|
|
3044
|
-
*/
|
|
3045
2778
|
category?: string;
|
|
3046
|
-
/**
|
|
3047
|
-
* - List of
|
|
3048
|
-
* validations available for the field
|
|
3049
|
-
*/
|
|
3050
2779
|
supported_validations?: SupportedValidationsSchema[];
|
|
3051
2780
|
};
|
|
3052
2781
|
/** @returns {FloatType} */
|
|
3053
2782
|
declare function FloatType(): FloatType;
|
|
3054
2783
|
type FloatType = {
|
|
3055
|
-
/**
|
|
3056
|
-
* - Name data type of custom field
|
|
3057
|
-
*/
|
|
3058
2784
|
name?: string;
|
|
3059
|
-
/**
|
|
3060
|
-
* - Flag for listing enabled or not
|
|
3061
|
-
*/
|
|
3062
2785
|
list_enabled?: boolean;
|
|
3063
|
-
/**
|
|
3064
|
-
* - Type of custom field
|
|
3065
|
-
*/
|
|
3066
2786
|
type?: string;
|
|
3067
|
-
/**
|
|
3068
|
-
* - Category of custom field
|
|
3069
|
-
*/
|
|
3070
2787
|
category?: string;
|
|
3071
|
-
/**
|
|
3072
|
-
* - List of
|
|
3073
|
-
* validations available for the field
|
|
3074
|
-
*/
|
|
3075
2788
|
supported_validations?: SupportedValidationsSchema[];
|
|
3076
2789
|
};
|
|
3077
2790
|
/** @returns {BooleanType} */
|
|
3078
2791
|
declare function BooleanType(): BooleanType;
|
|
3079
2792
|
type BooleanType = {
|
|
3080
|
-
/**
|
|
3081
|
-
* - Name data type of custom field
|
|
3082
|
-
*/
|
|
3083
2793
|
name?: string;
|
|
3084
|
-
/**
|
|
3085
|
-
* - Category of custom field
|
|
3086
|
-
*/
|
|
3087
2794
|
category?: string;
|
|
3088
|
-
/**
|
|
3089
|
-
* - Flag for listing enabled or not
|
|
3090
|
-
*/
|
|
3091
2795
|
list_enabled?: boolean;
|
|
3092
|
-
/**
|
|
3093
|
-
* - Category of custom field
|
|
3094
|
-
*/
|
|
3095
2796
|
type?: string;
|
|
3096
|
-
/**
|
|
3097
|
-
* - List of
|
|
3098
|
-
* validations available for the field
|
|
3099
|
-
*/
|
|
3100
2797
|
supported_validations?: SupportedValidationsSchema[];
|
|
3101
2798
|
};
|
|
3102
2799
|
/** @returns {Date} */
|
|
3103
2800
|
declare function Date(): Date;
|
|
3104
2801
|
type Date = {
|
|
3105
|
-
/**
|
|
3106
|
-
* - Name data type of custom field
|
|
3107
|
-
*/
|
|
3108
2802
|
name?: string;
|
|
3109
|
-
/**
|
|
3110
|
-
* - Flag for listing enabled or not
|
|
3111
|
-
*/
|
|
3112
2803
|
list_enabled?: boolean;
|
|
3113
|
-
/**
|
|
3114
|
-
* - Category of custom field
|
|
3115
|
-
*/
|
|
3116
2804
|
category?: string;
|
|
3117
|
-
/**
|
|
3118
|
-
* - Type of custom field
|
|
3119
|
-
*/
|
|
3120
2805
|
type?: string;
|
|
3121
|
-
/**
|
|
3122
|
-
* - List of
|
|
3123
|
-
* validations available for the field
|
|
3124
|
-
*/
|
|
3125
2806
|
supported_validations?: SupportedValidationsSchema[];
|
|
3126
2807
|
};
|
|
3127
2808
|
/** @returns {Datetime} */
|
|
3128
2809
|
declare function Datetime(): Datetime;
|
|
3129
2810
|
type Datetime = {
|
|
3130
|
-
/**
|
|
3131
|
-
* - Name data type of custom field
|
|
3132
|
-
*/
|
|
3133
2811
|
name?: string;
|
|
3134
|
-
/**
|
|
3135
|
-
* - Category of custom field
|
|
3136
|
-
*/
|
|
3137
2812
|
category?: string;
|
|
3138
|
-
/**
|
|
3139
|
-
* - Flag for listing enabled or not
|
|
3140
|
-
*/
|
|
3141
2813
|
list_enabled?: boolean;
|
|
3142
|
-
/**
|
|
3143
|
-
* - Type of custom field
|
|
3144
|
-
*/
|
|
3145
2814
|
type?: string;
|
|
3146
|
-
/**
|
|
3147
|
-
* - List of
|
|
3148
|
-
* validations available for the field
|
|
3149
|
-
*/
|
|
3150
2815
|
supported_validations?: SupportedValidationsSchema[];
|
|
3151
2816
|
};
|
|
3152
2817
|
/** @returns {Json} */
|
|
3153
2818
|
declare function Json(): Json;
|
|
3154
2819
|
type Json = {
|
|
3155
|
-
/**
|
|
3156
|
-
* - Name data type of custom field
|
|
3157
|
-
*/
|
|
3158
2820
|
name?: string;
|
|
3159
|
-
/**
|
|
3160
|
-
* - Flag for listing enabled or not
|
|
3161
|
-
*/
|
|
3162
2821
|
list_enabled?: boolean;
|
|
3163
|
-
/**
|
|
3164
|
-
* - Category of custom field
|
|
3165
|
-
*/
|
|
3166
2822
|
category?: string;
|
|
3167
|
-
/**
|
|
3168
|
-
* - Type of custom field
|
|
3169
|
-
*/
|
|
3170
2823
|
type?: string;
|
|
3171
|
-
/**
|
|
3172
|
-
* - List of
|
|
3173
|
-
* validations available for the field
|
|
3174
|
-
*/
|
|
3175
2824
|
supported_validations?: SupportedValidationsSchema[];
|
|
3176
2825
|
};
|
|
3177
2826
|
/** @returns {File} */
|
|
3178
2827
|
declare function File(): File;
|
|
3179
2828
|
type File = {
|
|
3180
|
-
/**
|
|
3181
|
-
* - Name data type of custom field
|
|
3182
|
-
*/
|
|
3183
2829
|
name?: string;
|
|
3184
|
-
/**
|
|
3185
|
-
* - Category of custom field
|
|
3186
|
-
*/
|
|
3187
2830
|
category?: string;
|
|
3188
|
-
/**
|
|
3189
|
-
* - Flag for listing enabled or not
|
|
3190
|
-
*/
|
|
3191
2831
|
list_enabled?: boolean;
|
|
3192
|
-
/**
|
|
3193
|
-
* - Type of custom field
|
|
3194
|
-
*/
|
|
3195
2832
|
type?: string;
|
|
3196
2833
|
supported_validations?: SupportedValidationsSchema[];
|
|
3197
2834
|
};
|
|
3198
2835
|
/** @returns {Url} */
|
|
3199
2836
|
declare function Url(): Url;
|
|
3200
2837
|
type Url = {
|
|
3201
|
-
/**
|
|
3202
|
-
* - Name data type of custom field
|
|
3203
|
-
*/
|
|
3204
2838
|
name?: string;
|
|
3205
|
-
/**
|
|
3206
|
-
* - Flag for listing enabled or not
|
|
3207
|
-
*/
|
|
3208
2839
|
list_enabled?: boolean;
|
|
3209
|
-
/**
|
|
3210
|
-
* - Type of custom field
|
|
3211
|
-
*/
|
|
3212
2840
|
type?: string;
|
|
3213
|
-
/**
|
|
3214
|
-
* - List of
|
|
3215
|
-
* validations available for the field
|
|
3216
|
-
*/
|
|
3217
2841
|
supported_validations?: SupportedValidationsSchema[];
|
|
3218
2842
|
};
|
|
3219
2843
|
/** @returns {Metaobject} */
|
|
3220
2844
|
declare function Metaobject(): Metaobject;
|
|
3221
2845
|
type Metaobject = {
|
|
3222
|
-
/**
|
|
3223
|
-
* - Name of Custom Object
|
|
3224
|
-
*/
|
|
3225
2846
|
name?: string;
|
|
3226
|
-
/**
|
|
3227
|
-
* - Whether the field is allowed to have
|
|
3228
|
-
* multiple list items
|
|
3229
|
-
*/
|
|
3230
2847
|
list_enabled?: boolean;
|
|
3231
|
-
/**
|
|
3232
|
-
* - Category of Custom Object Definition that
|
|
3233
|
-
* Custom Object belongs to
|
|
3234
|
-
*/
|
|
3235
2848
|
category?: string;
|
|
3236
|
-
/**
|
|
3237
|
-
* - Type of Custom Object Definition
|
|
3238
|
-
*/
|
|
3239
2849
|
type?: string;
|
|
3240
2850
|
supported_validations?: SupportedValidationsSchema[];
|
|
3241
2851
|
};
|
|
3242
2852
|
/** @returns {Product} */
|
|
3243
2853
|
declare function Product(): Product;
|
|
3244
2854
|
type Product = {
|
|
3245
|
-
/**
|
|
3246
|
-
* - Name of Product
|
|
3247
|
-
*/
|
|
3248
2855
|
name?: string;
|
|
3249
|
-
/**
|
|
3250
|
-
* - Whether the field is allowed to have
|
|
3251
|
-
* multiple list items
|
|
3252
|
-
*/
|
|
3253
2856
|
list_enabled?: boolean;
|
|
3254
|
-
/**
|
|
3255
|
-
* - Category of Custom Object Definition that
|
|
3256
|
-
* Product is associated with
|
|
3257
|
-
*/
|
|
3258
2857
|
category?: string;
|
|
3259
|
-
/**
|
|
3260
|
-
* - Custom Object Definition that Product is associated with
|
|
3261
|
-
*/
|
|
3262
2858
|
type?: string;
|
|
3263
2859
|
supported_validations?: SupportedValidationsSchema[];
|
|
2860
|
+
scope?: string[];
|
|
3264
2861
|
};
|
|
3265
2862
|
/** @returns {CustomObjectEntry} */
|
|
3266
2863
|
declare function CustomObjectEntry(): CustomObjectEntry;
|
|
3267
2864
|
type CustomObjectEntry = {
|
|
3268
|
-
|
|
3269
|
-
* - Unique system generated id
|
|
3270
|
-
*/
|
|
3271
|
-
id?: string;
|
|
3272
|
-
/**
|
|
3273
|
-
* - Name of Custom Object definition
|
|
3274
|
-
*/
|
|
2865
|
+
_id?: string;
|
|
3275
2866
|
name?: string;
|
|
3276
|
-
/**
|
|
3277
|
-
* - Type of Custom Object Definition
|
|
3278
|
-
*/
|
|
3279
2867
|
type?: string;
|
|
3280
|
-
/**
|
|
3281
|
-
* - Updation time of a Custom Object
|
|
3282
|
-
*/
|
|
3283
2868
|
updated_at?: string;
|
|
3284
|
-
/**
|
|
3285
|
-
* - Number of entries against the Custom
|
|
3286
|
-
* Object definition
|
|
3287
|
-
*/
|
|
3288
2869
|
entries_count?: number;
|
|
3289
|
-
/**
|
|
3290
|
-
* - Number of fields against a Custom Object definition
|
|
3291
|
-
*/
|
|
3292
2870
|
fields_count?: number;
|
|
3293
2871
|
};
|
|
3294
2872
|
/** @returns {CustomObjectDefinitionsSchema} */
|
|
@@ -3300,65 +2878,20 @@ type CustomObjectDefinitionsSchema = {
|
|
|
3300
2878
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
3301
2879
|
declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
|
|
3302
2880
|
type CustomObjectEntryFieldSchema = {
|
|
3303
|
-
|
|
3304
|
-
* - This is namespace for a custom field definition
|
|
3305
|
-
*/
|
|
3306
|
-
namespace?: string;
|
|
3307
|
-
/**
|
|
3308
|
-
* - This is slug for a custom field definition
|
|
3309
|
-
*/
|
|
3310
|
-
slug?: string;
|
|
3311
|
-
};
|
|
3312
|
-
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3313
|
-
declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
|
|
3314
|
-
type CustomObjectEntryFieldSchemaWithoutID = {
|
|
3315
|
-
/**
|
|
3316
|
-
* - Custom fields belonging to a custom object
|
|
3317
|
-
*/
|
|
3318
|
-
slug?: string;
|
|
3319
|
-
/**
|
|
3320
|
-
* - Value of custom field inside a custom object
|
|
3321
|
-
*/
|
|
3322
|
-
value?: any;
|
|
2881
|
+
definition_id?: string;
|
|
3323
2882
|
};
|
|
3324
2883
|
/** @returns {CustomObjectRequestSchema} */
|
|
3325
2884
|
declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
|
|
3326
2885
|
type CustomObjectRequestSchema = {
|
|
3327
|
-
/**
|
|
3328
|
-
* - Flag to denote status of Custom Object
|
|
3329
|
-
*/
|
|
3330
2886
|
status?: string;
|
|
3331
|
-
/**
|
|
3332
|
-
* - This is slug for a custom field definition
|
|
3333
|
-
*/
|
|
3334
2887
|
slug?: string;
|
|
3335
|
-
|
|
3336
|
-
* - List of custom fields
|
|
3337
|
-
*/
|
|
2888
|
+
definition_id?: string;
|
|
3338
2889
|
fields?: CustomObjectEntryFieldSchema[];
|
|
3339
2890
|
};
|
|
3340
|
-
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3341
|
-
declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
|
|
3342
|
-
type CustomObjectRequestSchemaWithoutId = {
|
|
3343
|
-
/**
|
|
3344
|
-
* - Status of the custom object entry.
|
|
3345
|
-
*/
|
|
3346
|
-
status?: string;
|
|
3347
|
-
/**
|
|
3348
|
-
* - List of custom fields
|
|
3349
|
-
*/
|
|
3350
|
-
fields?: CustomObjectEntryFieldSchemaWithoutID[];
|
|
3351
|
-
};
|
|
3352
2891
|
/** @returns {CustomObjectBulkSchema} */
|
|
3353
2892
|
declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
|
|
3354
2893
|
type CustomObjectBulkSchema = {
|
|
3355
|
-
/**
|
|
3356
|
-
* - Full URL for the bulk operations data
|
|
3357
|
-
*/
|
|
3358
2894
|
url?: string;
|
|
3359
|
-
/**
|
|
3360
|
-
* - Total records in the upload.
|
|
3361
|
-
*/
|
|
3362
2895
|
total_records?: number;
|
|
3363
2896
|
};
|
|
3364
2897
|
/** @returns {ActionPage} */
|
|
@@ -3378,13 +2911,6 @@ type ActionPage = {
|
|
|
3378
2911
|
url?: string;
|
|
3379
2912
|
type: PageType;
|
|
3380
2913
|
};
|
|
3381
|
-
/**
|
|
3382
|
-
* Enum: GenerationEntityType Used By: Content
|
|
3383
|
-
*
|
|
3384
|
-
* @returns {GenerationEntityType}
|
|
3385
|
-
*/
|
|
3386
|
-
declare function GenerationEntityType(): GenerationEntityType;
|
|
3387
|
-
type GenerationEntityType = "title" | "description";
|
|
3388
2914
|
/**
|
|
3389
2915
|
* Enum: PageType Used By: Content
|
|
3390
2916
|
*
|