@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -1,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]
|
|
@@ -81,7 +86,7 @@ export = ContentPlatformModel;
|
|
|
81
86
|
* @typedef SEOSchemaMarkupTemplate
|
|
82
87
|
* @property {string} [id]
|
|
83
88
|
* @property {string} [title]
|
|
84
|
-
* @property {
|
|
89
|
+
* @property {PageType} [page_type]
|
|
85
90
|
* @property {string} [schema]
|
|
86
91
|
* @property {string} [description]
|
|
87
92
|
* @property {boolean} [active]
|
|
@@ -93,7 +98,7 @@ export = ContentPlatformModel;
|
|
|
93
98
|
/**
|
|
94
99
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
95
100
|
* @property {string} [title]
|
|
96
|
-
* @property {
|
|
101
|
+
* @property {PageType} [page_type]
|
|
97
102
|
* @property {string} [schema]
|
|
98
103
|
* @property {string} [description]
|
|
99
104
|
* @property {Object} [target_json]
|
|
@@ -138,7 +143,7 @@ export = ContentPlatformModel;
|
|
|
138
143
|
*/
|
|
139
144
|
/**
|
|
140
145
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
141
|
-
* @property {
|
|
146
|
+
* @property {PageType} [page_type]
|
|
142
147
|
* @property {string} [schema]
|
|
143
148
|
* @property {Object} [target_json]
|
|
144
149
|
*/
|
|
@@ -156,7 +161,7 @@ export = ContentPlatformModel;
|
|
|
156
161
|
* @property {string} [end]
|
|
157
162
|
*/
|
|
158
163
|
/**
|
|
159
|
-
* @typedef
|
|
164
|
+
* @typedef BlogGetDetails
|
|
160
165
|
* @property {BlogSchema[]} [items]
|
|
161
166
|
* @property {Page} [page]
|
|
162
167
|
* @property {BlogFilters} [filters]
|
|
@@ -180,7 +185,7 @@ export = ContentPlatformModel;
|
|
|
180
185
|
* @typedef Author
|
|
181
186
|
* @property {string} [designation]
|
|
182
187
|
* @property {string} [id]
|
|
183
|
-
* @property {string} [name]
|
|
188
|
+
* @property {string} [name] - Name of the author
|
|
184
189
|
*/
|
|
185
190
|
/**
|
|
186
191
|
* @typedef BlogSchema
|
|
@@ -241,7 +246,7 @@ export = ContentPlatformModel;
|
|
|
241
246
|
* @property {string} [modified_on]
|
|
242
247
|
*/
|
|
243
248
|
/**
|
|
244
|
-
* @typedef
|
|
249
|
+
* @typedef BlogPayload
|
|
245
250
|
* @property {string} [application]
|
|
246
251
|
* @property {Object} [_custom_json]
|
|
247
252
|
* @property {Author} [author]
|
|
@@ -319,55 +324,89 @@ export = ContentPlatformModel;
|
|
|
319
324
|
* @property {string} [start]
|
|
320
325
|
* @property {string} [end]
|
|
321
326
|
*/
|
|
322
|
-
/**
|
|
323
|
-
* @typedef ConfigurationSchema
|
|
324
|
-
* @property {number} [sleep_time]
|
|
325
|
-
* @property {boolean} [start_on_launch]
|
|
326
|
-
* @property {number} [duration]
|
|
327
|
-
* @property {string} [slide_direction]
|
|
328
|
-
*/
|
|
329
|
-
/**
|
|
330
|
-
* @typedef SlideshowMedia
|
|
331
|
-
* @property {string} [type]
|
|
332
|
-
* @property {string} [url]
|
|
333
|
-
* @property {string} [bg_color]
|
|
334
|
-
* @property {number} [duration]
|
|
335
|
-
* @property {boolean} [auto_decide_duration]
|
|
336
|
-
* @property {Action} [action]
|
|
337
|
-
*/
|
|
338
327
|
/**
|
|
339
328
|
* @typedef UpdateHandpickedSchema
|
|
340
329
|
* @property {HandpickedTagSchema} [tag]
|
|
341
330
|
*/
|
|
342
331
|
/**
|
|
343
332
|
* @typedef HandpickedTagSchema
|
|
344
|
-
* @property {string} [position]
|
|
345
|
-
*
|
|
346
|
-
* @property {
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
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.
|
|
356
|
+
* @property {TemplateSchema} [template]
|
|
351
357
|
*/
|
|
352
358
|
/**
|
|
353
359
|
* @typedef RemoveHandpickedSchema
|
|
354
|
-
* @property {string[]} [tags]
|
|
360
|
+
* @property {string[]} [tags] - A list of tag IDs to remove from the system.
|
|
355
361
|
*/
|
|
356
362
|
/**
|
|
357
363
|
* @typedef CreateTagSchema
|
|
358
|
-
* @property {string} [name]
|
|
359
|
-
*
|
|
360
|
-
* @property {string} [
|
|
361
|
-
*
|
|
362
|
-
* @property {string} [
|
|
363
|
-
* @property {string} [
|
|
364
|
-
*
|
|
365
|
-
* @property {
|
|
366
|
-
*
|
|
364
|
+
* @property {string} [name] - The name of the tag to be created, used for
|
|
365
|
+
* identification purposes.
|
|
366
|
+
* @property {string} [sub_type] - Indicates if the tag is external (linked) or
|
|
367
|
+
* inline (embedded within the page).
|
|
368
|
+
* @property {string} [_id] - The unique identifier for the tag.
|
|
369
|
+
* @property {string} [type] - The type of the tag, either JavaScript ('js') or
|
|
370
|
+
* CSS ('css').
|
|
371
|
+
* @property {string} [url] - The external URL pointing to the script or
|
|
372
|
+
* stylesheet resource.
|
|
373
|
+
* @property {string} [position] - The position on the webpage where the tag
|
|
374
|
+
* will be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
375
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
376
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
377
|
+
* tag type for example:
|
|
378
|
+
*
|
|
379
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
380
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
381
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
382
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
383
|
+
*
|
|
384
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
385
|
+
* third-party tag can be injected or supported.
|
|
386
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be
|
|
387
|
+
* injected or active.
|
|
388
|
+
* @property {string} [content] - The inline content for tags of type 'inline'
|
|
389
|
+
* (e.g., JavaScript or CSS code).
|
|
390
|
+
* @property {TemplateSchema} [template]
|
|
391
|
+
*/
|
|
392
|
+
/**
|
|
393
|
+
* @typedef TemplateSchema
|
|
394
|
+
* @property {string} [template_id] - Unique identifier for the template linked
|
|
395
|
+
* to the tag.
|
|
396
|
+
* @property {string} [template_version] - Version number of the template used
|
|
397
|
+
* for configuration.
|
|
398
|
+
* @property {TemplateField[]} [template_fields] - List of dynamic key-value
|
|
399
|
+
* pairs defining configuration fields for third-party integrations or custom settings.
|
|
400
|
+
*/
|
|
401
|
+
/**
|
|
402
|
+
* @typedef TemplateField
|
|
403
|
+
* @property {string} [key] - Field name representing the configuration key.
|
|
404
|
+
* @property {string} [value] - Value assigned to the configuration field.
|
|
367
405
|
*/
|
|
368
406
|
/**
|
|
369
407
|
* @typedef CreateTagRequestSchema
|
|
370
|
-
* @property {CreateTagSchema[]} [tags]
|
|
408
|
+
* @property {CreateTagSchema[]} [tags] - A list of tags to be created or
|
|
409
|
+
* updated, each containing details such as name, type, and attributes.
|
|
371
410
|
*/
|
|
372
411
|
/**
|
|
373
412
|
* @typedef DataLoaderSchema
|
|
@@ -380,6 +419,57 @@ export = ContentPlatformModel;
|
|
|
380
419
|
* @property {DataLoaderSourceSchema} [__source]
|
|
381
420
|
* @property {string} [_id]
|
|
382
421
|
*/
|
|
422
|
+
/**
|
|
423
|
+
* @typedef TagsTemplateSchema
|
|
424
|
+
* @property {TagTemplateItem[]} [items] - Array of tag template objects.
|
|
425
|
+
*/
|
|
426
|
+
/**
|
|
427
|
+
* @typedef TagTemplateItem
|
|
428
|
+
* @property {string} [template_name] - Static name of the tag template (e.g.,
|
|
429
|
+
* gtm, ga4, metaPixel, sentry).
|
|
430
|
+
* @property {string} [type] - Script type.
|
|
431
|
+
* @property {string} [sub_type] - Script loading subtype.
|
|
432
|
+
* @property {string} [position] - Where the script should be injected.
|
|
433
|
+
* @property {string[]} [pages] - List of page types where the tag should be active.
|
|
434
|
+
* @property {Object} [attributes] - HTML attributes to apply on the script tag.
|
|
435
|
+
* @property {string[]} [compatible_engines] - List of compatible UI frameworks.
|
|
436
|
+
* @property {Object} [field_mappings] - Maps UI field names to backend keys.
|
|
437
|
+
* @property {TemplateLayout} [layout]
|
|
438
|
+
* @property {string} [name] - Human-readable name of the template.
|
|
439
|
+
* @property {string} [path] - URL-safe path or slug for the template.
|
|
440
|
+
* @property {string} [description] - Explains the purpose or behavior of the template.
|
|
441
|
+
* @property {string} [image] - URL to an icon or image for the template.
|
|
442
|
+
* @property {string} [note] - Helpful guidance for configuring the template.
|
|
443
|
+
* @property {string} [template_id] - Unique template identifier.
|
|
444
|
+
* @property {string} [template_version] - Version of this template.
|
|
445
|
+
* @property {string} [category] - Functional category of the template.
|
|
446
|
+
* @property {FieldDefinition[]} [fields] - Array of field definitions for
|
|
447
|
+
* template configuration.
|
|
448
|
+
* @property {string} [script] - JavaScript snippet or template script code.
|
|
449
|
+
*/
|
|
450
|
+
/**
|
|
451
|
+
* @typedef TemplateLayout
|
|
452
|
+
* @property {number} [columns]
|
|
453
|
+
* @property {string} [gap]
|
|
454
|
+
* @property {boolean} [responsive]
|
|
455
|
+
*/
|
|
456
|
+
/**
|
|
457
|
+
* @typedef FieldDefinition
|
|
458
|
+
* @property {string} [name] - Field key used in templates and mappings.
|
|
459
|
+
* @property {string} [type] - Input type (e.g., text, boolean, array, note).
|
|
460
|
+
* @property {string} [label]
|
|
461
|
+
* @property {string} [placeholder]
|
|
462
|
+
* @property {boolean} [required]
|
|
463
|
+
* @property {string} [size] - Visual width in the form layout.
|
|
464
|
+
* @property {string} [description]
|
|
465
|
+
* @property {FieldValidation} [validation]
|
|
466
|
+
* @property {Object} [events] - Optional client-side events configuration.
|
|
467
|
+
*/
|
|
468
|
+
/**
|
|
469
|
+
* @typedef FieldValidation
|
|
470
|
+
* @property {string} [pattern] - Regex pattern used for validation.
|
|
471
|
+
* @property {string} [message] - Error message shown when validation fails.
|
|
472
|
+
*/
|
|
383
473
|
/**
|
|
384
474
|
* @typedef DataLoaderSourceSchema
|
|
385
475
|
* @property {string} [type]
|
|
@@ -390,8 +480,9 @@ export = ContentPlatformModel;
|
|
|
390
480
|
* @property {DataLoaderSchema[]} [items]
|
|
391
481
|
*/
|
|
392
482
|
/**
|
|
393
|
-
* @typedef
|
|
394
|
-
* @property {boolean} [success]
|
|
483
|
+
* @typedef TagDeleteSuccessDetails
|
|
484
|
+
* @property {boolean} [success] - Indicates whether the tag removal operation
|
|
485
|
+
* was successful.
|
|
395
486
|
*/
|
|
396
487
|
/**
|
|
397
488
|
* @typedef ContentAPIError
|
|
@@ -494,16 +585,17 @@ export = ContentPlatformModel;
|
|
|
494
585
|
*/
|
|
495
586
|
/**
|
|
496
587
|
* @typedef Page
|
|
497
|
-
* @property {number} [item_total] - The total number of items
|
|
588
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
498
589
|
* @property {string} [next_id] - The identifier for the next page.
|
|
499
590
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
500
591
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
501
592
|
* @property {number} [current] - The current page number.
|
|
502
|
-
* @property {string} type - The type of the page,
|
|
593
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
503
594
|
* @property {number} [size] - The number of items per page.
|
|
595
|
+
* @property {number} [page_size] - The number of items per page.
|
|
504
596
|
*/
|
|
505
597
|
/**
|
|
506
|
-
* @typedef
|
|
598
|
+
* @typedef LandingPageGetDetails
|
|
507
599
|
* @property {LandingPageSchema[]} [items]
|
|
508
600
|
* @property {Page} [page]
|
|
509
601
|
*/
|
|
@@ -520,11 +612,11 @@ export = ContentPlatformModel;
|
|
|
520
612
|
* @property {Object} [_custom_json]
|
|
521
613
|
*/
|
|
522
614
|
/**
|
|
523
|
-
* @typedef
|
|
615
|
+
* @typedef DefaultNavigationDetails
|
|
524
616
|
* @property {NavigationSchema[]} [items]
|
|
525
617
|
*/
|
|
526
618
|
/**
|
|
527
|
-
* @typedef
|
|
619
|
+
* @typedef NavigationGetDetails
|
|
528
620
|
* @property {NavigationSchema[]} [items]
|
|
529
621
|
* @property {Page} [page]
|
|
530
622
|
*/
|
|
@@ -548,7 +640,7 @@ export = ContentPlatformModel;
|
|
|
548
640
|
* @property {NavigationReference[]} [navigation]
|
|
549
641
|
*/
|
|
550
642
|
/**
|
|
551
|
-
* @typedef
|
|
643
|
+
* @typedef NavigationPayload
|
|
552
644
|
* @property {string} [name]
|
|
553
645
|
* @property {string} [slug]
|
|
554
646
|
* @property {string[]} [platform]
|
|
@@ -556,7 +648,7 @@ export = ContentPlatformModel;
|
|
|
556
648
|
* @property {NavigationReference[]} [navigation]
|
|
557
649
|
*/
|
|
558
650
|
/**
|
|
559
|
-
* @typedef
|
|
651
|
+
* @typedef PageGetDetails
|
|
560
652
|
* @property {PageSchema[]} [items]
|
|
561
653
|
* @property {Page} [page]
|
|
562
654
|
*/
|
|
@@ -607,7 +699,7 @@ export = ContentPlatformModel;
|
|
|
607
699
|
* @property {string} [id]
|
|
608
700
|
*/
|
|
609
701
|
/**
|
|
610
|
-
* @typedef
|
|
702
|
+
* @typedef PagePayload
|
|
611
703
|
* @property {CronSchedule} [_schedule]
|
|
612
704
|
* @property {string} [application]
|
|
613
705
|
* @property {Author} [author]
|
|
@@ -630,7 +722,7 @@ export = ContentPlatformModel;
|
|
|
630
722
|
* @property {number} [duration]
|
|
631
723
|
*/
|
|
632
724
|
/**
|
|
633
|
-
* @typedef
|
|
725
|
+
* @typedef PagePublishPayload
|
|
634
726
|
* @property {boolean} [publish]
|
|
635
727
|
*/
|
|
636
728
|
/**
|
|
@@ -639,32 +731,6 @@ export = ContentPlatformModel;
|
|
|
639
731
|
* @property {PageSchema[]} [custom_pages]
|
|
640
732
|
* @property {string} [application_id]
|
|
641
733
|
*/
|
|
642
|
-
/**
|
|
643
|
-
* @typedef SlideshowGetResponse
|
|
644
|
-
* @property {SlideshowSchema[]} [items]
|
|
645
|
-
* @property {Page} [page]
|
|
646
|
-
*/
|
|
647
|
-
/**
|
|
648
|
-
* @typedef SlideshowSchema
|
|
649
|
-
* @property {string} [_id]
|
|
650
|
-
* @property {string} [slug]
|
|
651
|
-
* @property {DateMeta} [date_meta]
|
|
652
|
-
* @property {string} [application]
|
|
653
|
-
* @property {string} [platform]
|
|
654
|
-
* @property {ConfigurationSchema} [configuration]
|
|
655
|
-
* @property {SlideshowMedia[]} [media]
|
|
656
|
-
* @property {boolean} [active]
|
|
657
|
-
* @property {boolean} [archived]
|
|
658
|
-
* @property {Object} [_custom_json]
|
|
659
|
-
*/
|
|
660
|
-
/**
|
|
661
|
-
* @typedef SlideshowRequest
|
|
662
|
-
* @property {string} [slug]
|
|
663
|
-
* @property {string} [platform]
|
|
664
|
-
* @property {ConfigurationSchema} [configuration]
|
|
665
|
-
* @property {SlideshowMedia} [media]
|
|
666
|
-
* @property {boolean} [active]
|
|
667
|
-
*/
|
|
668
734
|
/**
|
|
669
735
|
* @typedef Support
|
|
670
736
|
* @property {boolean} [created]
|
|
@@ -703,27 +769,46 @@ export = ContentPlatformModel;
|
|
|
703
769
|
*/
|
|
704
770
|
/**
|
|
705
771
|
* @typedef TagsSchema
|
|
706
|
-
* @property {string} [application]
|
|
707
|
-
* @property {string} [_id]
|
|
708
|
-
* @property {
|
|
772
|
+
* @property {string} [application] - The ID of the application that owns the tags.
|
|
773
|
+
* @property {string} [_id] - The unique identifier for the tag set.
|
|
774
|
+
* @property {string} [company] - The ID of the company associated with this tags.
|
|
775
|
+
* @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
|
|
776
|
+
* or stylesheets) that are configured for the application.
|
|
709
777
|
*/
|
|
710
778
|
/**
|
|
711
779
|
* @typedef TagSchema
|
|
712
|
-
* @property {string} [name]
|
|
713
|
-
* @property {string} [url]
|
|
714
|
-
*
|
|
715
|
-
* @property {string} [
|
|
716
|
-
*
|
|
717
|
-
* @property {string} [
|
|
718
|
-
*
|
|
719
|
-
* @property {string} [
|
|
720
|
-
* @property {
|
|
780
|
+
* @property {string} [name] - The name of the tag used to identify it.
|
|
781
|
+
* @property {string} [url] - The URL where the external tag resource (such as a
|
|
782
|
+
* script or stylesheet) is located.
|
|
783
|
+
* @property {string} [type] - Specifies whether the tag is a JavaScript ('js')
|
|
784
|
+
* or CSS ('css') tag.
|
|
785
|
+
* @property {string} [sub_type] - Indicates whether the tag is an external
|
|
786
|
+
* resource (external) or inline content (inline).
|
|
787
|
+
* @property {string} [_id] - The unique identifier for the tag in the system.
|
|
788
|
+
* @property {string} [position] - The position within the page where the tag
|
|
789
|
+
* should be injected.
|
|
790
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
791
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
792
|
+
* tag type for example:
|
|
793
|
+
*
|
|
794
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
795
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
796
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
797
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
798
|
+
*
|
|
799
|
+
* @property {string} [content] - Content of the tag if it is inline, such as
|
|
800
|
+
* JavaScript or CSS code.
|
|
801
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
802
|
+
* third-party tag can be injected or supported.
|
|
803
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be active.
|
|
721
804
|
* @property {TagSourceSchema} [__source]
|
|
805
|
+
* @property {TemplateSchema} [template]
|
|
722
806
|
*/
|
|
723
807
|
/**
|
|
724
808
|
* @typedef TagSourceSchema
|
|
725
|
-
* @property {string} [type]
|
|
726
|
-
* @property {string} [id]
|
|
809
|
+
* @property {string} [type] - The type of source, such as 'extension'
|
|
810
|
+
* @property {string} [id] - The identifier of the source that created or
|
|
811
|
+
* provided the tag.
|
|
727
812
|
*/
|
|
728
813
|
/**
|
|
729
814
|
* @typedef ResourcesSchema
|
|
@@ -737,93 +822,108 @@ export = ContentPlatformModel;
|
|
|
737
822
|
*/
|
|
738
823
|
/**
|
|
739
824
|
* @typedef FieldValidations
|
|
740
|
-
* @property {string} [name]
|
|
741
|
-
* @property {string} [type]
|
|
825
|
+
* @property {string} [name] - Name of validation
|
|
826
|
+
* @property {string} [type] - Type of validation
|
|
742
827
|
* @property {Object} [value]
|
|
743
828
|
*/
|
|
744
829
|
/**
|
|
745
830
|
* @typedef FieldDefinitionSchema
|
|
746
|
-
* @property {string} [
|
|
747
|
-
* @property {string} [
|
|
748
|
-
* @property {string} [
|
|
749
|
-
* @property {string} [
|
|
750
|
-
* @property {string} [
|
|
751
|
-
* @property {string} [
|
|
752
|
-
* @property {string} [
|
|
753
|
-
* @property {
|
|
754
|
-
*
|
|
755
|
-
* @property {FieldValidations[]} [validations]
|
|
756
|
-
* @property {string} [company_id]
|
|
757
|
-
* @property {
|
|
758
|
-
* @property {
|
|
759
|
-
* @property {
|
|
760
|
-
* @property {
|
|
761
|
-
* @property {string} [created_at]
|
|
762
|
-
* @property {string} [updated_at]
|
|
763
|
-
* @property {string} [type_name]
|
|
764
|
-
* @property {number} [invalid_fields_count]
|
|
831
|
+
* @property {string} [id] - Unique system generated id
|
|
832
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
833
|
+
* @property {string} [name] - Name of custom field
|
|
834
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
835
|
+
* @property {string} [slug] - Slug of custom field
|
|
836
|
+
* @property {string} [description] - Description of custom field definition
|
|
837
|
+
* @property {string} [type] - Data type of custom field
|
|
838
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
839
|
+
* multivalued or not
|
|
840
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
841
|
+
* @property {string} [company_id] - Id of company
|
|
842
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
843
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
844
|
+
* @property {string} [type_name] - Type of type field
|
|
845
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
765
846
|
*/
|
|
766
847
|
/**
|
|
767
848
|
* @typedef CustomFieldDefinitionsSchema
|
|
768
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
849
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
769
850
|
* @property {Page} [page]
|
|
770
851
|
*/
|
|
771
852
|
/**
|
|
772
853
|
* @typedef CustomFieldDefinitionRequestSchema
|
|
773
|
-
* @property {string} [
|
|
774
|
-
* @property {string} [
|
|
775
|
-
* @property {string} [
|
|
776
|
-
* @property {
|
|
777
|
-
*
|
|
778
|
-
* @property {string} [name]
|
|
779
|
-
* @property {string} [description]
|
|
780
|
-
* @property {FieldValidations[]} [validations]
|
|
854
|
+
* @property {string} [type] - Data type of custom field
|
|
855
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
856
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
857
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
858
|
+
* multi valued or not
|
|
859
|
+
* @property {string} [name] - Name of custom field definition
|
|
860
|
+
* @property {string} [description] - Description of a custom field definition
|
|
861
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
781
862
|
*/
|
|
782
863
|
/**
|
|
783
864
|
* @typedef CustomObjectCustomFieldDefinitions
|
|
784
|
-
* @property {string} [id]
|
|
785
|
-
* @property {string} [type]
|
|
786
|
-
* @property {string} [description]
|
|
787
|
-
* @property {string} [name]
|
|
788
|
-
* @property {boolean} [multi_value]
|
|
789
|
-
*
|
|
790
|
-
* @property {
|
|
791
|
-
* @property {
|
|
865
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
866
|
+
* @property {string} [type] - Data type of custom field
|
|
867
|
+
* @property {string} [description] - Description of custom field
|
|
868
|
+
* @property {string} [name] - Name of custom field
|
|
869
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
870
|
+
* valued or not
|
|
871
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
872
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
873
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
874
|
+
* custom field
|
|
792
875
|
* @property {string} [action]
|
|
793
876
|
*/
|
|
794
877
|
/**
|
|
795
878
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
796
|
-
* @property {string} [
|
|
797
|
-
* @property {string} [
|
|
798
|
-
* @property {string} [
|
|
799
|
-
*
|
|
879
|
+
* @property {string} [description] - Description of custom object definiton
|
|
880
|
+
* @property {string} [name] - Name of custom object definition
|
|
881
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
882
|
+
* display key in
|
|
800
883
|
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
801
884
|
*/
|
|
802
885
|
/**
|
|
803
886
|
* @typedef CustomFieldDefinitionDetailResSchema
|
|
804
|
-
* @property {string} [
|
|
805
|
-
* @property {string} [
|
|
806
|
-
* @property {string} [
|
|
807
|
-
* @property {string} [
|
|
808
|
-
* @property {string} [
|
|
809
|
-
* @property {string} [
|
|
810
|
-
* @property {
|
|
811
|
-
*
|
|
812
|
-
* @property {string} [company_id]
|
|
813
|
-
* @property {string} [application_id]
|
|
814
|
-
* @property {
|
|
815
|
-
* @property {
|
|
816
|
-
* @property {
|
|
817
|
-
* @property {boolean} [is_deleted]
|
|
818
|
-
* @property {string} [_id]
|
|
887
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
888
|
+
* @property {string} [name] - Name of custom field
|
|
889
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
890
|
+
* @property {string} [slug] - Slug of custom field
|
|
891
|
+
* @property {string} [description] - Description regarding custom field
|
|
892
|
+
* @property {string} [type] - Data type of custom field
|
|
893
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
894
|
+
* multi valued or not
|
|
895
|
+
* @property {string} [company_id] - Company Identifer
|
|
896
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
897
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
898
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
899
|
+
* @property {string} [id] - Unique system generated id
|
|
819
900
|
* @property {Object[]} [validations]
|
|
820
|
-
* @property {string} [created_at]
|
|
821
|
-
* @property {string} [updated_at]
|
|
901
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
902
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
903
|
+
*/
|
|
904
|
+
/**
|
|
905
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
906
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
907
|
+
* @property {string} [name] - Name of meta field
|
|
908
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
909
|
+
* @property {string} [slug] - Slug of meta field
|
|
910
|
+
* @property {string} [description] - Description regarding meta field
|
|
911
|
+
* @property {string} [type] - Data type of meta field
|
|
912
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
913
|
+
* multi valued or not
|
|
914
|
+
* @property {string} [company_id] - Company Identifer
|
|
915
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
916
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
917
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
918
|
+
* @property {string} [id] - Unique system generated id
|
|
919
|
+
* @property {Object[]} [validations]
|
|
920
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
921
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
822
922
|
*/
|
|
823
923
|
/**
|
|
824
924
|
* @typedef CustomDataDeleteSchema
|
|
825
|
-
* @property {boolean} [success]
|
|
826
|
-
* @property {string} [message]
|
|
925
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
926
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
827
927
|
*/
|
|
828
928
|
/**
|
|
829
929
|
* @typedef CustomFieldValue
|
|
@@ -831,29 +931,31 @@ export = ContentPlatformModel;
|
|
|
831
931
|
*/
|
|
832
932
|
/**
|
|
833
933
|
* @typedef CustomFieldSchema
|
|
834
|
-
* @property {string} [
|
|
835
|
-
* @property {string} [namespace]
|
|
836
|
-
* @property {string} [
|
|
837
|
-
* @property {string} [resource]
|
|
838
|
-
* @property {string} [creator]
|
|
934
|
+
* @property {string} [id] - Unique system generated id
|
|
935
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
936
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
937
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
839
938
|
* @property {CustomFieldValue[]} [value]
|
|
840
|
-
* @property {string} [
|
|
841
|
-
* @property {string} [type]
|
|
842
|
-
* @property {boolean} [multi_value]
|
|
843
|
-
* @property {string} [company_id]
|
|
844
|
-
* @property {string} [definition_id]
|
|
939
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
940
|
+
* @property {string} [type] - Data type of custom field
|
|
941
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
942
|
+
* @property {string} [company_id] - Identifer for a company
|
|
845
943
|
* @property {boolean} [has_invalid_values]
|
|
846
944
|
* @property {Object[]} [invalid_value_errors]
|
|
847
|
-
* @property {
|
|
848
|
-
* @property {
|
|
849
|
-
* @property {string} [
|
|
850
|
-
* @property {string} [updated_at]
|
|
945
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
946
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
947
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
851
948
|
*/
|
|
852
949
|
/**
|
|
853
950
|
* @typedef CustomFieldsResponseSchema
|
|
854
951
|
* @property {CustomFieldSchema[]} [items]
|
|
855
952
|
* @property {Page} [page]
|
|
856
953
|
*/
|
|
954
|
+
/**
|
|
955
|
+
* @typedef CustomFieldsDeleteSchema
|
|
956
|
+
* @property {boolean} [success]
|
|
957
|
+
* @property {string} [message]
|
|
958
|
+
*/
|
|
857
959
|
/**
|
|
858
960
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
859
961
|
* @property {CustomFieldSchema[]} [items]
|
|
@@ -861,7 +963,9 @@ export = ContentPlatformModel;
|
|
|
861
963
|
/**
|
|
862
964
|
* @typedef CustomField
|
|
863
965
|
* @property {Object[]} [value]
|
|
864
|
-
* @property {string} [
|
|
966
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
967
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
968
|
+
* creating a custom field definition
|
|
865
969
|
*/
|
|
866
970
|
/**
|
|
867
971
|
* @typedef CustomFieldRequestSchema
|
|
@@ -869,146 +973,140 @@ export = ContentPlatformModel;
|
|
|
869
973
|
*/
|
|
870
974
|
/**
|
|
871
975
|
* @typedef CustomObjectSchema
|
|
872
|
-
* @property {string} [
|
|
873
|
-
* @property {string} [
|
|
874
|
-
* @property {string} [
|
|
875
|
-
* @property {string} [
|
|
876
|
-
* @property {string} [
|
|
877
|
-
* @property {string} [
|
|
878
|
-
* @property {string} [
|
|
879
|
-
*
|
|
880
|
-
* @property {
|
|
881
|
-
* @property {string} [definition_id]
|
|
882
|
-
* @property {CustomFieldSchema[]} [fields]
|
|
976
|
+
* @property {string} [id] - Unique system generated id
|
|
977
|
+
* @property {string} [company_id] - Identifer for a company
|
|
978
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
979
|
+
* @property {string} [status] - Status of custom object
|
|
980
|
+
* @property {string} [type] - Slug of custom object definition
|
|
981
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
982
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
983
|
+
* custom object
|
|
984
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
883
985
|
*/
|
|
884
986
|
/**
|
|
885
987
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
886
|
-
* @property {string} [type]
|
|
887
|
-
* @property {string} [
|
|
888
|
-
* @property {string} [
|
|
889
|
-
* @property {string} [
|
|
890
|
-
* @property {
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
*
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
* @
|
|
897
|
-
* @property {string} [
|
|
898
|
-
* @property {string} [
|
|
899
|
-
* @property {string} [
|
|
900
|
-
* @property {string} [
|
|
901
|
-
* @property {
|
|
902
|
-
* @property {
|
|
903
|
-
* @property {
|
|
904
|
-
*
|
|
905
|
-
* @property {string} [metaobject_definition_id]
|
|
906
|
-
* @property {boolean} [required]
|
|
907
|
-
* @property {boolean} [is_deleted]
|
|
908
|
-
* @property {string} [_id]
|
|
909
|
-
* @property {string} [created_at]
|
|
910
|
-
* @property {string} [updated_at]
|
|
911
|
-
*/
|
|
912
|
-
/**
|
|
913
|
-
* @typedef CustomObjectDefinitionSchema
|
|
914
|
-
* @property {string} [_id]
|
|
915
|
-
* @property {string} [name]
|
|
916
|
-
* @property {string} [type]
|
|
917
|
-
* @property {string} [display_name_key]
|
|
918
|
-
* @property {string} [description]
|
|
919
|
-
* @property {string} [creator]
|
|
920
|
-
* @property {string} [created_by]
|
|
921
|
-
* @property {string} [updated_by]
|
|
922
|
-
* @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
|
|
988
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
989
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
990
|
+
* @property {string} [description] - Description of custom object definition
|
|
991
|
+
* @property {string} [name] - Name of custom object
|
|
992
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
993
|
+
* for displaying custom object
|
|
994
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
995
|
+
* of custom field definitions belonging to this custom object definition
|
|
996
|
+
*/
|
|
997
|
+
/**
|
|
998
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
999
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
1000
|
+
* @property {string} [name] - Display name of custom object definition
|
|
1001
|
+
* @property {string} [type] - Type of custom object definiton
|
|
1002
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
1003
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
1004
|
+
* @property {string} [description] - Description of custom object definition
|
|
1005
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
1006
|
+
* Custom fields inside custom objects
|
|
923
1007
|
*/
|
|
924
1008
|
/**
|
|
925
1009
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
926
|
-
* @property {boolean} [success]
|
|
927
|
-
* @property {string} [message]
|
|
1010
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
1011
|
+
* @property {string} [message] - Response message when custom object definition
|
|
1012
|
+
* is deleted.
|
|
928
1013
|
*/
|
|
929
1014
|
/**
|
|
930
|
-
* @typedef
|
|
931
|
-
* @property {string} [url]
|
|
932
|
-
* @property {number} [total_records]
|
|
1015
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
1016
|
+
* @property {string} [url] - Signed url of csv
|
|
1017
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
933
1018
|
*/
|
|
934
1019
|
/**
|
|
935
|
-
* @typedef
|
|
936
|
-
* @property {string} [
|
|
937
|
-
* @property {string} [name]
|
|
938
|
-
* @property {string} [type]
|
|
1020
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
1021
|
+
* @property {string} [id] - Unique system generated id
|
|
1022
|
+
* @property {string} [name] - Name of custom object
|
|
1023
|
+
* @property {string} [type] - Type of custom object entry
|
|
939
1024
|
*/
|
|
940
1025
|
/**
|
|
941
1026
|
* @typedef CustomObjectListItemSchema
|
|
942
|
-
* @property {string} [
|
|
943
|
-
* @property {string} [
|
|
944
|
-
* @property {string} [
|
|
945
|
-
* @property {string} [updated_at]
|
|
946
|
-
* @property {string} [display_name]
|
|
947
|
-
* @property {
|
|
948
|
-
* @property {number} [references]
|
|
1027
|
+
* @property {string} [id] - Unique system generated id
|
|
1028
|
+
* @property {string} [status] - Status of custom object
|
|
1029
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
1030
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
1031
|
+
* @property {string} [display_name] - Display name of custom object
|
|
1032
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1033
|
+
* @property {number} [references] - References of the custom object entry
|
|
949
1034
|
*/
|
|
950
1035
|
/**
|
|
951
1036
|
* @typedef CustomObjectsSchema
|
|
952
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
1037
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
1038
|
+
* object entries
|
|
953
1039
|
* @property {Page} [page]
|
|
954
1040
|
*/
|
|
955
1041
|
/**
|
|
956
|
-
* @typedef
|
|
957
|
-
* @property {string} [
|
|
958
|
-
* @property {string} [
|
|
959
|
-
* @property {
|
|
960
|
-
* @property {
|
|
961
|
-
* @property {string} [
|
|
1042
|
+
* @typedef CustomObjectFieldDefinition
|
|
1043
|
+
* @property {string} [id] - Unique system generate id
|
|
1044
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1045
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1046
|
+
* @property {Object[]} [value] - Value of custom field
|
|
1047
|
+
* @property {string} [type] - Data type of the custom field
|
|
962
1048
|
*/
|
|
963
1049
|
/**
|
|
964
|
-
* @typedef
|
|
965
|
-
* @property {string} [
|
|
966
|
-
* @property {string} [status]
|
|
967
|
-
* @property {string} [display_name]
|
|
968
|
-
* @property {
|
|
969
|
-
* @property {Object[]} [references]
|
|
970
|
-
*
|
|
1050
|
+
* @typedef CustomObjectBySlugSchema
|
|
1051
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
1052
|
+
* @property {string} [status] - Status of Custom Object
|
|
1053
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
1054
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1055
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
1056
|
+
* used as a custom field
|
|
1057
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
1058
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
1059
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
1060
|
+
* inside the custom object
|
|
971
1061
|
*/
|
|
972
1062
|
/**
|
|
973
1063
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
974
|
-
* @property {string} [message]
|
|
975
|
-
* @property {string} [task_id]
|
|
1064
|
+
* @property {string} [message] - Message for the user
|
|
1065
|
+
* @property {string} [task_id] - Identifer for a task
|
|
976
1066
|
*/
|
|
977
1067
|
/**
|
|
978
1068
|
* @typedef CustomObjectMetaSchema
|
|
979
|
-
* @property {number} [mo_total_count]
|
|
980
|
-
* @property {number} [mo_success_count]
|
|
981
|
-
* @property {number} [mo_error_count]
|
|
982
|
-
* @property {string} [mo_defintion_type]
|
|
1069
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
1070
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
1071
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
1072
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
1073
|
+
*/
|
|
1074
|
+
/**
|
|
1075
|
+
* @typedef JobSchema
|
|
1076
|
+
* @property {string} [id] - Unique system generated id
|
|
1077
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
1078
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
1079
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1080
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1081
|
+
* @property {string} [company_id] - Company Identifer
|
|
1082
|
+
* @property {string} [status] - Status of job
|
|
1083
|
+
* @property {string} [action_type] - Type of job
|
|
1084
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1085
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1086
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1087
|
+
* @property {number} [error_count] - Number of items in error
|
|
1088
|
+
* @property {number} [success_count] - Number of successful items
|
|
1089
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1090
|
+
* @property {CustomObjectMetaSchema} [meta]
|
|
1091
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1092
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1093
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1094
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
983
1095
|
*/
|
|
984
1096
|
/**
|
|
985
|
-
* @typedef
|
|
986
|
-
* @property {
|
|
987
|
-
* @property {
|
|
988
|
-
* @property {string[]} [finished_jobs]
|
|
989
|
-
* @property {string[]} [error_jobs]
|
|
990
|
-
* @property {string[]} [errors_occured]
|
|
991
|
-
* @property {string} [company_id]
|
|
992
|
-
* @property {string} [creator]
|
|
993
|
-
* @property {string} [url]
|
|
994
|
-
* @property {string} [status]
|
|
995
|
-
* @property {string} [action_type]
|
|
996
|
-
* @property {string} [entity]
|
|
997
|
-
* @property {string} [error_url]
|
|
998
|
-
* @property {number} [finished_count]
|
|
999
|
-
* @property {number} [error_count]
|
|
1000
|
-
* @property {number} [success_count]
|
|
1001
|
-
* @property {number} [total_jobs]
|
|
1002
|
-
* @property {CustomObjectMetaSchema} [meta]
|
|
1003
|
-
* @property {string} [created_by]
|
|
1004
|
-
* @property {string} [created_at]
|
|
1005
|
-
* @property {string} [updated_at]
|
|
1097
|
+
* @typedef CustomFieldBulkEntry
|
|
1098
|
+
* @property {JobSchema[]} [items]
|
|
1099
|
+
* @property {Page} [page]
|
|
1006
1100
|
*/
|
|
1007
1101
|
/**
|
|
1008
1102
|
* @typedef CustomObjectBulkEntry
|
|
1009
|
-
* @property {
|
|
1103
|
+
* @property {JobSchema[]} [items]
|
|
1010
1104
|
* @property {Page} [page]
|
|
1011
1105
|
*/
|
|
1106
|
+
/**
|
|
1107
|
+
* @typedef MetafieldTypesSchema
|
|
1108
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1109
|
+
*/
|
|
1012
1110
|
/**
|
|
1013
1111
|
* @typedef CustomFieldTypeSchema
|
|
1014
1112
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1024,6 +1122,8 @@ export = ContentPlatformModel;
|
|
|
1024
1122
|
* @property {Url} [url]
|
|
1025
1123
|
* @property {Metaobject} [metaobject]
|
|
1026
1124
|
* @property {Product} [product]
|
|
1125
|
+
* @property {HTML} [html]
|
|
1126
|
+
* @property {Duration} [duration]
|
|
1027
1127
|
*/
|
|
1028
1128
|
/**
|
|
1029
1129
|
* @typedef SupportedValidationsMetaExampleSchema
|
|
@@ -1042,117 +1142,149 @@ export = ContentPlatformModel;
|
|
|
1042
1142
|
* @property {boolean} [required]
|
|
1043
1143
|
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1044
1144
|
*/
|
|
1145
|
+
/**
|
|
1146
|
+
* @typedef Duration
|
|
1147
|
+
* @property {string} [name] - Name data type of custom field
|
|
1148
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1149
|
+
* @property {string} [type] - Type of custom field
|
|
1150
|
+
* @property {string} [category] - Category of custom field
|
|
1151
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1152
|
+
* validations available for the field
|
|
1153
|
+
*/
|
|
1154
|
+
/**
|
|
1155
|
+
* @typedef HTML
|
|
1156
|
+
* @property {string} [name] - Name data type of custom field
|
|
1157
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1158
|
+
* @property {string} [type] - Type of custom field
|
|
1159
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1160
|
+
* validations available for the field
|
|
1161
|
+
*/
|
|
1045
1162
|
/**
|
|
1046
1163
|
* @typedef StringSingleLine
|
|
1047
|
-
* @property {string} [name]
|
|
1048
|
-
* @property {boolean} [list_enabled]
|
|
1049
|
-
* @property {string} [category]
|
|
1050
|
-
* @property {string} [type]
|
|
1051
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1164
|
+
* @property {string} [name] - Name data type of custom field
|
|
1165
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1166
|
+
* @property {string} [category] - Category of custom field
|
|
1167
|
+
* @property {string} [type] - Type of custom field
|
|
1168
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1169
|
+
* validations available for the field
|
|
1052
1170
|
*/
|
|
1053
1171
|
/**
|
|
1054
1172
|
* @typedef StringMultiLine
|
|
1055
|
-
* @property {string} [name]
|
|
1056
|
-
* @property {boolean} [list_enabled]
|
|
1057
|
-
* @property {string} [category]
|
|
1058
|
-
* @property {string} [type]
|
|
1059
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1173
|
+
* @property {string} [name] - Name data type of custom field
|
|
1174
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1175
|
+
* @property {string} [category] - Category of custom field
|
|
1176
|
+
* @property {string} [type] - Type of custom field
|
|
1177
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1178
|
+
* validations available for the field
|
|
1060
1179
|
*/
|
|
1061
1180
|
/**
|
|
1062
1181
|
* @typedef Dropdown
|
|
1063
|
-
* @property {string} [name]
|
|
1064
|
-
* @property {boolean} [list_enabled]
|
|
1065
|
-
* @property {string} [category]
|
|
1066
|
-
* @property {string} [type]
|
|
1067
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1182
|
+
* @property {string} [name] - Name data type of custom field
|
|
1183
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1184
|
+
* @property {string} [category] - Category of custom field
|
|
1185
|
+
* @property {string} [type] - Category of custom field
|
|
1186
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1187
|
+
* validations available for the field
|
|
1068
1188
|
*/
|
|
1069
1189
|
/**
|
|
1070
1190
|
* @typedef Integer
|
|
1071
|
-
* @property {string} [name]
|
|
1072
|
-
* @property {boolean} [list_enabled]
|
|
1073
|
-
* @property {string} [type]
|
|
1074
|
-
* @property {string} [category]
|
|
1075
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1191
|
+
* @property {string} [name] - Name data type of custom field
|
|
1192
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1193
|
+
* @property {string} [type] - Type of custom field
|
|
1194
|
+
* @property {string} [category] - Category of custom field
|
|
1195
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1196
|
+
* validations available for the field
|
|
1076
1197
|
*/
|
|
1077
1198
|
/**
|
|
1078
1199
|
* @typedef FloatType
|
|
1079
|
-
* @property {string} [name]
|
|
1080
|
-
* @property {boolean} [list_enabled]
|
|
1081
|
-
* @property {string} [type]
|
|
1082
|
-
* @property {string} [category]
|
|
1083
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1200
|
+
* @property {string} [name] - Name data type of custom field
|
|
1201
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1202
|
+
* @property {string} [type] - Type of custom field
|
|
1203
|
+
* @property {string} [category] - Category of custom field
|
|
1204
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1205
|
+
* validations available for the field
|
|
1084
1206
|
*/
|
|
1085
1207
|
/**
|
|
1086
1208
|
* @typedef BooleanType
|
|
1087
|
-
* @property {string} [name]
|
|
1088
|
-
* @property {string} [category]
|
|
1089
|
-
* @property {boolean} [list_enabled]
|
|
1090
|
-
* @property {string} [type]
|
|
1091
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1209
|
+
* @property {string} [name] - Name data type of custom field
|
|
1210
|
+
* @property {string} [category] - Category of custom field
|
|
1211
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1212
|
+
* @property {string} [type] - Category of custom field
|
|
1213
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1214
|
+
* validations available for the field
|
|
1092
1215
|
*/
|
|
1093
1216
|
/**
|
|
1094
1217
|
* @typedef Date
|
|
1095
|
-
* @property {string} [name]
|
|
1096
|
-
* @property {boolean} [list_enabled]
|
|
1097
|
-
* @property {string} [category]
|
|
1098
|
-
* @property {string} [type]
|
|
1099
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1218
|
+
* @property {string} [name] - Name data type of custom field
|
|
1219
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1220
|
+
* @property {string} [category] - Category of custom field
|
|
1221
|
+
* @property {string} [type] - Type of custom field
|
|
1222
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1223
|
+
* validations available for the field
|
|
1100
1224
|
*/
|
|
1101
1225
|
/**
|
|
1102
1226
|
* @typedef Datetime
|
|
1103
|
-
* @property {string} [name]
|
|
1104
|
-
* @property {string} [category]
|
|
1105
|
-
* @property {boolean} [list_enabled]
|
|
1106
|
-
* @property {string} [type]
|
|
1107
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1227
|
+
* @property {string} [name] - Name data type of custom field
|
|
1228
|
+
* @property {string} [category] - Category of custom field
|
|
1229
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1230
|
+
* @property {string} [type] - Type of custom field
|
|
1231
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1232
|
+
* validations available for the field
|
|
1108
1233
|
*/
|
|
1109
1234
|
/**
|
|
1110
1235
|
* @typedef Json
|
|
1111
|
-
* @property {string} [name]
|
|
1112
|
-
* @property {boolean} [list_enabled]
|
|
1113
|
-
* @property {string} [category]
|
|
1114
|
-
* @property {string} [type]
|
|
1115
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1236
|
+
* @property {string} [name] - Name data type of custom field
|
|
1237
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1238
|
+
* @property {string} [category] - Category of custom field
|
|
1239
|
+
* @property {string} [type] - Type of custom field
|
|
1240
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1241
|
+
* validations available for the field
|
|
1116
1242
|
*/
|
|
1117
1243
|
/**
|
|
1118
1244
|
* @typedef File
|
|
1119
|
-
* @property {string} [name]
|
|
1120
|
-
* @property {string} [category]
|
|
1121
|
-
* @property {boolean} [list_enabled]
|
|
1122
|
-
* @property {string} [type]
|
|
1245
|
+
* @property {string} [name] - Name data type of custom field
|
|
1246
|
+
* @property {string} [category] - Category of custom field
|
|
1247
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1248
|
+
* @property {string} [type] - Type of custom field
|
|
1123
1249
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1124
1250
|
*/
|
|
1125
1251
|
/**
|
|
1126
1252
|
* @typedef Url
|
|
1127
|
-
* @property {string} [name]
|
|
1128
|
-
* @property {boolean} [list_enabled]
|
|
1129
|
-
* @property {string} [type]
|
|
1130
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1253
|
+
* @property {string} [name] - Name data type of custom field
|
|
1254
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1255
|
+
* @property {string} [type] - Type of custom field
|
|
1256
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1257
|
+
* validations available for the field
|
|
1131
1258
|
*/
|
|
1132
1259
|
/**
|
|
1133
1260
|
* @typedef Metaobject
|
|
1134
|
-
* @property {string} [name]
|
|
1135
|
-
* @property {boolean} [list_enabled]
|
|
1136
|
-
*
|
|
1137
|
-
* @property {string} [
|
|
1261
|
+
* @property {string} [name] - Name of Custom Object
|
|
1262
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1263
|
+
* multiple list items
|
|
1264
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1265
|
+
* Custom Object belongs to
|
|
1266
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1138
1267
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1139
1268
|
*/
|
|
1140
1269
|
/**
|
|
1141
1270
|
* @typedef Product
|
|
1142
|
-
* @property {string} [name]
|
|
1143
|
-
* @property {boolean} [list_enabled]
|
|
1144
|
-
*
|
|
1145
|
-
* @property {string} [
|
|
1271
|
+
* @property {string} [name] - Name of Product
|
|
1272
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1273
|
+
* multiple list items
|
|
1274
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1275
|
+
* Product is associated with
|
|
1276
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1146
1277
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1147
1278
|
*/
|
|
1148
1279
|
/**
|
|
1149
1280
|
* @typedef CustomObjectEntry
|
|
1150
|
-
* @property {string} [
|
|
1151
|
-
* @property {string} [name]
|
|
1152
|
-
* @property {string} [type]
|
|
1153
|
-
* @property {string} [updated_at]
|
|
1154
|
-
* @property {number} [entries_count]
|
|
1155
|
-
*
|
|
1281
|
+
* @property {string} [id] - Unique system generated id
|
|
1282
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1283
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1284
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1285
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1286
|
+
* Object definition
|
|
1287
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1156
1288
|
*/
|
|
1157
1289
|
/**
|
|
1158
1290
|
* @typedef CustomObjectDefinitionsSchema
|
|
@@ -1161,19 +1293,29 @@ export = ContentPlatformModel;
|
|
|
1161
1293
|
*/
|
|
1162
1294
|
/**
|
|
1163
1295
|
* @typedef CustomObjectEntryFieldSchema
|
|
1164
|
-
* @property {string} [
|
|
1165
|
-
* @property {
|
|
1296
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1297
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1298
|
+
*/
|
|
1299
|
+
/**
|
|
1300
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1301
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1302
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1166
1303
|
*/
|
|
1167
1304
|
/**
|
|
1168
1305
|
* @typedef CustomObjectRequestSchema
|
|
1169
|
-
* @property {string} [status]
|
|
1170
|
-
* @property {string} [
|
|
1171
|
-
* @property {CustomObjectEntryFieldSchema[]} [fields]
|
|
1306
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1307
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1308
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1309
|
+
*/
|
|
1310
|
+
/**
|
|
1311
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1312
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1313
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1172
1314
|
*/
|
|
1173
1315
|
/**
|
|
1174
1316
|
* @typedef CustomObjectBulkSchema
|
|
1175
|
-
* @property {string} [url]
|
|
1176
|
-
* @property {number} [total_records]
|
|
1317
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1318
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1177
1319
|
*/
|
|
1178
1320
|
/**
|
|
1179
1321
|
* @typedef ActionPage
|
|
@@ -1182,46 +1324,294 @@ export = ContentPlatformModel;
|
|
|
1182
1324
|
* @property {string} [url] - The URL for the action.
|
|
1183
1325
|
* @property {PageType} type
|
|
1184
1326
|
*/
|
|
1185
|
-
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
1186
1327
|
/**
|
|
1187
|
-
* @typedef
|
|
1188
|
-
*
|
|
1189
|
-
*
|
|
1190
|
-
*
|
|
1191
|
-
*
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1194
|
-
*
|
|
1195
|
-
*
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
*
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
*
|
|
1206
|
-
*
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1210
|
-
*
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
*
|
|
1214
|
-
*
|
|
1215
|
-
*
|
|
1216
|
-
*
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
*
|
|
1222
|
-
*
|
|
1223
|
-
*
|
|
1224
|
-
*
|
|
1328
|
+
* @typedef TranslateUiLabels
|
|
1329
|
+
* @property {string} [_id] - Unique identifier assigned to the Translate Ui Labels entry
|
|
1330
|
+
* @property {string} [company_id] - Identifier linking the resource to a
|
|
1331
|
+
* specific company within the platform
|
|
1332
|
+
* @property {string} [application_id] - Reference to the application where this
|
|
1333
|
+
* Translate Ui Labels is utilized
|
|
1334
|
+
* @property {string} [template_theme_id] - Links the resource to a specific
|
|
1335
|
+
* template theme configuration
|
|
1336
|
+
* @property {string} [theme_id] - Associates the resource with a particular
|
|
1337
|
+
* theme implementation
|
|
1338
|
+
* @property {string} [locale] - Specifies the language and region format for
|
|
1339
|
+
* the resource content
|
|
1340
|
+
* @property {Object} [resource] - Contains the actual resource data and
|
|
1341
|
+
* configuration settings
|
|
1342
|
+
* @property {string} [type] - Categorizes the resource type for proper handling
|
|
1343
|
+
* and processing
|
|
1344
|
+
*/
|
|
1345
|
+
/**
|
|
1346
|
+
* @typedef TranslateUiLabelsCreate
|
|
1347
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1348
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1349
|
+
* @property {string} [locale] - Locale
|
|
1350
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1351
|
+
* @property {string} [type] - Resource type
|
|
1352
|
+
*/
|
|
1353
|
+
/**
|
|
1354
|
+
* @typedef StaticResourceUpdate
|
|
1355
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1356
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1357
|
+
* @property {string} [locale] - Locale
|
|
1358
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1359
|
+
* @property {string} [type] - Resource type
|
|
1360
|
+
*/
|
|
1361
|
+
/**
|
|
1362
|
+
* @typedef TranslateUiLabelsPage
|
|
1363
|
+
* @property {TranslateUiLabels[]} [items] - List of items containing all the
|
|
1364
|
+
* static info data.
|
|
1365
|
+
* @property {Page} [page]
|
|
1366
|
+
*/
|
|
1367
|
+
/**
|
|
1368
|
+
* @typedef Error
|
|
1369
|
+
* @property {string} [error] - Detailed message explaining the error that occurred
|
|
1370
|
+
*/
|
|
1371
|
+
/**
|
|
1372
|
+
* @typedef Meta
|
|
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
|
+
*/
|
|
1379
|
+
/**
|
|
1380
|
+
* @typedef CompanyLanguage
|
|
1381
|
+
* @property {string} [_id] - Unique identifier for the company language setting
|
|
1382
|
+
* @property {string} company_id - Identifier of the company this language
|
|
1383
|
+
* configuration belongs to
|
|
1384
|
+
* @property {string} [locale] - Language code following ISO standards for this
|
|
1385
|
+
* company setting
|
|
1386
|
+
* @property {string} [name] - Display name of the language for company usage
|
|
1387
|
+
* @property {string} [direction] - Text direction setting for company content
|
|
1388
|
+
* in this language
|
|
1389
|
+
* @property {boolean} [is_default] - Indicates if this is the default language
|
|
1390
|
+
* for the company
|
|
1391
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1392
|
+
* English for easy reference and display at the website.
|
|
1393
|
+
*/
|
|
1394
|
+
/**
|
|
1395
|
+
* @typedef CompanyLanguageCreate
|
|
1396
|
+
* @property {string[]} locales - List of language codes to be added to company
|
|
1397
|
+
* configuration
|
|
1398
|
+
*/
|
|
1399
|
+
/**
|
|
1400
|
+
* @typedef CompanyLanguageUpdate
|
|
1401
|
+
* @property {boolean} is_default - Sets the specified language as the company default
|
|
1402
|
+
*/
|
|
1403
|
+
/**
|
|
1404
|
+
* @typedef ApplicationLanguage
|
|
1405
|
+
* @property {string} [_id] - Unique identifier for the application language setting
|
|
1406
|
+
* @property {string} company_id - Identifier of the company this application belongs to
|
|
1407
|
+
* @property {string} application_id - Unique identifier of the application
|
|
1408
|
+
* using this language
|
|
1409
|
+
* @property {string} locale - Language code following ISO standards for this application
|
|
1410
|
+
* @property {string} name - Display name of the language for application usage
|
|
1411
|
+
* @property {string} direction - Specifies the text direction for displaying
|
|
1412
|
+
* application content, either left-to-right (ltr) or right-to-left (rtl)
|
|
1413
|
+
* @property {boolean} is_default - Indicates if this is the default language
|
|
1414
|
+
* for the application
|
|
1415
|
+
* @property {boolean} published - Indicates whether this language is currently
|
|
1416
|
+
* active and visible within the storefront.
|
|
1417
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1418
|
+
* English for easy reference and display at the website.
|
|
1419
|
+
*/
|
|
1420
|
+
/**
|
|
1421
|
+
* @typedef unPublishApplicationLanguage
|
|
1422
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1423
|
+
*/
|
|
1424
|
+
/**
|
|
1425
|
+
* @typedef ApplicationLanguageCreate
|
|
1426
|
+
* @property {string[]} locales - List of language codes to be added to
|
|
1427
|
+
* application configuration
|
|
1428
|
+
*/
|
|
1429
|
+
/**
|
|
1430
|
+
* @typedef ApplicationLanguageUpdate
|
|
1431
|
+
* @property {boolean} is_default - Sets the specified language as the application default
|
|
1432
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1433
|
+
*/
|
|
1434
|
+
/**
|
|
1435
|
+
* @typedef TranslatableResource
|
|
1436
|
+
* @property {string} [_id] - Unique identifier for the translatable resource
|
|
1437
|
+
* @property {string} type - Categorizes the type of content that can be translated
|
|
1438
|
+
* @property {string} name - Display name of the translatable resource
|
|
1439
|
+
* @property {string} description - Detailed explanation of the translatable resource
|
|
1440
|
+
* @property {string} schema_type - Defines the processing type for the
|
|
1441
|
+
* translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
|
|
1442
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1443
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1444
|
+
* this resource
|
|
1445
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1446
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1447
|
+
* @property {TranslatableSection} [section_id]
|
|
1448
|
+
*/
|
|
1449
|
+
/**
|
|
1450
|
+
* @typedef ResourceDefinition
|
|
1451
|
+
* @property {string} [_id] - Unique identifier for the resource definition
|
|
1452
|
+
* @property {string} translatable_resource_id - Reference to the associated
|
|
1453
|
+
* translatable resource
|
|
1454
|
+
* @property {ResourceJsonSchema} [json_schema]
|
|
1455
|
+
* @property {ResourceUISchema} [ui_schema]
|
|
1456
|
+
* @property {ResourceBulkDetails} [bulk_details]
|
|
1457
|
+
*/
|
|
1458
|
+
/**
|
|
1459
|
+
* @typedef ResourceJsonSchema
|
|
1460
|
+
* @property {string} [schema]
|
|
1461
|
+
* @property {ResourceJsonSchemaType} [type]
|
|
1462
|
+
*/
|
|
1463
|
+
/**
|
|
1464
|
+
* @typedef ResourceJsonSchemaType
|
|
1465
|
+
* @property {Author} [author]
|
|
1466
|
+
* @property {Title} [title]
|
|
1467
|
+
* @property {FeatureImage} [feature_image]
|
|
1468
|
+
*/
|
|
1469
|
+
/**
|
|
1470
|
+
* @typedef ResourceUISchema
|
|
1471
|
+
* @property {Author} [author]
|
|
1472
|
+
* @property {Title} [title]
|
|
1473
|
+
* @property {FeatureImage} [feature_image]
|
|
1474
|
+
* @property {SeoTranslate} [seo]
|
|
1475
|
+
*/
|
|
1476
|
+
/**
|
|
1477
|
+
* @typedef ResourceBulkDetails
|
|
1478
|
+
* @property {string[]} [fields]
|
|
1479
|
+
*/
|
|
1480
|
+
/**
|
|
1481
|
+
* @typedef Title
|
|
1482
|
+
* @property {string} [ui_widget]
|
|
1483
|
+
* @property {boolean} [ui_description]
|
|
1484
|
+
*/
|
|
1485
|
+
/**
|
|
1486
|
+
* @typedef FeatureImage
|
|
1487
|
+
* @property {string} [secure_url] - URL of the secure image
|
|
1488
|
+
*/
|
|
1489
|
+
/**
|
|
1490
|
+
* @typedef SeoTranslate
|
|
1491
|
+
* @property {Title} [title]
|
|
1492
|
+
* @property {string} [description]
|
|
1493
|
+
* @property {string} [canonical_url]
|
|
1494
|
+
* @property {MetaTag[]} [meta_tags]
|
|
1495
|
+
*/
|
|
1496
|
+
/**
|
|
1497
|
+
* @typedef MetaTag
|
|
1498
|
+
* @property {string} [title] - Title of the meta tag
|
|
1499
|
+
* @property {MetaTagItem[]} [items]
|
|
1500
|
+
*/
|
|
1501
|
+
/**
|
|
1502
|
+
* @typedef MetaTagItem
|
|
1503
|
+
* @property {string} [key] - Key of the meta tag item
|
|
1504
|
+
* @property {string} [value] - Value of the meta tag item
|
|
1505
|
+
*/
|
|
1506
|
+
/**
|
|
1507
|
+
* @typedef ResourceTranslation
|
|
1508
|
+
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1509
|
+
* @property {string} [locale] - Language code for this translation
|
|
1510
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1511
|
+
*/
|
|
1512
|
+
/**
|
|
1513
|
+
* @typedef TranslationSeo
|
|
1514
|
+
* @property {string} [title] - Translated SEO title
|
|
1515
|
+
* @property {string[]} [breadcrumbs] - List of translated breadcrumbs
|
|
1516
|
+
* @property {string[]} [meta_tags] - List of translated meta tags
|
|
1517
|
+
* @property {string} [canonical_url] - Translated canonical URL
|
|
1518
|
+
* @property {string} [description] - Translated SEO description
|
|
1519
|
+
*/
|
|
1520
|
+
/**
|
|
1521
|
+
* @typedef ResourceTranslationList
|
|
1522
|
+
* @property {ResourceTranslationCreate[]} [items]
|
|
1523
|
+
*/
|
|
1524
|
+
/**
|
|
1525
|
+
* @typedef ResourceTranslationCreate
|
|
1526
|
+
* @property {string} [type] - Type of content being translated
|
|
1527
|
+
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1528
|
+
* @property {string} [locale] - Target language code for the translation
|
|
1529
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1530
|
+
*/
|
|
1531
|
+
/**
|
|
1532
|
+
* @typedef ResourceTranslationUpdate
|
|
1533
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1534
|
+
*/
|
|
1535
|
+
/**
|
|
1536
|
+
* @typedef TranslatableSection
|
|
1537
|
+
* @property {string} [_id] - Unique identifier for the translatable section
|
|
1538
|
+
* @property {string} [name] - Display name of the section
|
|
1539
|
+
* @property {string} [description] - Detailed explanation of the section's purpose
|
|
1540
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1541
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1542
|
+
* this resource
|
|
1543
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1544
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1545
|
+
*/
|
|
1546
|
+
/**
|
|
1547
|
+
* @typedef Metrics
|
|
1548
|
+
* @property {number} [total] - Total number of translation operations attempted
|
|
1549
|
+
* @property {number} [success] - Number of successful translation operations
|
|
1550
|
+
* @property {number} [failed] - Number of failed translation operations
|
|
1551
|
+
*/
|
|
1552
|
+
/**
|
|
1553
|
+
* @typedef ResourceTranslationUpsertItem
|
|
1554
|
+
* @property {string} [message] - Status message for the translation operation
|
|
1555
|
+
* @property {ResourceTranslationCreate} [data]
|
|
1556
|
+
*/
|
|
1557
|
+
/**
|
|
1558
|
+
* @typedef ResourceTranslationBulkUpsert
|
|
1559
|
+
* @property {Metrics} [metrics]
|
|
1560
|
+
* @property {ResourceTranslationUpsertItem[]} [failed_items] - List of failed
|
|
1561
|
+
* translation operations
|
|
1562
|
+
* @property {ResourceTranslationUpsertItem[]} [updated_items] - List of
|
|
1563
|
+
* successful translation operations
|
|
1564
|
+
*/
|
|
1565
|
+
/**
|
|
1566
|
+
* @typedef StandardError
|
|
1567
|
+
* @property {string} message - A brief description of the error.
|
|
1568
|
+
*/
|
|
1569
|
+
/**
|
|
1570
|
+
* @typedef OperationResponseSchema
|
|
1571
|
+
* @property {boolean} success - Indicates if the operation was successful
|
|
1572
|
+
* @property {string} [message] - Optional message providing additional
|
|
1573
|
+
* information about the operation
|
|
1574
|
+
*/
|
|
1575
|
+
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
1576
|
+
/**
|
|
1577
|
+
* @typedef {| "about-us"
|
|
1578
|
+
* | "addresses"
|
|
1579
|
+
* | "blog"
|
|
1580
|
+
* | "brands"
|
|
1581
|
+
* | "cards"
|
|
1582
|
+
* | "cart"
|
|
1583
|
+
* | "categories"
|
|
1584
|
+
* | "brand"
|
|
1585
|
+
* | "category"
|
|
1586
|
+
* | "collection"
|
|
1587
|
+
* | "collections"
|
|
1588
|
+
* | "custom"
|
|
1589
|
+
* | "contact-us"
|
|
1590
|
+
* | "external"
|
|
1591
|
+
* | "faq"
|
|
1592
|
+
* | "freshchat"
|
|
1593
|
+
* | "home"
|
|
1594
|
+
* | "notification-settings"
|
|
1595
|
+
* | "orders"
|
|
1596
|
+
* | "page"
|
|
1597
|
+
* | "policy"
|
|
1598
|
+
* | "product"
|
|
1599
|
+
* | "product-request"
|
|
1600
|
+
* | "products"
|
|
1601
|
+
* | "profile"
|
|
1602
|
+
* | "profile-order-shipment"
|
|
1603
|
+
* | "profile-basic"
|
|
1604
|
+
* | "profile-company"
|
|
1605
|
+
* | "profile-email"
|
|
1606
|
+
* | "profile-phone"
|
|
1607
|
+
* | "rate-us"
|
|
1608
|
+
* | "refer-earn"
|
|
1609
|
+
* | "settings"
|
|
1610
|
+
* | "shared-cart"
|
|
1611
|
+
* | "tnc"
|
|
1612
|
+
* | "track-order"
|
|
1613
|
+
* | "wishlist"
|
|
1614
|
+
* | "sections"
|
|
1225
1615
|
* | "form"
|
|
1226
1616
|
* | "cart-delivery"
|
|
1227
1617
|
* | "cart-payment"
|
|
@@ -1231,13 +1621,28 @@ export = ContentPlatformModel;
|
|
|
1231
1621
|
* | "shipping-policy"
|
|
1232
1622
|
* | "return-policy"
|
|
1233
1623
|
* | "order-status"
|
|
1234
|
-
* | "locate-us"
|
|
1624
|
+
* | "locate-us"
|
|
1625
|
+
* | "single-page-checkout"
|
|
1626
|
+
* | "request-reattempt"
|
|
1627
|
+
* | "files"} PageType
|
|
1235
1628
|
*/
|
|
1236
1629
|
declare class ContentPlatformModel {
|
|
1237
1630
|
}
|
|
1238
1631
|
declare namespace ContentPlatformModel {
|
|
1239
|
-
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule,
|
|
1632
|
+
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, TemplateSchema, TemplateField, CreateTagRequestSchema, DataLoaderSchema, TagsTemplateSchema, TagTemplateItem, TemplateLayout, FieldDefinition, FieldValidation, 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, SeoTranslate, MetaTag, MetaTagItem, ResourceTranslation, TranslationSeo, ResourceTranslationList, ResourceTranslationCreate, ResourceTranslationUpdate, TranslatableSection, Metrics, ResourceTranslationUpsertItem, ResourceTranslationBulkUpsert, StandardError, OperationResponseSchema, GenerationEntityType, PageType };
|
|
1240
1633
|
}
|
|
1634
|
+
/** @returns {ValidationError} */
|
|
1635
|
+
declare function ValidationError(): ValidationError;
|
|
1636
|
+
type ValidationError = {
|
|
1637
|
+
/**
|
|
1638
|
+
* - A brief description of the error encountered.
|
|
1639
|
+
*/
|
|
1640
|
+
message: string;
|
|
1641
|
+
/**
|
|
1642
|
+
* - The field in the request that caused the error.
|
|
1643
|
+
*/
|
|
1644
|
+
field: string;
|
|
1645
|
+
};
|
|
1241
1646
|
/** @returns {GenerateSEOContent} */
|
|
1242
1647
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
1243
1648
|
type GenerateSEOContent = {
|
|
@@ -1332,7 +1737,7 @@ declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
|
|
|
1332
1737
|
type SEOSchemaMarkupTemplate = {
|
|
1333
1738
|
id?: string;
|
|
1334
1739
|
title?: string;
|
|
1335
|
-
page_type?:
|
|
1740
|
+
page_type?: PageType;
|
|
1336
1741
|
schema?: string;
|
|
1337
1742
|
description?: string;
|
|
1338
1743
|
active?: boolean;
|
|
@@ -1345,7 +1750,7 @@ type SEOSchemaMarkupTemplate = {
|
|
|
1345
1750
|
declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
|
|
1346
1751
|
type SEOSchemaMarkupTemplateRequestBody = {
|
|
1347
1752
|
title?: string;
|
|
1348
|
-
page_type?:
|
|
1753
|
+
page_type?: PageType;
|
|
1349
1754
|
schema?: string;
|
|
1350
1755
|
description?: string;
|
|
1351
1756
|
target_json?: any;
|
|
@@ -1396,7 +1801,7 @@ type DefaultSchemaComponent = {
|
|
|
1396
1801
|
/** @returns {DefaultSEOSchemaMarkupTemplate} */
|
|
1397
1802
|
declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplate;
|
|
1398
1803
|
type DefaultSEOSchemaMarkupTemplate = {
|
|
1399
|
-
page_type?:
|
|
1804
|
+
page_type?: PageType;
|
|
1400
1805
|
schema?: string;
|
|
1401
1806
|
target_json?: any;
|
|
1402
1807
|
};
|
|
@@ -1415,9 +1820,9 @@ type NextSchedule = {
|
|
|
1415
1820
|
start?: string;
|
|
1416
1821
|
end?: string;
|
|
1417
1822
|
};
|
|
1418
|
-
/** @returns {
|
|
1419
|
-
declare function
|
|
1420
|
-
type
|
|
1823
|
+
/** @returns {BlogGetDetails} */
|
|
1824
|
+
declare function BlogGetDetails(): BlogGetDetails;
|
|
1825
|
+
type BlogGetDetails = {
|
|
1421
1826
|
items?: BlogSchema[];
|
|
1422
1827
|
page?: Page;
|
|
1423
1828
|
filters?: BlogFilters;
|
|
@@ -1445,6 +1850,9 @@ declare function Author(): Author;
|
|
|
1445
1850
|
type Author = {
|
|
1446
1851
|
designation?: string;
|
|
1447
1852
|
id?: string;
|
|
1853
|
+
/**
|
|
1854
|
+
* - Name of the author
|
|
1855
|
+
*/
|
|
1448
1856
|
name?: string;
|
|
1449
1857
|
};
|
|
1450
1858
|
/** @returns {BlogSchema} */
|
|
@@ -1513,9 +1921,9 @@ type DateMeta = {
|
|
|
1513
1921
|
created_on?: string;
|
|
1514
1922
|
modified_on?: string;
|
|
1515
1923
|
};
|
|
1516
|
-
/** @returns {
|
|
1517
|
-
declare function
|
|
1518
|
-
type
|
|
1924
|
+
/** @returns {BlogPayload} */
|
|
1925
|
+
declare function BlogPayload(): BlogPayload;
|
|
1926
|
+
type BlogPayload = {
|
|
1519
1927
|
application?: string;
|
|
1520
1928
|
_custom_json?: any;
|
|
1521
1929
|
author?: Author;
|
|
@@ -1605,24 +2013,6 @@ type CronBasedScheduleSchema = {
|
|
|
1605
2013
|
start?: string;
|
|
1606
2014
|
end?: string;
|
|
1607
2015
|
};
|
|
1608
|
-
/** @returns {ConfigurationSchema} */
|
|
1609
|
-
declare function ConfigurationSchema(): ConfigurationSchema;
|
|
1610
|
-
type ConfigurationSchema = {
|
|
1611
|
-
sleep_time?: number;
|
|
1612
|
-
start_on_launch?: boolean;
|
|
1613
|
-
duration?: number;
|
|
1614
|
-
slide_direction?: string;
|
|
1615
|
-
};
|
|
1616
|
-
/** @returns {SlideshowMedia} */
|
|
1617
|
-
declare function SlideshowMedia(): SlideshowMedia;
|
|
1618
|
-
type SlideshowMedia = {
|
|
1619
|
-
type?: string;
|
|
1620
|
-
url?: string;
|
|
1621
|
-
bg_color?: string;
|
|
1622
|
-
duration?: number;
|
|
1623
|
-
auto_decide_duration?: boolean;
|
|
1624
|
-
action?: Action;
|
|
1625
|
-
};
|
|
1626
2016
|
/** @returns {UpdateHandpickedSchema} */
|
|
1627
2017
|
declare function UpdateHandpickedSchema(): UpdateHandpickedSchema;
|
|
1628
2018
|
type UpdateHandpickedSchema = {
|
|
@@ -1631,35 +2021,160 @@ type UpdateHandpickedSchema = {
|
|
|
1631
2021
|
/** @returns {HandpickedTagSchema} */
|
|
1632
2022
|
declare function HandpickedTagSchema(): HandpickedTagSchema;
|
|
1633
2023
|
type HandpickedTagSchema = {
|
|
2024
|
+
/**
|
|
2025
|
+
* - The location in the page where the tag should
|
|
2026
|
+
* be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
2027
|
+
*/
|
|
1634
2028
|
position?: string;
|
|
2029
|
+
/**
|
|
2030
|
+
* - Additional attributes for the tag to define
|
|
2031
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
2032
|
+
* tag type for example:
|
|
2033
|
+
*
|
|
2034
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
2035
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
2036
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
2037
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
2038
|
+
*/
|
|
1635
2039
|
attributes?: any;
|
|
2040
|
+
/**
|
|
2041
|
+
* - List of UI frameworks where this
|
|
2042
|
+
* third-party tag can be injected or supported.
|
|
2043
|
+
*/
|
|
2044
|
+
compatible_engines?: string[];
|
|
2045
|
+
/**
|
|
2046
|
+
* - The name of the tag used to identify it in the
|
|
2047
|
+
* system. Example: 'Google External Script' or 'Bootstrap CSS'.
|
|
2048
|
+
*/
|
|
1636
2049
|
name?: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* - The URL where the external tag resource (such as a
|
|
2052
|
+
* script or stylesheet) is hosted.
|
|
2053
|
+
*/
|
|
1637
2054
|
url?: string;
|
|
2055
|
+
/**
|
|
2056
|
+
* - The type of the tag, such as 'script' (for
|
|
2057
|
+
* JavaScript) or 'link' (for CSS).
|
|
2058
|
+
*/
|
|
1638
2059
|
type?: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* - Defines whether the tag is embedded within
|
|
2062
|
+
* the HTML (inline) or linked externally (external).
|
|
2063
|
+
*/
|
|
1639
2064
|
sub_type?: string;
|
|
2065
|
+
/**
|
|
2066
|
+
* - The actual content of the inline tag, such as
|
|
2067
|
+
* JavaScript or CSS code if the tag is inline.
|
|
2068
|
+
*/
|
|
1640
2069
|
content?: string;
|
|
2070
|
+
template?: TemplateSchema;
|
|
1641
2071
|
};
|
|
1642
2072
|
/** @returns {RemoveHandpickedSchema} */
|
|
1643
2073
|
declare function RemoveHandpickedSchema(): RemoveHandpickedSchema;
|
|
1644
2074
|
type RemoveHandpickedSchema = {
|
|
2075
|
+
/**
|
|
2076
|
+
* - A list of tag IDs to remove from the system.
|
|
2077
|
+
*/
|
|
1645
2078
|
tags?: string[];
|
|
1646
2079
|
};
|
|
1647
2080
|
/** @returns {CreateTagSchema} */
|
|
1648
2081
|
declare function CreateTagSchema(): CreateTagSchema;
|
|
1649
2082
|
type CreateTagSchema = {
|
|
2083
|
+
/**
|
|
2084
|
+
* - The name of the tag to be created, used for
|
|
2085
|
+
* identification purposes.
|
|
2086
|
+
*/
|
|
1650
2087
|
name?: string;
|
|
2088
|
+
/**
|
|
2089
|
+
* - Indicates if the tag is external (linked) or
|
|
2090
|
+
* inline (embedded within the page).
|
|
2091
|
+
*/
|
|
1651
2092
|
sub_type?: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* - The unique identifier for the tag.
|
|
2095
|
+
*/
|
|
1652
2096
|
_id?: string;
|
|
2097
|
+
/**
|
|
2098
|
+
* - The type of the tag, either JavaScript ('js') or
|
|
2099
|
+
* CSS ('css').
|
|
2100
|
+
*/
|
|
1653
2101
|
type?: string;
|
|
2102
|
+
/**
|
|
2103
|
+
* - The external URL pointing to the script or
|
|
2104
|
+
* stylesheet resource.
|
|
2105
|
+
*/
|
|
1654
2106
|
url?: string;
|
|
2107
|
+
/**
|
|
2108
|
+
* - The position on the webpage where the tag
|
|
2109
|
+
* will be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
2110
|
+
*/
|
|
1655
2111
|
position?: string;
|
|
2112
|
+
/**
|
|
2113
|
+
* - Additional attributes for the tag to define
|
|
2114
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
2115
|
+
* tag type for example:
|
|
2116
|
+
*
|
|
2117
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
2118
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
2119
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
2120
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
2121
|
+
*/
|
|
1656
2122
|
attributes?: any;
|
|
2123
|
+
/**
|
|
2124
|
+
* - List of UI frameworks where this
|
|
2125
|
+
* third-party tag can be injected or supported.
|
|
2126
|
+
*/
|
|
2127
|
+
compatible_engines?: string[];
|
|
2128
|
+
/**
|
|
2129
|
+
* - Pages or environments where the tag should be
|
|
2130
|
+
* injected or active.
|
|
2131
|
+
*/
|
|
1657
2132
|
pages?: any[];
|
|
2133
|
+
/**
|
|
2134
|
+
* - The inline content for tags of type 'inline'
|
|
2135
|
+
* (e.g., JavaScript or CSS code).
|
|
2136
|
+
*/
|
|
1658
2137
|
content?: string;
|
|
2138
|
+
template?: TemplateSchema;
|
|
2139
|
+
};
|
|
2140
|
+
/** @returns {TemplateSchema} */
|
|
2141
|
+
declare function TemplateSchema(): TemplateSchema;
|
|
2142
|
+
type TemplateSchema = {
|
|
2143
|
+
/**
|
|
2144
|
+
* - Unique identifier for the template linked
|
|
2145
|
+
* to the tag.
|
|
2146
|
+
*/
|
|
2147
|
+
template_id?: string;
|
|
2148
|
+
/**
|
|
2149
|
+
* - Version number of the template used
|
|
2150
|
+
* for configuration.
|
|
2151
|
+
*/
|
|
2152
|
+
template_version?: string;
|
|
2153
|
+
/**
|
|
2154
|
+
* - List of dynamic key-value
|
|
2155
|
+
* pairs defining configuration fields for third-party integrations or custom settings.
|
|
2156
|
+
*/
|
|
2157
|
+
template_fields?: TemplateField[];
|
|
2158
|
+
};
|
|
2159
|
+
/** @returns {TemplateField} */
|
|
2160
|
+
declare function TemplateField(): TemplateField;
|
|
2161
|
+
type TemplateField = {
|
|
2162
|
+
/**
|
|
2163
|
+
* - Field name representing the configuration key.
|
|
2164
|
+
*/
|
|
2165
|
+
key?: string;
|
|
2166
|
+
/**
|
|
2167
|
+
* - Value assigned to the configuration field.
|
|
2168
|
+
*/
|
|
2169
|
+
value?: string;
|
|
1659
2170
|
};
|
|
1660
2171
|
/** @returns {CreateTagRequestSchema} */
|
|
1661
2172
|
declare function CreateTagRequestSchema(): CreateTagRequestSchema;
|
|
1662
2173
|
type CreateTagRequestSchema = {
|
|
2174
|
+
/**
|
|
2175
|
+
* - A list of tags to be created or
|
|
2176
|
+
* updated, each containing details such as name, type, and attributes.
|
|
2177
|
+
*/
|
|
1663
2178
|
tags?: CreateTagSchema[];
|
|
1664
2179
|
};
|
|
1665
2180
|
/** @returns {DataLoaderSchema} */
|
|
@@ -1674,6 +2189,137 @@ type DataLoaderSchema = {
|
|
|
1674
2189
|
__source?: DataLoaderSourceSchema;
|
|
1675
2190
|
_id?: string;
|
|
1676
2191
|
};
|
|
2192
|
+
/** @returns {TagsTemplateSchema} */
|
|
2193
|
+
declare function TagsTemplateSchema(): TagsTemplateSchema;
|
|
2194
|
+
type TagsTemplateSchema = {
|
|
2195
|
+
/**
|
|
2196
|
+
* - Array of tag template objects.
|
|
2197
|
+
*/
|
|
2198
|
+
items?: TagTemplateItem[];
|
|
2199
|
+
};
|
|
2200
|
+
/** @returns {TagTemplateItem} */
|
|
2201
|
+
declare function TagTemplateItem(): TagTemplateItem;
|
|
2202
|
+
type TagTemplateItem = {
|
|
2203
|
+
/**
|
|
2204
|
+
* - Static name of the tag template (e.g.,
|
|
2205
|
+
* gtm, ga4, metaPixel, sentry).
|
|
2206
|
+
*/
|
|
2207
|
+
template_name?: string;
|
|
2208
|
+
/**
|
|
2209
|
+
* - Script type.
|
|
2210
|
+
*/
|
|
2211
|
+
type?: string;
|
|
2212
|
+
/**
|
|
2213
|
+
* - Script loading subtype.
|
|
2214
|
+
*/
|
|
2215
|
+
sub_type?: string;
|
|
2216
|
+
/**
|
|
2217
|
+
* - Where the script should be injected.
|
|
2218
|
+
*/
|
|
2219
|
+
position?: string;
|
|
2220
|
+
/**
|
|
2221
|
+
* - List of page types where the tag should be active.
|
|
2222
|
+
*/
|
|
2223
|
+
pages?: string[];
|
|
2224
|
+
/**
|
|
2225
|
+
* - HTML attributes to apply on the script tag.
|
|
2226
|
+
*/
|
|
2227
|
+
attributes?: any;
|
|
2228
|
+
/**
|
|
2229
|
+
* - List of compatible UI frameworks.
|
|
2230
|
+
*/
|
|
2231
|
+
compatible_engines?: string[];
|
|
2232
|
+
/**
|
|
2233
|
+
* - Maps UI field names to backend keys.
|
|
2234
|
+
*/
|
|
2235
|
+
field_mappings?: any;
|
|
2236
|
+
layout?: TemplateLayout;
|
|
2237
|
+
/**
|
|
2238
|
+
* - Human-readable name of the template.
|
|
2239
|
+
*/
|
|
2240
|
+
name?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* - URL-safe path or slug for the template.
|
|
2243
|
+
*/
|
|
2244
|
+
path?: string;
|
|
2245
|
+
/**
|
|
2246
|
+
* - Explains the purpose or behavior of the template.
|
|
2247
|
+
*/
|
|
2248
|
+
description?: string;
|
|
2249
|
+
/**
|
|
2250
|
+
* - URL to an icon or image for the template.
|
|
2251
|
+
*/
|
|
2252
|
+
image?: string;
|
|
2253
|
+
/**
|
|
2254
|
+
* - Helpful guidance for configuring the template.
|
|
2255
|
+
*/
|
|
2256
|
+
note?: string;
|
|
2257
|
+
/**
|
|
2258
|
+
* - Unique template identifier.
|
|
2259
|
+
*/
|
|
2260
|
+
template_id?: string;
|
|
2261
|
+
/**
|
|
2262
|
+
* - Version of this template.
|
|
2263
|
+
*/
|
|
2264
|
+
template_version?: string;
|
|
2265
|
+
/**
|
|
2266
|
+
* - Functional category of the template.
|
|
2267
|
+
*/
|
|
2268
|
+
category?: string;
|
|
2269
|
+
/**
|
|
2270
|
+
* - Array of field definitions for
|
|
2271
|
+
* template configuration.
|
|
2272
|
+
*/
|
|
2273
|
+
fields?: FieldDefinition[];
|
|
2274
|
+
/**
|
|
2275
|
+
* - JavaScript snippet or template script code.
|
|
2276
|
+
*/
|
|
2277
|
+
script?: string;
|
|
2278
|
+
};
|
|
2279
|
+
/** @returns {TemplateLayout} */
|
|
2280
|
+
declare function TemplateLayout(): TemplateLayout;
|
|
2281
|
+
type TemplateLayout = {
|
|
2282
|
+
columns?: number;
|
|
2283
|
+
gap?: string;
|
|
2284
|
+
responsive?: boolean;
|
|
2285
|
+
};
|
|
2286
|
+
/** @returns {FieldDefinition} */
|
|
2287
|
+
declare function FieldDefinition(): FieldDefinition;
|
|
2288
|
+
type FieldDefinition = {
|
|
2289
|
+
/**
|
|
2290
|
+
* - Field key used in templates and mappings.
|
|
2291
|
+
*/
|
|
2292
|
+
name?: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* - Input type (e.g., text, boolean, array, note).
|
|
2295
|
+
*/
|
|
2296
|
+
type?: string;
|
|
2297
|
+
label?: string;
|
|
2298
|
+
placeholder?: string;
|
|
2299
|
+
required?: boolean;
|
|
2300
|
+
/**
|
|
2301
|
+
* - Visual width in the form layout.
|
|
2302
|
+
*/
|
|
2303
|
+
size?: string;
|
|
2304
|
+
description?: string;
|
|
2305
|
+
validation?: FieldValidation;
|
|
2306
|
+
/**
|
|
2307
|
+
* - Optional client-side events configuration.
|
|
2308
|
+
*/
|
|
2309
|
+
events?: any;
|
|
2310
|
+
};
|
|
2311
|
+
/** @returns {FieldValidation} */
|
|
2312
|
+
declare function FieldValidation(): FieldValidation;
|
|
2313
|
+
type FieldValidation = {
|
|
2314
|
+
/**
|
|
2315
|
+
* - Regex pattern used for validation.
|
|
2316
|
+
*/
|
|
2317
|
+
pattern?: string;
|
|
2318
|
+
/**
|
|
2319
|
+
* - Error message shown when validation fails.
|
|
2320
|
+
*/
|
|
2321
|
+
message?: string;
|
|
2322
|
+
};
|
|
1677
2323
|
/** @returns {DataLoaderSourceSchema} */
|
|
1678
2324
|
declare function DataLoaderSourceSchema(): DataLoaderSourceSchema;
|
|
1679
2325
|
type DataLoaderSourceSchema = {
|
|
@@ -1685,9 +2331,13 @@ declare function DataLoadersSchema(): DataLoadersSchema;
|
|
|
1685
2331
|
type DataLoadersSchema = {
|
|
1686
2332
|
items?: DataLoaderSchema[];
|
|
1687
2333
|
};
|
|
1688
|
-
/** @returns {
|
|
1689
|
-
declare function
|
|
1690
|
-
type
|
|
2334
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
2335
|
+
declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
|
|
2336
|
+
type TagDeleteSuccessDetails = {
|
|
2337
|
+
/**
|
|
2338
|
+
* - Indicates whether the tag removal operation
|
|
2339
|
+
* was successful.
|
|
2340
|
+
*/
|
|
1691
2341
|
success?: boolean;
|
|
1692
2342
|
};
|
|
1693
2343
|
/** @returns {ContentAPIError} */
|
|
@@ -1809,7 +2459,7 @@ type GetFaqCategoryBySlugSchema = {
|
|
|
1809
2459
|
declare function Page(): Page;
|
|
1810
2460
|
type Page = {
|
|
1811
2461
|
/**
|
|
1812
|
-
* - The total number of items
|
|
2462
|
+
* - The total number of all items across all pages.
|
|
1813
2463
|
*/
|
|
1814
2464
|
item_total?: number;
|
|
1815
2465
|
/**
|
|
@@ -1829,17 +2479,21 @@ type Page = {
|
|
|
1829
2479
|
*/
|
|
1830
2480
|
current?: number;
|
|
1831
2481
|
/**
|
|
1832
|
-
* - The type of the page,
|
|
2482
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
1833
2483
|
*/
|
|
1834
2484
|
type: string;
|
|
1835
2485
|
/**
|
|
1836
2486
|
* - The number of items per page.
|
|
1837
2487
|
*/
|
|
1838
2488
|
size?: number;
|
|
2489
|
+
/**
|
|
2490
|
+
* - The number of items per page.
|
|
2491
|
+
*/
|
|
2492
|
+
page_size?: number;
|
|
1839
2493
|
};
|
|
1840
|
-
/** @returns {
|
|
1841
|
-
declare function
|
|
1842
|
-
type
|
|
2494
|
+
/** @returns {LandingPageGetDetails} */
|
|
2495
|
+
declare function LandingPageGetDetails(): LandingPageGetDetails;
|
|
2496
|
+
type LandingPageGetDetails = {
|
|
1843
2497
|
items?: LandingPageSchema[];
|
|
1844
2498
|
page?: Page;
|
|
1845
2499
|
};
|
|
@@ -1856,14 +2510,14 @@ type LandingPageSchema = {
|
|
|
1856
2510
|
archived?: boolean;
|
|
1857
2511
|
_custom_json?: any;
|
|
1858
2512
|
};
|
|
1859
|
-
/** @returns {
|
|
1860
|
-
declare function
|
|
1861
|
-
type
|
|
2513
|
+
/** @returns {DefaultNavigationDetails} */
|
|
2514
|
+
declare function DefaultNavigationDetails(): DefaultNavigationDetails;
|
|
2515
|
+
type DefaultNavigationDetails = {
|
|
1862
2516
|
items?: NavigationSchema[];
|
|
1863
2517
|
};
|
|
1864
|
-
/** @returns {
|
|
1865
|
-
declare function
|
|
1866
|
-
type
|
|
2518
|
+
/** @returns {NavigationGetDetails} */
|
|
2519
|
+
declare function NavigationGetDetails(): NavigationGetDetails;
|
|
2520
|
+
type NavigationGetDetails = {
|
|
1867
2521
|
items?: NavigationSchema[];
|
|
1868
2522
|
page?: Page;
|
|
1869
2523
|
};
|
|
@@ -1888,18 +2542,18 @@ type NavigationSchema = {
|
|
|
1888
2542
|
version?: number;
|
|
1889
2543
|
navigation?: NavigationReference[];
|
|
1890
2544
|
};
|
|
1891
|
-
/** @returns {
|
|
1892
|
-
declare function
|
|
1893
|
-
type
|
|
2545
|
+
/** @returns {NavigationPayload} */
|
|
2546
|
+
declare function NavigationPayload(): NavigationPayload;
|
|
2547
|
+
type NavigationPayload = {
|
|
1894
2548
|
name?: string;
|
|
1895
2549
|
slug?: string;
|
|
1896
2550
|
platform?: string[];
|
|
1897
2551
|
orientation?: Orientation;
|
|
1898
2552
|
navigation?: NavigationReference[];
|
|
1899
2553
|
};
|
|
1900
|
-
/** @returns {
|
|
1901
|
-
declare function
|
|
1902
|
-
type
|
|
2554
|
+
/** @returns {PageGetDetails} */
|
|
2555
|
+
declare function PageGetDetails(): PageGetDetails;
|
|
2556
|
+
type PageGetDetails = {
|
|
1903
2557
|
items?: PageSchema[];
|
|
1904
2558
|
page?: Page;
|
|
1905
2559
|
};
|
|
@@ -1957,9 +2611,9 @@ declare function CreatedBySchema(): CreatedBySchema;
|
|
|
1957
2611
|
type CreatedBySchema = {
|
|
1958
2612
|
id?: string;
|
|
1959
2613
|
};
|
|
1960
|
-
/** @returns {
|
|
1961
|
-
declare function
|
|
1962
|
-
type
|
|
2614
|
+
/** @returns {PagePayload} */
|
|
2615
|
+
declare function PagePayload(): PagePayload;
|
|
2616
|
+
type PagePayload = {
|
|
1963
2617
|
_schedule?: CronSchedule;
|
|
1964
2618
|
application?: string;
|
|
1965
2619
|
author?: Author;
|
|
@@ -1982,9 +2636,9 @@ type CronSchedule = {
|
|
|
1982
2636
|
end?: string;
|
|
1983
2637
|
duration?: number;
|
|
1984
2638
|
};
|
|
1985
|
-
/** @returns {
|
|
1986
|
-
declare function
|
|
1987
|
-
type
|
|
2639
|
+
/** @returns {PagePublishPayload} */
|
|
2640
|
+
declare function PagePublishPayload(): PagePublishPayload;
|
|
2641
|
+
type PagePublishPayload = {
|
|
1988
2642
|
publish?: boolean;
|
|
1989
2643
|
};
|
|
1990
2644
|
/** @returns {PageMetaSchema} */
|
|
@@ -1994,39 +2648,10 @@ type PageMetaSchema = {
|
|
|
1994
2648
|
custom_pages?: PageSchema[];
|
|
1995
2649
|
application_id?: string;
|
|
1996
2650
|
};
|
|
1997
|
-
/** @returns {
|
|
1998
|
-
declare function
|
|
1999
|
-
type
|
|
2000
|
-
|
|
2001
|
-
page?: Page;
|
|
2002
|
-
};
|
|
2003
|
-
/** @returns {SlideshowSchema} */
|
|
2004
|
-
declare function SlideshowSchema(): SlideshowSchema;
|
|
2005
|
-
type SlideshowSchema = {
|
|
2006
|
-
_id?: string;
|
|
2007
|
-
slug?: string;
|
|
2008
|
-
date_meta?: DateMeta;
|
|
2009
|
-
application?: string;
|
|
2010
|
-
platform?: string;
|
|
2011
|
-
configuration?: ConfigurationSchema;
|
|
2012
|
-
media?: SlideshowMedia[];
|
|
2013
|
-
active?: boolean;
|
|
2014
|
-
archived?: boolean;
|
|
2015
|
-
_custom_json?: any;
|
|
2016
|
-
};
|
|
2017
|
-
/** @returns {SlideshowRequest} */
|
|
2018
|
-
declare function SlideshowRequest(): SlideshowRequest;
|
|
2019
|
-
type SlideshowRequest = {
|
|
2020
|
-
slug?: string;
|
|
2021
|
-
platform?: string;
|
|
2022
|
-
configuration?: ConfigurationSchema;
|
|
2023
|
-
media?: SlideshowMedia;
|
|
2024
|
-
active?: boolean;
|
|
2025
|
-
};
|
|
2026
|
-
/** @returns {Support} */
|
|
2027
|
-
declare function Support(): Support;
|
|
2028
|
-
type Support = {
|
|
2029
|
-
created?: boolean;
|
|
2651
|
+
/** @returns {Support} */
|
|
2652
|
+
declare function Support(): Support;
|
|
2653
|
+
type Support = {
|
|
2654
|
+
created?: boolean;
|
|
2030
2655
|
_id?: string;
|
|
2031
2656
|
application?: string;
|
|
2032
2657
|
created_at?: string;
|
|
@@ -2068,28 +2693,94 @@ type ContactSchema = {
|
|
|
2068
2693
|
/** @returns {TagsSchema} */
|
|
2069
2694
|
declare function TagsSchema(): TagsSchema;
|
|
2070
2695
|
type TagsSchema = {
|
|
2696
|
+
/**
|
|
2697
|
+
* - The ID of the application that owns the tags.
|
|
2698
|
+
*/
|
|
2071
2699
|
application?: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* - The unique identifier for the tag set.
|
|
2702
|
+
*/
|
|
2072
2703
|
_id?: string;
|
|
2704
|
+
/**
|
|
2705
|
+
* - The ID of the company associated with this tags.
|
|
2706
|
+
*/
|
|
2707
|
+
company?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* - A list of tags (HTML resources like scripts
|
|
2710
|
+
* or stylesheets) that are configured for the application.
|
|
2711
|
+
*/
|
|
2073
2712
|
tags?: TagSchema[];
|
|
2074
2713
|
};
|
|
2075
2714
|
/** @returns {TagSchema} */
|
|
2076
2715
|
declare function TagSchema(): TagSchema;
|
|
2077
2716
|
type TagSchema = {
|
|
2717
|
+
/**
|
|
2718
|
+
* - The name of the tag used to identify it.
|
|
2719
|
+
*/
|
|
2078
2720
|
name?: string;
|
|
2721
|
+
/**
|
|
2722
|
+
* - The URL where the external tag resource (such as a
|
|
2723
|
+
* script or stylesheet) is located.
|
|
2724
|
+
*/
|
|
2079
2725
|
url?: string;
|
|
2726
|
+
/**
|
|
2727
|
+
* - Specifies whether the tag is a JavaScript ('js')
|
|
2728
|
+
* or CSS ('css') tag.
|
|
2729
|
+
*/
|
|
2080
2730
|
type?: string;
|
|
2731
|
+
/**
|
|
2732
|
+
* - Indicates whether the tag is an external
|
|
2733
|
+
* resource (external) or inline content (inline).
|
|
2734
|
+
*/
|
|
2081
2735
|
sub_type?: string;
|
|
2736
|
+
/**
|
|
2737
|
+
* - The unique identifier for the tag in the system.
|
|
2738
|
+
*/
|
|
2082
2739
|
_id?: string;
|
|
2740
|
+
/**
|
|
2741
|
+
* - The position within the page where the tag
|
|
2742
|
+
* should be injected.
|
|
2743
|
+
*/
|
|
2083
2744
|
position?: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* - Additional attributes for the tag to define
|
|
2747
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
2748
|
+
* tag type for example:
|
|
2749
|
+
*
|
|
2750
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
2751
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
2752
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
2753
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
2754
|
+
*/
|
|
2084
2755
|
attributes?: any;
|
|
2756
|
+
/**
|
|
2757
|
+
* - Content of the tag if it is inline, such as
|
|
2758
|
+
* JavaScript or CSS code.
|
|
2759
|
+
*/
|
|
2085
2760
|
content?: string;
|
|
2761
|
+
/**
|
|
2762
|
+
* - List of UI frameworks where this
|
|
2763
|
+
* third-party tag can be injected or supported.
|
|
2764
|
+
*/
|
|
2765
|
+
compatible_engines?: string[];
|
|
2766
|
+
/**
|
|
2767
|
+
* - Pages or environments where the tag should be active.
|
|
2768
|
+
*/
|
|
2086
2769
|
pages?: any[];
|
|
2087
2770
|
__source?: TagSourceSchema;
|
|
2771
|
+
template?: TemplateSchema;
|
|
2088
2772
|
};
|
|
2089
2773
|
/** @returns {TagSourceSchema} */
|
|
2090
2774
|
declare function TagSourceSchema(): TagSourceSchema;
|
|
2091
2775
|
type TagSourceSchema = {
|
|
2776
|
+
/**
|
|
2777
|
+
* - The type of source, such as 'extension'
|
|
2778
|
+
*/
|
|
2092
2779
|
type?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* - The identifier of the source that created or
|
|
2782
|
+
* provided the tag.
|
|
2783
|
+
*/
|
|
2093
2784
|
id?: string;
|
|
2094
2785
|
};
|
|
2095
2786
|
/** @returns {ResourcesSchema} */
|
|
@@ -2116,99 +2807,310 @@ type ResourceSchema = {
|
|
|
2116
2807
|
/** @returns {FieldValidations} */
|
|
2117
2808
|
declare function FieldValidations(): FieldValidations;
|
|
2118
2809
|
type FieldValidations = {
|
|
2810
|
+
/**
|
|
2811
|
+
* - Name of validation
|
|
2812
|
+
*/
|
|
2119
2813
|
name?: string;
|
|
2814
|
+
/**
|
|
2815
|
+
* - Type of validation
|
|
2816
|
+
*/
|
|
2120
2817
|
type?: string;
|
|
2121
2818
|
value?: any;
|
|
2122
2819
|
};
|
|
2123
2820
|
/** @returns {FieldDefinitionSchema} */
|
|
2124
2821
|
declare function FieldDefinitionSchema(): FieldDefinitionSchema;
|
|
2125
2822
|
type FieldDefinitionSchema = {
|
|
2126
|
-
|
|
2127
|
-
|
|
2823
|
+
/**
|
|
2824
|
+
* - Unique system generated id
|
|
2825
|
+
*/
|
|
2826
|
+
id?: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* - Resource type to which custom field belongs
|
|
2829
|
+
*/
|
|
2128
2830
|
resource?: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* - Name of custom field
|
|
2833
|
+
*/
|
|
2129
2834
|
name?: string;
|
|
2835
|
+
/**
|
|
2836
|
+
* - Namespace of custom field
|
|
2837
|
+
*/
|
|
2130
2838
|
namespace?: string;
|
|
2131
|
-
|
|
2839
|
+
/**
|
|
2840
|
+
* - Slug of custom field
|
|
2841
|
+
*/
|
|
2842
|
+
slug?: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* - Description of custom field definition
|
|
2845
|
+
*/
|
|
2132
2846
|
description?: string;
|
|
2847
|
+
/**
|
|
2848
|
+
* - Data type of custom field
|
|
2849
|
+
*/
|
|
2133
2850
|
type?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* - Flag to denote whether custom field is
|
|
2853
|
+
* multivalued or not
|
|
2854
|
+
*/
|
|
2134
2855
|
multi_value?: boolean;
|
|
2856
|
+
/**
|
|
2857
|
+
* - List of validations applied
|
|
2858
|
+
*/
|
|
2135
2859
|
validations?: FieldValidations[];
|
|
2860
|
+
/**
|
|
2861
|
+
* - Id of company
|
|
2862
|
+
*/
|
|
2136
2863
|
company_id?: string;
|
|
2137
|
-
|
|
2138
|
-
|
|
2864
|
+
/**
|
|
2865
|
+
* - Whether the custom field is required or not
|
|
2866
|
+
*/
|
|
2139
2867
|
required?: boolean;
|
|
2868
|
+
/**
|
|
2869
|
+
* - Whether the custom field is deleted or not
|
|
2870
|
+
*/
|
|
2140
2871
|
is_deleted?: boolean;
|
|
2141
|
-
|
|
2142
|
-
|
|
2872
|
+
/**
|
|
2873
|
+
* - Type of type field
|
|
2874
|
+
*/
|
|
2143
2875
|
type_name?: string;
|
|
2876
|
+
/**
|
|
2877
|
+
* - Count of invalid fields after validation
|
|
2878
|
+
*/
|
|
2144
2879
|
invalid_fields_count?: number;
|
|
2145
2880
|
};
|
|
2146
2881
|
/** @returns {CustomFieldDefinitionsSchema} */
|
|
2147
2882
|
declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
|
|
2148
2883
|
type CustomFieldDefinitionsSchema = {
|
|
2884
|
+
/**
|
|
2885
|
+
* - List of custom field definitions
|
|
2886
|
+
*/
|
|
2149
2887
|
items?: FieldDefinitionSchema[];
|
|
2150
2888
|
page?: Page;
|
|
2151
2889
|
};
|
|
2152
2890
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2153
2891
|
declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
|
|
2154
2892
|
type CustomFieldDefinitionRequestSchema = {
|
|
2155
|
-
|
|
2893
|
+
/**
|
|
2894
|
+
* - Data type of custom field
|
|
2895
|
+
*/
|
|
2156
2896
|
type?: string;
|
|
2157
|
-
|
|
2897
|
+
/**
|
|
2898
|
+
* - Slug of custom field definition
|
|
2899
|
+
*/
|
|
2900
|
+
slug?: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* - Namespace of custom field definition
|
|
2903
|
+
*/
|
|
2158
2904
|
namespace?: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* - Flag to denote whether custom field is
|
|
2907
|
+
* multi valued or not
|
|
2908
|
+
*/
|
|
2159
2909
|
multi_value?: boolean;
|
|
2910
|
+
/**
|
|
2911
|
+
* - Name of custom field definition
|
|
2912
|
+
*/
|
|
2160
2913
|
name?: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* - Description of a custom field definition
|
|
2916
|
+
*/
|
|
2161
2917
|
description?: string;
|
|
2918
|
+
/**
|
|
2919
|
+
* - Validations for a custom field
|
|
2920
|
+
*/
|
|
2162
2921
|
validations?: FieldValidations[];
|
|
2163
2922
|
};
|
|
2164
2923
|
/** @returns {CustomObjectCustomFieldDefinitions} */
|
|
2165
2924
|
declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
|
|
2166
2925
|
type CustomObjectCustomFieldDefinitions = {
|
|
2926
|
+
/**
|
|
2927
|
+
* - Unique identifer for a custom field
|
|
2928
|
+
*/
|
|
2167
2929
|
id?: string;
|
|
2930
|
+
/**
|
|
2931
|
+
* - Data type of custom field
|
|
2932
|
+
*/
|
|
2168
2933
|
type?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* - Description of custom field
|
|
2936
|
+
*/
|
|
2169
2937
|
description?: string;
|
|
2938
|
+
/**
|
|
2939
|
+
* - Name of custom field
|
|
2940
|
+
*/
|
|
2170
2941
|
name?: string;
|
|
2942
|
+
/**
|
|
2943
|
+
* - Flag to denote if cusom field is multi
|
|
2944
|
+
* valued or not
|
|
2945
|
+
*/
|
|
2171
2946
|
multi_value?: boolean;
|
|
2947
|
+
/**
|
|
2948
|
+
* - Whether the field is required or not
|
|
2949
|
+
*/
|
|
2172
2950
|
required?: boolean;
|
|
2173
|
-
|
|
2951
|
+
/**
|
|
2952
|
+
* - Slug of custom field definition
|
|
2953
|
+
*/
|
|
2954
|
+
slug?: string;
|
|
2955
|
+
/**
|
|
2956
|
+
* - Validations added against the
|
|
2957
|
+
* custom field
|
|
2958
|
+
*/
|
|
2174
2959
|
validations?: FieldValidations[];
|
|
2175
2960
|
action?: string;
|
|
2176
2961
|
};
|
|
2177
2962
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2178
2963
|
declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
|
|
2179
2964
|
type CustomObjectDefinitionUpdateRequestSchema = {
|
|
2180
|
-
|
|
2965
|
+
/**
|
|
2966
|
+
* - Description of custom object definiton
|
|
2967
|
+
*/
|
|
2181
2968
|
description?: string;
|
|
2969
|
+
/**
|
|
2970
|
+
* - Name of custom object definition
|
|
2971
|
+
*/
|
|
2182
2972
|
name?: string;
|
|
2973
|
+
/**
|
|
2974
|
+
* - Custom field slug which is used as a
|
|
2975
|
+
* display key in
|
|
2976
|
+
*/
|
|
2183
2977
|
display_name_key?: string;
|
|
2184
2978
|
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2185
2979
|
};
|
|
2186
2980
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2187
2981
|
declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
|
|
2188
2982
|
type CustomFieldDefinitionDetailResSchema = {
|
|
2189
|
-
|
|
2983
|
+
/**
|
|
2984
|
+
* - Resource to which custom field is associated
|
|
2985
|
+
*/
|
|
2190
2986
|
resource?: string;
|
|
2987
|
+
/**
|
|
2988
|
+
* - Name of custom field
|
|
2989
|
+
*/
|
|
2191
2990
|
name?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* - Namespace of custom field
|
|
2993
|
+
*/
|
|
2192
2994
|
namespace?: string;
|
|
2193
|
-
|
|
2995
|
+
/**
|
|
2996
|
+
* - Slug of custom field
|
|
2997
|
+
*/
|
|
2998
|
+
slug?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* - Description regarding custom field
|
|
3001
|
+
*/
|
|
2194
3002
|
description?: string;
|
|
3003
|
+
/**
|
|
3004
|
+
* - Data type of custom field
|
|
3005
|
+
*/
|
|
2195
3006
|
type?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
* - Flag to denote whether custom field is
|
|
3009
|
+
* multi valued or not
|
|
3010
|
+
*/
|
|
2196
3011
|
multi_value?: boolean;
|
|
3012
|
+
/**
|
|
3013
|
+
* - Company Identifer
|
|
3014
|
+
*/
|
|
2197
3015
|
company_id?: string;
|
|
3016
|
+
/**
|
|
3017
|
+
* - Sales channel identifier
|
|
3018
|
+
*/
|
|
2198
3019
|
application_id?: string;
|
|
2199
|
-
|
|
2200
|
-
|
|
3020
|
+
/**
|
|
3021
|
+
* - Whether the customfield is required or not
|
|
3022
|
+
*/
|
|
2201
3023
|
required?: boolean;
|
|
3024
|
+
/**
|
|
3025
|
+
* - Is custom field deleted
|
|
3026
|
+
*/
|
|
2202
3027
|
is_deleted?: boolean;
|
|
2203
|
-
|
|
3028
|
+
/**
|
|
3029
|
+
* - Unique system generated id
|
|
3030
|
+
*/
|
|
3031
|
+
id?: string;
|
|
3032
|
+
validations?: any[];
|
|
3033
|
+
/**
|
|
3034
|
+
* - Date time at which field was created
|
|
3035
|
+
*/
|
|
3036
|
+
created_at?: string;
|
|
3037
|
+
/**
|
|
3038
|
+
* - Date time at for a field's last modification
|
|
3039
|
+
*/
|
|
3040
|
+
updated_at?: string;
|
|
3041
|
+
};
|
|
3042
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
3043
|
+
declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
|
|
3044
|
+
type MetaFieldDefinitionDetailResSchema = {
|
|
3045
|
+
/**
|
|
3046
|
+
* - Resource to which meta field is associated
|
|
3047
|
+
*/
|
|
3048
|
+
resource?: string;
|
|
3049
|
+
/**
|
|
3050
|
+
* - Name of meta field
|
|
3051
|
+
*/
|
|
3052
|
+
name?: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* - Namespace of meta field
|
|
3055
|
+
*/
|
|
3056
|
+
namespace?: string;
|
|
3057
|
+
/**
|
|
3058
|
+
* - Slug of meta field
|
|
3059
|
+
*/
|
|
3060
|
+
slug?: string;
|
|
3061
|
+
/**
|
|
3062
|
+
* - Description regarding meta field
|
|
3063
|
+
*/
|
|
3064
|
+
description?: string;
|
|
3065
|
+
/**
|
|
3066
|
+
* - Data type of meta field
|
|
3067
|
+
*/
|
|
3068
|
+
type?: string;
|
|
3069
|
+
/**
|
|
3070
|
+
* - Flag to denote whether meta field is
|
|
3071
|
+
* multi valued or not
|
|
3072
|
+
*/
|
|
3073
|
+
multi_value?: boolean;
|
|
3074
|
+
/**
|
|
3075
|
+
* - Company Identifer
|
|
3076
|
+
*/
|
|
3077
|
+
company_id?: string;
|
|
3078
|
+
/**
|
|
3079
|
+
* - Sales channel identifier
|
|
3080
|
+
*/
|
|
3081
|
+
application_id?: string;
|
|
3082
|
+
/**
|
|
3083
|
+
* - Whether the field is required or not
|
|
3084
|
+
*/
|
|
3085
|
+
required?: boolean;
|
|
3086
|
+
/**
|
|
3087
|
+
* - Is meta field deleted
|
|
3088
|
+
*/
|
|
3089
|
+
is_deleted?: boolean;
|
|
3090
|
+
/**
|
|
3091
|
+
* - Unique system generated id
|
|
3092
|
+
*/
|
|
3093
|
+
id?: string;
|
|
2204
3094
|
validations?: any[];
|
|
3095
|
+
/**
|
|
3096
|
+
* - Date time at which field was created
|
|
3097
|
+
*/
|
|
2205
3098
|
created_at?: string;
|
|
3099
|
+
/**
|
|
3100
|
+
* - Date time at for a field's last modification
|
|
3101
|
+
*/
|
|
2206
3102
|
updated_at?: string;
|
|
2207
3103
|
};
|
|
2208
3104
|
/** @returns {CustomDataDeleteSchema} */
|
|
2209
3105
|
declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
|
|
2210
3106
|
type CustomDataDeleteSchema = {
|
|
3107
|
+
/**
|
|
3108
|
+
* - Denotes the success of the delete operation
|
|
3109
|
+
*/
|
|
2211
3110
|
success?: boolean;
|
|
3111
|
+
/**
|
|
3112
|
+
* - Denotes the message of delete operation
|
|
3113
|
+
*/
|
|
2212
3114
|
message?: string;
|
|
2213
3115
|
};
|
|
2214
3116
|
/** @returns {CustomFieldValue} */
|
|
@@ -2219,22 +3121,52 @@ type CustomFieldValue = {
|
|
|
2219
3121
|
/** @returns {CustomFieldSchema} */
|
|
2220
3122
|
declare function CustomFieldSchema(): CustomFieldSchema;
|
|
2221
3123
|
type CustomFieldSchema = {
|
|
2222
|
-
|
|
3124
|
+
/**
|
|
3125
|
+
* - Unique system generated id
|
|
3126
|
+
*/
|
|
3127
|
+
id?: string;
|
|
3128
|
+
/**
|
|
3129
|
+
* - Namespace of custom field definition
|
|
3130
|
+
*/
|
|
2223
3131
|
namespace?: string;
|
|
2224
|
-
|
|
3132
|
+
/**
|
|
3133
|
+
* - Slug of custom field definition
|
|
3134
|
+
*/
|
|
3135
|
+
slug?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* - The resource for which custom field is being created
|
|
3138
|
+
*/
|
|
2225
3139
|
resource?: string;
|
|
2226
|
-
creator?: string;
|
|
2227
3140
|
value?: CustomFieldValue[];
|
|
2228
|
-
|
|
3141
|
+
/**
|
|
3142
|
+
* - Unique identifier of the resource
|
|
3143
|
+
*/
|
|
3144
|
+
resource_slug?: string;
|
|
3145
|
+
/**
|
|
3146
|
+
* - Data type of custom field
|
|
3147
|
+
*/
|
|
2229
3148
|
type?: string;
|
|
3149
|
+
/**
|
|
3150
|
+
* - Whether custom field is multi valued
|
|
3151
|
+
*/
|
|
2230
3152
|
multi_value?: boolean;
|
|
3153
|
+
/**
|
|
3154
|
+
* - Identifer for a company
|
|
3155
|
+
*/
|
|
2231
3156
|
company_id?: string;
|
|
2232
|
-
definition_id?: string;
|
|
2233
3157
|
has_invalid_values?: boolean;
|
|
2234
3158
|
invalid_value_errors?: any[];
|
|
2235
|
-
|
|
3159
|
+
/**
|
|
3160
|
+
* - Indicates whether custom field is deleted
|
|
3161
|
+
*/
|
|
2236
3162
|
is_deleted?: boolean;
|
|
3163
|
+
/**
|
|
3164
|
+
* - Time at which customer field was created
|
|
3165
|
+
*/
|
|
2237
3166
|
created_at?: string;
|
|
3167
|
+
/**
|
|
3168
|
+
* - Time at which custom field was updated
|
|
3169
|
+
*/
|
|
2238
3170
|
updated_at?: string;
|
|
2239
3171
|
};
|
|
2240
3172
|
/** @returns {CustomFieldsResponseSchema} */
|
|
@@ -2243,6 +3175,12 @@ type CustomFieldsResponseSchema = {
|
|
|
2243
3175
|
items?: CustomFieldSchema[];
|
|
2244
3176
|
page?: Page;
|
|
2245
3177
|
};
|
|
3178
|
+
/** @returns {CustomFieldsDeleteSchema} */
|
|
3179
|
+
declare function CustomFieldsDeleteSchema(): CustomFieldsDeleteSchema;
|
|
3180
|
+
type CustomFieldsDeleteSchema = {
|
|
3181
|
+
success?: boolean;
|
|
3182
|
+
message?: string;
|
|
3183
|
+
};
|
|
2246
3184
|
/** @returns {CustomFieldsResponseByResourceIdSchema} */
|
|
2247
3185
|
declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
|
|
2248
3186
|
type CustomFieldsResponseByResourceIdSchema = {
|
|
@@ -2252,7 +3190,15 @@ type CustomFieldsResponseByResourceIdSchema = {
|
|
|
2252
3190
|
declare function CustomField(): CustomField;
|
|
2253
3191
|
type CustomField = {
|
|
2254
3192
|
value?: any[];
|
|
2255
|
-
|
|
3193
|
+
/**
|
|
3194
|
+
* - This is the namespace to which custom field belongs
|
|
3195
|
+
*/
|
|
3196
|
+
namespace?: string;
|
|
3197
|
+
/**
|
|
3198
|
+
* - This is the slug of custom field used while
|
|
3199
|
+
* creating a custom field definition
|
|
3200
|
+
*/
|
|
3201
|
+
slug?: string;
|
|
2256
3202
|
};
|
|
2257
3203
|
/** @returns {CustomFieldRequestSchema} */
|
|
2258
3204
|
declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
|
|
@@ -2262,160 +3208,368 @@ type CustomFieldRequestSchema = {
|
|
|
2262
3208
|
/** @returns {CustomObjectSchema} */
|
|
2263
3209
|
declare function CustomObjectSchema(): CustomObjectSchema;
|
|
2264
3210
|
type CustomObjectSchema = {
|
|
2265
|
-
|
|
2266
|
-
|
|
3211
|
+
/**
|
|
3212
|
+
* - Unique system generated id
|
|
3213
|
+
*/
|
|
3214
|
+
id?: string;
|
|
3215
|
+
/**
|
|
3216
|
+
* - Identifer for a company
|
|
3217
|
+
*/
|
|
2267
3218
|
company_id?: string;
|
|
3219
|
+
/**
|
|
3220
|
+
* - Identifer for a sales channel
|
|
3221
|
+
*/
|
|
2268
3222
|
application_id?: string;
|
|
2269
|
-
|
|
2270
|
-
|
|
3223
|
+
/**
|
|
3224
|
+
* - Status of custom object
|
|
3225
|
+
*/
|
|
2271
3226
|
status?: string;
|
|
3227
|
+
/**
|
|
3228
|
+
* - Slug of custom object definition
|
|
3229
|
+
*/
|
|
2272
3230
|
type?: string;
|
|
3231
|
+
/**
|
|
3232
|
+
* - Slug for custom object definition
|
|
3233
|
+
*/
|
|
3234
|
+
definition_slug?: string;
|
|
3235
|
+
/**
|
|
3236
|
+
* - Value of custom field used for displaying
|
|
3237
|
+
* custom object
|
|
3238
|
+
*/
|
|
2273
3239
|
display_name?: string;
|
|
2274
|
-
|
|
3240
|
+
/**
|
|
3241
|
+
* - Fields associated to the custom object
|
|
3242
|
+
*/
|
|
2275
3243
|
fields?: CustomFieldSchema[];
|
|
2276
3244
|
};
|
|
2277
3245
|
/** @returns {CustomObjectDefinitionRequestSchema} */
|
|
2278
3246
|
declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
|
|
2279
3247
|
type CustomObjectDefinitionRequestSchema = {
|
|
3248
|
+
/**
|
|
3249
|
+
* - Namespace/Slug of Custom object definition
|
|
3250
|
+
*/
|
|
2280
3251
|
type?: string;
|
|
3252
|
+
/**
|
|
3253
|
+
* - Unique slug for a custom object definition
|
|
3254
|
+
*/
|
|
3255
|
+
definition_slug?: string;
|
|
3256
|
+
/**
|
|
3257
|
+
* - Description of custom object definition
|
|
3258
|
+
*/
|
|
2281
3259
|
description?: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* - Name of custom object
|
|
3262
|
+
*/
|
|
2282
3263
|
name?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* - Denotes which custom field to be used
|
|
3266
|
+
* for displaying custom object
|
|
3267
|
+
*/
|
|
2283
3268
|
display_name_key?: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* - List
|
|
3271
|
+
* of custom field definitions belonging to this custom object definition
|
|
3272
|
+
*/
|
|
2284
3273
|
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2285
3274
|
};
|
|
2286
|
-
/** @returns {
|
|
2287
|
-
declare function
|
|
2288
|
-
type
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
multi_value?: boolean;
|
|
2297
|
-
validations?: FieldValidations[];
|
|
2298
|
-
company_id?: string;
|
|
2299
|
-
created_by?: string;
|
|
2300
|
-
metaobject_definition_id?: string;
|
|
2301
|
-
required?: boolean;
|
|
2302
|
-
is_deleted?: boolean;
|
|
2303
|
-
_id?: string;
|
|
2304
|
-
created_at?: string;
|
|
2305
|
-
updated_at?: string;
|
|
2306
|
-
};
|
|
2307
|
-
/** @returns {CustomObjectDefinitionSchema} */
|
|
2308
|
-
declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
|
|
2309
|
-
type CustomObjectDefinitionSchema = {
|
|
2310
|
-
_id?: string;
|
|
3275
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
3276
|
+
declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
|
|
3277
|
+
type CustomObjectDefinitionSlugSchema = {
|
|
3278
|
+
/**
|
|
3279
|
+
* - Unique system generated custom object definition id
|
|
3280
|
+
*/
|
|
3281
|
+
id?: string;
|
|
3282
|
+
/**
|
|
3283
|
+
* - Display name of custom object definition
|
|
3284
|
+
*/
|
|
2311
3285
|
name?: string;
|
|
3286
|
+
/**
|
|
3287
|
+
* - Type of custom object definiton
|
|
3288
|
+
*/
|
|
2312
3289
|
type?: string;
|
|
3290
|
+
/**
|
|
3291
|
+
* - Slug of custom object definiton
|
|
3292
|
+
*/
|
|
3293
|
+
definition_slug?: string;
|
|
3294
|
+
/**
|
|
3295
|
+
* - Display name of custom object definition
|
|
3296
|
+
*/
|
|
2313
3297
|
display_name_key?: string;
|
|
3298
|
+
/**
|
|
3299
|
+
* - Description of custom object definition
|
|
3300
|
+
*/
|
|
2314
3301
|
description?: string;
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
3302
|
+
/**
|
|
3303
|
+
* -
|
|
3304
|
+
* Custom fields inside custom objects
|
|
3305
|
+
*/
|
|
3306
|
+
field_definitions?: CustomFieldDefinitionDetailResSchema[];
|
|
2319
3307
|
};
|
|
2320
3308
|
/** @returns {CustomObjectDefinitionDeleteResponseSchema} */
|
|
2321
3309
|
declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
|
|
2322
3310
|
type CustomObjectDefinitionDeleteResponseSchema = {
|
|
3311
|
+
/**
|
|
3312
|
+
* - Success status of delete custom object definition.
|
|
3313
|
+
*/
|
|
2323
3314
|
success?: boolean;
|
|
3315
|
+
/**
|
|
3316
|
+
* - Response message when custom object definition
|
|
3317
|
+
* is deleted.
|
|
3318
|
+
*/
|
|
2324
3319
|
message?: string;
|
|
2325
3320
|
};
|
|
2326
|
-
/** @returns {
|
|
2327
|
-
declare function
|
|
2328
|
-
type
|
|
3321
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
3322
|
+
declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
|
|
3323
|
+
type CustomObjectEntryBulkUploadDetails = {
|
|
3324
|
+
/**
|
|
3325
|
+
* - Signed url of csv
|
|
3326
|
+
*/
|
|
2329
3327
|
url?: string;
|
|
3328
|
+
/**
|
|
3329
|
+
* - Total no of records in csv file
|
|
3330
|
+
*/
|
|
2330
3331
|
total_records?: number;
|
|
2331
3332
|
};
|
|
2332
|
-
/** @returns {
|
|
2333
|
-
declare function
|
|
2334
|
-
type
|
|
2335
|
-
|
|
3333
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
3334
|
+
declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
|
|
3335
|
+
type CustomObjectListItemDefinitionModel = {
|
|
3336
|
+
/**
|
|
3337
|
+
* - Unique system generated id
|
|
3338
|
+
*/
|
|
3339
|
+
id?: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* - Name of custom object
|
|
3342
|
+
*/
|
|
2336
3343
|
name?: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* - Type of custom object entry
|
|
3346
|
+
*/
|
|
2337
3347
|
type?: string;
|
|
2338
3348
|
};
|
|
2339
3349
|
/** @returns {CustomObjectListItemSchema} */
|
|
2340
3350
|
declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
|
|
2341
3351
|
type CustomObjectListItemSchema = {
|
|
2342
|
-
|
|
2343
|
-
|
|
3352
|
+
/**
|
|
3353
|
+
* - Unique system generated id
|
|
3354
|
+
*/
|
|
3355
|
+
id?: string;
|
|
3356
|
+
/**
|
|
3357
|
+
* - Status of custom object
|
|
3358
|
+
*/
|
|
2344
3359
|
status?: string;
|
|
3360
|
+
/**
|
|
3361
|
+
* - Creation time of custom object document
|
|
3362
|
+
*/
|
|
3363
|
+
created_at?: string;
|
|
3364
|
+
/**
|
|
3365
|
+
* - Updation time of custom object document
|
|
3366
|
+
*/
|
|
2345
3367
|
updated_at?: string;
|
|
3368
|
+
/**
|
|
3369
|
+
* - Display name of custom object
|
|
3370
|
+
*/
|
|
2346
3371
|
display_name?: string;
|
|
2347
|
-
definition?:
|
|
3372
|
+
definition?: CustomObjectListItemDefinitionModel;
|
|
3373
|
+
/**
|
|
3374
|
+
* - References of the custom object entry
|
|
3375
|
+
*/
|
|
2348
3376
|
references?: number;
|
|
2349
3377
|
};
|
|
2350
3378
|
/** @returns {CustomObjectsSchema} */
|
|
2351
3379
|
declare function CustomObjectsSchema(): CustomObjectsSchema;
|
|
2352
3380
|
type CustomObjectsSchema = {
|
|
3381
|
+
/**
|
|
3382
|
+
* - List of paginated custom
|
|
3383
|
+
* object entries
|
|
3384
|
+
*/
|
|
2353
3385
|
items?: CustomObjectListItemSchema[];
|
|
2354
3386
|
page?: Page;
|
|
2355
3387
|
};
|
|
2356
|
-
/** @returns {
|
|
2357
|
-
declare function
|
|
2358
|
-
type
|
|
2359
|
-
|
|
2360
|
-
|
|
3388
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
3389
|
+
declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
|
|
3390
|
+
type CustomObjectFieldDefinition = {
|
|
3391
|
+
/**
|
|
3392
|
+
* - Unique system generate id
|
|
3393
|
+
*/
|
|
3394
|
+
id?: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* - Slug of custom field definition
|
|
3397
|
+
*/
|
|
3398
|
+
slug?: string;
|
|
3399
|
+
/**
|
|
3400
|
+
* - Namespace of custom field definition
|
|
3401
|
+
*/
|
|
3402
|
+
namespace?: string;
|
|
3403
|
+
/**
|
|
3404
|
+
* - Value of custom field
|
|
3405
|
+
*/
|
|
2361
3406
|
value?: any[];
|
|
3407
|
+
/**
|
|
3408
|
+
* - Data type of the custom field
|
|
3409
|
+
*/
|
|
2362
3410
|
type?: string;
|
|
2363
|
-
definition_id?: string;
|
|
2364
3411
|
};
|
|
2365
|
-
/** @returns {
|
|
2366
|
-
declare function
|
|
2367
|
-
type
|
|
2368
|
-
|
|
3412
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
3413
|
+
declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
|
|
3414
|
+
type CustomObjectBySlugSchema = {
|
|
3415
|
+
/**
|
|
3416
|
+
* - Unique system generated identifer for a Custom Object
|
|
3417
|
+
*/
|
|
3418
|
+
id?: string;
|
|
3419
|
+
/**
|
|
3420
|
+
* - Status of Custom Object
|
|
3421
|
+
*/
|
|
2369
3422
|
status?: string;
|
|
3423
|
+
/**
|
|
3424
|
+
* - Display name for the Custom Object
|
|
3425
|
+
*/
|
|
2370
3426
|
display_name?: string;
|
|
2371
|
-
definition?:
|
|
3427
|
+
definition?: CustomObjectListItemDefinitionModel;
|
|
3428
|
+
/**
|
|
3429
|
+
* - Places where the custom object has been
|
|
3430
|
+
* used as a custom field
|
|
3431
|
+
*/
|
|
2372
3432
|
references?: any[];
|
|
2373
|
-
|
|
3433
|
+
/**
|
|
3434
|
+
* - Slug of custom object entry
|
|
3435
|
+
*/
|
|
3436
|
+
slug?: string;
|
|
3437
|
+
/**
|
|
3438
|
+
* - Slug of custom object definition
|
|
3439
|
+
*/
|
|
3440
|
+
definition_slug?: string;
|
|
3441
|
+
/**
|
|
3442
|
+
* - List of custom fields
|
|
3443
|
+
* inside the custom object
|
|
3444
|
+
*/
|
|
3445
|
+
fields?: CustomObjectFieldDefinition[];
|
|
2374
3446
|
};
|
|
2375
3447
|
/** @returns {CustomObjectBulkEntryInitiateDownload} */
|
|
2376
3448
|
declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
|
|
2377
3449
|
type CustomObjectBulkEntryInitiateDownload = {
|
|
3450
|
+
/**
|
|
3451
|
+
* - Message for the user
|
|
3452
|
+
*/
|
|
2378
3453
|
message?: string;
|
|
3454
|
+
/**
|
|
3455
|
+
* - Identifer for a task
|
|
3456
|
+
*/
|
|
2379
3457
|
task_id?: string;
|
|
2380
3458
|
};
|
|
2381
3459
|
/** @returns {CustomObjectMetaSchema} */
|
|
2382
3460
|
declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
|
|
2383
3461
|
type CustomObjectMetaSchema = {
|
|
3462
|
+
/**
|
|
3463
|
+
* - Total number of entries in the bulk entry
|
|
3464
|
+
*/
|
|
2384
3465
|
mo_total_count?: number;
|
|
3466
|
+
/**
|
|
3467
|
+
* - Number of entries which were successful
|
|
3468
|
+
*/
|
|
2385
3469
|
mo_success_count?: number;
|
|
3470
|
+
/**
|
|
3471
|
+
* - Number of entries which were failed
|
|
3472
|
+
*/
|
|
2386
3473
|
mo_error_count?: number;
|
|
3474
|
+
/**
|
|
3475
|
+
* - Type of object
|
|
3476
|
+
*/
|
|
2387
3477
|
mo_defintion_type?: string;
|
|
2388
3478
|
};
|
|
2389
|
-
/** @returns {
|
|
2390
|
-
declare function
|
|
2391
|
-
type
|
|
2392
|
-
|
|
3479
|
+
/** @returns {JobSchema} */
|
|
3480
|
+
declare function JobSchema(): JobSchema;
|
|
3481
|
+
type JobSchema = {
|
|
3482
|
+
/**
|
|
3483
|
+
* - Unique system generated id
|
|
3484
|
+
*/
|
|
3485
|
+
id?: string;
|
|
3486
|
+
/**
|
|
3487
|
+
* - List of total jobs
|
|
3488
|
+
*/
|
|
2393
3489
|
jobs?: string[];
|
|
3490
|
+
/**
|
|
3491
|
+
* - List of finished jobs
|
|
3492
|
+
*/
|
|
2394
3493
|
finished_jobs?: string[];
|
|
3494
|
+
/**
|
|
3495
|
+
* - List of jobs which resulted in an error
|
|
3496
|
+
*/
|
|
2395
3497
|
error_jobs?: string[];
|
|
3498
|
+
/**
|
|
3499
|
+
* - List of errors occurred in the job
|
|
3500
|
+
*/
|
|
2396
3501
|
errors_occured?: string[];
|
|
3502
|
+
/**
|
|
3503
|
+
* - Company Identifer
|
|
3504
|
+
*/
|
|
2397
3505
|
company_id?: string;
|
|
2398
|
-
|
|
2399
|
-
|
|
3506
|
+
/**
|
|
3507
|
+
* - Status of job
|
|
3508
|
+
*/
|
|
2400
3509
|
status?: string;
|
|
3510
|
+
/**
|
|
3511
|
+
* - Type of job
|
|
3512
|
+
*/
|
|
2401
3513
|
action_type?: string;
|
|
3514
|
+
/**
|
|
3515
|
+
* - Entity against which job is running
|
|
3516
|
+
*/
|
|
2402
3517
|
entity?: string;
|
|
3518
|
+
/**
|
|
3519
|
+
* - URL which contains the file with errors
|
|
3520
|
+
*/
|
|
2403
3521
|
error_url?: string;
|
|
3522
|
+
/**
|
|
3523
|
+
* - Number of items successfully finished
|
|
3524
|
+
*/
|
|
2404
3525
|
finished_count?: number;
|
|
3526
|
+
/**
|
|
3527
|
+
* - Number of items in error
|
|
3528
|
+
*/
|
|
2405
3529
|
error_count?: number;
|
|
3530
|
+
/**
|
|
3531
|
+
* - Number of successful items
|
|
3532
|
+
*/
|
|
2406
3533
|
success_count?: number;
|
|
3534
|
+
/**
|
|
3535
|
+
* - Total number of jobs
|
|
3536
|
+
*/
|
|
2407
3537
|
total_jobs?: number;
|
|
2408
3538
|
meta?: CustomObjectMetaSchema;
|
|
3539
|
+
/**
|
|
3540
|
+
* - Source from where the bulk job is created
|
|
3541
|
+
*/
|
|
2409
3542
|
created_by?: string;
|
|
3543
|
+
/**
|
|
3544
|
+
* - Date/Time when the job was created
|
|
3545
|
+
*/
|
|
2410
3546
|
created_at?: string;
|
|
3547
|
+
/**
|
|
3548
|
+
* - Date/Time when the job was updated
|
|
3549
|
+
*/
|
|
2411
3550
|
updated_at?: string;
|
|
3551
|
+
/**
|
|
3552
|
+
* - Sales Channel Identifier
|
|
3553
|
+
*/
|
|
3554
|
+
application_id?: string;
|
|
3555
|
+
};
|
|
3556
|
+
/** @returns {CustomFieldBulkEntry} */
|
|
3557
|
+
declare function CustomFieldBulkEntry(): CustomFieldBulkEntry;
|
|
3558
|
+
type CustomFieldBulkEntry = {
|
|
3559
|
+
items?: JobSchema[];
|
|
3560
|
+
page?: Page;
|
|
2412
3561
|
};
|
|
2413
3562
|
/** @returns {CustomObjectBulkEntry} */
|
|
2414
3563
|
declare function CustomObjectBulkEntry(): CustomObjectBulkEntry;
|
|
2415
3564
|
type CustomObjectBulkEntry = {
|
|
2416
|
-
items?:
|
|
3565
|
+
items?: JobSchema[];
|
|
2417
3566
|
page?: Page;
|
|
2418
3567
|
};
|
|
3568
|
+
/** @returns {MetafieldTypesSchema} */
|
|
3569
|
+
declare function MetafieldTypesSchema(): MetafieldTypesSchema;
|
|
3570
|
+
type MetafieldTypesSchema = {
|
|
3571
|
+
metafield_types?: CustomFieldTypeSchema;
|
|
3572
|
+
};
|
|
2419
3573
|
/** @returns {CustomFieldTypeSchema} */
|
|
2420
3574
|
declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
|
|
2421
3575
|
type CustomFieldTypeSchema = {
|
|
@@ -2432,6 +3586,8 @@ type CustomFieldTypeSchema = {
|
|
|
2432
3586
|
url?: Url;
|
|
2433
3587
|
metaobject?: Metaobject;
|
|
2434
3588
|
product?: Product;
|
|
3589
|
+
html?: HTML;
|
|
3590
|
+
duration?: Duration;
|
|
2435
3591
|
};
|
|
2436
3592
|
/** @returns {SupportedValidationsMetaExampleSchema} */
|
|
2437
3593
|
declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
|
|
@@ -2453,130 +3609,392 @@ type SupportedValidationsSchema = {
|
|
|
2453
3609
|
required?: boolean;
|
|
2454
3610
|
meta?: SupportedValidationsMetaSchema;
|
|
2455
3611
|
};
|
|
3612
|
+
/** @returns {Duration} */
|
|
3613
|
+
declare function Duration(): Duration;
|
|
3614
|
+
type Duration = {
|
|
3615
|
+
/**
|
|
3616
|
+
* - Name data type of custom field
|
|
3617
|
+
*/
|
|
3618
|
+
name?: string;
|
|
3619
|
+
/**
|
|
3620
|
+
* - Flag for listing enabled or not
|
|
3621
|
+
*/
|
|
3622
|
+
list_enabled?: boolean;
|
|
3623
|
+
/**
|
|
3624
|
+
* - Type of custom field
|
|
3625
|
+
*/
|
|
3626
|
+
type?: string;
|
|
3627
|
+
/**
|
|
3628
|
+
* - Category of custom field
|
|
3629
|
+
*/
|
|
3630
|
+
category?: string;
|
|
3631
|
+
/**
|
|
3632
|
+
* - List of
|
|
3633
|
+
* validations available for the field
|
|
3634
|
+
*/
|
|
3635
|
+
supported_validations?: SupportedValidationsSchema[];
|
|
3636
|
+
};
|
|
3637
|
+
/** @returns {HTML} */
|
|
3638
|
+
declare function HTML(): HTML;
|
|
3639
|
+
type HTML = {
|
|
3640
|
+
/**
|
|
3641
|
+
* - Name data type of custom field
|
|
3642
|
+
*/
|
|
3643
|
+
name?: string;
|
|
3644
|
+
/**
|
|
3645
|
+
* - Flag for listing enabled or not
|
|
3646
|
+
*/
|
|
3647
|
+
list_enabled?: boolean;
|
|
3648
|
+
/**
|
|
3649
|
+
* - Type of custom field
|
|
3650
|
+
*/
|
|
3651
|
+
type?: string;
|
|
3652
|
+
/**
|
|
3653
|
+
* - List of
|
|
3654
|
+
* validations available for the field
|
|
3655
|
+
*/
|
|
3656
|
+
supported_validations?: SupportedValidationsSchema[];
|
|
3657
|
+
};
|
|
2456
3658
|
/** @returns {StringSingleLine} */
|
|
2457
3659
|
declare function StringSingleLine(): StringSingleLine;
|
|
2458
3660
|
type StringSingleLine = {
|
|
3661
|
+
/**
|
|
3662
|
+
* - Name data type of custom field
|
|
3663
|
+
*/
|
|
2459
3664
|
name?: string;
|
|
3665
|
+
/**
|
|
3666
|
+
* - Flag for listing enabled or not
|
|
3667
|
+
*/
|
|
2460
3668
|
list_enabled?: boolean;
|
|
3669
|
+
/**
|
|
3670
|
+
* - Category of custom field
|
|
3671
|
+
*/
|
|
2461
3672
|
category?: string;
|
|
3673
|
+
/**
|
|
3674
|
+
* - Type of custom field
|
|
3675
|
+
*/
|
|
2462
3676
|
type?: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* - List of
|
|
3679
|
+
* validations available for the field
|
|
3680
|
+
*/
|
|
2463
3681
|
supported_validations?: SupportedValidationsSchema[];
|
|
2464
3682
|
};
|
|
2465
3683
|
/** @returns {StringMultiLine} */
|
|
2466
3684
|
declare function StringMultiLine(): StringMultiLine;
|
|
2467
3685
|
type StringMultiLine = {
|
|
3686
|
+
/**
|
|
3687
|
+
* - Name data type of custom field
|
|
3688
|
+
*/
|
|
2468
3689
|
name?: string;
|
|
3690
|
+
/**
|
|
3691
|
+
* - Flag for listing enabled or not
|
|
3692
|
+
*/
|
|
2469
3693
|
list_enabled?: boolean;
|
|
3694
|
+
/**
|
|
3695
|
+
* - Category of custom field
|
|
3696
|
+
*/
|
|
2470
3697
|
category?: string;
|
|
3698
|
+
/**
|
|
3699
|
+
* - Type of custom field
|
|
3700
|
+
*/
|
|
2471
3701
|
type?: string;
|
|
3702
|
+
/**
|
|
3703
|
+
* - List of
|
|
3704
|
+
* validations available for the field
|
|
3705
|
+
*/
|
|
2472
3706
|
supported_validations?: SupportedValidationsSchema[];
|
|
2473
3707
|
};
|
|
2474
3708
|
/** @returns {Dropdown} */
|
|
2475
3709
|
declare function Dropdown(): Dropdown;
|
|
2476
3710
|
type Dropdown = {
|
|
3711
|
+
/**
|
|
3712
|
+
* - Name data type of custom field
|
|
3713
|
+
*/
|
|
2477
3714
|
name?: string;
|
|
3715
|
+
/**
|
|
3716
|
+
* - Flag for listing enabled or not
|
|
3717
|
+
*/
|
|
2478
3718
|
list_enabled?: boolean;
|
|
3719
|
+
/**
|
|
3720
|
+
* - Category of custom field
|
|
3721
|
+
*/
|
|
2479
3722
|
category?: string;
|
|
3723
|
+
/**
|
|
3724
|
+
* - Category of custom field
|
|
3725
|
+
*/
|
|
2480
3726
|
type?: string;
|
|
3727
|
+
/**
|
|
3728
|
+
* - List of
|
|
3729
|
+
* validations available for the field
|
|
3730
|
+
*/
|
|
2481
3731
|
supported_validations?: SupportedValidationsSchema[];
|
|
2482
3732
|
};
|
|
2483
3733
|
/** @returns {Integer} */
|
|
2484
3734
|
declare function Integer(): Integer;
|
|
2485
3735
|
type Integer = {
|
|
3736
|
+
/**
|
|
3737
|
+
* - Name data type of custom field
|
|
3738
|
+
*/
|
|
2486
3739
|
name?: string;
|
|
3740
|
+
/**
|
|
3741
|
+
* - Flag for listing enabled or not
|
|
3742
|
+
*/
|
|
2487
3743
|
list_enabled?: boolean;
|
|
3744
|
+
/**
|
|
3745
|
+
* - Type of custom field
|
|
3746
|
+
*/
|
|
2488
3747
|
type?: string;
|
|
3748
|
+
/**
|
|
3749
|
+
* - Category of custom field
|
|
3750
|
+
*/
|
|
2489
3751
|
category?: string;
|
|
3752
|
+
/**
|
|
3753
|
+
* - List of
|
|
3754
|
+
* validations available for the field
|
|
3755
|
+
*/
|
|
2490
3756
|
supported_validations?: SupportedValidationsSchema[];
|
|
2491
3757
|
};
|
|
2492
3758
|
/** @returns {FloatType} */
|
|
2493
3759
|
declare function FloatType(): FloatType;
|
|
2494
3760
|
type FloatType = {
|
|
3761
|
+
/**
|
|
3762
|
+
* - Name data type of custom field
|
|
3763
|
+
*/
|
|
2495
3764
|
name?: string;
|
|
3765
|
+
/**
|
|
3766
|
+
* - Flag for listing enabled or not
|
|
3767
|
+
*/
|
|
2496
3768
|
list_enabled?: boolean;
|
|
3769
|
+
/**
|
|
3770
|
+
* - Type of custom field
|
|
3771
|
+
*/
|
|
2497
3772
|
type?: string;
|
|
3773
|
+
/**
|
|
3774
|
+
* - Category of custom field
|
|
3775
|
+
*/
|
|
2498
3776
|
category?: string;
|
|
2499
|
-
|
|
3777
|
+
/**
|
|
3778
|
+
* - List of
|
|
3779
|
+
* validations available for the field
|
|
3780
|
+
*/
|
|
3781
|
+
supported_validations?: SupportedValidationsSchema[];
|
|
2500
3782
|
};
|
|
2501
3783
|
/** @returns {BooleanType} */
|
|
2502
3784
|
declare function BooleanType(): BooleanType;
|
|
2503
3785
|
type BooleanType = {
|
|
3786
|
+
/**
|
|
3787
|
+
* - Name data type of custom field
|
|
3788
|
+
*/
|
|
2504
3789
|
name?: string;
|
|
3790
|
+
/**
|
|
3791
|
+
* - Category of custom field
|
|
3792
|
+
*/
|
|
2505
3793
|
category?: string;
|
|
3794
|
+
/**
|
|
3795
|
+
* - Flag for listing enabled or not
|
|
3796
|
+
*/
|
|
2506
3797
|
list_enabled?: boolean;
|
|
3798
|
+
/**
|
|
3799
|
+
* - Category of custom field
|
|
3800
|
+
*/
|
|
2507
3801
|
type?: string;
|
|
3802
|
+
/**
|
|
3803
|
+
* - List of
|
|
3804
|
+
* validations available for the field
|
|
3805
|
+
*/
|
|
2508
3806
|
supported_validations?: SupportedValidationsSchema[];
|
|
2509
3807
|
};
|
|
2510
3808
|
/** @returns {Date} */
|
|
2511
3809
|
declare function Date(): Date;
|
|
2512
3810
|
type Date = {
|
|
3811
|
+
/**
|
|
3812
|
+
* - Name data type of custom field
|
|
3813
|
+
*/
|
|
2513
3814
|
name?: string;
|
|
3815
|
+
/**
|
|
3816
|
+
* - Flag for listing enabled or not
|
|
3817
|
+
*/
|
|
2514
3818
|
list_enabled?: boolean;
|
|
3819
|
+
/**
|
|
3820
|
+
* - Category of custom field
|
|
3821
|
+
*/
|
|
2515
3822
|
category?: string;
|
|
3823
|
+
/**
|
|
3824
|
+
* - Type of custom field
|
|
3825
|
+
*/
|
|
2516
3826
|
type?: string;
|
|
3827
|
+
/**
|
|
3828
|
+
* - List of
|
|
3829
|
+
* validations available for the field
|
|
3830
|
+
*/
|
|
2517
3831
|
supported_validations?: SupportedValidationsSchema[];
|
|
2518
3832
|
};
|
|
2519
3833
|
/** @returns {Datetime} */
|
|
2520
3834
|
declare function Datetime(): Datetime;
|
|
2521
3835
|
type Datetime = {
|
|
3836
|
+
/**
|
|
3837
|
+
* - Name data type of custom field
|
|
3838
|
+
*/
|
|
2522
3839
|
name?: string;
|
|
3840
|
+
/**
|
|
3841
|
+
* - Category of custom field
|
|
3842
|
+
*/
|
|
2523
3843
|
category?: string;
|
|
3844
|
+
/**
|
|
3845
|
+
* - Flag for listing enabled or not
|
|
3846
|
+
*/
|
|
2524
3847
|
list_enabled?: boolean;
|
|
3848
|
+
/**
|
|
3849
|
+
* - Type of custom field
|
|
3850
|
+
*/
|
|
2525
3851
|
type?: string;
|
|
3852
|
+
/**
|
|
3853
|
+
* - List of
|
|
3854
|
+
* validations available for the field
|
|
3855
|
+
*/
|
|
2526
3856
|
supported_validations?: SupportedValidationsSchema[];
|
|
2527
3857
|
};
|
|
2528
3858
|
/** @returns {Json} */
|
|
2529
3859
|
declare function Json(): Json;
|
|
2530
3860
|
type Json = {
|
|
3861
|
+
/**
|
|
3862
|
+
* - Name data type of custom field
|
|
3863
|
+
*/
|
|
2531
3864
|
name?: string;
|
|
3865
|
+
/**
|
|
3866
|
+
* - Flag for listing enabled or not
|
|
3867
|
+
*/
|
|
2532
3868
|
list_enabled?: boolean;
|
|
3869
|
+
/**
|
|
3870
|
+
* - Category of custom field
|
|
3871
|
+
*/
|
|
2533
3872
|
category?: string;
|
|
3873
|
+
/**
|
|
3874
|
+
* - Type of custom field
|
|
3875
|
+
*/
|
|
2534
3876
|
type?: string;
|
|
3877
|
+
/**
|
|
3878
|
+
* - List of
|
|
3879
|
+
* validations available for the field
|
|
3880
|
+
*/
|
|
2535
3881
|
supported_validations?: SupportedValidationsSchema[];
|
|
2536
3882
|
};
|
|
2537
3883
|
/** @returns {File} */
|
|
2538
3884
|
declare function File(): File;
|
|
2539
3885
|
type File = {
|
|
3886
|
+
/**
|
|
3887
|
+
* - Name data type of custom field
|
|
3888
|
+
*/
|
|
2540
3889
|
name?: string;
|
|
3890
|
+
/**
|
|
3891
|
+
* - Category of custom field
|
|
3892
|
+
*/
|
|
2541
3893
|
category?: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* - Flag for listing enabled or not
|
|
3896
|
+
*/
|
|
2542
3897
|
list_enabled?: boolean;
|
|
3898
|
+
/**
|
|
3899
|
+
* - Type of custom field
|
|
3900
|
+
*/
|
|
2543
3901
|
type?: string;
|
|
2544
3902
|
supported_validations?: SupportedValidationsSchema[];
|
|
2545
3903
|
};
|
|
2546
3904
|
/** @returns {Url} */
|
|
2547
3905
|
declare function Url(): Url;
|
|
2548
3906
|
type Url = {
|
|
3907
|
+
/**
|
|
3908
|
+
* - Name data type of custom field
|
|
3909
|
+
*/
|
|
2549
3910
|
name?: string;
|
|
3911
|
+
/**
|
|
3912
|
+
* - Flag for listing enabled or not
|
|
3913
|
+
*/
|
|
2550
3914
|
list_enabled?: boolean;
|
|
3915
|
+
/**
|
|
3916
|
+
* - Type of custom field
|
|
3917
|
+
*/
|
|
2551
3918
|
type?: string;
|
|
3919
|
+
/**
|
|
3920
|
+
* - List of
|
|
3921
|
+
* validations available for the field
|
|
3922
|
+
*/
|
|
2552
3923
|
supported_validations?: SupportedValidationsSchema[];
|
|
2553
3924
|
};
|
|
2554
3925
|
/** @returns {Metaobject} */
|
|
2555
3926
|
declare function Metaobject(): Metaobject;
|
|
2556
3927
|
type Metaobject = {
|
|
3928
|
+
/**
|
|
3929
|
+
* - Name of Custom Object
|
|
3930
|
+
*/
|
|
2557
3931
|
name?: string;
|
|
3932
|
+
/**
|
|
3933
|
+
* - Whether the field is allowed to have
|
|
3934
|
+
* multiple list items
|
|
3935
|
+
*/
|
|
2558
3936
|
list_enabled?: boolean;
|
|
3937
|
+
/**
|
|
3938
|
+
* - Category of Custom Object Definition that
|
|
3939
|
+
* Custom Object belongs to
|
|
3940
|
+
*/
|
|
2559
3941
|
category?: string;
|
|
3942
|
+
/**
|
|
3943
|
+
* - Type of Custom Object Definition
|
|
3944
|
+
*/
|
|
2560
3945
|
type?: string;
|
|
2561
3946
|
supported_validations?: SupportedValidationsSchema[];
|
|
2562
3947
|
};
|
|
2563
3948
|
/** @returns {Product} */
|
|
2564
3949
|
declare function Product(): Product;
|
|
2565
3950
|
type Product = {
|
|
3951
|
+
/**
|
|
3952
|
+
* - Name of Product
|
|
3953
|
+
*/
|
|
2566
3954
|
name?: string;
|
|
3955
|
+
/**
|
|
3956
|
+
* - Whether the field is allowed to have
|
|
3957
|
+
* multiple list items
|
|
3958
|
+
*/
|
|
2567
3959
|
list_enabled?: boolean;
|
|
3960
|
+
/**
|
|
3961
|
+
* - Category of Custom Object Definition that
|
|
3962
|
+
* Product is associated with
|
|
3963
|
+
*/
|
|
2568
3964
|
category?: string;
|
|
3965
|
+
/**
|
|
3966
|
+
* - Custom Object Definition that Product is associated with
|
|
3967
|
+
*/
|
|
2569
3968
|
type?: string;
|
|
2570
3969
|
supported_validations?: SupportedValidationsSchema[];
|
|
2571
3970
|
};
|
|
2572
3971
|
/** @returns {CustomObjectEntry} */
|
|
2573
3972
|
declare function CustomObjectEntry(): CustomObjectEntry;
|
|
2574
3973
|
type CustomObjectEntry = {
|
|
2575
|
-
|
|
3974
|
+
/**
|
|
3975
|
+
* - Unique system generated id
|
|
3976
|
+
*/
|
|
3977
|
+
id?: string;
|
|
3978
|
+
/**
|
|
3979
|
+
* - Name of Custom Object definition
|
|
3980
|
+
*/
|
|
2576
3981
|
name?: string;
|
|
3982
|
+
/**
|
|
3983
|
+
* - Type of Custom Object Definition
|
|
3984
|
+
*/
|
|
2577
3985
|
type?: string;
|
|
3986
|
+
/**
|
|
3987
|
+
* - Updation time of a Custom Object
|
|
3988
|
+
*/
|
|
2578
3989
|
updated_at?: string;
|
|
3990
|
+
/**
|
|
3991
|
+
* - Number of entries against the Custom
|
|
3992
|
+
* Object definition
|
|
3993
|
+
*/
|
|
2579
3994
|
entries_count?: number;
|
|
3995
|
+
/**
|
|
3996
|
+
* - Number of fields against a Custom Object definition
|
|
3997
|
+
*/
|
|
2580
3998
|
fields_count?: number;
|
|
2581
3999
|
};
|
|
2582
4000
|
/** @returns {CustomObjectDefinitionsSchema} */
|
|
@@ -2588,20 +4006,65 @@ type CustomObjectDefinitionsSchema = {
|
|
|
2588
4006
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
2589
4007
|
declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
|
|
2590
4008
|
type CustomObjectEntryFieldSchema = {
|
|
2591
|
-
|
|
2592
|
-
|
|
4009
|
+
/**
|
|
4010
|
+
* - This is namespace for a custom field definition
|
|
4011
|
+
*/
|
|
4012
|
+
namespace?: string;
|
|
4013
|
+
/**
|
|
4014
|
+
* - This is slug for a custom field definition
|
|
4015
|
+
*/
|
|
4016
|
+
slug?: string;
|
|
4017
|
+
};
|
|
4018
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
4019
|
+
declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
|
|
4020
|
+
type CustomObjectEntryFieldSchemaWithoutID = {
|
|
4021
|
+
/**
|
|
4022
|
+
* - Custom fields belonging to a custom object
|
|
4023
|
+
*/
|
|
4024
|
+
slug?: string;
|
|
4025
|
+
/**
|
|
4026
|
+
* - Value of custom field inside a custom object
|
|
4027
|
+
*/
|
|
4028
|
+
value?: any;
|
|
2593
4029
|
};
|
|
2594
4030
|
/** @returns {CustomObjectRequestSchema} */
|
|
2595
4031
|
declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
|
|
2596
4032
|
type CustomObjectRequestSchema = {
|
|
4033
|
+
/**
|
|
4034
|
+
* - Flag to denote status of Custom Object
|
|
4035
|
+
*/
|
|
2597
4036
|
status?: string;
|
|
2598
|
-
|
|
4037
|
+
/**
|
|
4038
|
+
* - This is slug for a custom field definition
|
|
4039
|
+
*/
|
|
4040
|
+
slug?: string;
|
|
4041
|
+
/**
|
|
4042
|
+
* - List of custom fields
|
|
4043
|
+
*/
|
|
2599
4044
|
fields?: CustomObjectEntryFieldSchema[];
|
|
2600
4045
|
};
|
|
4046
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
4047
|
+
declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
|
|
4048
|
+
type CustomObjectRequestSchemaWithoutId = {
|
|
4049
|
+
/**
|
|
4050
|
+
* - Status of the custom object entry.
|
|
4051
|
+
*/
|
|
4052
|
+
status?: string;
|
|
4053
|
+
/**
|
|
4054
|
+
* - List of custom fields
|
|
4055
|
+
*/
|
|
4056
|
+
fields?: CustomObjectEntryFieldSchemaWithoutID[];
|
|
4057
|
+
};
|
|
2601
4058
|
/** @returns {CustomObjectBulkSchema} */
|
|
2602
4059
|
declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
|
|
2603
4060
|
type CustomObjectBulkSchema = {
|
|
4061
|
+
/**
|
|
4062
|
+
* - Full URL for the bulk operations data
|
|
4063
|
+
*/
|
|
2604
4064
|
url?: string;
|
|
4065
|
+
/**
|
|
4066
|
+
* - Total records in the upload.
|
|
4067
|
+
*/
|
|
2605
4068
|
total_records?: number;
|
|
2606
4069
|
};
|
|
2607
4070
|
/** @returns {ActionPage} */
|
|
@@ -2621,6 +4084,559 @@ type ActionPage = {
|
|
|
2621
4084
|
url?: string;
|
|
2622
4085
|
type: PageType;
|
|
2623
4086
|
};
|
|
4087
|
+
/** @returns {TranslateUiLabels} */
|
|
4088
|
+
declare function TranslateUiLabels(): TranslateUiLabels;
|
|
4089
|
+
type TranslateUiLabels = {
|
|
4090
|
+
/**
|
|
4091
|
+
* - Unique identifier assigned to the Translate Ui Labels entry
|
|
4092
|
+
*/
|
|
4093
|
+
_id?: string;
|
|
4094
|
+
/**
|
|
4095
|
+
* - Identifier linking the resource to a
|
|
4096
|
+
* specific company within the platform
|
|
4097
|
+
*/
|
|
4098
|
+
company_id?: string;
|
|
4099
|
+
/**
|
|
4100
|
+
* - Reference to the application where this
|
|
4101
|
+
* Translate Ui Labels is utilized
|
|
4102
|
+
*/
|
|
4103
|
+
application_id?: string;
|
|
4104
|
+
/**
|
|
4105
|
+
* - Links the resource to a specific
|
|
4106
|
+
* template theme configuration
|
|
4107
|
+
*/
|
|
4108
|
+
template_theme_id?: string;
|
|
4109
|
+
/**
|
|
4110
|
+
* - Associates the resource with a particular
|
|
4111
|
+
* theme implementation
|
|
4112
|
+
*/
|
|
4113
|
+
theme_id?: string;
|
|
4114
|
+
/**
|
|
4115
|
+
* - Specifies the language and region format for
|
|
4116
|
+
* the resource content
|
|
4117
|
+
*/
|
|
4118
|
+
locale?: string;
|
|
4119
|
+
/**
|
|
4120
|
+
* - Contains the actual resource data and
|
|
4121
|
+
* configuration settings
|
|
4122
|
+
*/
|
|
4123
|
+
resource?: any;
|
|
4124
|
+
/**
|
|
4125
|
+
* - Categorizes the resource type for proper handling
|
|
4126
|
+
* and processing
|
|
4127
|
+
*/
|
|
4128
|
+
type?: string;
|
|
4129
|
+
};
|
|
4130
|
+
/** @returns {TranslateUiLabelsCreate} */
|
|
4131
|
+
declare function TranslateUiLabelsCreate(): TranslateUiLabelsCreate;
|
|
4132
|
+
type TranslateUiLabelsCreate = {
|
|
4133
|
+
/**
|
|
4134
|
+
* - Unique identifier for the template theme
|
|
4135
|
+
*/
|
|
4136
|
+
template_theme_id?: string;
|
|
4137
|
+
/**
|
|
4138
|
+
* - Unique identifier for the theme
|
|
4139
|
+
*/
|
|
4140
|
+
theme_id?: string;
|
|
4141
|
+
/**
|
|
4142
|
+
* - Locale
|
|
4143
|
+
*/
|
|
4144
|
+
locale?: string;
|
|
4145
|
+
/**
|
|
4146
|
+
* - Translate Ui Labels json object
|
|
4147
|
+
*/
|
|
4148
|
+
resource?: any;
|
|
4149
|
+
/**
|
|
4150
|
+
* - Resource type
|
|
4151
|
+
*/
|
|
4152
|
+
type?: string;
|
|
4153
|
+
};
|
|
4154
|
+
/** @returns {StaticResourceUpdate} */
|
|
4155
|
+
declare function StaticResourceUpdate(): StaticResourceUpdate;
|
|
4156
|
+
type StaticResourceUpdate = {
|
|
4157
|
+
/**
|
|
4158
|
+
* - Unique identifier for the template theme
|
|
4159
|
+
*/
|
|
4160
|
+
template_theme_id?: string;
|
|
4161
|
+
/**
|
|
4162
|
+
* - Unique identifier for the theme
|
|
4163
|
+
*/
|
|
4164
|
+
theme_id?: string;
|
|
4165
|
+
/**
|
|
4166
|
+
* - Locale
|
|
4167
|
+
*/
|
|
4168
|
+
locale?: string;
|
|
4169
|
+
/**
|
|
4170
|
+
* - Translate Ui Labels json object
|
|
4171
|
+
*/
|
|
4172
|
+
resource?: any;
|
|
4173
|
+
/**
|
|
4174
|
+
* - Resource type
|
|
4175
|
+
*/
|
|
4176
|
+
type?: string;
|
|
4177
|
+
};
|
|
4178
|
+
/** @returns {TranslateUiLabelsPage} */
|
|
4179
|
+
declare function TranslateUiLabelsPage(): TranslateUiLabelsPage;
|
|
4180
|
+
type TranslateUiLabelsPage = {
|
|
4181
|
+
/**
|
|
4182
|
+
* - List of items containing all the
|
|
4183
|
+
* static info data.
|
|
4184
|
+
*/
|
|
4185
|
+
items?: TranslateUiLabels[];
|
|
4186
|
+
page?: Page;
|
|
4187
|
+
};
|
|
4188
|
+
/** @returns {Error} */
|
|
4189
|
+
declare function Error(): Error;
|
|
4190
|
+
type Error = {
|
|
4191
|
+
/**
|
|
4192
|
+
* - Detailed message explaining the error that occurred
|
|
4193
|
+
*/
|
|
4194
|
+
error?: string;
|
|
4195
|
+
};
|
|
4196
|
+
/** @returns {Meta} */
|
|
4197
|
+
declare function Meta(): Meta;
|
|
4198
|
+
type Meta = {
|
|
4199
|
+
/**
|
|
4200
|
+
* - Identifier of the user who created this resource
|
|
4201
|
+
*/
|
|
4202
|
+
created_by?: string;
|
|
4203
|
+
/**
|
|
4204
|
+
* - Identifier of the user who last modified
|
|
4205
|
+
* this resource
|
|
4206
|
+
*/
|
|
4207
|
+
modified_by?: string;
|
|
4208
|
+
/**
|
|
4209
|
+
* - Timestamp when this resource was initially created
|
|
4210
|
+
*/
|
|
4211
|
+
created_on?: string;
|
|
4212
|
+
/**
|
|
4213
|
+
* - Timestamp when this resource was last modified
|
|
4214
|
+
*/
|
|
4215
|
+
modified_on?: string;
|
|
4216
|
+
};
|
|
4217
|
+
/** @returns {CompanyLanguage} */
|
|
4218
|
+
declare function CompanyLanguage(): CompanyLanguage;
|
|
4219
|
+
type CompanyLanguage = {
|
|
4220
|
+
/**
|
|
4221
|
+
* - Unique identifier for the company language setting
|
|
4222
|
+
*/
|
|
4223
|
+
_id?: string;
|
|
4224
|
+
/**
|
|
4225
|
+
* - Identifier of the company this language
|
|
4226
|
+
* configuration belongs to
|
|
4227
|
+
*/
|
|
4228
|
+
company_id: string;
|
|
4229
|
+
/**
|
|
4230
|
+
* - Language code following ISO standards for this
|
|
4231
|
+
* company setting
|
|
4232
|
+
*/
|
|
4233
|
+
locale?: string;
|
|
4234
|
+
/**
|
|
4235
|
+
* - Display name of the language for company usage
|
|
4236
|
+
*/
|
|
4237
|
+
name?: string;
|
|
4238
|
+
/**
|
|
4239
|
+
* - Text direction setting for company content
|
|
4240
|
+
* in this language
|
|
4241
|
+
*/
|
|
4242
|
+
direction?: string;
|
|
4243
|
+
/**
|
|
4244
|
+
* - Indicates if this is the default language
|
|
4245
|
+
* for the company
|
|
4246
|
+
*/
|
|
4247
|
+
is_default?: boolean;
|
|
4248
|
+
/**
|
|
4249
|
+
* - Translated name of the language in
|
|
4250
|
+
* English for easy reference and display at the website.
|
|
4251
|
+
*/
|
|
4252
|
+
display_name?: string;
|
|
4253
|
+
};
|
|
4254
|
+
/** @returns {CompanyLanguageCreate} */
|
|
4255
|
+
declare function CompanyLanguageCreate(): CompanyLanguageCreate;
|
|
4256
|
+
type CompanyLanguageCreate = {
|
|
4257
|
+
/**
|
|
4258
|
+
* - List of language codes to be added to company
|
|
4259
|
+
* configuration
|
|
4260
|
+
*/
|
|
4261
|
+
locales: string[];
|
|
4262
|
+
};
|
|
4263
|
+
/** @returns {CompanyLanguageUpdate} */
|
|
4264
|
+
declare function CompanyLanguageUpdate(): CompanyLanguageUpdate;
|
|
4265
|
+
type CompanyLanguageUpdate = {
|
|
4266
|
+
/**
|
|
4267
|
+
* - Sets the specified language as the company default
|
|
4268
|
+
*/
|
|
4269
|
+
is_default: boolean;
|
|
4270
|
+
};
|
|
4271
|
+
/** @returns {ApplicationLanguage} */
|
|
4272
|
+
declare function ApplicationLanguage(): ApplicationLanguage;
|
|
4273
|
+
type ApplicationLanguage = {
|
|
4274
|
+
/**
|
|
4275
|
+
* - Unique identifier for the application language setting
|
|
4276
|
+
*/
|
|
4277
|
+
_id?: string;
|
|
4278
|
+
/**
|
|
4279
|
+
* - Identifier of the company this application belongs to
|
|
4280
|
+
*/
|
|
4281
|
+
company_id: string;
|
|
4282
|
+
/**
|
|
4283
|
+
* - Unique identifier of the application
|
|
4284
|
+
* using this language
|
|
4285
|
+
*/
|
|
4286
|
+
application_id: string;
|
|
4287
|
+
/**
|
|
4288
|
+
* - Language code following ISO standards for this application
|
|
4289
|
+
*/
|
|
4290
|
+
locale: string;
|
|
4291
|
+
/**
|
|
4292
|
+
* - Display name of the language for application usage
|
|
4293
|
+
*/
|
|
4294
|
+
name: string;
|
|
4295
|
+
/**
|
|
4296
|
+
* - Specifies the text direction for displaying
|
|
4297
|
+
* application content, either left-to-right (ltr) or right-to-left (rtl)
|
|
4298
|
+
*/
|
|
4299
|
+
direction: string;
|
|
4300
|
+
/**
|
|
4301
|
+
* - Indicates if this is the default language
|
|
4302
|
+
* for the application
|
|
4303
|
+
*/
|
|
4304
|
+
is_default: boolean;
|
|
4305
|
+
/**
|
|
4306
|
+
* - Indicates whether this language is currently
|
|
4307
|
+
* active and visible within the storefront.
|
|
4308
|
+
*/
|
|
4309
|
+
published: boolean;
|
|
4310
|
+
/**
|
|
4311
|
+
* - Translated name of the language in
|
|
4312
|
+
* English for easy reference and display at the website.
|
|
4313
|
+
*/
|
|
4314
|
+
display_name?: string;
|
|
4315
|
+
};
|
|
4316
|
+
/** @returns {unPublishApplicationLanguage} */
|
|
4317
|
+
declare function unPublishApplicationLanguage(): unPublishApplicationLanguage;
|
|
4318
|
+
type unPublishApplicationLanguage = {
|
|
4319
|
+
/**
|
|
4320
|
+
* - Updates the publication status of the language
|
|
4321
|
+
*/
|
|
4322
|
+
published: boolean;
|
|
4323
|
+
};
|
|
4324
|
+
/** @returns {ApplicationLanguageCreate} */
|
|
4325
|
+
declare function ApplicationLanguageCreate(): ApplicationLanguageCreate;
|
|
4326
|
+
type ApplicationLanguageCreate = {
|
|
4327
|
+
/**
|
|
4328
|
+
* - List of language codes to be added to
|
|
4329
|
+
* application configuration
|
|
4330
|
+
*/
|
|
4331
|
+
locales: string[];
|
|
4332
|
+
};
|
|
4333
|
+
/** @returns {ApplicationLanguageUpdate} */
|
|
4334
|
+
declare function ApplicationLanguageUpdate(): ApplicationLanguageUpdate;
|
|
4335
|
+
type ApplicationLanguageUpdate = {
|
|
4336
|
+
/**
|
|
4337
|
+
* - Sets the specified language as the application default
|
|
4338
|
+
*/
|
|
4339
|
+
is_default: boolean;
|
|
4340
|
+
/**
|
|
4341
|
+
* - Updates the publication status of the language
|
|
4342
|
+
*/
|
|
4343
|
+
published: boolean;
|
|
4344
|
+
};
|
|
4345
|
+
/** @returns {TranslatableResource} */
|
|
4346
|
+
declare function TranslatableResource(): TranslatableResource;
|
|
4347
|
+
type TranslatableResource = {
|
|
4348
|
+
/**
|
|
4349
|
+
* - Unique identifier for the translatable resource
|
|
4350
|
+
*/
|
|
4351
|
+
_id?: string;
|
|
4352
|
+
/**
|
|
4353
|
+
* - Categorizes the type of content that can be translated
|
|
4354
|
+
*/
|
|
4355
|
+
type: string;
|
|
4356
|
+
/**
|
|
4357
|
+
* - Display name of the translatable resource
|
|
4358
|
+
*/
|
|
4359
|
+
name: string;
|
|
4360
|
+
/**
|
|
4361
|
+
* - Detailed explanation of the translatable resource
|
|
4362
|
+
*/
|
|
4363
|
+
description: string;
|
|
4364
|
+
/**
|
|
4365
|
+
* - Defines the processing type for the
|
|
4366
|
+
* translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
|
|
4367
|
+
*/
|
|
4368
|
+
schema_type: string;
|
|
4369
|
+
/**
|
|
4370
|
+
* - Identifier of the user who created this resource
|
|
4371
|
+
*/
|
|
4372
|
+
created_by?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
* - Identifier of the user who last modified
|
|
4375
|
+
* this resource
|
|
4376
|
+
*/
|
|
4377
|
+
modified_by?: string;
|
|
4378
|
+
/**
|
|
4379
|
+
* - Timestamp when this resource was initially created
|
|
4380
|
+
*/
|
|
4381
|
+
created_on?: string;
|
|
4382
|
+
/**
|
|
4383
|
+
* - Timestamp when this resource was last modified
|
|
4384
|
+
*/
|
|
4385
|
+
modified_on?: string;
|
|
4386
|
+
section_id?: TranslatableSection;
|
|
4387
|
+
};
|
|
4388
|
+
/** @returns {ResourceDefinition} */
|
|
4389
|
+
declare function ResourceDefinition(): ResourceDefinition;
|
|
4390
|
+
type ResourceDefinition = {
|
|
4391
|
+
/**
|
|
4392
|
+
* - Unique identifier for the resource definition
|
|
4393
|
+
*/
|
|
4394
|
+
_id?: string;
|
|
4395
|
+
/**
|
|
4396
|
+
* - Reference to the associated
|
|
4397
|
+
* translatable resource
|
|
4398
|
+
*/
|
|
4399
|
+
translatable_resource_id: string;
|
|
4400
|
+
json_schema?: ResourceJsonSchema;
|
|
4401
|
+
ui_schema?: ResourceUISchema;
|
|
4402
|
+
bulk_details?: ResourceBulkDetails;
|
|
4403
|
+
};
|
|
4404
|
+
/** @returns {ResourceJsonSchema} */
|
|
4405
|
+
declare function ResourceJsonSchema(): ResourceJsonSchema;
|
|
4406
|
+
type ResourceJsonSchema = {
|
|
4407
|
+
schema?: string;
|
|
4408
|
+
type?: ResourceJsonSchemaType;
|
|
4409
|
+
};
|
|
4410
|
+
/** @returns {ResourceJsonSchemaType} */
|
|
4411
|
+
declare function ResourceJsonSchemaType(): ResourceJsonSchemaType;
|
|
4412
|
+
type ResourceJsonSchemaType = {
|
|
4413
|
+
author?: Author;
|
|
4414
|
+
title?: Title;
|
|
4415
|
+
feature_image?: FeatureImage;
|
|
4416
|
+
};
|
|
4417
|
+
/** @returns {ResourceUISchema} */
|
|
4418
|
+
declare function ResourceUISchema(): ResourceUISchema;
|
|
4419
|
+
type ResourceUISchema = {
|
|
4420
|
+
author?: Author;
|
|
4421
|
+
title?: Title;
|
|
4422
|
+
feature_image?: FeatureImage;
|
|
4423
|
+
seo?: SeoTranslate;
|
|
4424
|
+
};
|
|
4425
|
+
/** @returns {ResourceBulkDetails} */
|
|
4426
|
+
declare function ResourceBulkDetails(): ResourceBulkDetails;
|
|
4427
|
+
type ResourceBulkDetails = {
|
|
4428
|
+
fields?: string[];
|
|
4429
|
+
};
|
|
4430
|
+
/** @returns {Title} */
|
|
4431
|
+
declare function Title(): Title;
|
|
4432
|
+
type Title = {
|
|
4433
|
+
ui_widget?: string;
|
|
4434
|
+
ui_description?: boolean;
|
|
4435
|
+
};
|
|
4436
|
+
/** @returns {FeatureImage} */
|
|
4437
|
+
declare function FeatureImage(): FeatureImage;
|
|
4438
|
+
type FeatureImage = {
|
|
4439
|
+
/**
|
|
4440
|
+
* - URL of the secure image
|
|
4441
|
+
*/
|
|
4442
|
+
secure_url?: string;
|
|
4443
|
+
};
|
|
4444
|
+
/** @returns {SeoTranslate} */
|
|
4445
|
+
declare function SeoTranslate(): SeoTranslate;
|
|
4446
|
+
type SeoTranslate = {
|
|
4447
|
+
title?: Title;
|
|
4448
|
+
description?: string;
|
|
4449
|
+
canonical_url?: string;
|
|
4450
|
+
meta_tags?: MetaTag[];
|
|
4451
|
+
};
|
|
4452
|
+
/** @returns {MetaTag} */
|
|
4453
|
+
declare function MetaTag(): MetaTag;
|
|
4454
|
+
type MetaTag = {
|
|
4455
|
+
/**
|
|
4456
|
+
* - Title of the meta tag
|
|
4457
|
+
*/
|
|
4458
|
+
title?: string;
|
|
4459
|
+
items?: MetaTagItem[];
|
|
4460
|
+
};
|
|
4461
|
+
/** @returns {MetaTagItem} */
|
|
4462
|
+
declare function MetaTagItem(): MetaTagItem;
|
|
4463
|
+
type MetaTagItem = {
|
|
4464
|
+
/**
|
|
4465
|
+
* - Key of the meta tag item
|
|
4466
|
+
*/
|
|
4467
|
+
key?: string;
|
|
4468
|
+
/**
|
|
4469
|
+
* - Value of the meta tag item
|
|
4470
|
+
*/
|
|
4471
|
+
value?: string;
|
|
4472
|
+
};
|
|
4473
|
+
/** @returns {ResourceTranslation} */
|
|
4474
|
+
declare function ResourceTranslation(): ResourceTranslation;
|
|
4475
|
+
type ResourceTranslation = {
|
|
4476
|
+
/**
|
|
4477
|
+
* - Unique identifier for the translation entry
|
|
4478
|
+
*/
|
|
4479
|
+
_id?: string;
|
|
4480
|
+
/**
|
|
4481
|
+
* - Language code for this translation
|
|
4482
|
+
*/
|
|
4483
|
+
locale?: string;
|
|
4484
|
+
/**
|
|
4485
|
+
* - Translated content in key-value format
|
|
4486
|
+
*/
|
|
4487
|
+
value?: any;
|
|
4488
|
+
};
|
|
4489
|
+
/** @returns {TranslationSeo} */
|
|
4490
|
+
declare function TranslationSeo(): TranslationSeo;
|
|
4491
|
+
type TranslationSeo = {
|
|
4492
|
+
/**
|
|
4493
|
+
* - Translated SEO title
|
|
4494
|
+
*/
|
|
4495
|
+
title?: string;
|
|
4496
|
+
/**
|
|
4497
|
+
* - List of translated breadcrumbs
|
|
4498
|
+
*/
|
|
4499
|
+
breadcrumbs?: string[];
|
|
4500
|
+
/**
|
|
4501
|
+
* - List of translated meta tags
|
|
4502
|
+
*/
|
|
4503
|
+
meta_tags?: string[];
|
|
4504
|
+
/**
|
|
4505
|
+
* - Translated canonical URL
|
|
4506
|
+
*/
|
|
4507
|
+
canonical_url?: string;
|
|
4508
|
+
/**
|
|
4509
|
+
* - Translated SEO description
|
|
4510
|
+
*/
|
|
4511
|
+
description?: string;
|
|
4512
|
+
};
|
|
4513
|
+
/** @returns {ResourceTranslationList} */
|
|
4514
|
+
declare function ResourceTranslationList(): ResourceTranslationList;
|
|
4515
|
+
type ResourceTranslationList = {
|
|
4516
|
+
items?: ResourceTranslationCreate[];
|
|
4517
|
+
};
|
|
4518
|
+
/** @returns {ResourceTranslationCreate} */
|
|
4519
|
+
declare function ResourceTranslationCreate(): ResourceTranslationCreate;
|
|
4520
|
+
type ResourceTranslationCreate = {
|
|
4521
|
+
/**
|
|
4522
|
+
* - Type of content being translated
|
|
4523
|
+
*/
|
|
4524
|
+
type?: string;
|
|
4525
|
+
/**
|
|
4526
|
+
* - Identifier of the resource requiring translation
|
|
4527
|
+
*/
|
|
4528
|
+
resource_id?: string;
|
|
4529
|
+
/**
|
|
4530
|
+
* - Target language code for the translation
|
|
4531
|
+
*/
|
|
4532
|
+
locale?: string;
|
|
4533
|
+
/**
|
|
4534
|
+
* - Translated content in key-value format
|
|
4535
|
+
*/
|
|
4536
|
+
value?: any;
|
|
4537
|
+
};
|
|
4538
|
+
/** @returns {ResourceTranslationUpdate} */
|
|
4539
|
+
declare function ResourceTranslationUpdate(): ResourceTranslationUpdate;
|
|
4540
|
+
type ResourceTranslationUpdate = {
|
|
4541
|
+
/**
|
|
4542
|
+
* - Translated content in key-value format
|
|
4543
|
+
*/
|
|
4544
|
+
value?: any;
|
|
4545
|
+
};
|
|
4546
|
+
/** @returns {TranslatableSection} */
|
|
4547
|
+
declare function TranslatableSection(): TranslatableSection;
|
|
4548
|
+
type TranslatableSection = {
|
|
4549
|
+
/**
|
|
4550
|
+
* - Unique identifier for the translatable section
|
|
4551
|
+
*/
|
|
4552
|
+
_id?: string;
|
|
4553
|
+
/**
|
|
4554
|
+
* - Display name of the section
|
|
4555
|
+
*/
|
|
4556
|
+
name?: string;
|
|
4557
|
+
/**
|
|
4558
|
+
* - Detailed explanation of the section's purpose
|
|
4559
|
+
*/
|
|
4560
|
+
description?: string;
|
|
4561
|
+
/**
|
|
4562
|
+
* - Identifier of the user who created this resource
|
|
4563
|
+
*/
|
|
4564
|
+
created_by?: string;
|
|
4565
|
+
/**
|
|
4566
|
+
* - Identifier of the user who last modified
|
|
4567
|
+
* this resource
|
|
4568
|
+
*/
|
|
4569
|
+
modified_by?: string;
|
|
4570
|
+
/**
|
|
4571
|
+
* - Timestamp when this resource was initially created
|
|
4572
|
+
*/
|
|
4573
|
+
created_on?: string;
|
|
4574
|
+
/**
|
|
4575
|
+
* - Timestamp when this resource was last modified
|
|
4576
|
+
*/
|
|
4577
|
+
modified_on?: string;
|
|
4578
|
+
};
|
|
4579
|
+
/** @returns {Metrics} */
|
|
4580
|
+
declare function Metrics(): Metrics;
|
|
4581
|
+
type Metrics = {
|
|
4582
|
+
/**
|
|
4583
|
+
* - Total number of translation operations attempted
|
|
4584
|
+
*/
|
|
4585
|
+
total?: number;
|
|
4586
|
+
/**
|
|
4587
|
+
* - Number of successful translation operations
|
|
4588
|
+
*/
|
|
4589
|
+
success?: number;
|
|
4590
|
+
/**
|
|
4591
|
+
* - Number of failed translation operations
|
|
4592
|
+
*/
|
|
4593
|
+
failed?: number;
|
|
4594
|
+
};
|
|
4595
|
+
/** @returns {ResourceTranslationUpsertItem} */
|
|
4596
|
+
declare function ResourceTranslationUpsertItem(): ResourceTranslationUpsertItem;
|
|
4597
|
+
type ResourceTranslationUpsertItem = {
|
|
4598
|
+
/**
|
|
4599
|
+
* - Status message for the translation operation
|
|
4600
|
+
*/
|
|
4601
|
+
message?: string;
|
|
4602
|
+
data?: ResourceTranslationCreate;
|
|
4603
|
+
};
|
|
4604
|
+
/** @returns {ResourceTranslationBulkUpsert} */
|
|
4605
|
+
declare function ResourceTranslationBulkUpsert(): ResourceTranslationBulkUpsert;
|
|
4606
|
+
type ResourceTranslationBulkUpsert = {
|
|
4607
|
+
metrics?: Metrics;
|
|
4608
|
+
/**
|
|
4609
|
+
* - List of failed
|
|
4610
|
+
* translation operations
|
|
4611
|
+
*/
|
|
4612
|
+
failed_items?: ResourceTranslationUpsertItem[];
|
|
4613
|
+
/**
|
|
4614
|
+
* - List of
|
|
4615
|
+
* successful translation operations
|
|
4616
|
+
*/
|
|
4617
|
+
updated_items?: ResourceTranslationUpsertItem[];
|
|
4618
|
+
};
|
|
4619
|
+
/** @returns {StandardError} */
|
|
4620
|
+
declare function StandardError(): StandardError;
|
|
4621
|
+
type StandardError = {
|
|
4622
|
+
/**
|
|
4623
|
+
* - A brief description of the error.
|
|
4624
|
+
*/
|
|
4625
|
+
message: string;
|
|
4626
|
+
};
|
|
4627
|
+
/** @returns {OperationResponseSchema} */
|
|
4628
|
+
declare function OperationResponseSchema(): OperationResponseSchema;
|
|
4629
|
+
type OperationResponseSchema = {
|
|
4630
|
+
/**
|
|
4631
|
+
* - Indicates if the operation was successful
|
|
4632
|
+
*/
|
|
4633
|
+
success: boolean;
|
|
4634
|
+
/**
|
|
4635
|
+
* - Optional message providing additional
|
|
4636
|
+
* information about the operation
|
|
4637
|
+
*/
|
|
4638
|
+
message?: string;
|
|
4639
|
+
};
|
|
2624
4640
|
/**
|
|
2625
4641
|
* Enum: GenerationEntityType Used By: Content
|
|
2626
4642
|
*
|
|
@@ -2634,4 +4650,4 @@ type GenerationEntityType = "title" | "description";
|
|
|
2634
4650
|
* @returns {PageType}
|
|
2635
4651
|
*/
|
|
2636
4652
|
declare function PageType(): PageType;
|
|
2637
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-
|
|
4653
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|