@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
- package/sdk/application/Cart/CartApplicationClient.js +157 -530
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +65 -55
- package/sdk/application/Content/ContentApplicationClient.js +211 -341
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +32 -87
- package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +18 -62
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -406
- package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
- package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
- package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
- package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +236 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +314 -422
- package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -68
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +565 -1282
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -246
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2374 -877
- package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +421 -418
- package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
- package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +934 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1327 -3529
- package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -513
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -4
- package/sdk/platform/Share/SharePlatformModel.js +45 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -1,4 +1,9 @@
|
|
|
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
|
+
*/
|
|
2
7
|
/**
|
|
3
8
|
* @typedef GenerateSEOContent
|
|
4
9
|
* @property {string} [text]
|
|
@@ -22,7 +27,6 @@ export = ContentPlatformModel;
|
|
|
22
27
|
* @property {string} [_id]
|
|
23
28
|
* @property {string} [updated_at]
|
|
24
29
|
* @property {string} [created_at]
|
|
25
|
-
* @property {number} [__v]
|
|
26
30
|
*/
|
|
27
31
|
/**
|
|
28
32
|
* @typedef ApplicationLegalFAQ
|
|
@@ -37,7 +41,7 @@ export = ContentPlatformModel;
|
|
|
37
41
|
* @property {string} [redirect_to]
|
|
38
42
|
* @property {string} [updated_at]
|
|
39
43
|
* @property {string} [created_at]
|
|
40
|
-
* @property {
|
|
44
|
+
* @property {PathSourceSchema} [__source]
|
|
41
45
|
*/
|
|
42
46
|
/**
|
|
43
47
|
* @typedef PathSourceSchema
|
|
@@ -50,8 +54,8 @@ export = ContentPlatformModel;
|
|
|
50
54
|
*/
|
|
51
55
|
/**
|
|
52
56
|
* @typedef SeoSchema
|
|
53
|
-
* @property {string} [_id]
|
|
54
57
|
* @property {string} [app]
|
|
58
|
+
* @property {string} [_id]
|
|
55
59
|
* @property {string} [robots_txt]
|
|
56
60
|
* @property {boolean} [sitemap_enabled]
|
|
57
61
|
* @property {string} [additional_sitemap]
|
|
@@ -60,8 +64,6 @@ export = ContentPlatformModel;
|
|
|
60
64
|
* @property {Detail} [details]
|
|
61
65
|
* @property {string} [created_at]
|
|
62
66
|
* @property {string} [updated_at]
|
|
63
|
-
* @property {number} [__v]
|
|
64
|
-
* @property {SEOSitemap} [sitemap]
|
|
65
67
|
*/
|
|
66
68
|
/**
|
|
67
69
|
* @typedef CustomMetaTag
|
|
@@ -82,50 +84,27 @@ export = ContentPlatformModel;
|
|
|
82
84
|
*/
|
|
83
85
|
/**
|
|
84
86
|
* @typedef SEOSchemaMarkupTemplate
|
|
85
|
-
* @property {string} [
|
|
87
|
+
* @property {string} [id]
|
|
86
88
|
* @property {string} [title]
|
|
87
89
|
* @property {string} [page_type]
|
|
88
90
|
* @property {string} [schema]
|
|
89
91
|
* @property {string} [description]
|
|
90
92
|
* @property {boolean} [active]
|
|
91
|
-
* @property {string} [application]
|
|
92
93
|
* @property {string} [created_at]
|
|
93
94
|
* @property {string} [updated_at]
|
|
95
|
+
* @property {string} [application]
|
|
94
96
|
* @property {Object} [target_json]
|
|
95
|
-
* @property {number} [__v]
|
|
96
97
|
*/
|
|
97
98
|
/**
|
|
98
99
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
99
100
|
* @property {string} [title]
|
|
100
101
|
* @property {string} [page_type]
|
|
101
|
-
* @property {string} [description]
|
|
102
102
|
* @property {string} [schema]
|
|
103
|
+
* @property {string} [description]
|
|
103
104
|
* @property {Object} [target_json]
|
|
104
105
|
* @property {boolean} [active]
|
|
105
106
|
* @property {string} [created_at]
|
|
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]
|
|
107
|
+
* @property {string} [updated_at]
|
|
129
108
|
*/
|
|
130
109
|
/**
|
|
131
110
|
* @typedef AnnouncementPageSchema
|
|
@@ -166,10 +145,10 @@ export = ContentPlatformModel;
|
|
|
166
145
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
167
146
|
* @property {string} [page_type]
|
|
168
147
|
* @property {string} [schema]
|
|
148
|
+
* @property {Object} [target_json]
|
|
169
149
|
*/
|
|
170
150
|
/**
|
|
171
151
|
* @typedef ScheduleSchema
|
|
172
|
-
* @property {boolean} [published]
|
|
173
152
|
* @property {string} [cron]
|
|
174
153
|
* @property {string} [start]
|
|
175
154
|
* @property {string} [end]
|
|
@@ -182,7 +161,7 @@ export = ContentPlatformModel;
|
|
|
182
161
|
* @property {string} [end]
|
|
183
162
|
*/
|
|
184
163
|
/**
|
|
185
|
-
* @typedef
|
|
164
|
+
* @typedef BlogGetDetails
|
|
186
165
|
* @property {BlogSchema[]} [items]
|
|
187
166
|
* @property {Page} [page]
|
|
188
167
|
* @property {BlogFilters} [filters]
|
|
@@ -206,7 +185,7 @@ export = ContentPlatformModel;
|
|
|
206
185
|
* @typedef Author
|
|
207
186
|
* @property {string} [designation]
|
|
208
187
|
* @property {string} [id]
|
|
209
|
-
* @property {string} [name]
|
|
188
|
+
* @property {string} [name] - Name of the author
|
|
210
189
|
*/
|
|
211
190
|
/**
|
|
212
191
|
* @typedef BlogSchema
|
|
@@ -226,7 +205,6 @@ export = ContentPlatformModel;
|
|
|
226
205
|
* @property {string} [title]
|
|
227
206
|
* @property {DateMeta} [date_meta]
|
|
228
207
|
* @property {string} [summary]
|
|
229
|
-
* @property {string} [status]
|
|
230
208
|
*/
|
|
231
209
|
/**
|
|
232
210
|
* @typedef SEO
|
|
@@ -235,7 +213,7 @@ export = ContentPlatformModel;
|
|
|
235
213
|
* @property {string} [title]
|
|
236
214
|
* @property {SEOMetaItem[]} [meta_tags]
|
|
237
215
|
* @property {SEOSitemap} [sitemap]
|
|
238
|
-
* @property {SEObreadcrumb[]} [
|
|
216
|
+
* @property {SEObreadcrumb[]} [breadcrumb]
|
|
239
217
|
* @property {string} [canonical_url]
|
|
240
218
|
*/
|
|
241
219
|
/**
|
|
@@ -268,7 +246,7 @@ export = ContentPlatformModel;
|
|
|
268
246
|
* @property {string} [modified_on]
|
|
269
247
|
*/
|
|
270
248
|
/**
|
|
271
|
-
* @typedef
|
|
249
|
+
* @typedef BlogPayload
|
|
272
250
|
* @property {string} [application]
|
|
273
251
|
* @property {Object} [_custom_json]
|
|
274
252
|
* @property {Author} [author]
|
|
@@ -279,7 +257,6 @@ export = ContentPlatformModel;
|
|
|
279
257
|
* @property {string} [slug]
|
|
280
258
|
* @property {string[]} [tags]
|
|
281
259
|
* @property {string} [title]
|
|
282
|
-
* @property {string} [publish_date]
|
|
283
260
|
* @property {SEO} [seo]
|
|
284
261
|
* @property {string} [summary]
|
|
285
262
|
*/
|
|
@@ -293,10 +270,6 @@ export = ContentPlatformModel;
|
|
|
293
270
|
* @property {string} [message]
|
|
294
271
|
* @property {AdminAnnouncementSchema} [data]
|
|
295
272
|
*/
|
|
296
|
-
/**
|
|
297
|
-
* @typedef DataLoaderItemsResponseSchema
|
|
298
|
-
* @property {DataLoaderResponseSchema[]} [items]
|
|
299
|
-
*/
|
|
300
273
|
/**
|
|
301
274
|
* @typedef DataLoaderResponseSchema
|
|
302
275
|
* @property {string} [application]
|
|
@@ -308,15 +281,11 @@ export = ContentPlatformModel;
|
|
|
308
281
|
* @property {string} [type]
|
|
309
282
|
* @property {string} [url]
|
|
310
283
|
* @property {string} [content]
|
|
311
|
-
* @property {string} [created_at]
|
|
312
|
-
* @property {string} [modified_at]
|
|
313
|
-
* @property {number} [__v]
|
|
314
|
-
* @property {boolean} [is_selected]
|
|
315
284
|
* @property {DataLoaderSourceSchema} [__source]
|
|
316
285
|
*/
|
|
317
286
|
/**
|
|
318
287
|
* @typedef DataLoaderResetResponseSchema
|
|
319
|
-
* @property {boolean} [
|
|
288
|
+
* @property {boolean} [reset]
|
|
320
289
|
*/
|
|
321
290
|
/**
|
|
322
291
|
* @typedef LocaleLanguage
|
|
@@ -341,18 +310,13 @@ export = ContentPlatformModel;
|
|
|
341
310
|
* @property {LocaleLanguage} [_locale_language]
|
|
342
311
|
* @property {string} [image]
|
|
343
312
|
* @property {string} [type]
|
|
313
|
+
* @property {Action} [action]
|
|
344
314
|
* @property {boolean} [active]
|
|
345
315
|
* @property {string} [display]
|
|
346
316
|
* @property {number} [sort_order]
|
|
347
317
|
* @property {CronBasedScheduleSchema} [schedule]
|
|
348
318
|
* @property {NavigationReference[]} [sub_navigation]
|
|
349
319
|
*/
|
|
350
|
-
/**
|
|
351
|
-
* @typedef AssignmentReference
|
|
352
|
-
* @property {string} [platform]
|
|
353
|
-
* @property {string} [orientation]
|
|
354
|
-
* @property {string} [position]
|
|
355
|
-
*/
|
|
356
320
|
/**
|
|
357
321
|
* @typedef CronBasedScheduleSchema
|
|
358
322
|
* @property {boolean} [enabled]
|
|
@@ -366,78 +330,92 @@ export = ContentPlatformModel;
|
|
|
366
330
|
*/
|
|
367
331
|
/**
|
|
368
332
|
* @typedef HandpickedTagSchema
|
|
369
|
-
* @property {string} [position]
|
|
370
|
-
*
|
|
371
|
-
* @property {
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
333
|
+
* @property {string} [position] - The location in the page where the tag should
|
|
334
|
+
* be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
335
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
336
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
337
|
+
* tag type for example:
|
|
338
|
+
*
|
|
339
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
340
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
341
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
342
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
343
|
+
*
|
|
344
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
345
|
+
* third-party tag can be injected or supported.
|
|
346
|
+
* @property {string} [name] - The name of the tag used to identify it in the
|
|
347
|
+
* system. Example: 'Google External Script' or 'Bootstrap CSS'.
|
|
348
|
+
* @property {string} [url] - The URL where the external tag resource (such as a
|
|
349
|
+
* script or stylesheet) is hosted.
|
|
350
|
+
* @property {string} [type] - The type of the tag, such as 'script' (for
|
|
351
|
+
* JavaScript) or 'link' (for CSS).
|
|
352
|
+
* @property {string} [sub_type] - Defines whether the tag is embedded within
|
|
353
|
+
* the HTML (inline) or linked externally (external).
|
|
354
|
+
* @property {string} [content] - The actual content of the inline tag, such as
|
|
355
|
+
* JavaScript or CSS code if the tag is inline.
|
|
376
356
|
*/
|
|
377
357
|
/**
|
|
378
358
|
* @typedef RemoveHandpickedSchema
|
|
379
|
-
* @property {string[]} [tags]
|
|
359
|
+
* @property {string[]} [tags] - A list of tag IDs to remove from the system.
|
|
380
360
|
*/
|
|
381
361
|
/**
|
|
382
362
|
* @typedef CreateTagSchema
|
|
383
|
-
* @property {string} [name]
|
|
384
|
-
*
|
|
385
|
-
* @property {string} [
|
|
386
|
-
*
|
|
387
|
-
* @property {string} [
|
|
388
|
-
* @property {string} [
|
|
389
|
-
*
|
|
390
|
-
* @property {
|
|
391
|
-
*
|
|
363
|
+
* @property {string} [name] - The name of the tag to be created, used for
|
|
364
|
+
* identification purposes.
|
|
365
|
+
* @property {string} [sub_type] - Indicates if the tag is external (linked) or
|
|
366
|
+
* inline (embedded within the page).
|
|
367
|
+
* @property {string} [_id] - The unique identifier for the tag.
|
|
368
|
+
* @property {string} [type] - The type of the tag, either JavaScript ('js') or
|
|
369
|
+
* CSS ('css').
|
|
370
|
+
* @property {string} [url] - The external URL pointing to the script or
|
|
371
|
+
* stylesheet resource.
|
|
372
|
+
* @property {string} [position] - The position on the webpage where the tag
|
|
373
|
+
* will be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
374
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
375
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
376
|
+
* tag type for example:
|
|
377
|
+
*
|
|
378
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
379
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
380
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
381
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
382
|
+
*
|
|
383
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
384
|
+
* third-party tag can be injected or supported.
|
|
385
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be
|
|
386
|
+
* injected or active.
|
|
387
|
+
* @property {string} [content] - The inline content for tags of type 'inline'
|
|
388
|
+
* (e.g., JavaScript or CSS code).
|
|
392
389
|
*/
|
|
393
390
|
/**
|
|
394
391
|
* @typedef CreateTagRequestSchema
|
|
395
|
-
* @property {CreateTagSchema[]} [tags]
|
|
392
|
+
* @property {CreateTagSchema[]} [tags] - A list of tags to be created or
|
|
393
|
+
* updated, each containing details such as name, type, and attributes.
|
|
396
394
|
*/
|
|
397
395
|
/**
|
|
398
396
|
* @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]
|
|
405
397
|
* @property {string} [name]
|
|
406
398
|
* @property {string} [service]
|
|
407
399
|
* @property {string} [operation_id]
|
|
408
|
-
* @property {boolean} [is_selected]
|
|
409
400
|
* @property {string} [type]
|
|
401
|
+
* @property {string} [url]
|
|
402
|
+
* @property {string} [content]
|
|
410
403
|
* @property {DataLoaderSourceSchema} [__source]
|
|
404
|
+
* @property {string} [_id]
|
|
411
405
|
*/
|
|
412
406
|
/**
|
|
413
407
|
* @typedef DataLoaderSourceSchema
|
|
414
408
|
* @property {string} [type]
|
|
415
409
|
* @property {string} [id]
|
|
416
410
|
*/
|
|
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
|
-
*/
|
|
434
411
|
/**
|
|
435
412
|
* @typedef DataLoadersSchema
|
|
436
413
|
* @property {DataLoaderSchema[]} [items]
|
|
437
414
|
*/
|
|
438
415
|
/**
|
|
439
|
-
* @typedef
|
|
440
|
-
* @property {boolean} [success]
|
|
416
|
+
* @typedef TagDeleteSuccessDetails
|
|
417
|
+
* @property {boolean} [success] - Indicates whether the tag removal operation
|
|
418
|
+
* was successful.
|
|
441
419
|
*/
|
|
442
420
|
/**
|
|
443
421
|
* @typedef ContentAPIError
|
|
@@ -445,6 +423,7 @@ export = ContentPlatformModel;
|
|
|
445
423
|
* @property {number} [status]
|
|
446
424
|
* @property {string} [code]
|
|
447
425
|
* @property {string} [exception]
|
|
426
|
+
* @property {string} [info]
|
|
448
427
|
* @property {string} [request_id]
|
|
449
428
|
* @property {string} [stack_trace]
|
|
450
429
|
* @property {Object} [meta]
|
|
@@ -464,7 +443,6 @@ export = ContentPlatformModel;
|
|
|
464
443
|
* @property {string} [application]
|
|
465
444
|
* @property {string} [icon_url]
|
|
466
445
|
* @property {Object} [_custom_json]
|
|
467
|
-
* @property {number} [__v]
|
|
468
446
|
*/
|
|
469
447
|
/**
|
|
470
448
|
* @typedef ChildrenSchema
|
|
@@ -481,15 +459,15 @@ export = ContentPlatformModel;
|
|
|
481
459
|
*/
|
|
482
460
|
/**
|
|
483
461
|
* @typedef FAQCategorySchema
|
|
484
|
-
* @property {
|
|
485
|
-
* @property {string} [application]
|
|
462
|
+
* @property {number} [index]
|
|
486
463
|
* @property {string} [title]
|
|
487
464
|
* @property {string} [description]
|
|
488
|
-
* @property {number} [index]
|
|
489
|
-
* @property {string} [slug]
|
|
490
465
|
* @property {ChildrenSchema[]} [children]
|
|
466
|
+
* @property {string} [_id]
|
|
467
|
+
* @property {string} [slug]
|
|
468
|
+
* @property {string} [application]
|
|
491
469
|
* @property {string} [icon_url]
|
|
492
|
-
* @property {
|
|
470
|
+
* @property {Object} [_custom_json]
|
|
493
471
|
*/
|
|
494
472
|
/**
|
|
495
473
|
* @typedef FaqSchema
|
|
@@ -499,7 +477,6 @@ export = ContentPlatformModel;
|
|
|
499
477
|
* @property {string} [question]
|
|
500
478
|
* @property {string} [answer]
|
|
501
479
|
* @property {string[]} [tags]
|
|
502
|
-
* @property {number} [__v]
|
|
503
480
|
*/
|
|
504
481
|
/**
|
|
505
482
|
* @typedef FAQ
|
|
@@ -548,16 +525,17 @@ export = ContentPlatformModel;
|
|
|
548
525
|
* @property {number} [current] - The current page number.
|
|
549
526
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
550
527
|
* @property {number} [size] - The number of items per page.
|
|
551
|
-
* @property {number} [
|
|
528
|
+
* @property {number} [page_size] - The number of items per page.
|
|
552
529
|
*/
|
|
553
530
|
/**
|
|
554
|
-
* @typedef
|
|
531
|
+
* @typedef LandingPageGetDetails
|
|
555
532
|
* @property {LandingPageSchema[]} [items]
|
|
556
533
|
* @property {Page} [page]
|
|
557
534
|
*/
|
|
558
535
|
/**
|
|
559
536
|
* @typedef LandingPageSchema
|
|
560
537
|
* @property {string} [slug]
|
|
538
|
+
* @property {Action} [action]
|
|
561
539
|
* @property {string[]} [platform]
|
|
562
540
|
* @property {CreatedBySchema} [created_by]
|
|
563
541
|
* @property {DateMeta} [date_meta]
|
|
@@ -565,14 +543,13 @@ export = ContentPlatformModel;
|
|
|
565
543
|
* @property {string} [application]
|
|
566
544
|
* @property {boolean} [archived]
|
|
567
545
|
* @property {Object} [_custom_json]
|
|
568
|
-
* @property {number} [__v]
|
|
569
546
|
*/
|
|
570
547
|
/**
|
|
571
|
-
* @typedef
|
|
548
|
+
* @typedef DefaultNavigationDetails
|
|
572
549
|
* @property {NavigationSchema[]} [items]
|
|
573
550
|
*/
|
|
574
551
|
/**
|
|
575
|
-
* @typedef
|
|
552
|
+
* @typedef NavigationGetDetails
|
|
576
553
|
* @property {NavigationSchema[]} [items]
|
|
577
554
|
* @property {Page} [page]
|
|
578
555
|
*/
|
|
@@ -594,26 +571,17 @@ export = ContentPlatformModel;
|
|
|
594
571
|
* @property {Orientation} [orientation]
|
|
595
572
|
* @property {number} [version]
|
|
596
573
|
* @property {NavigationReference[]} [navigation]
|
|
597
|
-
* @property {AssignmentReference[]} [assignments]
|
|
598
|
-
* @property {number} [__v]
|
|
599
574
|
*/
|
|
600
575
|
/**
|
|
601
|
-
* @typedef
|
|
576
|
+
* @typedef NavigationPayload
|
|
602
577
|
* @property {string} [name]
|
|
603
578
|
* @property {string} [slug]
|
|
604
579
|
* @property {string[]} [platform]
|
|
605
580
|
* @property {Orientation} [orientation]
|
|
606
|
-
* @property {NavigationAssignment[]} [assignments]
|
|
607
581
|
* @property {NavigationReference[]} [navigation]
|
|
608
582
|
*/
|
|
609
583
|
/**
|
|
610
|
-
* @typedef
|
|
611
|
-
* @property {string} [platform]
|
|
612
|
-
* @property {string} [orientation]
|
|
613
|
-
* @property {string} [position]
|
|
614
|
-
*/
|
|
615
|
-
/**
|
|
616
|
-
* @typedef PageGetResponse
|
|
584
|
+
* @typedef PageGetDetails
|
|
617
585
|
* @property {PageSchema[]} [items]
|
|
618
586
|
* @property {Page} [page]
|
|
619
587
|
*/
|
|
@@ -633,65 +601,44 @@ export = ContentPlatformModel;
|
|
|
633
601
|
* @property {PageSpecParam[]} [params]
|
|
634
602
|
* @property {PageSpecParam[]} [query]
|
|
635
603
|
*/
|
|
636
|
-
/**
|
|
637
|
-
* @typedef PageResponseError
|
|
638
|
-
* @property {string} [errors]
|
|
639
|
-
*/
|
|
640
604
|
/**
|
|
641
605
|
* @typedef PageSchema
|
|
642
606
|
* @property {string} [_id]
|
|
643
607
|
* @property {string} [application]
|
|
644
|
-
* @property {string} [
|
|
645
|
-
*
|
|
646
|
-
* @property {
|
|
647
|
-
* @property {string} [type]
|
|
648
|
-
* @property {string[]} [tags]
|
|
608
|
+
* @property {string[]} [component_ids] - Components can be used to store
|
|
609
|
+
* multiple components
|
|
610
|
+
* @property {Object[]} [content]
|
|
649
611
|
* @property {string} [content_path]
|
|
650
|
-
* @property {string} [orientation]
|
|
651
|
-
* @property {string} [description]
|
|
652
|
-
* @property {boolean} [published]
|
|
653
612
|
* @property {CreatedBySchema} [created_by]
|
|
654
613
|
* @property {DateMeta} [date_meta]
|
|
614
|
+
* @property {string} [description]
|
|
655
615
|
* @property {Asset} [feature_image]
|
|
616
|
+
* @property {Object[]} [page_meta]
|
|
656
617
|
* @property {ScheduleSchema} [_schedule]
|
|
657
|
-
* @property {
|
|
618
|
+
* @property {Object} [_custom_json]
|
|
619
|
+
* @property {string} [orientation]
|
|
620
|
+
* @property {string} [platform]
|
|
621
|
+
* @property {boolean} [published]
|
|
622
|
+
* @property {string} [slug]
|
|
623
|
+
* @property {string[]} [tags]
|
|
624
|
+
* @property {string} [title]
|
|
625
|
+
* @property {string} [type]
|
|
658
626
|
* @property {SEO} [seo]
|
|
659
|
-
* @property {
|
|
627
|
+
* @property {Object} [visibility]
|
|
660
628
|
* @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]
|
|
678
629
|
*/
|
|
679
630
|
/**
|
|
680
631
|
* @typedef CreatedBySchema
|
|
681
632
|
* @property {string} [id]
|
|
682
633
|
*/
|
|
683
634
|
/**
|
|
684
|
-
* @typedef
|
|
685
|
-
* @property {boolean} [test]
|
|
686
|
-
*/
|
|
687
|
-
/**
|
|
688
|
-
* @typedef PageRequest
|
|
635
|
+
* @typedef PagePayload
|
|
689
636
|
* @property {CronSchedule} [_schedule]
|
|
690
637
|
* @property {string} [application]
|
|
691
638
|
* @property {Author} [author]
|
|
692
639
|
* @property {Object} [_custom_json]
|
|
693
640
|
* @property {string} [orientation]
|
|
694
|
-
* @property {
|
|
641
|
+
* @property {Object[]} [content]
|
|
695
642
|
* @property {Asset} [feature_image]
|
|
696
643
|
* @property {boolean} [published]
|
|
697
644
|
* @property {string} [reading_time]
|
|
@@ -699,10 +646,6 @@ export = ContentPlatformModel;
|
|
|
699
646
|
* @property {string[]} [tags]
|
|
700
647
|
* @property {SEO} [seo]
|
|
701
648
|
* @property {string} [title]
|
|
702
|
-
* @property {string} [platform]
|
|
703
|
-
* @property {string} [type]
|
|
704
|
-
* @property {string} [description]
|
|
705
|
-
* @property {Object} [visibility] - Visibility of Page.
|
|
706
649
|
*/
|
|
707
650
|
/**
|
|
708
651
|
* @typedef CronSchedule
|
|
@@ -710,38 +653,17 @@ export = ContentPlatformModel;
|
|
|
710
653
|
* @property {string} [start]
|
|
711
654
|
* @property {string} [end]
|
|
712
655
|
* @property {number} [duration]
|
|
713
|
-
* @property {NextSchedule[]} [next_schedule]
|
|
714
656
|
*/
|
|
715
657
|
/**
|
|
716
|
-
* @typedef
|
|
658
|
+
* @typedef PagePublishPayload
|
|
717
659
|
* @property {boolean} [publish]
|
|
718
660
|
*/
|
|
719
661
|
/**
|
|
720
662
|
* @typedef PageMetaSchema
|
|
721
|
-
* @property {
|
|
722
|
-
* @property {
|
|
663
|
+
* @property {NavigationSchema[]} [system_pages]
|
|
664
|
+
* @property {PageSchema[]} [custom_pages]
|
|
723
665
|
* @property {string} [application_id]
|
|
724
666
|
*/
|
|
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
|
-
*/
|
|
745
667
|
/**
|
|
746
668
|
* @typedef Support
|
|
747
669
|
* @property {boolean} [created]
|
|
@@ -780,30 +702,44 @@ export = ContentPlatformModel;
|
|
|
780
702
|
*/
|
|
781
703
|
/**
|
|
782
704
|
* @typedef TagsSchema
|
|
783
|
-
* @property {string} [application]
|
|
784
|
-
* @property {string} [_id]
|
|
785
|
-
* @property {
|
|
786
|
-
*
|
|
787
|
-
* @property {TagSchema[]} [tags]
|
|
705
|
+
* @property {string} [application] - The ID of the application that owns the tags.
|
|
706
|
+
* @property {string} [_id] - The unique identifier for the tag set.
|
|
707
|
+
* @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
|
|
708
|
+
* or stylesheets) that are configured for the application.
|
|
788
709
|
*/
|
|
789
710
|
/**
|
|
790
711
|
* @typedef TagSchema
|
|
791
|
-
* @property {string} [name]
|
|
792
|
-
* @property {string} [url]
|
|
793
|
-
*
|
|
794
|
-
* @property {string} [
|
|
795
|
-
*
|
|
796
|
-
* @property {string} [
|
|
797
|
-
*
|
|
798
|
-
* @property {string} [
|
|
799
|
-
* @property {
|
|
800
|
-
*
|
|
712
|
+
* @property {string} [name] - The name of the tag used to identify it.
|
|
713
|
+
* @property {string} [url] - The URL where the external tag resource (such as a
|
|
714
|
+
* script or stylesheet) is located.
|
|
715
|
+
* @property {string} [type] - Specifies whether the tag is a JavaScript ('js')
|
|
716
|
+
* or CSS ('css') tag.
|
|
717
|
+
* @property {string} [sub_type] - Indicates whether the tag is an external
|
|
718
|
+
* resource (external) or inline content (inline).
|
|
719
|
+
* @property {string} [_id] - The unique identifier for the tag in the system.
|
|
720
|
+
* @property {string} [position] - The position within the page where the tag
|
|
721
|
+
* should be injected.
|
|
722
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
723
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
724
|
+
* tag type for example:
|
|
725
|
+
*
|
|
726
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
727
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
728
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
729
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
730
|
+
*
|
|
731
|
+
* @property {string} [content] - Content of the tag if it is inline, such as
|
|
732
|
+
* JavaScript or CSS code.
|
|
733
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
734
|
+
* third-party tag can be injected or supported.
|
|
735
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be active.
|
|
801
736
|
* @property {TagSourceSchema} [__source]
|
|
802
737
|
*/
|
|
803
738
|
/**
|
|
804
739
|
* @typedef TagSourceSchema
|
|
805
|
-
* @property {string} [type]
|
|
806
|
-
* @property {string} [id]
|
|
740
|
+
* @property {string} [type] - The type of source, such as 'extension'
|
|
741
|
+
* @property {string} [id] - The identifier of the source that created or
|
|
742
|
+
* provided the tag.
|
|
807
743
|
*/
|
|
808
744
|
/**
|
|
809
745
|
* @typedef ResourcesSchema
|
|
@@ -817,140 +753,129 @@ export = ContentPlatformModel;
|
|
|
817
753
|
*/
|
|
818
754
|
/**
|
|
819
755
|
* @typedef FieldValidations
|
|
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]
|
|
756
|
+
* @property {string} [name] - Name of validation
|
|
757
|
+
* @property {string} [type] - Type of validation
|
|
758
|
+
* @property {Object} [value]
|
|
845
759
|
*/
|
|
846
760
|
/**
|
|
847
761
|
* @typedef FieldDefinitionSchema
|
|
848
|
-
* @property {string} [
|
|
849
|
-
* @property {string} [
|
|
850
|
-
* @property {string} [
|
|
851
|
-
* @property {string} [
|
|
852
|
-
* @property {string} [
|
|
853
|
-
* @property {string} [
|
|
854
|
-
* @property {string} [
|
|
855
|
-
* @property {
|
|
856
|
-
*
|
|
857
|
-
* @property {FieldValidations[]} [validations]
|
|
858
|
-
* @property {string} [company_id]
|
|
859
|
-
* @property {
|
|
860
|
-
* @property {
|
|
861
|
-
* @property {
|
|
862
|
-
* @property {
|
|
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]
|
|
762
|
+
* @property {string} [id] - Unique system generated id
|
|
763
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
764
|
+
* @property {string} [name] - Name of custom field
|
|
765
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
766
|
+
* @property {string} [slug] - Slug of custom field
|
|
767
|
+
* @property {string} [description] - Description of custom field definition
|
|
768
|
+
* @property {string} [type] - Data type of custom field
|
|
769
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
770
|
+
* multivalued or not
|
|
771
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
772
|
+
* @property {string} [company_id] - Id of company
|
|
773
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
774
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
775
|
+
* @property {string} [type_name] - Type of type field
|
|
776
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
872
777
|
*/
|
|
873
778
|
/**
|
|
874
779
|
* @typedef CustomFieldDefinitionsSchema
|
|
875
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
780
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
876
781
|
* @property {Page} [page]
|
|
877
782
|
*/
|
|
878
783
|
/**
|
|
879
784
|
* @typedef CustomFieldDefinitionRequestSchema
|
|
880
|
-
* @property {string} [
|
|
881
|
-
* @property {string} [
|
|
882
|
-
* @property {string} [
|
|
883
|
-
* @property {
|
|
884
|
-
*
|
|
885
|
-
* @property {string} [name]
|
|
886
|
-
* @property {string} [description]
|
|
887
|
-
* @property {
|
|
888
|
-
* @property {FieldValidations[]} [validations]
|
|
785
|
+
* @property {string} [type] - Data type of custom field
|
|
786
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
787
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
788
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
789
|
+
* multi valued or not
|
|
790
|
+
* @property {string} [name] - Name of custom field definition
|
|
791
|
+
* @property {string} [description] - Description of a custom field definition
|
|
792
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
889
793
|
*/
|
|
890
794
|
/**
|
|
891
795
|
* @typedef CustomObjectCustomFieldDefinitions
|
|
892
|
-
* @property {string} [
|
|
893
|
-
* @property {string} type
|
|
894
|
-
* @property {string} [description]
|
|
895
|
-
* @property {string} [name]
|
|
896
|
-
* @property {boolean} [multi_value]
|
|
897
|
-
*
|
|
898
|
-
* @property {
|
|
899
|
-
* @property {
|
|
796
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
797
|
+
* @property {string} [type] - Data type of custom field
|
|
798
|
+
* @property {string} [description] - Description of custom field
|
|
799
|
+
* @property {string} [name] - Name of custom field
|
|
800
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
801
|
+
* valued or not
|
|
802
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
803
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
804
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
805
|
+
* custom field
|
|
900
806
|
* @property {string} [action]
|
|
901
807
|
*/
|
|
902
808
|
/**
|
|
903
809
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
904
|
-
* @property {string} [
|
|
905
|
-
* @property {string} [
|
|
906
|
-
* @property {string} [
|
|
907
|
-
*
|
|
908
|
-
* @property {
|
|
810
|
+
* @property {string} [description] - Description of custom object definiton
|
|
811
|
+
* @property {string} [name] - Name of custom object definition
|
|
812
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
813
|
+
* display key in
|
|
814
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
909
815
|
*/
|
|
910
816
|
/**
|
|
911
817
|
* @typedef CustomFieldDefinitionDetailResSchema
|
|
912
|
-
* @property {string} [
|
|
913
|
-
* @property {string} [
|
|
914
|
-
* @property {string} [
|
|
915
|
-
* @property {string} [
|
|
916
|
-
* @property {string} [
|
|
917
|
-
* @property {string} [
|
|
918
|
-
* @property {
|
|
919
|
-
*
|
|
920
|
-
* @property {string} [company_id]
|
|
921
|
-
* @property {string} [application_id]
|
|
922
|
-
* @property {
|
|
923
|
-
* @property {
|
|
924
|
-
* @property {
|
|
925
|
-
* @property {boolean} [is_deleted]
|
|
926
|
-
* @property {string} [_id]
|
|
818
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
819
|
+
* @property {string} [name] - Name of custom field
|
|
820
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
821
|
+
* @property {string} [slug] - Slug of custom field
|
|
822
|
+
* @property {string} [description] - Description regarding custom field
|
|
823
|
+
* @property {string} [type] - Data type of custom field
|
|
824
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
825
|
+
* multi valued or not
|
|
826
|
+
* @property {string} [company_id] - Company Identifer
|
|
827
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
828
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
829
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
830
|
+
* @property {string} [id] - Unique system generated id
|
|
927
831
|
* @property {Object[]} [validations]
|
|
928
|
-
* @property {string} [created_at]
|
|
929
|
-
* @property {string} [updated_at]
|
|
832
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
833
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
834
|
+
*/
|
|
835
|
+
/**
|
|
836
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
837
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
838
|
+
* @property {string} [name] - Name of meta field
|
|
839
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
840
|
+
* @property {string} [slug] - Slug of meta field
|
|
841
|
+
* @property {string} [description] - Description regarding meta field
|
|
842
|
+
* @property {string} [type] - Data type of meta field
|
|
843
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
844
|
+
* multi valued or not
|
|
845
|
+
* @property {string} [company_id] - Company Identifer
|
|
846
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
847
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
848
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
849
|
+
* @property {string} [id] - Unique system generated id
|
|
850
|
+
* @property {Object[]} [validations]
|
|
851
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
852
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
930
853
|
*/
|
|
931
854
|
/**
|
|
932
855
|
* @typedef CustomDataDeleteSchema
|
|
933
|
-
* @property {boolean} [success]
|
|
934
|
-
* @property {string} [message]
|
|
856
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
857
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
858
|
+
*/
|
|
859
|
+
/**
|
|
860
|
+
* @typedef CustomFieldValue
|
|
861
|
+
* @property {Object} [value]
|
|
935
862
|
*/
|
|
936
863
|
/**
|
|
937
864
|
* @typedef CustomFieldSchema
|
|
938
|
-
* @property {string} [
|
|
939
|
-
* @property {string} [namespace]
|
|
940
|
-
* @property {string} [
|
|
941
|
-
* @property {string} [resource]
|
|
942
|
-
* @property {
|
|
943
|
-
* @property {string} [
|
|
944
|
-
* @property {string} type
|
|
945
|
-
* @property {boolean} [multi_value]
|
|
946
|
-
* @property {string} [company_id]
|
|
947
|
-
* @property {string} [definition_id]
|
|
865
|
+
* @property {string} [id] - Unique system generated id
|
|
866
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
867
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
868
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
869
|
+
* @property {CustomFieldValue[]} [value]
|
|
870
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
871
|
+
* @property {string} [type] - Data type of custom field
|
|
872
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
873
|
+
* @property {string} [company_id] - Identifer for a company
|
|
948
874
|
* @property {boolean} [has_invalid_values]
|
|
949
875
|
* @property {Object[]} [invalid_value_errors]
|
|
950
|
-
* @property {
|
|
951
|
-
* @property {
|
|
952
|
-
* @property {string} [
|
|
953
|
-
* @property {string} [updated_at]
|
|
876
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
877
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
878
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
954
879
|
*/
|
|
955
880
|
/**
|
|
956
881
|
* @typedef CustomFieldsResponseSchema
|
|
@@ -968,7 +893,10 @@ export = ContentPlatformModel;
|
|
|
968
893
|
*/
|
|
969
894
|
/**
|
|
970
895
|
* @typedef CustomField
|
|
971
|
-
* @property {
|
|
896
|
+
* @property {Object[]} [value]
|
|
897
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
898
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
899
|
+
* creating a custom field definition
|
|
972
900
|
*/
|
|
973
901
|
/**
|
|
974
902
|
* @typedef CustomFieldRequestSchema
|
|
@@ -976,155 +904,125 @@ export = ContentPlatformModel;
|
|
|
976
904
|
*/
|
|
977
905
|
/**
|
|
978
906
|
* @typedef CustomObjectSchema
|
|
979
|
-
* @property {string} [
|
|
980
|
-
* @property {string} [
|
|
981
|
-
* @property {string} [
|
|
982
|
-
* @property {string} [
|
|
983
|
-
* @property {string} [
|
|
984
|
-
* @property {string} [
|
|
985
|
-
* @property {string} [
|
|
986
|
-
*
|
|
987
|
-
* @property {
|
|
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]
|
|
907
|
+
* @property {string} [id] - Unique system generated id
|
|
908
|
+
* @property {string} [company_id] - Identifer for a company
|
|
909
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
910
|
+
* @property {string} [status] - Status of custom object
|
|
911
|
+
* @property {string} [type] - Slug of custom object definition
|
|
912
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
913
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
914
|
+
* custom object
|
|
915
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
994
916
|
*/
|
|
995
917
|
/**
|
|
996
918
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
997
|
-
* @property {string} [type]
|
|
998
|
-
* @property {string} [
|
|
999
|
-
* @property {string} [
|
|
1000
|
-
* @property {string} [
|
|
1001
|
-
* @property {
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
*
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
* @
|
|
1008
|
-
* @property {string} [
|
|
1009
|
-
* @property {string} [
|
|
1010
|
-
* @property {string} [
|
|
1011
|
-
* @property {string}
|
|
1012
|
-
* @property {
|
|
1013
|
-
* @property {
|
|
1014
|
-
* @property {
|
|
1015
|
-
*
|
|
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]
|
|
919
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
920
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
921
|
+
* @property {string} [description] - Description of custom object definition
|
|
922
|
+
* @property {string} [name] - Name of custom object
|
|
923
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
924
|
+
* for displaying custom object
|
|
925
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
926
|
+
* of custom field definitions belonging to this custom object definition
|
|
927
|
+
*/
|
|
928
|
+
/**
|
|
929
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
930
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
931
|
+
* @property {string} [name] - Display name of custom object definition
|
|
932
|
+
* @property {string} [type] - Type of custom object definiton
|
|
933
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
934
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
935
|
+
* @property {string} [description] - Description of custom object definition
|
|
936
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
937
|
+
* Custom fields inside custom objects
|
|
1039
938
|
*/
|
|
1040
939
|
/**
|
|
1041
940
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
1042
|
-
* @property {boolean} [success]
|
|
1043
|
-
* @property {string} [message]
|
|
941
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
942
|
+
* @property {string} [message] - Response message when custom object definition
|
|
943
|
+
* is deleted.
|
|
1044
944
|
*/
|
|
1045
945
|
/**
|
|
1046
|
-
* @typedef
|
|
1047
|
-
* @property {string} [
|
|
1048
|
-
* @property {
|
|
946
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
947
|
+
* @property {string} [url] - Signed url of csv
|
|
948
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
1049
949
|
*/
|
|
1050
950
|
/**
|
|
1051
|
-
* @typedef
|
|
1052
|
-
* @property {string} [
|
|
1053
|
-
* @property {string} [name]
|
|
1054
|
-
* @property {string} [type]
|
|
1055
|
-
* @property {string} [display_name_key]
|
|
951
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
952
|
+
* @property {string} [id] - Unique system generated id
|
|
953
|
+
* @property {string} [name] - Name of custom object
|
|
954
|
+
* @property {string} [type] - Type of custom object entry
|
|
1056
955
|
*/
|
|
1057
956
|
/**
|
|
1058
957
|
* @typedef CustomObjectListItemSchema
|
|
1059
|
-
* @property {string} [
|
|
1060
|
-
* @property {string} [
|
|
1061
|
-
* @property {string} [
|
|
1062
|
-
* @property {string} [
|
|
1063
|
-
* @property {string} [
|
|
1064
|
-
* @property {
|
|
1065
|
-
* @property {
|
|
1066
|
-
* @property {number} [references]
|
|
958
|
+
* @property {string} [id] - Unique system generated id
|
|
959
|
+
* @property {string} [status] - Status of custom object
|
|
960
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
961
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
962
|
+
* @property {string} [display_name] - Display name of custom object
|
|
963
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
964
|
+
* @property {number} [references] - References of the custom object entry
|
|
1067
965
|
*/
|
|
1068
966
|
/**
|
|
1069
967
|
* @typedef CustomObjectsSchema
|
|
1070
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
968
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
969
|
+
* object entries
|
|
1071
970
|
* @property {Page} [page]
|
|
1072
971
|
*/
|
|
1073
972
|
/**
|
|
1074
|
-
* @typedef
|
|
1075
|
-
* @property {string} [
|
|
1076
|
-
* @property {string} [
|
|
1077
|
-
* @property {string} [
|
|
1078
|
-
* @property {
|
|
973
|
+
* @typedef CustomObjectFieldDefinition
|
|
974
|
+
* @property {string} [id] - Unique system generate id
|
|
975
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
976
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
977
|
+
* @property {Object[]} [value] - Value of custom field
|
|
978
|
+
* @property {string} [type] - Data type of the custom field
|
|
1079
979
|
*/
|
|
1080
980
|
/**
|
|
1081
|
-
* @typedef
|
|
1082
|
-
* @property {
|
|
981
|
+
* @typedef CustomObjectBySlugSchema
|
|
982
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
983
|
+
* @property {string} [status] - Status of Custom Object
|
|
984
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
985
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
986
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
987
|
+
* used as a custom field
|
|
988
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
989
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
990
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
991
|
+
* inside the custom object
|
|
1083
992
|
*/
|
|
1084
993
|
/**
|
|
1085
|
-
* @typedef
|
|
1086
|
-
* @property {string} [
|
|
1087
|
-
* @property {string} [
|
|
1088
|
-
* @property {string} [slug]
|
|
1089
|
-
* @property {string} [display_name]
|
|
1090
|
-
* @property {CustomObjectListItemDefinationSchema} [definition]
|
|
1091
|
-
* @property {Object[]} [references]
|
|
1092
|
-
* @property {CustomObjectFieldSchema[]} [fields]
|
|
1093
|
-
*/
|
|
1094
|
-
/**
|
|
1095
|
-
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
1096
|
-
* @property {string} [message]
|
|
1097
|
-
* @property {string} [task_id]
|
|
994
|
+
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
995
|
+
* @property {string} [message] - Message for the user
|
|
996
|
+
* @property {string} [task_id] - Identifer for a task
|
|
1098
997
|
*/
|
|
1099
998
|
/**
|
|
1100
999
|
* @typedef CustomObjectMetaSchema
|
|
1101
|
-
* @property {number} [mo_total_count]
|
|
1102
|
-
* @property {number} [mo_success_count]
|
|
1103
|
-
* @property {number} [mo_error_count]
|
|
1104
|
-
* @property {string} [mo_defintion_type]
|
|
1000
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
1001
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
1002
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
1003
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
1105
1004
|
*/
|
|
1106
1005
|
/**
|
|
1107
1006
|
* @typedef JobSchema
|
|
1108
|
-
* @property {string} [
|
|
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} [
|
|
1115
|
-
* @property {string} [
|
|
1116
|
-
* @property {string} [
|
|
1117
|
-
* @property {string} [
|
|
1118
|
-
* @property {
|
|
1119
|
-
* @property {number} [
|
|
1120
|
-
* @property {number} [
|
|
1121
|
-
* @property {number} [
|
|
1122
|
-
* @property {number} [total_jobs]
|
|
1007
|
+
* @property {string} [id] - Unique system generated id
|
|
1008
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
1009
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
1010
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1011
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1012
|
+
* @property {string} [company_id] - Company Identifer
|
|
1013
|
+
* @property {string} [status] - Status of job
|
|
1014
|
+
* @property {string} [action_type] - Type of job
|
|
1015
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1016
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1017
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1018
|
+
* @property {number} [error_count] - Number of items in error
|
|
1019
|
+
* @property {number} [success_count] - Number of successful items
|
|
1020
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1123
1021
|
* @property {CustomObjectMetaSchema} [meta]
|
|
1124
|
-
* @property {string} [created_by]
|
|
1125
|
-
* @property {string} [created_at]
|
|
1126
|
-
* @property {string} [updated_at]
|
|
1127
|
-
* @property {string} [application_id]
|
|
1022
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1023
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1024
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1025
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
1128
1026
|
*/
|
|
1129
1027
|
/**
|
|
1130
1028
|
* @typedef CustomFieldBulkEntry
|
|
@@ -1136,6 +1034,10 @@ export = ContentPlatformModel;
|
|
|
1136
1034
|
* @property {JobSchema[]} [items]
|
|
1137
1035
|
* @property {Page} [page]
|
|
1138
1036
|
*/
|
|
1037
|
+
/**
|
|
1038
|
+
* @typedef MetafieldTypesSchema
|
|
1039
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1040
|
+
*/
|
|
1139
1041
|
/**
|
|
1140
1042
|
* @typedef CustomFieldTypeSchema
|
|
1141
1043
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1154,140 +1056,166 @@ export = ContentPlatformModel;
|
|
|
1154
1056
|
* @property {HTML} [html]
|
|
1155
1057
|
* @property {Duration} [duration]
|
|
1156
1058
|
*/
|
|
1059
|
+
/**
|
|
1060
|
+
* @typedef SupportedValidationsMetaExampleSchema
|
|
1061
|
+
* @property {string} [name]
|
|
1062
|
+
* @property {string} [value]
|
|
1063
|
+
*/
|
|
1064
|
+
/**
|
|
1065
|
+
* @typedef SupportedValidationsMetaSchema
|
|
1066
|
+
* @property {SupportedValidationsMetaExampleSchema[]} [examples]
|
|
1067
|
+
*/
|
|
1157
1068
|
/**
|
|
1158
1069
|
* @typedef SupportedValidationsSchema
|
|
1159
1070
|
* @property {string} [name]
|
|
1160
1071
|
* @property {string} [type]
|
|
1161
1072
|
* @property {string} [display]
|
|
1162
1073
|
* @property {boolean} [required]
|
|
1074
|
+
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1163
1075
|
*/
|
|
1164
1076
|
/**
|
|
1165
1077
|
* @typedef Duration
|
|
1166
|
-
* @property {string} [name]
|
|
1167
|
-
* @property {boolean} [list_enabled]
|
|
1168
|
-
* @property {string} [type]
|
|
1169
|
-
* @property {string} [category]
|
|
1170
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1078
|
+
* @property {string} [name] - Name data type of custom field
|
|
1079
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1080
|
+
* @property {string} [type] - Type of custom field
|
|
1081
|
+
* @property {string} [category] - Category of custom field
|
|
1082
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1083
|
+
* validations available for the field
|
|
1171
1084
|
*/
|
|
1172
1085
|
/**
|
|
1173
1086
|
* @typedef HTML
|
|
1174
|
-
* @property {string} [name]
|
|
1175
|
-
* @property {boolean} [list_enabled]
|
|
1176
|
-
* @property {string} [type]
|
|
1177
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1087
|
+
* @property {string} [name] - Name data type of custom field
|
|
1088
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1089
|
+
* @property {string} [type] - Type of custom field
|
|
1090
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1091
|
+
* validations available for the field
|
|
1178
1092
|
*/
|
|
1179
1093
|
/**
|
|
1180
1094
|
* @typedef StringSingleLine
|
|
1181
|
-
* @property {string} [name]
|
|
1182
|
-
* @property {boolean} [list_enabled]
|
|
1183
|
-
* @property {string} [category]
|
|
1184
|
-
* @property {string} [type]
|
|
1185
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1095
|
+
* @property {string} [name] - Name data type of custom field
|
|
1096
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1097
|
+
* @property {string} [category] - Category of custom field
|
|
1098
|
+
* @property {string} [type] - Type of custom field
|
|
1099
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1100
|
+
* validations available for the field
|
|
1186
1101
|
*/
|
|
1187
1102
|
/**
|
|
1188
1103
|
* @typedef StringMultiLine
|
|
1189
|
-
* @property {string} [name]
|
|
1190
|
-
* @property {boolean} [list_enabled]
|
|
1191
|
-
* @property {string} [category]
|
|
1192
|
-
* @property {string} [type]
|
|
1193
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1104
|
+
* @property {string} [name] - Name data type of custom field
|
|
1105
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1106
|
+
* @property {string} [category] - Category of custom field
|
|
1107
|
+
* @property {string} [type] - Type of custom field
|
|
1108
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1109
|
+
* validations available for the field
|
|
1194
1110
|
*/
|
|
1195
1111
|
/**
|
|
1196
1112
|
* @typedef Dropdown
|
|
1197
|
-
* @property {string} [name]
|
|
1198
|
-
* @property {boolean} [list_enabled]
|
|
1199
|
-
* @property {string} [category]
|
|
1200
|
-
* @property {string} [type]
|
|
1201
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1113
|
+
* @property {string} [name] - Name data type of custom field
|
|
1114
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1115
|
+
* @property {string} [category] - Category of custom field
|
|
1116
|
+
* @property {string} [type] - Category of custom field
|
|
1117
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1118
|
+
* validations available for the field
|
|
1202
1119
|
*/
|
|
1203
1120
|
/**
|
|
1204
1121
|
* @typedef Integer
|
|
1205
|
-
* @property {string} [name]
|
|
1206
|
-
* @property {boolean} [list_enabled]
|
|
1207
|
-
* @property {string} [type]
|
|
1208
|
-
* @property {string} [category]
|
|
1209
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1122
|
+
* @property {string} [name] - Name data type of custom field
|
|
1123
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1124
|
+
* @property {string} [type] - Type of custom field
|
|
1125
|
+
* @property {string} [category] - Category of custom field
|
|
1126
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1127
|
+
* validations available for the field
|
|
1210
1128
|
*/
|
|
1211
1129
|
/**
|
|
1212
1130
|
* @typedef FloatType
|
|
1213
|
-
* @property {string} [name]
|
|
1214
|
-
* @property {boolean} [list_enabled]
|
|
1215
|
-
* @property {string} [type]
|
|
1216
|
-
* @property {string} [category]
|
|
1217
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1131
|
+
* @property {string} [name] - Name data type of custom field
|
|
1132
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1133
|
+
* @property {string} [type] - Type of custom field
|
|
1134
|
+
* @property {string} [category] - Category of custom field
|
|
1135
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1136
|
+
* validations available for the field
|
|
1218
1137
|
*/
|
|
1219
1138
|
/**
|
|
1220
1139
|
* @typedef BooleanType
|
|
1221
|
-
* @property {string} [name]
|
|
1222
|
-
* @property {string} [category]
|
|
1223
|
-
* @property {boolean} [list_enabled]
|
|
1224
|
-
* @property {string} [type]
|
|
1225
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1140
|
+
* @property {string} [name] - Name data type of custom field
|
|
1141
|
+
* @property {string} [category] - Category of custom field
|
|
1142
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1143
|
+
* @property {string} [type] - Category of custom field
|
|
1144
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1145
|
+
* validations available for the field
|
|
1226
1146
|
*/
|
|
1227
1147
|
/**
|
|
1228
1148
|
* @typedef Date
|
|
1229
|
-
* @property {string} [name]
|
|
1230
|
-
* @property {boolean} [list_enabled]
|
|
1231
|
-
* @property {string} [category]
|
|
1232
|
-
* @property {string} [type]
|
|
1233
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1149
|
+
* @property {string} [name] - Name data type of custom field
|
|
1150
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1151
|
+
* @property {string} [category] - Category of custom field
|
|
1152
|
+
* @property {string} [type] - Type of custom field
|
|
1153
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1154
|
+
* validations available for the field
|
|
1234
1155
|
*/
|
|
1235
1156
|
/**
|
|
1236
1157
|
* @typedef Datetime
|
|
1237
|
-
* @property {string} [name]
|
|
1238
|
-
* @property {string} [category]
|
|
1239
|
-
* @property {boolean} [list_enabled]
|
|
1240
|
-
* @property {string} [type]
|
|
1241
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1158
|
+
* @property {string} [name] - Name data type of custom field
|
|
1159
|
+
* @property {string} [category] - Category of custom field
|
|
1160
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1161
|
+
* @property {string} [type] - Type of custom field
|
|
1162
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1163
|
+
* validations available for the field
|
|
1242
1164
|
*/
|
|
1243
1165
|
/**
|
|
1244
1166
|
* @typedef Json
|
|
1245
|
-
* @property {string} [name]
|
|
1246
|
-
* @property {boolean} [list_enabled]
|
|
1247
|
-
* @property {string} [category]
|
|
1248
|
-
* @property {string} [type]
|
|
1249
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1167
|
+
* @property {string} [name] - Name data type of custom field
|
|
1168
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1169
|
+
* @property {string} [category] - Category of custom field
|
|
1170
|
+
* @property {string} [type] - Type of custom field
|
|
1171
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1172
|
+
* validations available for the field
|
|
1250
1173
|
*/
|
|
1251
1174
|
/**
|
|
1252
1175
|
* @typedef File
|
|
1253
|
-
* @property {string} [name]
|
|
1254
|
-
* @property {string} [category]
|
|
1255
|
-
* @property {boolean} [list_enabled]
|
|
1256
|
-
* @property {string} [type]
|
|
1176
|
+
* @property {string} [name] - Name data type of custom field
|
|
1177
|
+
* @property {string} [category] - Category of custom field
|
|
1178
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1179
|
+
* @property {string} [type] - Type of custom field
|
|
1257
1180
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1258
1181
|
*/
|
|
1259
1182
|
/**
|
|
1260
1183
|
* @typedef Url
|
|
1261
|
-
* @property {string} [name]
|
|
1262
|
-
* @property {boolean} [list_enabled]
|
|
1263
|
-
* @property {string} [type]
|
|
1264
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1184
|
+
* @property {string} [name] - Name data type of custom field
|
|
1185
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1186
|
+
* @property {string} [type] - Type of custom field
|
|
1187
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1188
|
+
* validations available for the field
|
|
1265
1189
|
*/
|
|
1266
1190
|
/**
|
|
1267
1191
|
* @typedef Metaobject
|
|
1268
|
-
* @property {string} [name]
|
|
1269
|
-
* @property {boolean} [list_enabled]
|
|
1270
|
-
*
|
|
1271
|
-
* @property {string} [
|
|
1192
|
+
* @property {string} [name] - Name of Custom Object
|
|
1193
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1194
|
+
* multiple list items
|
|
1195
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1196
|
+
* Custom Object belongs to
|
|
1197
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1272
1198
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1273
1199
|
*/
|
|
1274
1200
|
/**
|
|
1275
1201
|
* @typedef Product
|
|
1276
|
-
* @property {string} [name]
|
|
1277
|
-
* @property {boolean} [list_enabled]
|
|
1278
|
-
*
|
|
1279
|
-
* @property {string} [
|
|
1202
|
+
* @property {string} [name] - Name of Product
|
|
1203
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1204
|
+
* multiple list items
|
|
1205
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1206
|
+
* Product is associated with
|
|
1207
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1280
1208
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1281
|
-
* @property {string[]} [scope]
|
|
1282
1209
|
*/
|
|
1283
1210
|
/**
|
|
1284
1211
|
* @typedef CustomObjectEntry
|
|
1285
|
-
* @property {string} [
|
|
1286
|
-
* @property {string} [name]
|
|
1287
|
-
* @property {string} [type]
|
|
1288
|
-
* @property {string} [updated_at]
|
|
1289
|
-
* @property {number} [entries_count]
|
|
1290
|
-
*
|
|
1212
|
+
* @property {string} [id] - Unique system generated id
|
|
1213
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1214
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1215
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1216
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1217
|
+
* Object definition
|
|
1218
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1291
1219
|
*/
|
|
1292
1220
|
/**
|
|
1293
1221
|
* @typedef CustomObjectDefinitionsSchema
|
|
@@ -1296,19 +1224,29 @@ export = ContentPlatformModel;
|
|
|
1296
1224
|
*/
|
|
1297
1225
|
/**
|
|
1298
1226
|
* @typedef CustomObjectEntryFieldSchema
|
|
1299
|
-
* @property {string} [
|
|
1227
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1228
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1229
|
+
*/
|
|
1230
|
+
/**
|
|
1231
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1232
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1233
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1300
1234
|
*/
|
|
1301
1235
|
/**
|
|
1302
1236
|
* @typedef CustomObjectRequestSchema
|
|
1303
|
-
* @property {string} [status]
|
|
1304
|
-
* @property {string} [slug]
|
|
1305
|
-
* @property {
|
|
1306
|
-
|
|
1237
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1238
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1239
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1240
|
+
*/
|
|
1241
|
+
/**
|
|
1242
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1243
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1244
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1307
1245
|
*/
|
|
1308
1246
|
/**
|
|
1309
1247
|
* @typedef CustomObjectBulkSchema
|
|
1310
|
-
* @property {string} [url]
|
|
1311
|
-
* @property {number} [total_records]
|
|
1248
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1249
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1312
1250
|
*/
|
|
1313
1251
|
/**
|
|
1314
1252
|
* @typedef ActionPage
|
|
@@ -1317,6 +1255,260 @@ export = ContentPlatformModel;
|
|
|
1317
1255
|
* @property {string} [url] - The URL for the action.
|
|
1318
1256
|
* @property {PageType} type
|
|
1319
1257
|
*/
|
|
1258
|
+
/**
|
|
1259
|
+
* @typedef TranslateUiLabels
|
|
1260
|
+
* @property {string} [_id] - Unique identifier assigned to the Translate Ui Labels entry
|
|
1261
|
+
* @property {string} [company_id] - Identifier linking the resource to a
|
|
1262
|
+
* specific company within the platform
|
|
1263
|
+
* @property {string} [application_id] - Reference to the application where this
|
|
1264
|
+
* Translate Ui Labels is utilized
|
|
1265
|
+
* @property {string} [template_theme_id] - Links the resource to a specific
|
|
1266
|
+
* template theme configuration
|
|
1267
|
+
* @property {string} [theme_id] - Associates the resource with a particular
|
|
1268
|
+
* theme implementation
|
|
1269
|
+
* @property {string} [locale] - Specifies the language and region format for
|
|
1270
|
+
* the resource content
|
|
1271
|
+
* @property {Object} [resource] - Contains the actual resource data and
|
|
1272
|
+
* configuration settings
|
|
1273
|
+
* @property {string} [type] - Categorizes the resource type for proper handling
|
|
1274
|
+
* and processing
|
|
1275
|
+
*/
|
|
1276
|
+
/**
|
|
1277
|
+
* @typedef TranslateUiLabelsCreate
|
|
1278
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1279
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1280
|
+
* @property {string} [locale] - Locale
|
|
1281
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1282
|
+
* @property {string} [type] - Resource type
|
|
1283
|
+
*/
|
|
1284
|
+
/**
|
|
1285
|
+
* @typedef StaticResourceUpdate
|
|
1286
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1287
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1288
|
+
* @property {string} [locale] - Locale
|
|
1289
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1290
|
+
* @property {string} [type] - Resource type
|
|
1291
|
+
*/
|
|
1292
|
+
/**
|
|
1293
|
+
* @typedef TranslateUiLabelsPage
|
|
1294
|
+
* @property {TranslateUiLabels[]} [items] - List of items containing all the
|
|
1295
|
+
* static info data.
|
|
1296
|
+
* @property {Page} [page]
|
|
1297
|
+
*/
|
|
1298
|
+
/**
|
|
1299
|
+
* @typedef Error
|
|
1300
|
+
* @property {string} [error] - Detailed message explaining the error that occurred
|
|
1301
|
+
*/
|
|
1302
|
+
/**
|
|
1303
|
+
* @typedef Meta
|
|
1304
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1305
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1306
|
+
* this resource
|
|
1307
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1308
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1309
|
+
*/
|
|
1310
|
+
/**
|
|
1311
|
+
* @typedef CompanyLanguage
|
|
1312
|
+
* @property {string} [_id] - Unique identifier for the company language setting
|
|
1313
|
+
* @property {string} company_id - Identifier of the company this language
|
|
1314
|
+
* configuration belongs to
|
|
1315
|
+
* @property {string} [locale] - Language code following ISO standards for this
|
|
1316
|
+
* company setting
|
|
1317
|
+
* @property {string} [name] - Display name of the language for company usage
|
|
1318
|
+
* @property {string} [direction] - Text direction setting for company content
|
|
1319
|
+
* in this language
|
|
1320
|
+
* @property {boolean} [is_default] - Indicates if this is the default language
|
|
1321
|
+
* for the company
|
|
1322
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1323
|
+
* English for easy reference and display at the website.
|
|
1324
|
+
*/
|
|
1325
|
+
/**
|
|
1326
|
+
* @typedef CompanyLanguageCreate
|
|
1327
|
+
* @property {string[]} locales - List of language codes to be added to company
|
|
1328
|
+
* configuration
|
|
1329
|
+
*/
|
|
1330
|
+
/**
|
|
1331
|
+
* @typedef CompanyLanguageUpdate
|
|
1332
|
+
* @property {boolean} is_default - Sets the specified language as the company default
|
|
1333
|
+
*/
|
|
1334
|
+
/**
|
|
1335
|
+
* @typedef ApplicationLanguage
|
|
1336
|
+
* @property {string} [_id] - Unique identifier for the application language setting
|
|
1337
|
+
* @property {string} company_id - Identifier of the company this application belongs to
|
|
1338
|
+
* @property {string} application_id - Unique identifier of the application
|
|
1339
|
+
* using this language
|
|
1340
|
+
* @property {string} locale - Language code following ISO standards for this application
|
|
1341
|
+
* @property {string} name - Display name of the language for application usage
|
|
1342
|
+
* @property {string} direction - Specifies the text direction for displaying
|
|
1343
|
+
* application content, either left-to-right (ltr) or right-to-left (rtl)
|
|
1344
|
+
* @property {boolean} is_default - Indicates if this is the default language
|
|
1345
|
+
* for the application
|
|
1346
|
+
* @property {boolean} published - Indicates whether this language is currently
|
|
1347
|
+
* active and visible within the storefront.
|
|
1348
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1349
|
+
* English for easy reference and display at the website.
|
|
1350
|
+
*/
|
|
1351
|
+
/**
|
|
1352
|
+
* @typedef unPublishApplicationLanguage
|
|
1353
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1354
|
+
*/
|
|
1355
|
+
/**
|
|
1356
|
+
* @typedef ApplicationLanguageCreate
|
|
1357
|
+
* @property {string[]} locales - List of language codes to be added to
|
|
1358
|
+
* application configuration
|
|
1359
|
+
*/
|
|
1360
|
+
/**
|
|
1361
|
+
* @typedef ApplicationLanguageUpdate
|
|
1362
|
+
* @property {boolean} is_default - Sets the specified language as the application default
|
|
1363
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1364
|
+
*/
|
|
1365
|
+
/**
|
|
1366
|
+
* @typedef TranslatableResource
|
|
1367
|
+
* @property {string} [_id] - Unique identifier for the translatable resource
|
|
1368
|
+
* @property {string} type - Categorizes the type of content that can be translated
|
|
1369
|
+
* @property {string} name - Display name of the translatable resource
|
|
1370
|
+
* @property {string} description - Detailed explanation of the translatable resource
|
|
1371
|
+
* @property {string} schema_type - Defines the processing type for the
|
|
1372
|
+
* translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
|
|
1373
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1374
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1375
|
+
* this resource
|
|
1376
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1377
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1378
|
+
* @property {TranslatableSection} [section_id]
|
|
1379
|
+
*/
|
|
1380
|
+
/**
|
|
1381
|
+
* @typedef ResourceDefinition
|
|
1382
|
+
* @property {string} [_id] - Unique identifier for the resource definition
|
|
1383
|
+
* @property {string} translatable_resource_id - Reference to the associated
|
|
1384
|
+
* translatable resource
|
|
1385
|
+
* @property {ResourceJsonSchema} [json_schema]
|
|
1386
|
+
* @property {ResourceUISchema} [ui_schema]
|
|
1387
|
+
* @property {ResourceBulkDetails} [bulk_details]
|
|
1388
|
+
*/
|
|
1389
|
+
/**
|
|
1390
|
+
* @typedef ResourceJsonSchema
|
|
1391
|
+
* @property {string} [schema]
|
|
1392
|
+
* @property {ResourceJsonSchemaType} [type]
|
|
1393
|
+
*/
|
|
1394
|
+
/**
|
|
1395
|
+
* @typedef ResourceJsonSchemaType
|
|
1396
|
+
* @property {Author} [author]
|
|
1397
|
+
* @property {Title} [title]
|
|
1398
|
+
* @property {FeatureImage} [feature_image]
|
|
1399
|
+
*/
|
|
1400
|
+
/**
|
|
1401
|
+
* @typedef ResourceUISchema
|
|
1402
|
+
* @property {Author} [author]
|
|
1403
|
+
* @property {Title} [title]
|
|
1404
|
+
* @property {FeatureImage} [feature_image]
|
|
1405
|
+
* @property {Seo} [seo]
|
|
1406
|
+
*/
|
|
1407
|
+
/**
|
|
1408
|
+
* @typedef ResourceBulkDetails
|
|
1409
|
+
* @property {string[]} [fields]
|
|
1410
|
+
*/
|
|
1411
|
+
/**
|
|
1412
|
+
* @typedef Title
|
|
1413
|
+
* @property {string} [ui_widget]
|
|
1414
|
+
* @property {boolean} [ui_description]
|
|
1415
|
+
*/
|
|
1416
|
+
/**
|
|
1417
|
+
* @typedef FeatureImage
|
|
1418
|
+
* @property {string} [secure_url] - URL of the secure image
|
|
1419
|
+
*/
|
|
1420
|
+
/**
|
|
1421
|
+
* @typedef Seo
|
|
1422
|
+
* @property {Title} [title]
|
|
1423
|
+
* @property {string} [description]
|
|
1424
|
+
* @property {string} [canonical_url]
|
|
1425
|
+
* @property {MetaTag[]} [meta_tags]
|
|
1426
|
+
*/
|
|
1427
|
+
/**
|
|
1428
|
+
* @typedef MetaTag
|
|
1429
|
+
* @property {string} [title] - Title of the meta tag
|
|
1430
|
+
* @property {MetaTagItem[]} [items]
|
|
1431
|
+
*/
|
|
1432
|
+
/**
|
|
1433
|
+
* @typedef MetaTagItem
|
|
1434
|
+
* @property {string} [key] - Key of the meta tag item
|
|
1435
|
+
* @property {string} [value] - Value of the meta tag item
|
|
1436
|
+
*/
|
|
1437
|
+
/**
|
|
1438
|
+
* @typedef ResourceTranslation
|
|
1439
|
+
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1440
|
+
* @property {string} [locale] - Language code for this translation
|
|
1441
|
+
* @property {TranslationValue} [value]
|
|
1442
|
+
*/
|
|
1443
|
+
/**
|
|
1444
|
+
* @typedef TranslationValue
|
|
1445
|
+
* @property {string} [name] - Translated name
|
|
1446
|
+
* @property {TranslationSeo} [seo]
|
|
1447
|
+
*/
|
|
1448
|
+
/**
|
|
1449
|
+
* @typedef TranslationSeo
|
|
1450
|
+
* @property {string} [title] - Translated SEO title
|
|
1451
|
+
* @property {string[]} [breadcrumbs] - List of translated breadcrumbs
|
|
1452
|
+
* @property {string[]} [meta_tags] - List of translated meta tags
|
|
1453
|
+
* @property {string} [canonical_url] - Translated canonical URL
|
|
1454
|
+
* @property {string} [description] - Translated SEO description
|
|
1455
|
+
*/
|
|
1456
|
+
/**
|
|
1457
|
+
* @typedef ResourceTranslationList
|
|
1458
|
+
* @property {ResourceTranslationCreate[]} [items]
|
|
1459
|
+
*/
|
|
1460
|
+
/**
|
|
1461
|
+
* @typedef ResourceTranslationCreate
|
|
1462
|
+
* @property {string} [type] - Type of content being translated
|
|
1463
|
+
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1464
|
+
* @property {string} [locale] - Target language code for the translation
|
|
1465
|
+
* @property {TranslationValue} [value]
|
|
1466
|
+
*/
|
|
1467
|
+
/**
|
|
1468
|
+
* @typedef ResourceTranslationUpdate
|
|
1469
|
+
* @property {TranslationValue} [value]
|
|
1470
|
+
*/
|
|
1471
|
+
/**
|
|
1472
|
+
* @typedef TranslatableSection
|
|
1473
|
+
* @property {string} [_id] - Unique identifier for the translatable section
|
|
1474
|
+
* @property {string} [name] - Display name of the section
|
|
1475
|
+
* @property {string} [description] - Detailed explanation of the section's purpose
|
|
1476
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1477
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1478
|
+
* this resource
|
|
1479
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1480
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1481
|
+
*/
|
|
1482
|
+
/**
|
|
1483
|
+
* @typedef Metrics
|
|
1484
|
+
* @property {number} [total] - Total number of translation operations attempted
|
|
1485
|
+
* @property {number} [success] - Number of successful translation operations
|
|
1486
|
+
* @property {number} [failed] - Number of failed translation operations
|
|
1487
|
+
*/
|
|
1488
|
+
/**
|
|
1489
|
+
* @typedef ResourceTranslationUpsertItem
|
|
1490
|
+
* @property {string} [message] - Status message for the translation operation
|
|
1491
|
+
* @property {ResourceTranslationCreate} [data]
|
|
1492
|
+
*/
|
|
1493
|
+
/**
|
|
1494
|
+
* @typedef ResourceTranslationBulkUpsert
|
|
1495
|
+
* @property {Metrics} [metrics]
|
|
1496
|
+
* @property {ResourceTranslationUpsertItem[]} [failed_items] - List of failed
|
|
1497
|
+
* translation operations
|
|
1498
|
+
* @property {ResourceTranslationUpsertItem[]} [updated_items] - List of
|
|
1499
|
+
* successful translation operations
|
|
1500
|
+
*/
|
|
1501
|
+
/**
|
|
1502
|
+
* @typedef StandardError
|
|
1503
|
+
* @property {string} message - A brief description of the error.
|
|
1504
|
+
*/
|
|
1505
|
+
/**
|
|
1506
|
+
* @typedef OperationResponseSchema
|
|
1507
|
+
* @property {boolean} success - Indicates if the operation was successful
|
|
1508
|
+
* @property {string} [message] - Optional message providing additional
|
|
1509
|
+
* information about the operation
|
|
1510
|
+
*/
|
|
1511
|
+
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
1320
1512
|
/**
|
|
1321
1513
|
* @typedef {| "about-us"
|
|
1322
1514
|
* | "addresses"
|
|
@@ -1370,8 +1562,20 @@ export = ContentPlatformModel;
|
|
|
1370
1562
|
declare class ContentPlatformModel {
|
|
1371
1563
|
}
|
|
1372
1564
|
declare namespace ContentPlatformModel {
|
|
1373
|
-
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody,
|
|
1565
|
+
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, Seo, MetaTag, MetaTagItem, ResourceTranslation, TranslationValue, TranslationSeo, ResourceTranslationList, ResourceTranslationCreate, ResourceTranslationUpdate, TranslatableSection, Metrics, ResourceTranslationUpsertItem, ResourceTranslationBulkUpsert, StandardError, OperationResponseSchema, GenerationEntityType, PageType };
|
|
1374
1566
|
}
|
|
1567
|
+
/** @returns {ValidationError} */
|
|
1568
|
+
declare function ValidationError(): ValidationError;
|
|
1569
|
+
type ValidationError = {
|
|
1570
|
+
/**
|
|
1571
|
+
* - A brief description of the error encountered.
|
|
1572
|
+
*/
|
|
1573
|
+
message: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* - The field in the request that caused the error.
|
|
1576
|
+
*/
|
|
1577
|
+
field: string;
|
|
1578
|
+
};
|
|
1375
1579
|
/** @returns {GenerateSEOContent} */
|
|
1376
1580
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
1377
1581
|
type GenerateSEOContent = {
|
|
@@ -1398,7 +1602,6 @@ type ApplicationLegal = {
|
|
|
1398
1602
|
_id?: string;
|
|
1399
1603
|
updated_at?: string;
|
|
1400
1604
|
created_at?: string;
|
|
1401
|
-
__v?: number;
|
|
1402
1605
|
};
|
|
1403
1606
|
/** @returns {ApplicationLegalFAQ} */
|
|
1404
1607
|
declare function ApplicationLegalFAQ(): ApplicationLegalFAQ;
|
|
@@ -1415,7 +1618,7 @@ type PathMappingSchema = {
|
|
|
1415
1618
|
redirect_to?: string;
|
|
1416
1619
|
updated_at?: string;
|
|
1417
1620
|
created_at?: string;
|
|
1418
|
-
|
|
1621
|
+
__source?: PathSourceSchema;
|
|
1419
1622
|
};
|
|
1420
1623
|
/** @returns {PathSourceSchema} */
|
|
1421
1624
|
declare function PathSourceSchema(): PathSourceSchema;
|
|
@@ -1431,8 +1634,8 @@ type SeoComponent = {
|
|
|
1431
1634
|
/** @returns {SeoSchema} */
|
|
1432
1635
|
declare function SeoSchema(): SeoSchema;
|
|
1433
1636
|
type SeoSchema = {
|
|
1434
|
-
_id?: string;
|
|
1435
1637
|
app?: string;
|
|
1638
|
+
_id?: string;
|
|
1436
1639
|
robots_txt?: string;
|
|
1437
1640
|
sitemap_enabled?: boolean;
|
|
1438
1641
|
additional_sitemap?: string;
|
|
@@ -1441,8 +1644,6 @@ type SeoSchema = {
|
|
|
1441
1644
|
details?: Detail;
|
|
1442
1645
|
created_at?: string;
|
|
1443
1646
|
updated_at?: string;
|
|
1444
|
-
__v?: number;
|
|
1445
|
-
sitemap?: SEOSitemap;
|
|
1446
1647
|
};
|
|
1447
1648
|
/** @returns {CustomMetaTag} */
|
|
1448
1649
|
declare function CustomMetaTag(): CustomMetaTag;
|
|
@@ -1467,55 +1668,28 @@ type SeoSchemaComponent = {
|
|
|
1467
1668
|
/** @returns {SEOSchemaMarkupTemplate} */
|
|
1468
1669
|
declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
|
|
1469
1670
|
type SEOSchemaMarkupTemplate = {
|
|
1470
|
-
|
|
1671
|
+
id?: string;
|
|
1471
1672
|
title?: string;
|
|
1472
1673
|
page_type?: string;
|
|
1473
1674
|
schema?: string;
|
|
1474
1675
|
description?: string;
|
|
1475
1676
|
active?: boolean;
|
|
1476
|
-
application?: string;
|
|
1477
1677
|
created_at?: string;
|
|
1478
1678
|
updated_at?: string;
|
|
1679
|
+
application?: string;
|
|
1479
1680
|
target_json?: any;
|
|
1480
|
-
__v?: number;
|
|
1481
1681
|
};
|
|
1482
1682
|
/** @returns {SEOSchemaMarkupTemplateRequestBody} */
|
|
1483
1683
|
declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
|
|
1484
1684
|
type SEOSchemaMarkupTemplateRequestBody = {
|
|
1485
1685
|
title?: string;
|
|
1486
1686
|
page_type?: string;
|
|
1487
|
-
description?: string;
|
|
1488
1687
|
schema?: string;
|
|
1688
|
+
description?: string;
|
|
1489
1689
|
target_json?: any;
|
|
1490
1690
|
active?: boolean;
|
|
1491
1691
|
created_at?: string;
|
|
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;
|
|
1692
|
+
updated_at?: string;
|
|
1519
1693
|
};
|
|
1520
1694
|
/** @returns {AnnouncementPageSchema} */
|
|
1521
1695
|
declare function AnnouncementPageSchema(): AnnouncementPageSchema;
|
|
@@ -1562,11 +1736,11 @@ declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplat
|
|
|
1562
1736
|
type DefaultSEOSchemaMarkupTemplate = {
|
|
1563
1737
|
page_type?: string;
|
|
1564
1738
|
schema?: string;
|
|
1739
|
+
target_json?: any;
|
|
1565
1740
|
};
|
|
1566
1741
|
/** @returns {ScheduleSchema} */
|
|
1567
1742
|
declare function ScheduleSchema(): ScheduleSchema;
|
|
1568
1743
|
type ScheduleSchema = {
|
|
1569
|
-
published?: boolean;
|
|
1570
1744
|
cron?: string;
|
|
1571
1745
|
start?: string;
|
|
1572
1746
|
end?: string;
|
|
@@ -1579,9 +1753,9 @@ type NextSchedule = {
|
|
|
1579
1753
|
start?: string;
|
|
1580
1754
|
end?: string;
|
|
1581
1755
|
};
|
|
1582
|
-
/** @returns {
|
|
1583
|
-
declare function
|
|
1584
|
-
type
|
|
1756
|
+
/** @returns {BlogGetDetails} */
|
|
1757
|
+
declare function BlogGetDetails(): BlogGetDetails;
|
|
1758
|
+
type BlogGetDetails = {
|
|
1585
1759
|
items?: BlogSchema[];
|
|
1586
1760
|
page?: Page;
|
|
1587
1761
|
filters?: BlogFilters;
|
|
@@ -1609,6 +1783,9 @@ declare function Author(): Author;
|
|
|
1609
1783
|
type Author = {
|
|
1610
1784
|
designation?: string;
|
|
1611
1785
|
id?: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* - Name of the author
|
|
1788
|
+
*/
|
|
1612
1789
|
name?: string;
|
|
1613
1790
|
};
|
|
1614
1791
|
/** @returns {BlogSchema} */
|
|
@@ -1630,7 +1807,6 @@ type BlogSchema = {
|
|
|
1630
1807
|
title?: string;
|
|
1631
1808
|
date_meta?: DateMeta;
|
|
1632
1809
|
summary?: string;
|
|
1633
|
-
status?: string;
|
|
1634
1810
|
};
|
|
1635
1811
|
/** @returns {SEO} */
|
|
1636
1812
|
declare function SEO(): SEO;
|
|
@@ -1640,7 +1816,7 @@ type SEO = {
|
|
|
1640
1816
|
title?: string;
|
|
1641
1817
|
meta_tags?: SEOMetaItem[];
|
|
1642
1818
|
sitemap?: SEOSitemap;
|
|
1643
|
-
|
|
1819
|
+
breadcrumb?: SEObreadcrumb[];
|
|
1644
1820
|
canonical_url?: string;
|
|
1645
1821
|
};
|
|
1646
1822
|
/** @returns {SEOImage} */
|
|
@@ -1678,9 +1854,9 @@ type DateMeta = {
|
|
|
1678
1854
|
created_on?: string;
|
|
1679
1855
|
modified_on?: string;
|
|
1680
1856
|
};
|
|
1681
|
-
/** @returns {
|
|
1682
|
-
declare function
|
|
1683
|
-
type
|
|
1857
|
+
/** @returns {BlogPayload} */
|
|
1858
|
+
declare function BlogPayload(): BlogPayload;
|
|
1859
|
+
type BlogPayload = {
|
|
1684
1860
|
application?: string;
|
|
1685
1861
|
_custom_json?: any;
|
|
1686
1862
|
author?: Author;
|
|
@@ -1691,7 +1867,6 @@ type BlogRequest = {
|
|
|
1691
1867
|
slug?: string;
|
|
1692
1868
|
tags?: string[];
|
|
1693
1869
|
title?: string;
|
|
1694
|
-
publish_date?: string;
|
|
1695
1870
|
seo?: SEO;
|
|
1696
1871
|
summary?: string;
|
|
1697
1872
|
};
|
|
@@ -1707,11 +1882,6 @@ type CreateAnnouncementSchema = {
|
|
|
1707
1882
|
message?: string;
|
|
1708
1883
|
data?: AdminAnnouncementSchema;
|
|
1709
1884
|
};
|
|
1710
|
-
/** @returns {DataLoaderItemsResponseSchema} */
|
|
1711
|
-
declare function DataLoaderItemsResponseSchema(): DataLoaderItemsResponseSchema;
|
|
1712
|
-
type DataLoaderItemsResponseSchema = {
|
|
1713
|
-
items?: DataLoaderResponseSchema[];
|
|
1714
|
-
};
|
|
1715
1885
|
/** @returns {DataLoaderResponseSchema} */
|
|
1716
1886
|
declare function DataLoaderResponseSchema(): DataLoaderResponseSchema;
|
|
1717
1887
|
type DataLoaderResponseSchema = {
|
|
@@ -1724,16 +1894,12 @@ type DataLoaderResponseSchema = {
|
|
|
1724
1894
|
type?: string;
|
|
1725
1895
|
url?: string;
|
|
1726
1896
|
content?: string;
|
|
1727
|
-
created_at?: string;
|
|
1728
|
-
modified_at?: string;
|
|
1729
|
-
__v?: number;
|
|
1730
|
-
is_selected?: boolean;
|
|
1731
1897
|
__source?: DataLoaderSourceSchema;
|
|
1732
1898
|
};
|
|
1733
1899
|
/** @returns {DataLoaderResetResponseSchema} */
|
|
1734
1900
|
declare function DataLoaderResetResponseSchema(): DataLoaderResetResponseSchema;
|
|
1735
1901
|
type DataLoaderResetResponseSchema = {
|
|
1736
|
-
|
|
1902
|
+
reset?: boolean;
|
|
1737
1903
|
};
|
|
1738
1904
|
/** @returns {LocaleLanguage} */
|
|
1739
1905
|
declare function LocaleLanguage(): LocaleLanguage;
|
|
@@ -1765,19 +1931,13 @@ type NavigationReference = {
|
|
|
1765
1931
|
_locale_language?: LocaleLanguage;
|
|
1766
1932
|
image?: string;
|
|
1767
1933
|
type?: string;
|
|
1934
|
+
action?: Action;
|
|
1768
1935
|
active?: boolean;
|
|
1769
1936
|
display?: string;
|
|
1770
1937
|
sort_order?: number;
|
|
1771
1938
|
schedule?: CronBasedScheduleSchema;
|
|
1772
1939
|
sub_navigation?: NavigationReference[];
|
|
1773
1940
|
};
|
|
1774
|
-
/** @returns {AssignmentReference} */
|
|
1775
|
-
declare function AssignmentReference(): AssignmentReference;
|
|
1776
|
-
type AssignmentReference = {
|
|
1777
|
-
platform?: string;
|
|
1778
|
-
orientation?: string;
|
|
1779
|
-
position?: string;
|
|
1780
|
-
};
|
|
1781
1941
|
/** @returns {CronBasedScheduleSchema} */
|
|
1782
1942
|
declare function CronBasedScheduleSchema(): CronBasedScheduleSchema;
|
|
1783
1943
|
type CronBasedScheduleSchema = {
|
|
@@ -1794,52 +1954,140 @@ type UpdateHandpickedSchema = {
|
|
|
1794
1954
|
/** @returns {HandpickedTagSchema} */
|
|
1795
1955
|
declare function HandpickedTagSchema(): HandpickedTagSchema;
|
|
1796
1956
|
type HandpickedTagSchema = {
|
|
1957
|
+
/**
|
|
1958
|
+
* - The location in the page where the tag should
|
|
1959
|
+
* be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
1960
|
+
*/
|
|
1797
1961
|
position?: string;
|
|
1962
|
+
/**
|
|
1963
|
+
* - Additional attributes for the tag to define
|
|
1964
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
1965
|
+
* tag type for example:
|
|
1966
|
+
*
|
|
1967
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
1968
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
1969
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
1970
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
1971
|
+
*/
|
|
1798
1972
|
attributes?: any;
|
|
1973
|
+
/**
|
|
1974
|
+
* - List of UI frameworks where this
|
|
1975
|
+
* third-party tag can be injected or supported.
|
|
1976
|
+
*/
|
|
1977
|
+
compatible_engines?: string[];
|
|
1978
|
+
/**
|
|
1979
|
+
* - The name of the tag used to identify it in the
|
|
1980
|
+
* system. Example: 'Google External Script' or 'Bootstrap CSS'.
|
|
1981
|
+
*/
|
|
1799
1982
|
name?: string;
|
|
1983
|
+
/**
|
|
1984
|
+
* - The URL where the external tag resource (such as a
|
|
1985
|
+
* script or stylesheet) is hosted.
|
|
1986
|
+
*/
|
|
1800
1987
|
url?: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* - The type of the tag, such as 'script' (for
|
|
1990
|
+
* JavaScript) or 'link' (for CSS).
|
|
1991
|
+
*/
|
|
1801
1992
|
type?: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* - Defines whether the tag is embedded within
|
|
1995
|
+
* the HTML (inline) or linked externally (external).
|
|
1996
|
+
*/
|
|
1802
1997
|
sub_type?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* - The actual content of the inline tag, such as
|
|
2000
|
+
* JavaScript or CSS code if the tag is inline.
|
|
2001
|
+
*/
|
|
1803
2002
|
content?: string;
|
|
1804
2003
|
};
|
|
1805
2004
|
/** @returns {RemoveHandpickedSchema} */
|
|
1806
2005
|
declare function RemoveHandpickedSchema(): RemoveHandpickedSchema;
|
|
1807
2006
|
type RemoveHandpickedSchema = {
|
|
2007
|
+
/**
|
|
2008
|
+
* - A list of tag IDs to remove from the system.
|
|
2009
|
+
*/
|
|
1808
2010
|
tags?: string[];
|
|
1809
2011
|
};
|
|
1810
2012
|
/** @returns {CreateTagSchema} */
|
|
1811
2013
|
declare function CreateTagSchema(): CreateTagSchema;
|
|
1812
2014
|
type CreateTagSchema = {
|
|
2015
|
+
/**
|
|
2016
|
+
* - The name of the tag to be created, used for
|
|
2017
|
+
* identification purposes.
|
|
2018
|
+
*/
|
|
1813
2019
|
name?: string;
|
|
2020
|
+
/**
|
|
2021
|
+
* - Indicates if the tag is external (linked) or
|
|
2022
|
+
* inline (embedded within the page).
|
|
2023
|
+
*/
|
|
1814
2024
|
sub_type?: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* - The unique identifier for the tag.
|
|
2027
|
+
*/
|
|
1815
2028
|
_id?: string;
|
|
2029
|
+
/**
|
|
2030
|
+
* - The type of the tag, either JavaScript ('js') or
|
|
2031
|
+
* CSS ('css').
|
|
2032
|
+
*/
|
|
1816
2033
|
type?: string;
|
|
2034
|
+
/**
|
|
2035
|
+
* - The external URL pointing to the script or
|
|
2036
|
+
* stylesheet resource.
|
|
2037
|
+
*/
|
|
1817
2038
|
url?: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* - The position on the webpage where the tag
|
|
2041
|
+
* will be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
2042
|
+
*/
|
|
1818
2043
|
position?: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* - Additional attributes for the tag to define
|
|
2046
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
2047
|
+
* tag type for example:
|
|
2048
|
+
*
|
|
2049
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
2050
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
2051
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
2052
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
2053
|
+
*/
|
|
1819
2054
|
attributes?: any;
|
|
2055
|
+
/**
|
|
2056
|
+
* - List of UI frameworks where this
|
|
2057
|
+
* third-party tag can be injected or supported.
|
|
2058
|
+
*/
|
|
2059
|
+
compatible_engines?: string[];
|
|
2060
|
+
/**
|
|
2061
|
+
* - Pages or environments where the tag should be
|
|
2062
|
+
* injected or active.
|
|
2063
|
+
*/
|
|
1820
2064
|
pages?: any[];
|
|
2065
|
+
/**
|
|
2066
|
+
* - The inline content for tags of type 'inline'
|
|
2067
|
+
* (e.g., JavaScript or CSS code).
|
|
2068
|
+
*/
|
|
1821
2069
|
content?: string;
|
|
1822
2070
|
};
|
|
1823
2071
|
/** @returns {CreateTagRequestSchema} */
|
|
1824
2072
|
declare function CreateTagRequestSchema(): CreateTagRequestSchema;
|
|
1825
2073
|
type CreateTagRequestSchema = {
|
|
2074
|
+
/**
|
|
2075
|
+
* - A list of tags to be created or
|
|
2076
|
+
* updated, each containing details such as name, type, and attributes.
|
|
2077
|
+
*/
|
|
1826
2078
|
tags?: CreateTagSchema[];
|
|
1827
2079
|
};
|
|
1828
2080
|
/** @returns {DataLoaderSchema} */
|
|
1829
2081
|
declare function DataLoaderSchema(): DataLoaderSchema;
|
|
1830
2082
|
type DataLoaderSchema = {
|
|
1831
|
-
_id?: string;
|
|
1832
|
-
url?: string;
|
|
1833
|
-
created_at?: string;
|
|
1834
|
-
modified_at?: string;
|
|
1835
|
-
application?: string;
|
|
1836
|
-
company?: string;
|
|
1837
2083
|
name?: string;
|
|
1838
2084
|
service?: string;
|
|
1839
2085
|
operation_id?: string;
|
|
1840
|
-
is_selected?: boolean;
|
|
1841
2086
|
type?: string;
|
|
2087
|
+
url?: string;
|
|
2088
|
+
content?: string;
|
|
1842
2089
|
__source?: DataLoaderSourceSchema;
|
|
2090
|
+
_id?: string;
|
|
1843
2091
|
};
|
|
1844
2092
|
/** @returns {DataLoaderSourceSchema} */
|
|
1845
2093
|
declare function DataLoaderSourceSchema(): DataLoaderSourceSchema;
|
|
@@ -1847,34 +2095,18 @@ type DataLoaderSourceSchema = {
|
|
|
1847
2095
|
type?: string;
|
|
1848
2096
|
id?: string;
|
|
1849
2097
|
};
|
|
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
|
-
};
|
|
1870
2098
|
/** @returns {DataLoadersSchema} */
|
|
1871
2099
|
declare function DataLoadersSchema(): DataLoadersSchema;
|
|
1872
2100
|
type DataLoadersSchema = {
|
|
1873
2101
|
items?: DataLoaderSchema[];
|
|
1874
2102
|
};
|
|
1875
|
-
/** @returns {
|
|
1876
|
-
declare function
|
|
1877
|
-
type
|
|
2103
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
2104
|
+
declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
|
|
2105
|
+
type TagDeleteSuccessDetails = {
|
|
2106
|
+
/**
|
|
2107
|
+
* - Indicates whether the tag removal operation
|
|
2108
|
+
* was successful.
|
|
2109
|
+
*/
|
|
1878
2110
|
success?: boolean;
|
|
1879
2111
|
};
|
|
1880
2112
|
/** @returns {ContentAPIError} */
|
|
@@ -1884,6 +2116,7 @@ type ContentAPIError = {
|
|
|
1884
2116
|
status?: number;
|
|
1885
2117
|
code?: string;
|
|
1886
2118
|
exception?: string;
|
|
2119
|
+
info?: string;
|
|
1887
2120
|
request_id?: string;
|
|
1888
2121
|
stack_trace?: string;
|
|
1889
2122
|
meta?: any;
|
|
@@ -1905,7 +2138,6 @@ type CategorySchema = {
|
|
|
1905
2138
|
application?: string;
|
|
1906
2139
|
icon_url?: string;
|
|
1907
2140
|
_custom_json?: any;
|
|
1908
|
-
__v?: number;
|
|
1909
2141
|
};
|
|
1910
2142
|
/** @returns {ChildrenSchema} */
|
|
1911
2143
|
declare function ChildrenSchema(): ChildrenSchema;
|
|
@@ -1925,15 +2157,15 @@ type CategoryRequestSchema = {
|
|
|
1925
2157
|
/** @returns {FAQCategorySchema} */
|
|
1926
2158
|
declare function FAQCategorySchema(): FAQCategorySchema;
|
|
1927
2159
|
type FAQCategorySchema = {
|
|
1928
|
-
|
|
1929
|
-
application?: string;
|
|
2160
|
+
index?: number;
|
|
1930
2161
|
title?: string;
|
|
1931
2162
|
description?: string;
|
|
1932
|
-
index?: number;
|
|
1933
|
-
slug?: string;
|
|
1934
2163
|
children?: ChildrenSchema[];
|
|
2164
|
+
_id?: string;
|
|
2165
|
+
slug?: string;
|
|
2166
|
+
application?: string;
|
|
1935
2167
|
icon_url?: string;
|
|
1936
|
-
|
|
2168
|
+
_custom_json?: any;
|
|
1937
2169
|
};
|
|
1938
2170
|
/** @returns {FaqSchema} */
|
|
1939
2171
|
declare function FaqSchema(): FaqSchema;
|
|
@@ -1944,7 +2176,6 @@ type FaqSchema = {
|
|
|
1944
2176
|
question?: string;
|
|
1945
2177
|
answer?: string;
|
|
1946
2178
|
tags?: string[];
|
|
1947
|
-
__v?: number;
|
|
1948
2179
|
};
|
|
1949
2180
|
/** @returns {FAQ} */
|
|
1950
2181
|
declare function FAQ(): FAQ;
|
|
@@ -2025,13 +2256,13 @@ type Page = {
|
|
|
2025
2256
|
*/
|
|
2026
2257
|
size?: number;
|
|
2027
2258
|
/**
|
|
2028
|
-
* -
|
|
2259
|
+
* - The number of items per page.
|
|
2029
2260
|
*/
|
|
2030
|
-
|
|
2261
|
+
page_size?: number;
|
|
2031
2262
|
};
|
|
2032
|
-
/** @returns {
|
|
2033
|
-
declare function
|
|
2034
|
-
type
|
|
2263
|
+
/** @returns {LandingPageGetDetails} */
|
|
2264
|
+
declare function LandingPageGetDetails(): LandingPageGetDetails;
|
|
2265
|
+
type LandingPageGetDetails = {
|
|
2035
2266
|
items?: LandingPageSchema[];
|
|
2036
2267
|
page?: Page;
|
|
2037
2268
|
};
|
|
@@ -2039,6 +2270,7 @@ type LandingPageGetResponse = {
|
|
|
2039
2270
|
declare function LandingPageSchema(): LandingPageSchema;
|
|
2040
2271
|
type LandingPageSchema = {
|
|
2041
2272
|
slug?: string;
|
|
2273
|
+
action?: Action;
|
|
2042
2274
|
platform?: string[];
|
|
2043
2275
|
created_by?: CreatedBySchema;
|
|
2044
2276
|
date_meta?: DateMeta;
|
|
@@ -2046,16 +2278,15 @@ type LandingPageSchema = {
|
|
|
2046
2278
|
application?: string;
|
|
2047
2279
|
archived?: boolean;
|
|
2048
2280
|
_custom_json?: any;
|
|
2049
|
-
__v?: number;
|
|
2050
2281
|
};
|
|
2051
|
-
/** @returns {
|
|
2052
|
-
declare function
|
|
2053
|
-
type
|
|
2282
|
+
/** @returns {DefaultNavigationDetails} */
|
|
2283
|
+
declare function DefaultNavigationDetails(): DefaultNavigationDetails;
|
|
2284
|
+
type DefaultNavigationDetails = {
|
|
2054
2285
|
items?: NavigationSchema[];
|
|
2055
2286
|
};
|
|
2056
|
-
/** @returns {
|
|
2057
|
-
declare function
|
|
2058
|
-
type
|
|
2287
|
+
/** @returns {NavigationGetDetails} */
|
|
2288
|
+
declare function NavigationGetDetails(): NavigationGetDetails;
|
|
2289
|
+
type NavigationGetDetails = {
|
|
2059
2290
|
items?: NavigationSchema[];
|
|
2060
2291
|
page?: Page;
|
|
2061
2292
|
};
|
|
@@ -2079,29 +2310,19 @@ type NavigationSchema = {
|
|
|
2079
2310
|
orientation?: Orientation;
|
|
2080
2311
|
version?: number;
|
|
2081
2312
|
navigation?: NavigationReference[];
|
|
2082
|
-
assignments?: AssignmentReference[];
|
|
2083
|
-
__v?: number;
|
|
2084
2313
|
};
|
|
2085
|
-
/** @returns {
|
|
2086
|
-
declare function
|
|
2087
|
-
type
|
|
2314
|
+
/** @returns {NavigationPayload} */
|
|
2315
|
+
declare function NavigationPayload(): NavigationPayload;
|
|
2316
|
+
type NavigationPayload = {
|
|
2088
2317
|
name?: string;
|
|
2089
2318
|
slug?: string;
|
|
2090
2319
|
platform?: string[];
|
|
2091
2320
|
orientation?: Orientation;
|
|
2092
|
-
assignments?: NavigationAssignment[];
|
|
2093
2321
|
navigation?: NavigationReference[];
|
|
2094
2322
|
};
|
|
2095
|
-
/** @returns {
|
|
2096
|
-
declare function
|
|
2097
|
-
type
|
|
2098
|
-
platform?: string;
|
|
2099
|
-
orientation?: string;
|
|
2100
|
-
position?: string;
|
|
2101
|
-
};
|
|
2102
|
-
/** @returns {PageGetResponse} */
|
|
2103
|
-
declare function PageGetResponse(): PageGetResponse;
|
|
2104
|
-
type PageGetResponse = {
|
|
2323
|
+
/** @returns {PageGetDetails} */
|
|
2324
|
+
declare function PageGetDetails(): PageGetDetails;
|
|
2325
|
+
type PageGetDetails = {
|
|
2105
2326
|
items?: PageSchema[];
|
|
2106
2327
|
page?: Page;
|
|
2107
2328
|
};
|
|
@@ -2124,73 +2345,50 @@ type PageSpecItem = {
|
|
|
2124
2345
|
params?: PageSpecParam[];
|
|
2125
2346
|
query?: PageSpecParam[];
|
|
2126
2347
|
};
|
|
2127
|
-
/** @returns {PageResponseError} */
|
|
2128
|
-
declare function PageResponseError(): PageResponseError;
|
|
2129
|
-
type PageResponseError = {
|
|
2130
|
-
errors?: string;
|
|
2131
|
-
};
|
|
2132
2348
|
/** @returns {PageSchema} */
|
|
2133
2349
|
declare function PageSchema(): PageSchema;
|
|
2134
2350
|
type PageSchema = {
|
|
2135
2351
|
_id?: string;
|
|
2136
2352
|
application?: string;
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2353
|
+
/**
|
|
2354
|
+
* - Components can be used to store
|
|
2355
|
+
* multiple components
|
|
2356
|
+
*/
|
|
2357
|
+
component_ids?: string[];
|
|
2358
|
+
content?: any[];
|
|
2142
2359
|
content_path?: string;
|
|
2143
|
-
orientation?: string;
|
|
2144
|
-
description?: string;
|
|
2145
|
-
published?: boolean;
|
|
2146
2360
|
created_by?: CreatedBySchema;
|
|
2147
2361
|
date_meta?: DateMeta;
|
|
2362
|
+
description?: string;
|
|
2148
2363
|
feature_image?: Asset;
|
|
2364
|
+
page_meta?: any[];
|
|
2149
2365
|
_schedule?: ScheduleSchema;
|
|
2150
|
-
|
|
2366
|
+
_custom_json?: any;
|
|
2367
|
+
orientation?: string;
|
|
2368
|
+
platform?: string;
|
|
2369
|
+
published?: boolean;
|
|
2370
|
+
slug?: string;
|
|
2371
|
+
tags?: string[];
|
|
2372
|
+
title?: string;
|
|
2373
|
+
type?: string;
|
|
2151
2374
|
seo?: SEO;
|
|
2152
|
-
|
|
2375
|
+
visibility?: any;
|
|
2153
2376
|
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;
|
|
2174
2377
|
};
|
|
2175
2378
|
/** @returns {CreatedBySchema} */
|
|
2176
2379
|
declare function CreatedBySchema(): CreatedBySchema;
|
|
2177
2380
|
type CreatedBySchema = {
|
|
2178
2381
|
id?: string;
|
|
2179
2382
|
};
|
|
2180
|
-
/** @returns {
|
|
2181
|
-
declare function
|
|
2182
|
-
type
|
|
2183
|
-
test?: boolean;
|
|
2184
|
-
};
|
|
2185
|
-
/** @returns {PageRequest} */
|
|
2186
|
-
declare function PageRequest(): PageRequest;
|
|
2187
|
-
type PageRequest = {
|
|
2383
|
+
/** @returns {PagePayload} */
|
|
2384
|
+
declare function PagePayload(): PagePayload;
|
|
2385
|
+
type PagePayload = {
|
|
2188
2386
|
_schedule?: CronSchedule;
|
|
2189
2387
|
application?: string;
|
|
2190
2388
|
author?: Author;
|
|
2191
2389
|
_custom_json?: any;
|
|
2192
2390
|
orientation?: string;
|
|
2193
|
-
content?:
|
|
2391
|
+
content?: any[];
|
|
2194
2392
|
feature_image?: Asset;
|
|
2195
2393
|
published?: boolean;
|
|
2196
2394
|
reading_time?: string;
|
|
@@ -2198,13 +2396,6 @@ type PageRequest = {
|
|
|
2198
2396
|
tags?: string[];
|
|
2199
2397
|
seo?: SEO;
|
|
2200
2398
|
title?: string;
|
|
2201
|
-
platform?: string;
|
|
2202
|
-
type?: string;
|
|
2203
|
-
description?: string;
|
|
2204
|
-
/**
|
|
2205
|
-
* - Visibility of Page.
|
|
2206
|
-
*/
|
|
2207
|
-
visibility?: any;
|
|
2208
2399
|
};
|
|
2209
2400
|
/** @returns {CronSchedule} */
|
|
2210
2401
|
declare function CronSchedule(): CronSchedule;
|
|
@@ -2213,44 +2404,19 @@ type CronSchedule = {
|
|
|
2213
2404
|
start?: string;
|
|
2214
2405
|
end?: string;
|
|
2215
2406
|
duration?: number;
|
|
2216
|
-
next_schedule?: NextSchedule[];
|
|
2217
2407
|
};
|
|
2218
|
-
/** @returns {
|
|
2219
|
-
declare function
|
|
2220
|
-
type
|
|
2408
|
+
/** @returns {PagePublishPayload} */
|
|
2409
|
+
declare function PagePublishPayload(): PagePublishPayload;
|
|
2410
|
+
type PagePublishPayload = {
|
|
2221
2411
|
publish?: boolean;
|
|
2222
2412
|
};
|
|
2223
2413
|
/** @returns {PageMetaSchema} */
|
|
2224
2414
|
declare function PageMetaSchema(): PageMetaSchema;
|
|
2225
2415
|
type PageMetaSchema = {
|
|
2226
|
-
system_pages?:
|
|
2227
|
-
custom_pages?:
|
|
2416
|
+
system_pages?: NavigationSchema[];
|
|
2417
|
+
custom_pages?: PageSchema[];
|
|
2228
2418
|
application_id?: string;
|
|
2229
2419
|
};
|
|
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
|
-
};
|
|
2254
2420
|
/** @returns {Support} */
|
|
2255
2421
|
declare function Support(): Support;
|
|
2256
2422
|
type Support = {
|
|
@@ -2296,31 +2462,89 @@ type ContactSchema = {
|
|
|
2296
2462
|
/** @returns {TagsSchema} */
|
|
2297
2463
|
declare function TagsSchema(): TagsSchema;
|
|
2298
2464
|
type TagsSchema = {
|
|
2465
|
+
/**
|
|
2466
|
+
* - The ID of the application that owns the tags.
|
|
2467
|
+
*/
|
|
2299
2468
|
application?: string;
|
|
2469
|
+
/**
|
|
2470
|
+
* - The unique identifier for the tag set.
|
|
2471
|
+
*/
|
|
2300
2472
|
_id?: string;
|
|
2301
|
-
|
|
2302
|
-
|
|
2473
|
+
/**
|
|
2474
|
+
* - A list of tags (HTML resources like scripts
|
|
2475
|
+
* or stylesheets) that are configured for the application.
|
|
2476
|
+
*/
|
|
2303
2477
|
tags?: TagSchema[];
|
|
2304
2478
|
};
|
|
2305
2479
|
/** @returns {TagSchema} */
|
|
2306
2480
|
declare function TagSchema(): TagSchema;
|
|
2307
2481
|
type TagSchema = {
|
|
2482
|
+
/**
|
|
2483
|
+
* - The name of the tag used to identify it.
|
|
2484
|
+
*/
|
|
2308
2485
|
name?: string;
|
|
2486
|
+
/**
|
|
2487
|
+
* - The URL where the external tag resource (such as a
|
|
2488
|
+
* script or stylesheet) is located.
|
|
2489
|
+
*/
|
|
2309
2490
|
url?: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* - Specifies whether the tag is a JavaScript ('js')
|
|
2493
|
+
* or CSS ('css') tag.
|
|
2494
|
+
*/
|
|
2310
2495
|
type?: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* - Indicates whether the tag is an external
|
|
2498
|
+
* resource (external) or inline content (inline).
|
|
2499
|
+
*/
|
|
2311
2500
|
sub_type?: string;
|
|
2501
|
+
/**
|
|
2502
|
+
* - The unique identifier for the tag in the system.
|
|
2503
|
+
*/
|
|
2312
2504
|
_id?: string;
|
|
2505
|
+
/**
|
|
2506
|
+
* - The position within the page where the tag
|
|
2507
|
+
* should be injected.
|
|
2508
|
+
*/
|
|
2313
2509
|
position?: string;
|
|
2510
|
+
/**
|
|
2511
|
+
* - Additional attributes for the tag to define
|
|
2512
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
2513
|
+
* tag type for example:
|
|
2514
|
+
*
|
|
2515
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
2516
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
2517
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
2518
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
2519
|
+
*/
|
|
2314
2520
|
attributes?: any;
|
|
2521
|
+
/**
|
|
2522
|
+
* - Content of the tag if it is inline, such as
|
|
2523
|
+
* JavaScript or CSS code.
|
|
2524
|
+
*/
|
|
2315
2525
|
content?: string;
|
|
2316
|
-
|
|
2526
|
+
/**
|
|
2527
|
+
* - List of UI frameworks where this
|
|
2528
|
+
* third-party tag can be injected or supported.
|
|
2529
|
+
*/
|
|
2530
|
+
compatible_engines?: string[];
|
|
2531
|
+
/**
|
|
2532
|
+
* - Pages or environments where the tag should be active.
|
|
2533
|
+
*/
|
|
2317
2534
|
pages?: any[];
|
|
2318
2535
|
__source?: TagSourceSchema;
|
|
2319
2536
|
};
|
|
2320
2537
|
/** @returns {TagSourceSchema} */
|
|
2321
2538
|
declare function TagSourceSchema(): TagSourceSchema;
|
|
2322
2539
|
type TagSourceSchema = {
|
|
2540
|
+
/**
|
|
2541
|
+
* - The type of source, such as 'extension'
|
|
2542
|
+
*/
|
|
2323
2543
|
type?: string;
|
|
2544
|
+
/**
|
|
2545
|
+
* - The identifier of the source that created or
|
|
2546
|
+
* provided the tag.
|
|
2547
|
+
*/
|
|
2324
2548
|
id?: string;
|
|
2325
2549
|
};
|
|
2326
2550
|
/** @returns {ResourcesSchema} */
|
|
@@ -2347,149 +2571,366 @@ type ResourceSchema = {
|
|
|
2347
2571
|
/** @returns {FieldValidations} */
|
|
2348
2572
|
declare function FieldValidations(): FieldValidations;
|
|
2349
2573
|
type FieldValidations = {
|
|
2574
|
+
/**
|
|
2575
|
+
* - Name of validation
|
|
2576
|
+
*/
|
|
2350
2577
|
name?: string;
|
|
2578
|
+
/**
|
|
2579
|
+
* - Type of validation
|
|
2580
|
+
*/
|
|
2351
2581
|
type?: string;
|
|
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;
|
|
2582
|
+
value?: any;
|
|
2376
2583
|
};
|
|
2377
2584
|
/** @returns {FieldDefinitionSchema} */
|
|
2378
2585
|
declare function FieldDefinitionSchema(): FieldDefinitionSchema;
|
|
2379
2586
|
type FieldDefinitionSchema = {
|
|
2380
|
-
|
|
2381
|
-
|
|
2587
|
+
/**
|
|
2588
|
+
* - Unique system generated id
|
|
2589
|
+
*/
|
|
2590
|
+
id?: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* - Resource type to which custom field belongs
|
|
2593
|
+
*/
|
|
2382
2594
|
resource?: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* - Name of custom field
|
|
2597
|
+
*/
|
|
2383
2598
|
name?: string;
|
|
2599
|
+
/**
|
|
2600
|
+
* - Namespace of custom field
|
|
2601
|
+
*/
|
|
2384
2602
|
namespace?: string;
|
|
2385
|
-
|
|
2603
|
+
/**
|
|
2604
|
+
* - Slug of custom field
|
|
2605
|
+
*/
|
|
2606
|
+
slug?: string;
|
|
2607
|
+
/**
|
|
2608
|
+
* - Description of custom field definition
|
|
2609
|
+
*/
|
|
2386
2610
|
description?: string;
|
|
2611
|
+
/**
|
|
2612
|
+
* - Data type of custom field
|
|
2613
|
+
*/
|
|
2387
2614
|
type?: string;
|
|
2615
|
+
/**
|
|
2616
|
+
* - Flag to denote whether custom field is
|
|
2617
|
+
* multivalued or not
|
|
2618
|
+
*/
|
|
2388
2619
|
multi_value?: boolean;
|
|
2620
|
+
/**
|
|
2621
|
+
* - List of validations applied
|
|
2622
|
+
*/
|
|
2389
2623
|
validations?: FieldValidations[];
|
|
2624
|
+
/**
|
|
2625
|
+
* - Id of company
|
|
2626
|
+
*/
|
|
2390
2627
|
company_id?: string;
|
|
2391
|
-
|
|
2392
|
-
|
|
2628
|
+
/**
|
|
2629
|
+
* - Whether the custom field is required or not
|
|
2630
|
+
*/
|
|
2393
2631
|
required?: boolean;
|
|
2632
|
+
/**
|
|
2633
|
+
* - Whether the custom field is deleted or not
|
|
2634
|
+
*/
|
|
2394
2635
|
is_deleted?: boolean;
|
|
2395
|
-
|
|
2396
|
-
|
|
2636
|
+
/**
|
|
2637
|
+
* - Type of type field
|
|
2638
|
+
*/
|
|
2397
2639
|
type_name?: string;
|
|
2640
|
+
/**
|
|
2641
|
+
* - Count of invalid fields after validation
|
|
2642
|
+
*/
|
|
2398
2643
|
invalid_fields_count?: number;
|
|
2399
2644
|
};
|
|
2400
|
-
/** @returns {ApplicationCustomFieldDefinitionsSchema} */
|
|
2401
|
-
declare function ApplicationCustomFieldDefinitionsSchema(): ApplicationCustomFieldDefinitionsSchema;
|
|
2402
|
-
type ApplicationCustomFieldDefinitionsSchema = {
|
|
2403
|
-
items?: ApplicationFieldDefinitionSchema[];
|
|
2404
|
-
page?: Page;
|
|
2405
|
-
};
|
|
2406
2645
|
/** @returns {CustomFieldDefinitionsSchema} */
|
|
2407
2646
|
declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
|
|
2408
2647
|
type CustomFieldDefinitionsSchema = {
|
|
2648
|
+
/**
|
|
2649
|
+
* - List of custom field definitions
|
|
2650
|
+
*/
|
|
2409
2651
|
items?: FieldDefinitionSchema[];
|
|
2410
2652
|
page?: Page;
|
|
2411
2653
|
};
|
|
2412
2654
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2413
2655
|
declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
|
|
2414
2656
|
type CustomFieldDefinitionRequestSchema = {
|
|
2415
|
-
|
|
2657
|
+
/**
|
|
2658
|
+
* - Data type of custom field
|
|
2659
|
+
*/
|
|
2416
2660
|
type?: string;
|
|
2417
|
-
|
|
2661
|
+
/**
|
|
2662
|
+
* - Slug of custom field definition
|
|
2663
|
+
*/
|
|
2664
|
+
slug?: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* - Namespace of custom field definition
|
|
2667
|
+
*/
|
|
2418
2668
|
namespace?: string;
|
|
2669
|
+
/**
|
|
2670
|
+
* - Flag to denote whether custom field is
|
|
2671
|
+
* multi valued or not
|
|
2672
|
+
*/
|
|
2419
2673
|
multi_value?: boolean;
|
|
2674
|
+
/**
|
|
2675
|
+
* - Name of custom field definition
|
|
2676
|
+
*/
|
|
2420
2677
|
name?: string;
|
|
2678
|
+
/**
|
|
2679
|
+
* - Description of a custom field definition
|
|
2680
|
+
*/
|
|
2421
2681
|
description?: string;
|
|
2422
|
-
|
|
2682
|
+
/**
|
|
2683
|
+
* - Validations for a custom field
|
|
2684
|
+
*/
|
|
2423
2685
|
validations?: FieldValidations[];
|
|
2424
2686
|
};
|
|
2425
2687
|
/** @returns {CustomObjectCustomFieldDefinitions} */
|
|
2426
2688
|
declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
|
|
2427
2689
|
type CustomObjectCustomFieldDefinitions = {
|
|
2428
|
-
|
|
2429
|
-
|
|
2690
|
+
/**
|
|
2691
|
+
* - Unique identifer for a custom field
|
|
2692
|
+
*/
|
|
2693
|
+
id?: string;
|
|
2694
|
+
/**
|
|
2695
|
+
* - Data type of custom field
|
|
2696
|
+
*/
|
|
2697
|
+
type?: string;
|
|
2698
|
+
/**
|
|
2699
|
+
* - Description of custom field
|
|
2700
|
+
*/
|
|
2430
2701
|
description?: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* - Name of custom field
|
|
2704
|
+
*/
|
|
2431
2705
|
name?: string;
|
|
2706
|
+
/**
|
|
2707
|
+
* - Flag to denote if cusom field is multi
|
|
2708
|
+
* valued or not
|
|
2709
|
+
*/
|
|
2432
2710
|
multi_value?: boolean;
|
|
2711
|
+
/**
|
|
2712
|
+
* - Whether the field is required or not
|
|
2713
|
+
*/
|
|
2433
2714
|
required?: boolean;
|
|
2434
|
-
|
|
2715
|
+
/**
|
|
2716
|
+
* - Slug of custom field definition
|
|
2717
|
+
*/
|
|
2718
|
+
slug?: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* - Validations added against the
|
|
2721
|
+
* custom field
|
|
2722
|
+
*/
|
|
2435
2723
|
validations?: FieldValidations[];
|
|
2436
2724
|
action?: string;
|
|
2437
2725
|
};
|
|
2438
2726
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2439
2727
|
declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
|
|
2440
2728
|
type CustomObjectDefinitionUpdateRequestSchema = {
|
|
2441
|
-
|
|
2729
|
+
/**
|
|
2730
|
+
* - Description of custom object definiton
|
|
2731
|
+
*/
|
|
2442
2732
|
description?: string;
|
|
2733
|
+
/**
|
|
2734
|
+
* - Name of custom object definition
|
|
2735
|
+
*/
|
|
2443
2736
|
name?: string;
|
|
2737
|
+
/**
|
|
2738
|
+
* - Custom field slug which is used as a
|
|
2739
|
+
* display key in
|
|
2740
|
+
*/
|
|
2444
2741
|
display_name_key?: string;
|
|
2445
|
-
field_definitions?:
|
|
2742
|
+
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2446
2743
|
};
|
|
2447
2744
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2448
2745
|
declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
|
|
2449
2746
|
type CustomFieldDefinitionDetailResSchema = {
|
|
2450
|
-
|
|
2747
|
+
/**
|
|
2748
|
+
* - Resource to which custom field is associated
|
|
2749
|
+
*/
|
|
2451
2750
|
resource?: string;
|
|
2751
|
+
/**
|
|
2752
|
+
* - Name of custom field
|
|
2753
|
+
*/
|
|
2452
2754
|
name?: string;
|
|
2755
|
+
/**
|
|
2756
|
+
* - Namespace of custom field
|
|
2757
|
+
*/
|
|
2453
2758
|
namespace?: string;
|
|
2454
|
-
|
|
2759
|
+
/**
|
|
2760
|
+
* - Slug of custom field
|
|
2761
|
+
*/
|
|
2762
|
+
slug?: string;
|
|
2763
|
+
/**
|
|
2764
|
+
* - Description regarding custom field
|
|
2765
|
+
*/
|
|
2455
2766
|
description?: string;
|
|
2767
|
+
/**
|
|
2768
|
+
* - Data type of custom field
|
|
2769
|
+
*/
|
|
2456
2770
|
type?: string;
|
|
2771
|
+
/**
|
|
2772
|
+
* - Flag to denote whether custom field is
|
|
2773
|
+
* multi valued or not
|
|
2774
|
+
*/
|
|
2457
2775
|
multi_value?: boolean;
|
|
2776
|
+
/**
|
|
2777
|
+
* - Company Identifer
|
|
2778
|
+
*/
|
|
2458
2779
|
company_id?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* - Sales channel identifier
|
|
2782
|
+
*/
|
|
2459
2783
|
application_id?: string;
|
|
2460
|
-
|
|
2461
|
-
|
|
2784
|
+
/**
|
|
2785
|
+
* - Whether the customfield is required or not
|
|
2786
|
+
*/
|
|
2462
2787
|
required?: boolean;
|
|
2788
|
+
/**
|
|
2789
|
+
* - Is custom field deleted
|
|
2790
|
+
*/
|
|
2463
2791
|
is_deleted?: boolean;
|
|
2464
|
-
|
|
2792
|
+
/**
|
|
2793
|
+
* - Unique system generated id
|
|
2794
|
+
*/
|
|
2795
|
+
id?: string;
|
|
2465
2796
|
validations?: any[];
|
|
2797
|
+
/**
|
|
2798
|
+
* - Date time at which field was created
|
|
2799
|
+
*/
|
|
2466
2800
|
created_at?: string;
|
|
2801
|
+
/**
|
|
2802
|
+
* - Date time at for a field's last modification
|
|
2803
|
+
*/
|
|
2467
2804
|
updated_at?: string;
|
|
2468
2805
|
};
|
|
2469
|
-
/** @returns {
|
|
2470
|
-
declare function
|
|
2471
|
-
type
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
/** @returns {CustomFieldSchema} */
|
|
2476
|
-
declare function CustomFieldSchema(): CustomFieldSchema;
|
|
2477
|
-
type CustomFieldSchema = {
|
|
2478
|
-
_id?: string;
|
|
2479
|
-
namespace?: string;
|
|
2480
|
-
key?: string;
|
|
2806
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
2807
|
+
declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
|
|
2808
|
+
type MetaFieldDefinitionDetailResSchema = {
|
|
2809
|
+
/**
|
|
2810
|
+
* - Resource to which meta field is associated
|
|
2811
|
+
*/
|
|
2481
2812
|
resource?: string;
|
|
2482
|
-
|
|
2483
|
-
|
|
2484
|
-
|
|
2813
|
+
/**
|
|
2814
|
+
* - Name of meta field
|
|
2815
|
+
*/
|
|
2816
|
+
name?: string;
|
|
2817
|
+
/**
|
|
2818
|
+
* - Namespace of meta field
|
|
2819
|
+
*/
|
|
2820
|
+
namespace?: string;
|
|
2821
|
+
/**
|
|
2822
|
+
* - Slug of meta field
|
|
2823
|
+
*/
|
|
2824
|
+
slug?: string;
|
|
2825
|
+
/**
|
|
2826
|
+
* - Description regarding meta field
|
|
2827
|
+
*/
|
|
2828
|
+
description?: string;
|
|
2829
|
+
/**
|
|
2830
|
+
* - Data type of meta field
|
|
2831
|
+
*/
|
|
2832
|
+
type?: string;
|
|
2833
|
+
/**
|
|
2834
|
+
* - Flag to denote whether meta field is
|
|
2835
|
+
* multi valued or not
|
|
2836
|
+
*/
|
|
2485
2837
|
multi_value?: boolean;
|
|
2838
|
+
/**
|
|
2839
|
+
* - Company Identifer
|
|
2840
|
+
*/
|
|
2486
2841
|
company_id?: string;
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2842
|
+
/**
|
|
2843
|
+
* - Sales channel identifier
|
|
2844
|
+
*/
|
|
2845
|
+
application_id?: string;
|
|
2846
|
+
/**
|
|
2847
|
+
* - Whether the field is required or not
|
|
2848
|
+
*/
|
|
2849
|
+
required?: boolean;
|
|
2850
|
+
/**
|
|
2851
|
+
* - Is meta field deleted
|
|
2852
|
+
*/
|
|
2853
|
+
is_deleted?: boolean;
|
|
2854
|
+
/**
|
|
2855
|
+
* - Unique system generated id
|
|
2856
|
+
*/
|
|
2857
|
+
id?: string;
|
|
2858
|
+
validations?: any[];
|
|
2859
|
+
/**
|
|
2860
|
+
* - Date time at which field was created
|
|
2861
|
+
*/
|
|
2862
|
+
created_at?: string;
|
|
2863
|
+
/**
|
|
2864
|
+
* - Date time at for a field's last modification
|
|
2865
|
+
*/
|
|
2866
|
+
updated_at?: string;
|
|
2867
|
+
};
|
|
2868
|
+
/** @returns {CustomDataDeleteSchema} */
|
|
2869
|
+
declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
|
|
2870
|
+
type CustomDataDeleteSchema = {
|
|
2871
|
+
/**
|
|
2872
|
+
* - Denotes the success of the delete operation
|
|
2873
|
+
*/
|
|
2874
|
+
success?: boolean;
|
|
2875
|
+
/**
|
|
2876
|
+
* - Denotes the message of delete operation
|
|
2877
|
+
*/
|
|
2878
|
+
message?: string;
|
|
2879
|
+
};
|
|
2880
|
+
/** @returns {CustomFieldValue} */
|
|
2881
|
+
declare function CustomFieldValue(): CustomFieldValue;
|
|
2882
|
+
type CustomFieldValue = {
|
|
2883
|
+
value?: any;
|
|
2884
|
+
};
|
|
2885
|
+
/** @returns {CustomFieldSchema} */
|
|
2886
|
+
declare function CustomFieldSchema(): CustomFieldSchema;
|
|
2887
|
+
type CustomFieldSchema = {
|
|
2888
|
+
/**
|
|
2889
|
+
* - Unique system generated id
|
|
2890
|
+
*/
|
|
2891
|
+
id?: string;
|
|
2892
|
+
/**
|
|
2893
|
+
* - Namespace of custom field definition
|
|
2894
|
+
*/
|
|
2895
|
+
namespace?: string;
|
|
2896
|
+
/**
|
|
2897
|
+
* - Slug of custom field definition
|
|
2898
|
+
*/
|
|
2899
|
+
slug?: string;
|
|
2900
|
+
/**
|
|
2901
|
+
* - The resource for which custom field is being created
|
|
2902
|
+
*/
|
|
2903
|
+
resource?: string;
|
|
2904
|
+
value?: CustomFieldValue[];
|
|
2905
|
+
/**
|
|
2906
|
+
* - Unique identifier of the resource
|
|
2907
|
+
*/
|
|
2908
|
+
resource_slug?: string;
|
|
2909
|
+
/**
|
|
2910
|
+
* - Data type of custom field
|
|
2911
|
+
*/
|
|
2912
|
+
type?: string;
|
|
2913
|
+
/**
|
|
2914
|
+
* - Whether custom field is multi valued
|
|
2915
|
+
*/
|
|
2916
|
+
multi_value?: boolean;
|
|
2917
|
+
/**
|
|
2918
|
+
* - Identifer for a company
|
|
2919
|
+
*/
|
|
2920
|
+
company_id?: string;
|
|
2921
|
+
has_invalid_values?: boolean;
|
|
2922
|
+
invalid_value_errors?: any[];
|
|
2923
|
+
/**
|
|
2924
|
+
* - Indicates whether custom field is deleted
|
|
2925
|
+
*/
|
|
2491
2926
|
is_deleted?: boolean;
|
|
2927
|
+
/**
|
|
2928
|
+
* - Time at which customer field was created
|
|
2929
|
+
*/
|
|
2492
2930
|
created_at?: string;
|
|
2931
|
+
/**
|
|
2932
|
+
* - Time at which custom field was updated
|
|
2933
|
+
*/
|
|
2493
2934
|
updated_at?: string;
|
|
2494
2935
|
};
|
|
2495
2936
|
/** @returns {CustomFieldsResponseSchema} */
|
|
@@ -2512,7 +2953,16 @@ type CustomFieldsResponseByResourceIdSchema = {
|
|
|
2512
2953
|
/** @returns {CustomField} */
|
|
2513
2954
|
declare function CustomField(): CustomField;
|
|
2514
2955
|
type CustomField = {
|
|
2515
|
-
|
|
2956
|
+
value?: any[];
|
|
2957
|
+
/**
|
|
2958
|
+
* - This is the namespace to which custom field belongs
|
|
2959
|
+
*/
|
|
2960
|
+
namespace?: string;
|
|
2961
|
+
/**
|
|
2962
|
+
* - This is the slug of custom field used while
|
|
2963
|
+
* creating a custom field definition
|
|
2964
|
+
*/
|
|
2965
|
+
slug?: string;
|
|
2516
2966
|
};
|
|
2517
2967
|
/** @returns {CustomFieldRequestSchema} */
|
|
2518
2968
|
declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
|
|
@@ -2522,168 +2972,349 @@ type CustomFieldRequestSchema = {
|
|
|
2522
2972
|
/** @returns {CustomObjectSchema} */
|
|
2523
2973
|
declare function CustomObjectSchema(): CustomObjectSchema;
|
|
2524
2974
|
type CustomObjectSchema = {
|
|
2525
|
-
|
|
2526
|
-
|
|
2975
|
+
/**
|
|
2976
|
+
* - Unique system generated id
|
|
2977
|
+
*/
|
|
2978
|
+
id?: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* - Identifer for a company
|
|
2981
|
+
*/
|
|
2527
2982
|
company_id?: string;
|
|
2983
|
+
/**
|
|
2984
|
+
* - Identifer for a sales channel
|
|
2985
|
+
*/
|
|
2528
2986
|
application_id?: string;
|
|
2529
|
-
|
|
2530
|
-
|
|
2987
|
+
/**
|
|
2988
|
+
* - Status of custom object
|
|
2989
|
+
*/
|
|
2531
2990
|
status?: string;
|
|
2532
|
-
|
|
2991
|
+
/**
|
|
2992
|
+
* - Slug of custom object definition
|
|
2993
|
+
*/
|
|
2533
2994
|
type?: string;
|
|
2995
|
+
/**
|
|
2996
|
+
* - Slug for custom object definition
|
|
2997
|
+
*/
|
|
2998
|
+
definition_slug?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* - Value of custom field used for displaying
|
|
3001
|
+
* custom object
|
|
3002
|
+
*/
|
|
2534
3003
|
display_name?: string;
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
updated_at?: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* - Fields associated to the custom object
|
|
3006
|
+
*/
|
|
2539
3007
|
fields?: CustomFieldSchema[];
|
|
2540
3008
|
};
|
|
2541
3009
|
/** @returns {CustomObjectDefinitionRequestSchema} */
|
|
2542
3010
|
declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
|
|
2543
3011
|
type CustomObjectDefinitionRequestSchema = {
|
|
3012
|
+
/**
|
|
3013
|
+
* - Namespace/Slug of Custom object definition
|
|
3014
|
+
*/
|
|
2544
3015
|
type?: string;
|
|
3016
|
+
/**
|
|
3017
|
+
* - Unique slug for a custom object definition
|
|
3018
|
+
*/
|
|
3019
|
+
definition_slug?: string;
|
|
3020
|
+
/**
|
|
3021
|
+
* - Description of custom object definition
|
|
3022
|
+
*/
|
|
2545
3023
|
description?: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* - Name of custom object
|
|
3026
|
+
*/
|
|
2546
3027
|
name?: string;
|
|
3028
|
+
/**
|
|
3029
|
+
* - Denotes which custom field to be used
|
|
3030
|
+
* for displaying custom object
|
|
3031
|
+
*/
|
|
2547
3032
|
display_name_key?: string;
|
|
3033
|
+
/**
|
|
3034
|
+
* - List
|
|
3035
|
+
* of custom field definitions belonging to this custom object definition
|
|
3036
|
+
*/
|
|
2548
3037
|
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2549
3038
|
};
|
|
2550
|
-
/** @returns {
|
|
2551
|
-
declare function
|
|
2552
|
-
type
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
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;
|
|
3039
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
3040
|
+
declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
|
|
3041
|
+
type CustomObjectDefinitionSlugSchema = {
|
|
3042
|
+
/**
|
|
3043
|
+
* - Unique system generated custom object definition id
|
|
3044
|
+
*/
|
|
3045
|
+
id?: string;
|
|
3046
|
+
/**
|
|
3047
|
+
* - Display name of custom object definition
|
|
3048
|
+
*/
|
|
2576
3049
|
name?: string;
|
|
3050
|
+
/**
|
|
3051
|
+
* - Type of custom object definiton
|
|
3052
|
+
*/
|
|
2577
3053
|
type?: string;
|
|
3054
|
+
/**
|
|
3055
|
+
* - Slug of custom object definiton
|
|
3056
|
+
*/
|
|
3057
|
+
definition_slug?: string;
|
|
3058
|
+
/**
|
|
3059
|
+
* - Display name of custom object definition
|
|
3060
|
+
*/
|
|
2578
3061
|
display_name_key?: string;
|
|
3062
|
+
/**
|
|
3063
|
+
* - Description of custom object definition
|
|
3064
|
+
*/
|
|
2579
3065
|
description?: string;
|
|
2580
|
-
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
created_at?: string;
|
|
2586
|
-
updated_at?: string;
|
|
2587
|
-
field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
|
|
3066
|
+
/**
|
|
3067
|
+
* -
|
|
3068
|
+
* Custom fields inside custom objects
|
|
3069
|
+
*/
|
|
3070
|
+
field_definitions?: CustomFieldDefinitionDetailResSchema[];
|
|
2588
3071
|
};
|
|
2589
3072
|
/** @returns {CustomObjectDefinitionDeleteResponseSchema} */
|
|
2590
3073
|
declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
|
|
2591
3074
|
type CustomObjectDefinitionDeleteResponseSchema = {
|
|
3075
|
+
/**
|
|
3076
|
+
* - Success status of delete custom object definition.
|
|
3077
|
+
*/
|
|
2592
3078
|
success?: boolean;
|
|
3079
|
+
/**
|
|
3080
|
+
* - Response message when custom object definition
|
|
3081
|
+
* is deleted.
|
|
3082
|
+
*/
|
|
2593
3083
|
message?: string;
|
|
2594
3084
|
};
|
|
2595
|
-
/** @returns {
|
|
2596
|
-
declare function
|
|
2597
|
-
type
|
|
2598
|
-
|
|
2599
|
-
|
|
3085
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
3086
|
+
declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
|
|
3087
|
+
type CustomObjectEntryBulkUploadDetails = {
|
|
3088
|
+
/**
|
|
3089
|
+
* - Signed url of csv
|
|
3090
|
+
*/
|
|
3091
|
+
url?: string;
|
|
3092
|
+
/**
|
|
3093
|
+
* - Total no of records in csv file
|
|
3094
|
+
*/
|
|
3095
|
+
total_records?: number;
|
|
2600
3096
|
};
|
|
2601
|
-
/** @returns {
|
|
2602
|
-
declare function
|
|
2603
|
-
type
|
|
2604
|
-
|
|
3097
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
3098
|
+
declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
|
|
3099
|
+
type CustomObjectListItemDefinitionModel = {
|
|
3100
|
+
/**
|
|
3101
|
+
* - Unique system generated id
|
|
3102
|
+
*/
|
|
3103
|
+
id?: string;
|
|
3104
|
+
/**
|
|
3105
|
+
* - Name of custom object
|
|
3106
|
+
*/
|
|
2605
3107
|
name?: string;
|
|
3108
|
+
/**
|
|
3109
|
+
* - Type of custom object entry
|
|
3110
|
+
*/
|
|
2606
3111
|
type?: string;
|
|
2607
|
-
display_name_key?: string;
|
|
2608
3112
|
};
|
|
2609
3113
|
/** @returns {CustomObjectListItemSchema} */
|
|
2610
3114
|
declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
|
|
2611
3115
|
type CustomObjectListItemSchema = {
|
|
2612
|
-
|
|
2613
|
-
|
|
3116
|
+
/**
|
|
3117
|
+
* - Unique system generated id
|
|
3118
|
+
*/
|
|
3119
|
+
id?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* - Status of custom object
|
|
3122
|
+
*/
|
|
2614
3123
|
status?: string;
|
|
2615
|
-
|
|
3124
|
+
/**
|
|
3125
|
+
* - Creation time of custom object document
|
|
3126
|
+
*/
|
|
3127
|
+
created_at?: string;
|
|
3128
|
+
/**
|
|
3129
|
+
* - Updation time of custom object document
|
|
3130
|
+
*/
|
|
2616
3131
|
updated_at?: string;
|
|
3132
|
+
/**
|
|
3133
|
+
* - Display name of custom object
|
|
3134
|
+
*/
|
|
2617
3135
|
display_name?: string;
|
|
2618
|
-
definition?:
|
|
3136
|
+
definition?: CustomObjectListItemDefinitionModel;
|
|
3137
|
+
/**
|
|
3138
|
+
* - References of the custom object entry
|
|
3139
|
+
*/
|
|
2619
3140
|
references?: number;
|
|
2620
3141
|
};
|
|
2621
3142
|
/** @returns {CustomObjectsSchema} */
|
|
2622
3143
|
declare function CustomObjectsSchema(): CustomObjectsSchema;
|
|
2623
3144
|
type CustomObjectsSchema = {
|
|
3145
|
+
/**
|
|
3146
|
+
* - List of paginated custom
|
|
3147
|
+
* object entries
|
|
3148
|
+
*/
|
|
2624
3149
|
items?: CustomObjectListItemSchema[];
|
|
2625
3150
|
page?: Page;
|
|
2626
3151
|
};
|
|
2627
|
-
/** @returns {
|
|
2628
|
-
declare function
|
|
2629
|
-
type
|
|
2630
|
-
|
|
2631
|
-
|
|
3152
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
3153
|
+
declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
|
|
3154
|
+
type CustomObjectFieldDefinition = {
|
|
3155
|
+
/**
|
|
3156
|
+
* - Unique system generate id
|
|
3157
|
+
*/
|
|
3158
|
+
id?: string;
|
|
3159
|
+
/**
|
|
3160
|
+
* - Slug of custom field definition
|
|
3161
|
+
*/
|
|
3162
|
+
slug?: string;
|
|
3163
|
+
/**
|
|
3164
|
+
* - Namespace of custom field definition
|
|
3165
|
+
*/
|
|
3166
|
+
namespace?: string;
|
|
3167
|
+
/**
|
|
3168
|
+
* - Value of custom field
|
|
3169
|
+
*/
|
|
3170
|
+
value?: any[];
|
|
3171
|
+
/**
|
|
3172
|
+
* - Data type of the custom field
|
|
3173
|
+
*/
|
|
2632
3174
|
type?: string;
|
|
2633
|
-
definition_id?: string;
|
|
2634
3175
|
};
|
|
2635
|
-
/** @returns {
|
|
2636
|
-
declare function
|
|
2637
|
-
type
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
3176
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
3177
|
+
declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
|
|
3178
|
+
type CustomObjectBySlugSchema = {
|
|
3179
|
+
/**
|
|
3180
|
+
* - Unique system generated identifer for a Custom Object
|
|
3181
|
+
*/
|
|
3182
|
+
id?: string;
|
|
3183
|
+
/**
|
|
3184
|
+
* - Status of Custom Object
|
|
3185
|
+
*/
|
|
2644
3186
|
status?: string;
|
|
2645
|
-
|
|
3187
|
+
/**
|
|
3188
|
+
* - Display name for the Custom Object
|
|
3189
|
+
*/
|
|
2646
3190
|
display_name?: string;
|
|
2647
|
-
definition?:
|
|
3191
|
+
definition?: CustomObjectListItemDefinitionModel;
|
|
3192
|
+
/**
|
|
3193
|
+
* - Places where the custom object has been
|
|
3194
|
+
* used as a custom field
|
|
3195
|
+
*/
|
|
2648
3196
|
references?: any[];
|
|
2649
|
-
|
|
3197
|
+
/**
|
|
3198
|
+
* - Slug of custom object entry
|
|
3199
|
+
*/
|
|
3200
|
+
slug?: string;
|
|
3201
|
+
/**
|
|
3202
|
+
* - Slug of custom object definition
|
|
3203
|
+
*/
|
|
3204
|
+
definition_slug?: string;
|
|
3205
|
+
/**
|
|
3206
|
+
* - List of custom fields
|
|
3207
|
+
* inside the custom object
|
|
3208
|
+
*/
|
|
3209
|
+
fields?: CustomObjectFieldDefinition[];
|
|
2650
3210
|
};
|
|
2651
3211
|
/** @returns {CustomObjectBulkEntryInitiateDownload} */
|
|
2652
3212
|
declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
|
|
2653
3213
|
type CustomObjectBulkEntryInitiateDownload = {
|
|
3214
|
+
/**
|
|
3215
|
+
* - Message for the user
|
|
3216
|
+
*/
|
|
2654
3217
|
message?: string;
|
|
3218
|
+
/**
|
|
3219
|
+
* - Identifer for a task
|
|
3220
|
+
*/
|
|
2655
3221
|
task_id?: string;
|
|
2656
3222
|
};
|
|
2657
3223
|
/** @returns {CustomObjectMetaSchema} */
|
|
2658
3224
|
declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
|
|
2659
3225
|
type CustomObjectMetaSchema = {
|
|
3226
|
+
/**
|
|
3227
|
+
* - Total number of entries in the bulk entry
|
|
3228
|
+
*/
|
|
2660
3229
|
mo_total_count?: number;
|
|
3230
|
+
/**
|
|
3231
|
+
* - Number of entries which were successful
|
|
3232
|
+
*/
|
|
2661
3233
|
mo_success_count?: number;
|
|
3234
|
+
/**
|
|
3235
|
+
* - Number of entries which were failed
|
|
3236
|
+
*/
|
|
2662
3237
|
mo_error_count?: number;
|
|
3238
|
+
/**
|
|
3239
|
+
* - Type of object
|
|
3240
|
+
*/
|
|
2663
3241
|
mo_defintion_type?: string;
|
|
2664
3242
|
};
|
|
2665
3243
|
/** @returns {JobSchema} */
|
|
2666
3244
|
declare function JobSchema(): JobSchema;
|
|
2667
3245
|
type JobSchema = {
|
|
2668
|
-
|
|
3246
|
+
/**
|
|
3247
|
+
* - Unique system generated id
|
|
3248
|
+
*/
|
|
3249
|
+
id?: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* - List of total jobs
|
|
3252
|
+
*/
|
|
2669
3253
|
jobs?: string[];
|
|
3254
|
+
/**
|
|
3255
|
+
* - List of finished jobs
|
|
3256
|
+
*/
|
|
2670
3257
|
finished_jobs?: string[];
|
|
3258
|
+
/**
|
|
3259
|
+
* - List of jobs which resulted in an error
|
|
3260
|
+
*/
|
|
2671
3261
|
error_jobs?: string[];
|
|
3262
|
+
/**
|
|
3263
|
+
* - List of errors occurred in the job
|
|
3264
|
+
*/
|
|
2672
3265
|
errors_occured?: string[];
|
|
3266
|
+
/**
|
|
3267
|
+
* - Company Identifer
|
|
3268
|
+
*/
|
|
2673
3269
|
company_id?: string;
|
|
2674
|
-
|
|
3270
|
+
/**
|
|
3271
|
+
* - Status of job
|
|
3272
|
+
*/
|
|
2675
3273
|
status?: string;
|
|
3274
|
+
/**
|
|
3275
|
+
* - Type of job
|
|
3276
|
+
*/
|
|
2676
3277
|
action_type?: string;
|
|
3278
|
+
/**
|
|
3279
|
+
* - Entity against which job is running
|
|
3280
|
+
*/
|
|
2677
3281
|
entity?: string;
|
|
2678
|
-
|
|
3282
|
+
/**
|
|
3283
|
+
* - URL which contains the file with errors
|
|
3284
|
+
*/
|
|
3285
|
+
error_url?: string;
|
|
3286
|
+
/**
|
|
3287
|
+
* - Number of items successfully finished
|
|
3288
|
+
*/
|
|
2679
3289
|
finished_count?: number;
|
|
3290
|
+
/**
|
|
3291
|
+
* - Number of items in error
|
|
3292
|
+
*/
|
|
2680
3293
|
error_count?: number;
|
|
3294
|
+
/**
|
|
3295
|
+
* - Number of successful items
|
|
3296
|
+
*/
|
|
2681
3297
|
success_count?: number;
|
|
3298
|
+
/**
|
|
3299
|
+
* - Total number of jobs
|
|
3300
|
+
*/
|
|
2682
3301
|
total_jobs?: number;
|
|
2683
3302
|
meta?: CustomObjectMetaSchema;
|
|
3303
|
+
/**
|
|
3304
|
+
* - Source from where the bulk job is created
|
|
3305
|
+
*/
|
|
2684
3306
|
created_by?: string;
|
|
3307
|
+
/**
|
|
3308
|
+
* - Date/Time when the job was created
|
|
3309
|
+
*/
|
|
2685
3310
|
created_at?: string;
|
|
3311
|
+
/**
|
|
3312
|
+
* - Date/Time when the job was updated
|
|
3313
|
+
*/
|
|
2686
3314
|
updated_at?: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* - Sales Channel Identifier
|
|
3317
|
+
*/
|
|
2687
3318
|
application_id?: string;
|
|
2688
3319
|
};
|
|
2689
3320
|
/** @returns {CustomFieldBulkEntry} */
|
|
@@ -2698,6 +3329,11 @@ type CustomObjectBulkEntry = {
|
|
|
2698
3329
|
items?: JobSchema[];
|
|
2699
3330
|
page?: Page;
|
|
2700
3331
|
};
|
|
3332
|
+
/** @returns {MetafieldTypesSchema} */
|
|
3333
|
+
declare function MetafieldTypesSchema(): MetafieldTypesSchema;
|
|
3334
|
+
type MetafieldTypesSchema = {
|
|
3335
|
+
metafield_types?: CustomFieldTypeSchema;
|
|
3336
|
+
};
|
|
2701
3337
|
/** @returns {CustomFieldTypeSchema} */
|
|
2702
3338
|
declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
|
|
2703
3339
|
type CustomFieldTypeSchema = {
|
|
@@ -2717,6 +3353,17 @@ type CustomFieldTypeSchema = {
|
|
|
2717
3353
|
html?: HTML;
|
|
2718
3354
|
duration?: Duration;
|
|
2719
3355
|
};
|
|
3356
|
+
/** @returns {SupportedValidationsMetaExampleSchema} */
|
|
3357
|
+
declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
|
|
3358
|
+
type SupportedValidationsMetaExampleSchema = {
|
|
3359
|
+
name?: string;
|
|
3360
|
+
value?: string;
|
|
3361
|
+
};
|
|
3362
|
+
/** @returns {SupportedValidationsMetaSchema} */
|
|
3363
|
+
declare function SupportedValidationsMetaSchema(): SupportedValidationsMetaSchema;
|
|
3364
|
+
type SupportedValidationsMetaSchema = {
|
|
3365
|
+
examples?: SupportedValidationsMetaExampleSchema[];
|
|
3366
|
+
};
|
|
2720
3367
|
/** @returns {SupportedValidationsSchema} */
|
|
2721
3368
|
declare function SupportedValidationsSchema(): SupportedValidationsSchema;
|
|
2722
3369
|
type SupportedValidationsSchema = {
|
|
@@ -2724,149 +3371,394 @@ type SupportedValidationsSchema = {
|
|
|
2724
3371
|
type?: string;
|
|
2725
3372
|
display?: string;
|
|
2726
3373
|
required?: boolean;
|
|
3374
|
+
meta?: SupportedValidationsMetaSchema;
|
|
2727
3375
|
};
|
|
2728
3376
|
/** @returns {Duration} */
|
|
2729
3377
|
declare function Duration(): Duration;
|
|
2730
3378
|
type Duration = {
|
|
3379
|
+
/**
|
|
3380
|
+
* - Name data type of custom field
|
|
3381
|
+
*/
|
|
2731
3382
|
name?: string;
|
|
3383
|
+
/**
|
|
3384
|
+
* - Flag for listing enabled or not
|
|
3385
|
+
*/
|
|
2732
3386
|
list_enabled?: boolean;
|
|
3387
|
+
/**
|
|
3388
|
+
* - Type of custom field
|
|
3389
|
+
*/
|
|
2733
3390
|
type?: string;
|
|
3391
|
+
/**
|
|
3392
|
+
* - Category of custom field
|
|
3393
|
+
*/
|
|
2734
3394
|
category?: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* - List of
|
|
3397
|
+
* validations available for the field
|
|
3398
|
+
*/
|
|
2735
3399
|
supported_validations?: SupportedValidationsSchema[];
|
|
2736
3400
|
};
|
|
2737
3401
|
/** @returns {HTML} */
|
|
2738
3402
|
declare function HTML(): HTML;
|
|
2739
3403
|
type HTML = {
|
|
3404
|
+
/**
|
|
3405
|
+
* - Name data type of custom field
|
|
3406
|
+
*/
|
|
2740
3407
|
name?: string;
|
|
3408
|
+
/**
|
|
3409
|
+
* - Flag for listing enabled or not
|
|
3410
|
+
*/
|
|
2741
3411
|
list_enabled?: boolean;
|
|
3412
|
+
/**
|
|
3413
|
+
* - Type of custom field
|
|
3414
|
+
*/
|
|
2742
3415
|
type?: string;
|
|
3416
|
+
/**
|
|
3417
|
+
* - List of
|
|
3418
|
+
* validations available for the field
|
|
3419
|
+
*/
|
|
2743
3420
|
supported_validations?: SupportedValidationsSchema[];
|
|
2744
3421
|
};
|
|
2745
3422
|
/** @returns {StringSingleLine} */
|
|
2746
3423
|
declare function StringSingleLine(): StringSingleLine;
|
|
2747
3424
|
type StringSingleLine = {
|
|
3425
|
+
/**
|
|
3426
|
+
* - Name data type of custom field
|
|
3427
|
+
*/
|
|
2748
3428
|
name?: string;
|
|
3429
|
+
/**
|
|
3430
|
+
* - Flag for listing enabled or not
|
|
3431
|
+
*/
|
|
2749
3432
|
list_enabled?: boolean;
|
|
3433
|
+
/**
|
|
3434
|
+
* - Category of custom field
|
|
3435
|
+
*/
|
|
2750
3436
|
category?: string;
|
|
3437
|
+
/**
|
|
3438
|
+
* - Type of custom field
|
|
3439
|
+
*/
|
|
2751
3440
|
type?: string;
|
|
3441
|
+
/**
|
|
3442
|
+
* - List of
|
|
3443
|
+
* validations available for the field
|
|
3444
|
+
*/
|
|
2752
3445
|
supported_validations?: SupportedValidationsSchema[];
|
|
2753
3446
|
};
|
|
2754
3447
|
/** @returns {StringMultiLine} */
|
|
2755
3448
|
declare function StringMultiLine(): StringMultiLine;
|
|
2756
3449
|
type StringMultiLine = {
|
|
3450
|
+
/**
|
|
3451
|
+
* - Name data type of custom field
|
|
3452
|
+
*/
|
|
2757
3453
|
name?: string;
|
|
3454
|
+
/**
|
|
3455
|
+
* - Flag for listing enabled or not
|
|
3456
|
+
*/
|
|
2758
3457
|
list_enabled?: boolean;
|
|
3458
|
+
/**
|
|
3459
|
+
* - Category of custom field
|
|
3460
|
+
*/
|
|
2759
3461
|
category?: string;
|
|
3462
|
+
/**
|
|
3463
|
+
* - Type of custom field
|
|
3464
|
+
*/
|
|
2760
3465
|
type?: string;
|
|
3466
|
+
/**
|
|
3467
|
+
* - List of
|
|
3468
|
+
* validations available for the field
|
|
3469
|
+
*/
|
|
2761
3470
|
supported_validations?: SupportedValidationsSchema[];
|
|
2762
3471
|
};
|
|
2763
3472
|
/** @returns {Dropdown} */
|
|
2764
3473
|
declare function Dropdown(): Dropdown;
|
|
2765
3474
|
type Dropdown = {
|
|
3475
|
+
/**
|
|
3476
|
+
* - Name data type of custom field
|
|
3477
|
+
*/
|
|
2766
3478
|
name?: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* - Flag for listing enabled or not
|
|
3481
|
+
*/
|
|
2767
3482
|
list_enabled?: boolean;
|
|
3483
|
+
/**
|
|
3484
|
+
* - Category of custom field
|
|
3485
|
+
*/
|
|
2768
3486
|
category?: string;
|
|
3487
|
+
/**
|
|
3488
|
+
* - Category of custom field
|
|
3489
|
+
*/
|
|
2769
3490
|
type?: string;
|
|
3491
|
+
/**
|
|
3492
|
+
* - List of
|
|
3493
|
+
* validations available for the field
|
|
3494
|
+
*/
|
|
2770
3495
|
supported_validations?: SupportedValidationsSchema[];
|
|
2771
3496
|
};
|
|
2772
3497
|
/** @returns {Integer} */
|
|
2773
3498
|
declare function Integer(): Integer;
|
|
2774
3499
|
type Integer = {
|
|
3500
|
+
/**
|
|
3501
|
+
* - Name data type of custom field
|
|
3502
|
+
*/
|
|
2775
3503
|
name?: string;
|
|
3504
|
+
/**
|
|
3505
|
+
* - Flag for listing enabled or not
|
|
3506
|
+
*/
|
|
2776
3507
|
list_enabled?: boolean;
|
|
3508
|
+
/**
|
|
3509
|
+
* - Type of custom field
|
|
3510
|
+
*/
|
|
2777
3511
|
type?: string;
|
|
3512
|
+
/**
|
|
3513
|
+
* - Category of custom field
|
|
3514
|
+
*/
|
|
2778
3515
|
category?: string;
|
|
3516
|
+
/**
|
|
3517
|
+
* - List of
|
|
3518
|
+
* validations available for the field
|
|
3519
|
+
*/
|
|
2779
3520
|
supported_validations?: SupportedValidationsSchema[];
|
|
2780
3521
|
};
|
|
2781
3522
|
/** @returns {FloatType} */
|
|
2782
3523
|
declare function FloatType(): FloatType;
|
|
2783
3524
|
type FloatType = {
|
|
3525
|
+
/**
|
|
3526
|
+
* - Name data type of custom field
|
|
3527
|
+
*/
|
|
2784
3528
|
name?: string;
|
|
3529
|
+
/**
|
|
3530
|
+
* - Flag for listing enabled or not
|
|
3531
|
+
*/
|
|
2785
3532
|
list_enabled?: boolean;
|
|
3533
|
+
/**
|
|
3534
|
+
* - Type of custom field
|
|
3535
|
+
*/
|
|
2786
3536
|
type?: string;
|
|
3537
|
+
/**
|
|
3538
|
+
* - Category of custom field
|
|
3539
|
+
*/
|
|
2787
3540
|
category?: string;
|
|
3541
|
+
/**
|
|
3542
|
+
* - List of
|
|
3543
|
+
* validations available for the field
|
|
3544
|
+
*/
|
|
2788
3545
|
supported_validations?: SupportedValidationsSchema[];
|
|
2789
3546
|
};
|
|
2790
3547
|
/** @returns {BooleanType} */
|
|
2791
3548
|
declare function BooleanType(): BooleanType;
|
|
2792
3549
|
type BooleanType = {
|
|
3550
|
+
/**
|
|
3551
|
+
* - Name data type of custom field
|
|
3552
|
+
*/
|
|
2793
3553
|
name?: string;
|
|
3554
|
+
/**
|
|
3555
|
+
* - Category of custom field
|
|
3556
|
+
*/
|
|
2794
3557
|
category?: string;
|
|
3558
|
+
/**
|
|
3559
|
+
* - Flag for listing enabled or not
|
|
3560
|
+
*/
|
|
2795
3561
|
list_enabled?: boolean;
|
|
3562
|
+
/**
|
|
3563
|
+
* - Category of custom field
|
|
3564
|
+
*/
|
|
2796
3565
|
type?: string;
|
|
3566
|
+
/**
|
|
3567
|
+
* - List of
|
|
3568
|
+
* validations available for the field
|
|
3569
|
+
*/
|
|
2797
3570
|
supported_validations?: SupportedValidationsSchema[];
|
|
2798
3571
|
};
|
|
2799
3572
|
/** @returns {Date} */
|
|
2800
3573
|
declare function Date(): Date;
|
|
2801
3574
|
type Date = {
|
|
3575
|
+
/**
|
|
3576
|
+
* - Name data type of custom field
|
|
3577
|
+
*/
|
|
2802
3578
|
name?: string;
|
|
3579
|
+
/**
|
|
3580
|
+
* - Flag for listing enabled or not
|
|
3581
|
+
*/
|
|
2803
3582
|
list_enabled?: boolean;
|
|
3583
|
+
/**
|
|
3584
|
+
* - Category of custom field
|
|
3585
|
+
*/
|
|
2804
3586
|
category?: string;
|
|
3587
|
+
/**
|
|
3588
|
+
* - Type of custom field
|
|
3589
|
+
*/
|
|
2805
3590
|
type?: string;
|
|
3591
|
+
/**
|
|
3592
|
+
* - List of
|
|
3593
|
+
* validations available for the field
|
|
3594
|
+
*/
|
|
2806
3595
|
supported_validations?: SupportedValidationsSchema[];
|
|
2807
3596
|
};
|
|
2808
3597
|
/** @returns {Datetime} */
|
|
2809
3598
|
declare function Datetime(): Datetime;
|
|
2810
3599
|
type Datetime = {
|
|
3600
|
+
/**
|
|
3601
|
+
* - Name data type of custom field
|
|
3602
|
+
*/
|
|
2811
3603
|
name?: string;
|
|
3604
|
+
/**
|
|
3605
|
+
* - Category of custom field
|
|
3606
|
+
*/
|
|
2812
3607
|
category?: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* - Flag for listing enabled or not
|
|
3610
|
+
*/
|
|
2813
3611
|
list_enabled?: boolean;
|
|
3612
|
+
/**
|
|
3613
|
+
* - Type of custom field
|
|
3614
|
+
*/
|
|
2814
3615
|
type?: string;
|
|
3616
|
+
/**
|
|
3617
|
+
* - List of
|
|
3618
|
+
* validations available for the field
|
|
3619
|
+
*/
|
|
2815
3620
|
supported_validations?: SupportedValidationsSchema[];
|
|
2816
3621
|
};
|
|
2817
3622
|
/** @returns {Json} */
|
|
2818
3623
|
declare function Json(): Json;
|
|
2819
3624
|
type Json = {
|
|
3625
|
+
/**
|
|
3626
|
+
* - Name data type of custom field
|
|
3627
|
+
*/
|
|
2820
3628
|
name?: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* - Flag for listing enabled or not
|
|
3631
|
+
*/
|
|
2821
3632
|
list_enabled?: boolean;
|
|
3633
|
+
/**
|
|
3634
|
+
* - Category of custom field
|
|
3635
|
+
*/
|
|
2822
3636
|
category?: string;
|
|
3637
|
+
/**
|
|
3638
|
+
* - Type of custom field
|
|
3639
|
+
*/
|
|
2823
3640
|
type?: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* - List of
|
|
3643
|
+
* validations available for the field
|
|
3644
|
+
*/
|
|
2824
3645
|
supported_validations?: SupportedValidationsSchema[];
|
|
2825
3646
|
};
|
|
2826
3647
|
/** @returns {File} */
|
|
2827
3648
|
declare function File(): File;
|
|
2828
3649
|
type File = {
|
|
3650
|
+
/**
|
|
3651
|
+
* - Name data type of custom field
|
|
3652
|
+
*/
|
|
2829
3653
|
name?: string;
|
|
3654
|
+
/**
|
|
3655
|
+
* - Category of custom field
|
|
3656
|
+
*/
|
|
2830
3657
|
category?: string;
|
|
3658
|
+
/**
|
|
3659
|
+
* - Flag for listing enabled or not
|
|
3660
|
+
*/
|
|
2831
3661
|
list_enabled?: boolean;
|
|
3662
|
+
/**
|
|
3663
|
+
* - Type of custom field
|
|
3664
|
+
*/
|
|
2832
3665
|
type?: string;
|
|
2833
3666
|
supported_validations?: SupportedValidationsSchema[];
|
|
2834
3667
|
};
|
|
2835
3668
|
/** @returns {Url} */
|
|
2836
3669
|
declare function Url(): Url;
|
|
2837
3670
|
type Url = {
|
|
3671
|
+
/**
|
|
3672
|
+
* - Name data type of custom field
|
|
3673
|
+
*/
|
|
2838
3674
|
name?: string;
|
|
3675
|
+
/**
|
|
3676
|
+
* - Flag for listing enabled or not
|
|
3677
|
+
*/
|
|
2839
3678
|
list_enabled?: boolean;
|
|
3679
|
+
/**
|
|
3680
|
+
* - Type of custom field
|
|
3681
|
+
*/
|
|
2840
3682
|
type?: string;
|
|
3683
|
+
/**
|
|
3684
|
+
* - List of
|
|
3685
|
+
* validations available for the field
|
|
3686
|
+
*/
|
|
2841
3687
|
supported_validations?: SupportedValidationsSchema[];
|
|
2842
3688
|
};
|
|
2843
3689
|
/** @returns {Metaobject} */
|
|
2844
3690
|
declare function Metaobject(): Metaobject;
|
|
2845
3691
|
type Metaobject = {
|
|
3692
|
+
/**
|
|
3693
|
+
* - Name of Custom Object
|
|
3694
|
+
*/
|
|
2846
3695
|
name?: string;
|
|
3696
|
+
/**
|
|
3697
|
+
* - Whether the field is allowed to have
|
|
3698
|
+
* multiple list items
|
|
3699
|
+
*/
|
|
2847
3700
|
list_enabled?: boolean;
|
|
3701
|
+
/**
|
|
3702
|
+
* - Category of Custom Object Definition that
|
|
3703
|
+
* Custom Object belongs to
|
|
3704
|
+
*/
|
|
2848
3705
|
category?: string;
|
|
3706
|
+
/**
|
|
3707
|
+
* - Type of Custom Object Definition
|
|
3708
|
+
*/
|
|
2849
3709
|
type?: string;
|
|
2850
3710
|
supported_validations?: SupportedValidationsSchema[];
|
|
2851
3711
|
};
|
|
2852
3712
|
/** @returns {Product} */
|
|
2853
3713
|
declare function Product(): Product;
|
|
2854
3714
|
type Product = {
|
|
3715
|
+
/**
|
|
3716
|
+
* - Name of Product
|
|
3717
|
+
*/
|
|
2855
3718
|
name?: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* - Whether the field is allowed to have
|
|
3721
|
+
* multiple list items
|
|
3722
|
+
*/
|
|
2856
3723
|
list_enabled?: boolean;
|
|
3724
|
+
/**
|
|
3725
|
+
* - Category of Custom Object Definition that
|
|
3726
|
+
* Product is associated with
|
|
3727
|
+
*/
|
|
2857
3728
|
category?: string;
|
|
3729
|
+
/**
|
|
3730
|
+
* - Custom Object Definition that Product is associated with
|
|
3731
|
+
*/
|
|
2858
3732
|
type?: string;
|
|
2859
3733
|
supported_validations?: SupportedValidationsSchema[];
|
|
2860
|
-
scope?: string[];
|
|
2861
3734
|
};
|
|
2862
3735
|
/** @returns {CustomObjectEntry} */
|
|
2863
3736
|
declare function CustomObjectEntry(): CustomObjectEntry;
|
|
2864
3737
|
type CustomObjectEntry = {
|
|
2865
|
-
|
|
3738
|
+
/**
|
|
3739
|
+
* - Unique system generated id
|
|
3740
|
+
*/
|
|
3741
|
+
id?: string;
|
|
3742
|
+
/**
|
|
3743
|
+
* - Name of Custom Object definition
|
|
3744
|
+
*/
|
|
2866
3745
|
name?: string;
|
|
3746
|
+
/**
|
|
3747
|
+
* - Type of Custom Object Definition
|
|
3748
|
+
*/
|
|
2867
3749
|
type?: string;
|
|
3750
|
+
/**
|
|
3751
|
+
* - Updation time of a Custom Object
|
|
3752
|
+
*/
|
|
2868
3753
|
updated_at?: string;
|
|
3754
|
+
/**
|
|
3755
|
+
* - Number of entries against the Custom
|
|
3756
|
+
* Object definition
|
|
3757
|
+
*/
|
|
2869
3758
|
entries_count?: number;
|
|
3759
|
+
/**
|
|
3760
|
+
* - Number of fields against a Custom Object definition
|
|
3761
|
+
*/
|
|
2870
3762
|
fields_count?: number;
|
|
2871
3763
|
};
|
|
2872
3764
|
/** @returns {CustomObjectDefinitionsSchema} */
|
|
@@ -2878,20 +3770,65 @@ type CustomObjectDefinitionsSchema = {
|
|
|
2878
3770
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
2879
3771
|
declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
|
|
2880
3772
|
type CustomObjectEntryFieldSchema = {
|
|
2881
|
-
|
|
3773
|
+
/**
|
|
3774
|
+
* - This is namespace for a custom field definition
|
|
3775
|
+
*/
|
|
3776
|
+
namespace?: string;
|
|
3777
|
+
/**
|
|
3778
|
+
* - This is slug for a custom field definition
|
|
3779
|
+
*/
|
|
3780
|
+
slug?: string;
|
|
3781
|
+
};
|
|
3782
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3783
|
+
declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
|
|
3784
|
+
type CustomObjectEntryFieldSchemaWithoutID = {
|
|
3785
|
+
/**
|
|
3786
|
+
* - Custom fields belonging to a custom object
|
|
3787
|
+
*/
|
|
3788
|
+
slug?: string;
|
|
3789
|
+
/**
|
|
3790
|
+
* - Value of custom field inside a custom object
|
|
3791
|
+
*/
|
|
3792
|
+
value?: any;
|
|
2882
3793
|
};
|
|
2883
3794
|
/** @returns {CustomObjectRequestSchema} */
|
|
2884
3795
|
declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
|
|
2885
3796
|
type CustomObjectRequestSchema = {
|
|
3797
|
+
/**
|
|
3798
|
+
* - Flag to denote status of Custom Object
|
|
3799
|
+
*/
|
|
2886
3800
|
status?: string;
|
|
3801
|
+
/**
|
|
3802
|
+
* - This is slug for a custom field definition
|
|
3803
|
+
*/
|
|
2887
3804
|
slug?: string;
|
|
2888
|
-
|
|
3805
|
+
/**
|
|
3806
|
+
* - List of custom fields
|
|
3807
|
+
*/
|
|
2889
3808
|
fields?: CustomObjectEntryFieldSchema[];
|
|
2890
3809
|
};
|
|
3810
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3811
|
+
declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
|
|
3812
|
+
type CustomObjectRequestSchemaWithoutId = {
|
|
3813
|
+
/**
|
|
3814
|
+
* - Status of the custom object entry.
|
|
3815
|
+
*/
|
|
3816
|
+
status?: string;
|
|
3817
|
+
/**
|
|
3818
|
+
* - List of custom fields
|
|
3819
|
+
*/
|
|
3820
|
+
fields?: CustomObjectEntryFieldSchemaWithoutID[];
|
|
3821
|
+
};
|
|
2891
3822
|
/** @returns {CustomObjectBulkSchema} */
|
|
2892
3823
|
declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
|
|
2893
3824
|
type CustomObjectBulkSchema = {
|
|
3825
|
+
/**
|
|
3826
|
+
* - Full URL for the bulk operations data
|
|
3827
|
+
*/
|
|
2894
3828
|
url?: string;
|
|
3829
|
+
/**
|
|
3830
|
+
* - Total records in the upload.
|
|
3831
|
+
*/
|
|
2895
3832
|
total_records?: number;
|
|
2896
3833
|
};
|
|
2897
3834
|
/** @returns {ActionPage} */
|
|
@@ -2911,6 +3848,566 @@ type ActionPage = {
|
|
|
2911
3848
|
url?: string;
|
|
2912
3849
|
type: PageType;
|
|
2913
3850
|
};
|
|
3851
|
+
/** @returns {TranslateUiLabels} */
|
|
3852
|
+
declare function TranslateUiLabels(): TranslateUiLabels;
|
|
3853
|
+
type TranslateUiLabels = {
|
|
3854
|
+
/**
|
|
3855
|
+
* - Unique identifier assigned to the Translate Ui Labels entry
|
|
3856
|
+
*/
|
|
3857
|
+
_id?: string;
|
|
3858
|
+
/**
|
|
3859
|
+
* - Identifier linking the resource to a
|
|
3860
|
+
* specific company within the platform
|
|
3861
|
+
*/
|
|
3862
|
+
company_id?: string;
|
|
3863
|
+
/**
|
|
3864
|
+
* - Reference to the application where this
|
|
3865
|
+
* Translate Ui Labels is utilized
|
|
3866
|
+
*/
|
|
3867
|
+
application_id?: string;
|
|
3868
|
+
/**
|
|
3869
|
+
* - Links the resource to a specific
|
|
3870
|
+
* template theme configuration
|
|
3871
|
+
*/
|
|
3872
|
+
template_theme_id?: string;
|
|
3873
|
+
/**
|
|
3874
|
+
* - Associates the resource with a particular
|
|
3875
|
+
* theme implementation
|
|
3876
|
+
*/
|
|
3877
|
+
theme_id?: string;
|
|
3878
|
+
/**
|
|
3879
|
+
* - Specifies the language and region format for
|
|
3880
|
+
* the resource content
|
|
3881
|
+
*/
|
|
3882
|
+
locale?: string;
|
|
3883
|
+
/**
|
|
3884
|
+
* - Contains the actual resource data and
|
|
3885
|
+
* configuration settings
|
|
3886
|
+
*/
|
|
3887
|
+
resource?: any;
|
|
3888
|
+
/**
|
|
3889
|
+
* - Categorizes the resource type for proper handling
|
|
3890
|
+
* and processing
|
|
3891
|
+
*/
|
|
3892
|
+
type?: string;
|
|
3893
|
+
};
|
|
3894
|
+
/** @returns {TranslateUiLabelsCreate} */
|
|
3895
|
+
declare function TranslateUiLabelsCreate(): TranslateUiLabelsCreate;
|
|
3896
|
+
type TranslateUiLabelsCreate = {
|
|
3897
|
+
/**
|
|
3898
|
+
* - Unique identifier for the template theme
|
|
3899
|
+
*/
|
|
3900
|
+
template_theme_id?: string;
|
|
3901
|
+
/**
|
|
3902
|
+
* - Unique identifier for the theme
|
|
3903
|
+
*/
|
|
3904
|
+
theme_id?: string;
|
|
3905
|
+
/**
|
|
3906
|
+
* - Locale
|
|
3907
|
+
*/
|
|
3908
|
+
locale?: string;
|
|
3909
|
+
/**
|
|
3910
|
+
* - Translate Ui Labels json object
|
|
3911
|
+
*/
|
|
3912
|
+
resource?: any;
|
|
3913
|
+
/**
|
|
3914
|
+
* - Resource type
|
|
3915
|
+
*/
|
|
3916
|
+
type?: string;
|
|
3917
|
+
};
|
|
3918
|
+
/** @returns {StaticResourceUpdate} */
|
|
3919
|
+
declare function StaticResourceUpdate(): StaticResourceUpdate;
|
|
3920
|
+
type StaticResourceUpdate = {
|
|
3921
|
+
/**
|
|
3922
|
+
* - Unique identifier for the template theme
|
|
3923
|
+
*/
|
|
3924
|
+
template_theme_id?: string;
|
|
3925
|
+
/**
|
|
3926
|
+
* - Unique identifier for the theme
|
|
3927
|
+
*/
|
|
3928
|
+
theme_id?: string;
|
|
3929
|
+
/**
|
|
3930
|
+
* - Locale
|
|
3931
|
+
*/
|
|
3932
|
+
locale?: string;
|
|
3933
|
+
/**
|
|
3934
|
+
* - Translate Ui Labels json object
|
|
3935
|
+
*/
|
|
3936
|
+
resource?: any;
|
|
3937
|
+
/**
|
|
3938
|
+
* - Resource type
|
|
3939
|
+
*/
|
|
3940
|
+
type?: string;
|
|
3941
|
+
};
|
|
3942
|
+
/** @returns {TranslateUiLabelsPage} */
|
|
3943
|
+
declare function TranslateUiLabelsPage(): TranslateUiLabelsPage;
|
|
3944
|
+
type TranslateUiLabelsPage = {
|
|
3945
|
+
/**
|
|
3946
|
+
* - List of items containing all the
|
|
3947
|
+
* static info data.
|
|
3948
|
+
*/
|
|
3949
|
+
items?: TranslateUiLabels[];
|
|
3950
|
+
page?: Page;
|
|
3951
|
+
};
|
|
3952
|
+
/** @returns {Error} */
|
|
3953
|
+
declare function Error(): Error;
|
|
3954
|
+
type Error = {
|
|
3955
|
+
/**
|
|
3956
|
+
* - Detailed message explaining the error that occurred
|
|
3957
|
+
*/
|
|
3958
|
+
error?: string;
|
|
3959
|
+
};
|
|
3960
|
+
/** @returns {Meta} */
|
|
3961
|
+
declare function Meta(): Meta;
|
|
3962
|
+
type Meta = {
|
|
3963
|
+
/**
|
|
3964
|
+
* - Identifier of the user who created this resource
|
|
3965
|
+
*/
|
|
3966
|
+
created_by?: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* - Identifier of the user who last modified
|
|
3969
|
+
* this resource
|
|
3970
|
+
*/
|
|
3971
|
+
modified_by?: string;
|
|
3972
|
+
/**
|
|
3973
|
+
* - Timestamp when this resource was initially created
|
|
3974
|
+
*/
|
|
3975
|
+
created_on?: string;
|
|
3976
|
+
/**
|
|
3977
|
+
* - Timestamp when this resource was last modified
|
|
3978
|
+
*/
|
|
3979
|
+
modified_on?: string;
|
|
3980
|
+
};
|
|
3981
|
+
/** @returns {CompanyLanguage} */
|
|
3982
|
+
declare function CompanyLanguage(): CompanyLanguage;
|
|
3983
|
+
type CompanyLanguage = {
|
|
3984
|
+
/**
|
|
3985
|
+
* - Unique identifier for the company language setting
|
|
3986
|
+
*/
|
|
3987
|
+
_id?: string;
|
|
3988
|
+
/**
|
|
3989
|
+
* - Identifier of the company this language
|
|
3990
|
+
* configuration belongs to
|
|
3991
|
+
*/
|
|
3992
|
+
company_id: string;
|
|
3993
|
+
/**
|
|
3994
|
+
* - Language code following ISO standards for this
|
|
3995
|
+
* company setting
|
|
3996
|
+
*/
|
|
3997
|
+
locale?: string;
|
|
3998
|
+
/**
|
|
3999
|
+
* - Display name of the language for company usage
|
|
4000
|
+
*/
|
|
4001
|
+
name?: string;
|
|
4002
|
+
/**
|
|
4003
|
+
* - Text direction setting for company content
|
|
4004
|
+
* in this language
|
|
4005
|
+
*/
|
|
4006
|
+
direction?: string;
|
|
4007
|
+
/**
|
|
4008
|
+
* - Indicates if this is the default language
|
|
4009
|
+
* for the company
|
|
4010
|
+
*/
|
|
4011
|
+
is_default?: boolean;
|
|
4012
|
+
/**
|
|
4013
|
+
* - Translated name of the language in
|
|
4014
|
+
* English for easy reference and display at the website.
|
|
4015
|
+
*/
|
|
4016
|
+
display_name?: string;
|
|
4017
|
+
};
|
|
4018
|
+
/** @returns {CompanyLanguageCreate} */
|
|
4019
|
+
declare function CompanyLanguageCreate(): CompanyLanguageCreate;
|
|
4020
|
+
type CompanyLanguageCreate = {
|
|
4021
|
+
/**
|
|
4022
|
+
* - List of language codes to be added to company
|
|
4023
|
+
* configuration
|
|
4024
|
+
*/
|
|
4025
|
+
locales: string[];
|
|
4026
|
+
};
|
|
4027
|
+
/** @returns {CompanyLanguageUpdate} */
|
|
4028
|
+
declare function CompanyLanguageUpdate(): CompanyLanguageUpdate;
|
|
4029
|
+
type CompanyLanguageUpdate = {
|
|
4030
|
+
/**
|
|
4031
|
+
* - Sets the specified language as the company default
|
|
4032
|
+
*/
|
|
4033
|
+
is_default: boolean;
|
|
4034
|
+
};
|
|
4035
|
+
/** @returns {ApplicationLanguage} */
|
|
4036
|
+
declare function ApplicationLanguage(): ApplicationLanguage;
|
|
4037
|
+
type ApplicationLanguage = {
|
|
4038
|
+
/**
|
|
4039
|
+
* - Unique identifier for the application language setting
|
|
4040
|
+
*/
|
|
4041
|
+
_id?: string;
|
|
4042
|
+
/**
|
|
4043
|
+
* - Identifier of the company this application belongs to
|
|
4044
|
+
*/
|
|
4045
|
+
company_id: string;
|
|
4046
|
+
/**
|
|
4047
|
+
* - Unique identifier of the application
|
|
4048
|
+
* using this language
|
|
4049
|
+
*/
|
|
4050
|
+
application_id: string;
|
|
4051
|
+
/**
|
|
4052
|
+
* - Language code following ISO standards for this application
|
|
4053
|
+
*/
|
|
4054
|
+
locale: string;
|
|
4055
|
+
/**
|
|
4056
|
+
* - Display name of the language for application usage
|
|
4057
|
+
*/
|
|
4058
|
+
name: string;
|
|
4059
|
+
/**
|
|
4060
|
+
* - Specifies the text direction for displaying
|
|
4061
|
+
* application content, either left-to-right (ltr) or right-to-left (rtl)
|
|
4062
|
+
*/
|
|
4063
|
+
direction: string;
|
|
4064
|
+
/**
|
|
4065
|
+
* - Indicates if this is the default language
|
|
4066
|
+
* for the application
|
|
4067
|
+
*/
|
|
4068
|
+
is_default: boolean;
|
|
4069
|
+
/**
|
|
4070
|
+
* - Indicates whether this language is currently
|
|
4071
|
+
* active and visible within the storefront.
|
|
4072
|
+
*/
|
|
4073
|
+
published: boolean;
|
|
4074
|
+
/**
|
|
4075
|
+
* - Translated name of the language in
|
|
4076
|
+
* English for easy reference and display at the website.
|
|
4077
|
+
*/
|
|
4078
|
+
display_name?: string;
|
|
4079
|
+
};
|
|
4080
|
+
/** @returns {unPublishApplicationLanguage} */
|
|
4081
|
+
declare function unPublishApplicationLanguage(): unPublishApplicationLanguage;
|
|
4082
|
+
type unPublishApplicationLanguage = {
|
|
4083
|
+
/**
|
|
4084
|
+
* - Updates the publication status of the language
|
|
4085
|
+
*/
|
|
4086
|
+
published: boolean;
|
|
4087
|
+
};
|
|
4088
|
+
/** @returns {ApplicationLanguageCreate} */
|
|
4089
|
+
declare function ApplicationLanguageCreate(): ApplicationLanguageCreate;
|
|
4090
|
+
type ApplicationLanguageCreate = {
|
|
4091
|
+
/**
|
|
4092
|
+
* - List of language codes to be added to
|
|
4093
|
+
* application configuration
|
|
4094
|
+
*/
|
|
4095
|
+
locales: string[];
|
|
4096
|
+
};
|
|
4097
|
+
/** @returns {ApplicationLanguageUpdate} */
|
|
4098
|
+
declare function ApplicationLanguageUpdate(): ApplicationLanguageUpdate;
|
|
4099
|
+
type ApplicationLanguageUpdate = {
|
|
4100
|
+
/**
|
|
4101
|
+
* - Sets the specified language as the application default
|
|
4102
|
+
*/
|
|
4103
|
+
is_default: boolean;
|
|
4104
|
+
/**
|
|
4105
|
+
* - Updates the publication status of the language
|
|
4106
|
+
*/
|
|
4107
|
+
published: boolean;
|
|
4108
|
+
};
|
|
4109
|
+
/** @returns {TranslatableResource} */
|
|
4110
|
+
declare function TranslatableResource(): TranslatableResource;
|
|
4111
|
+
type TranslatableResource = {
|
|
4112
|
+
/**
|
|
4113
|
+
* - Unique identifier for the translatable resource
|
|
4114
|
+
*/
|
|
4115
|
+
_id?: string;
|
|
4116
|
+
/**
|
|
4117
|
+
* - Categorizes the type of content that can be translated
|
|
4118
|
+
*/
|
|
4119
|
+
type: string;
|
|
4120
|
+
/**
|
|
4121
|
+
* - Display name of the translatable resource
|
|
4122
|
+
*/
|
|
4123
|
+
name: string;
|
|
4124
|
+
/**
|
|
4125
|
+
* - Detailed explanation of the translatable resource
|
|
4126
|
+
*/
|
|
4127
|
+
description: string;
|
|
4128
|
+
/**
|
|
4129
|
+
* - Defines the processing type for the
|
|
4130
|
+
* translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
|
|
4131
|
+
*/
|
|
4132
|
+
schema_type: string;
|
|
4133
|
+
/**
|
|
4134
|
+
* - Identifier of the user who created this resource
|
|
4135
|
+
*/
|
|
4136
|
+
created_by?: string;
|
|
4137
|
+
/**
|
|
4138
|
+
* - Identifier of the user who last modified
|
|
4139
|
+
* this resource
|
|
4140
|
+
*/
|
|
4141
|
+
modified_by?: string;
|
|
4142
|
+
/**
|
|
4143
|
+
* - Timestamp when this resource was initially created
|
|
4144
|
+
*/
|
|
4145
|
+
created_on?: string;
|
|
4146
|
+
/**
|
|
4147
|
+
* - Timestamp when this resource was last modified
|
|
4148
|
+
*/
|
|
4149
|
+
modified_on?: string;
|
|
4150
|
+
section_id?: TranslatableSection;
|
|
4151
|
+
};
|
|
4152
|
+
/** @returns {ResourceDefinition} */
|
|
4153
|
+
declare function ResourceDefinition(): ResourceDefinition;
|
|
4154
|
+
type ResourceDefinition = {
|
|
4155
|
+
/**
|
|
4156
|
+
* - Unique identifier for the resource definition
|
|
4157
|
+
*/
|
|
4158
|
+
_id?: string;
|
|
4159
|
+
/**
|
|
4160
|
+
* - Reference to the associated
|
|
4161
|
+
* translatable resource
|
|
4162
|
+
*/
|
|
4163
|
+
translatable_resource_id: string;
|
|
4164
|
+
json_schema?: ResourceJsonSchema;
|
|
4165
|
+
ui_schema?: ResourceUISchema;
|
|
4166
|
+
bulk_details?: ResourceBulkDetails;
|
|
4167
|
+
};
|
|
4168
|
+
/** @returns {ResourceJsonSchema} */
|
|
4169
|
+
declare function ResourceJsonSchema(): ResourceJsonSchema;
|
|
4170
|
+
type ResourceJsonSchema = {
|
|
4171
|
+
schema?: string;
|
|
4172
|
+
type?: ResourceJsonSchemaType;
|
|
4173
|
+
};
|
|
4174
|
+
/** @returns {ResourceJsonSchemaType} */
|
|
4175
|
+
declare function ResourceJsonSchemaType(): ResourceJsonSchemaType;
|
|
4176
|
+
type ResourceJsonSchemaType = {
|
|
4177
|
+
author?: Author;
|
|
4178
|
+
title?: Title;
|
|
4179
|
+
feature_image?: FeatureImage;
|
|
4180
|
+
};
|
|
4181
|
+
/** @returns {ResourceUISchema} */
|
|
4182
|
+
declare function ResourceUISchema(): ResourceUISchema;
|
|
4183
|
+
type ResourceUISchema = {
|
|
4184
|
+
author?: Author;
|
|
4185
|
+
title?: Title;
|
|
4186
|
+
feature_image?: FeatureImage;
|
|
4187
|
+
seo?: Seo;
|
|
4188
|
+
};
|
|
4189
|
+
/** @returns {ResourceBulkDetails} */
|
|
4190
|
+
declare function ResourceBulkDetails(): ResourceBulkDetails;
|
|
4191
|
+
type ResourceBulkDetails = {
|
|
4192
|
+
fields?: string[];
|
|
4193
|
+
};
|
|
4194
|
+
/** @returns {Title} */
|
|
4195
|
+
declare function Title(): Title;
|
|
4196
|
+
type Title = {
|
|
4197
|
+
ui_widget?: string;
|
|
4198
|
+
ui_description?: boolean;
|
|
4199
|
+
};
|
|
4200
|
+
/** @returns {FeatureImage} */
|
|
4201
|
+
declare function FeatureImage(): FeatureImage;
|
|
4202
|
+
type FeatureImage = {
|
|
4203
|
+
/**
|
|
4204
|
+
* - URL of the secure image
|
|
4205
|
+
*/
|
|
4206
|
+
secure_url?: string;
|
|
4207
|
+
};
|
|
4208
|
+
/** @returns {Seo} */
|
|
4209
|
+
declare function Seo(): Seo;
|
|
4210
|
+
type Seo = {
|
|
4211
|
+
title?: Title;
|
|
4212
|
+
description?: string;
|
|
4213
|
+
canonical_url?: string;
|
|
4214
|
+
meta_tags?: MetaTag[];
|
|
4215
|
+
};
|
|
4216
|
+
/** @returns {MetaTag} */
|
|
4217
|
+
declare function MetaTag(): MetaTag;
|
|
4218
|
+
type MetaTag = {
|
|
4219
|
+
/**
|
|
4220
|
+
* - Title of the meta tag
|
|
4221
|
+
*/
|
|
4222
|
+
title?: string;
|
|
4223
|
+
items?: MetaTagItem[];
|
|
4224
|
+
};
|
|
4225
|
+
/** @returns {MetaTagItem} */
|
|
4226
|
+
declare function MetaTagItem(): MetaTagItem;
|
|
4227
|
+
type MetaTagItem = {
|
|
4228
|
+
/**
|
|
4229
|
+
* - Key of the meta tag item
|
|
4230
|
+
*/
|
|
4231
|
+
key?: string;
|
|
4232
|
+
/**
|
|
4233
|
+
* - Value of the meta tag item
|
|
4234
|
+
*/
|
|
4235
|
+
value?: string;
|
|
4236
|
+
};
|
|
4237
|
+
/** @returns {ResourceTranslation} */
|
|
4238
|
+
declare function ResourceTranslation(): ResourceTranslation;
|
|
4239
|
+
type ResourceTranslation = {
|
|
4240
|
+
/**
|
|
4241
|
+
* - Unique identifier for the translation entry
|
|
4242
|
+
*/
|
|
4243
|
+
_id?: string;
|
|
4244
|
+
/**
|
|
4245
|
+
* - Language code for this translation
|
|
4246
|
+
*/
|
|
4247
|
+
locale?: string;
|
|
4248
|
+
value?: TranslationValue;
|
|
4249
|
+
};
|
|
4250
|
+
/** @returns {TranslationValue} */
|
|
4251
|
+
declare function TranslationValue(): TranslationValue;
|
|
4252
|
+
type TranslationValue = {
|
|
4253
|
+
/**
|
|
4254
|
+
* - Translated name
|
|
4255
|
+
*/
|
|
4256
|
+
name?: string;
|
|
4257
|
+
seo?: TranslationSeo;
|
|
4258
|
+
};
|
|
4259
|
+
/** @returns {TranslationSeo} */
|
|
4260
|
+
declare function TranslationSeo(): TranslationSeo;
|
|
4261
|
+
type TranslationSeo = {
|
|
4262
|
+
/**
|
|
4263
|
+
* - Translated SEO title
|
|
4264
|
+
*/
|
|
4265
|
+
title?: string;
|
|
4266
|
+
/**
|
|
4267
|
+
* - List of translated breadcrumbs
|
|
4268
|
+
*/
|
|
4269
|
+
breadcrumbs?: string[];
|
|
4270
|
+
/**
|
|
4271
|
+
* - List of translated meta tags
|
|
4272
|
+
*/
|
|
4273
|
+
meta_tags?: string[];
|
|
4274
|
+
/**
|
|
4275
|
+
* - Translated canonical URL
|
|
4276
|
+
*/
|
|
4277
|
+
canonical_url?: string;
|
|
4278
|
+
/**
|
|
4279
|
+
* - Translated SEO description
|
|
4280
|
+
*/
|
|
4281
|
+
description?: string;
|
|
4282
|
+
};
|
|
4283
|
+
/** @returns {ResourceTranslationList} */
|
|
4284
|
+
declare function ResourceTranslationList(): ResourceTranslationList;
|
|
4285
|
+
type ResourceTranslationList = {
|
|
4286
|
+
items?: ResourceTranslationCreate[];
|
|
4287
|
+
};
|
|
4288
|
+
/** @returns {ResourceTranslationCreate} */
|
|
4289
|
+
declare function ResourceTranslationCreate(): ResourceTranslationCreate;
|
|
4290
|
+
type ResourceTranslationCreate = {
|
|
4291
|
+
/**
|
|
4292
|
+
* - Type of content being translated
|
|
4293
|
+
*/
|
|
4294
|
+
type?: string;
|
|
4295
|
+
/**
|
|
4296
|
+
* - Identifier of the resource requiring translation
|
|
4297
|
+
*/
|
|
4298
|
+
resource_id?: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* - Target language code for the translation
|
|
4301
|
+
*/
|
|
4302
|
+
locale?: string;
|
|
4303
|
+
value?: TranslationValue;
|
|
4304
|
+
};
|
|
4305
|
+
/** @returns {ResourceTranslationUpdate} */
|
|
4306
|
+
declare function ResourceTranslationUpdate(): ResourceTranslationUpdate;
|
|
4307
|
+
type ResourceTranslationUpdate = {
|
|
4308
|
+
value?: TranslationValue;
|
|
4309
|
+
};
|
|
4310
|
+
/** @returns {TranslatableSection} */
|
|
4311
|
+
declare function TranslatableSection(): TranslatableSection;
|
|
4312
|
+
type TranslatableSection = {
|
|
4313
|
+
/**
|
|
4314
|
+
* - Unique identifier for the translatable section
|
|
4315
|
+
*/
|
|
4316
|
+
_id?: string;
|
|
4317
|
+
/**
|
|
4318
|
+
* - Display name of the section
|
|
4319
|
+
*/
|
|
4320
|
+
name?: string;
|
|
4321
|
+
/**
|
|
4322
|
+
* - Detailed explanation of the section's purpose
|
|
4323
|
+
*/
|
|
4324
|
+
description?: string;
|
|
4325
|
+
/**
|
|
4326
|
+
* - Identifier of the user who created this resource
|
|
4327
|
+
*/
|
|
4328
|
+
created_by?: string;
|
|
4329
|
+
/**
|
|
4330
|
+
* - Identifier of the user who last modified
|
|
4331
|
+
* this resource
|
|
4332
|
+
*/
|
|
4333
|
+
modified_by?: string;
|
|
4334
|
+
/**
|
|
4335
|
+
* - Timestamp when this resource was initially created
|
|
4336
|
+
*/
|
|
4337
|
+
created_on?: string;
|
|
4338
|
+
/**
|
|
4339
|
+
* - Timestamp when this resource was last modified
|
|
4340
|
+
*/
|
|
4341
|
+
modified_on?: string;
|
|
4342
|
+
};
|
|
4343
|
+
/** @returns {Metrics} */
|
|
4344
|
+
declare function Metrics(): Metrics;
|
|
4345
|
+
type Metrics = {
|
|
4346
|
+
/**
|
|
4347
|
+
* - Total number of translation operations attempted
|
|
4348
|
+
*/
|
|
4349
|
+
total?: number;
|
|
4350
|
+
/**
|
|
4351
|
+
* - Number of successful translation operations
|
|
4352
|
+
*/
|
|
4353
|
+
success?: number;
|
|
4354
|
+
/**
|
|
4355
|
+
* - Number of failed translation operations
|
|
4356
|
+
*/
|
|
4357
|
+
failed?: number;
|
|
4358
|
+
};
|
|
4359
|
+
/** @returns {ResourceTranslationUpsertItem} */
|
|
4360
|
+
declare function ResourceTranslationUpsertItem(): ResourceTranslationUpsertItem;
|
|
4361
|
+
type ResourceTranslationUpsertItem = {
|
|
4362
|
+
/**
|
|
4363
|
+
* - Status message for the translation operation
|
|
4364
|
+
*/
|
|
4365
|
+
message?: string;
|
|
4366
|
+
data?: ResourceTranslationCreate;
|
|
4367
|
+
};
|
|
4368
|
+
/** @returns {ResourceTranslationBulkUpsert} */
|
|
4369
|
+
declare function ResourceTranslationBulkUpsert(): ResourceTranslationBulkUpsert;
|
|
4370
|
+
type ResourceTranslationBulkUpsert = {
|
|
4371
|
+
metrics?: Metrics;
|
|
4372
|
+
/**
|
|
4373
|
+
* - List of failed
|
|
4374
|
+
* translation operations
|
|
4375
|
+
*/
|
|
4376
|
+
failed_items?: ResourceTranslationUpsertItem[];
|
|
4377
|
+
/**
|
|
4378
|
+
* - List of
|
|
4379
|
+
* successful translation operations
|
|
4380
|
+
*/
|
|
4381
|
+
updated_items?: ResourceTranslationUpsertItem[];
|
|
4382
|
+
};
|
|
4383
|
+
/** @returns {StandardError} */
|
|
4384
|
+
declare function StandardError(): StandardError;
|
|
4385
|
+
type StandardError = {
|
|
4386
|
+
/**
|
|
4387
|
+
* - A brief description of the error.
|
|
4388
|
+
*/
|
|
4389
|
+
message: string;
|
|
4390
|
+
};
|
|
4391
|
+
/** @returns {OperationResponseSchema} */
|
|
4392
|
+
declare function OperationResponseSchema(): OperationResponseSchema;
|
|
4393
|
+
type OperationResponseSchema = {
|
|
4394
|
+
/**
|
|
4395
|
+
* - Indicates if the operation was successful
|
|
4396
|
+
*/
|
|
4397
|
+
success: boolean;
|
|
4398
|
+
/**
|
|
4399
|
+
* - Optional message providing additional
|
|
4400
|
+
* information about the operation
|
|
4401
|
+
*/
|
|
4402
|
+
message?: string;
|
|
4403
|
+
};
|
|
4404
|
+
/**
|
|
4405
|
+
* Enum: GenerationEntityType Used By: Content
|
|
4406
|
+
*
|
|
4407
|
+
* @returns {GenerationEntityType}
|
|
4408
|
+
*/
|
|
4409
|
+
declare function GenerationEntityType(): GenerationEntityType;
|
|
4410
|
+
type GenerationEntityType = "title" | "description";
|
|
2914
4411
|
/**
|
|
2915
4412
|
* Enum: PageType Used By: Content
|
|
2916
4413
|
*
|