@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +111 -1200
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
- package/sdk/application/Content/ContentApplicationClient.js +46 -990
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5067 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1988 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1893 -623
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +924 -568
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,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]
|
|
@@ -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]
|
|
@@ -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]
|
|
@@ -390,7 +395,7 @@ export = ContentPlatformModel;
|
|
|
390
395
|
* @property {DataLoaderSchema[]} [items]
|
|
391
396
|
*/
|
|
392
397
|
/**
|
|
393
|
-
* @typedef
|
|
398
|
+
* @typedef TagDeleteSuccessDetails
|
|
394
399
|
* @property {boolean} [success]
|
|
395
400
|
*/
|
|
396
401
|
/**
|
|
@@ -503,7 +508,7 @@ export = ContentPlatformModel;
|
|
|
503
508
|
* @property {number} [size] - The number of items per page.
|
|
504
509
|
*/
|
|
505
510
|
/**
|
|
506
|
-
* @typedef
|
|
511
|
+
* @typedef LandingPageGetDetails
|
|
507
512
|
* @property {LandingPageSchema[]} [items]
|
|
508
513
|
* @property {Page} [page]
|
|
509
514
|
*/
|
|
@@ -520,11 +525,11 @@ export = ContentPlatformModel;
|
|
|
520
525
|
* @property {Object} [_custom_json]
|
|
521
526
|
*/
|
|
522
527
|
/**
|
|
523
|
-
* @typedef
|
|
528
|
+
* @typedef DefaultNavigationDetails
|
|
524
529
|
* @property {NavigationSchema[]} [items]
|
|
525
530
|
*/
|
|
526
531
|
/**
|
|
527
|
-
* @typedef
|
|
532
|
+
* @typedef NavigationGetDetails
|
|
528
533
|
* @property {NavigationSchema[]} [items]
|
|
529
534
|
* @property {Page} [page]
|
|
530
535
|
*/
|
|
@@ -548,7 +553,7 @@ export = ContentPlatformModel;
|
|
|
548
553
|
* @property {NavigationReference[]} [navigation]
|
|
549
554
|
*/
|
|
550
555
|
/**
|
|
551
|
-
* @typedef
|
|
556
|
+
* @typedef NavigationPayload
|
|
552
557
|
* @property {string} [name]
|
|
553
558
|
* @property {string} [slug]
|
|
554
559
|
* @property {string[]} [platform]
|
|
@@ -556,7 +561,7 @@ export = ContentPlatformModel;
|
|
|
556
561
|
* @property {NavigationReference[]} [navigation]
|
|
557
562
|
*/
|
|
558
563
|
/**
|
|
559
|
-
* @typedef
|
|
564
|
+
* @typedef PageGetDetails
|
|
560
565
|
* @property {PageSchema[]} [items]
|
|
561
566
|
* @property {Page} [page]
|
|
562
567
|
*/
|
|
@@ -607,7 +612,7 @@ export = ContentPlatformModel;
|
|
|
607
612
|
* @property {string} [id]
|
|
608
613
|
*/
|
|
609
614
|
/**
|
|
610
|
-
* @typedef
|
|
615
|
+
* @typedef PagePayload
|
|
611
616
|
* @property {CronSchedule} [_schedule]
|
|
612
617
|
* @property {string} [application]
|
|
613
618
|
* @property {Author} [author]
|
|
@@ -630,7 +635,7 @@ export = ContentPlatformModel;
|
|
|
630
635
|
* @property {number} [duration]
|
|
631
636
|
*/
|
|
632
637
|
/**
|
|
633
|
-
* @typedef
|
|
638
|
+
* @typedef PagePublishPayload
|
|
634
639
|
* @property {boolean} [publish]
|
|
635
640
|
*/
|
|
636
641
|
/**
|
|
@@ -640,7 +645,7 @@ export = ContentPlatformModel;
|
|
|
640
645
|
* @property {string} [application_id]
|
|
641
646
|
*/
|
|
642
647
|
/**
|
|
643
|
-
* @typedef
|
|
648
|
+
* @typedef SlideshowGetDetails
|
|
644
649
|
* @property {SlideshowSchema[]} [items]
|
|
645
650
|
* @property {Page} [page]
|
|
646
651
|
*/
|
|
@@ -658,7 +663,7 @@ export = ContentPlatformModel;
|
|
|
658
663
|
* @property {Object} [_custom_json]
|
|
659
664
|
*/
|
|
660
665
|
/**
|
|
661
|
-
* @typedef
|
|
666
|
+
* @typedef SlideshowPayload
|
|
662
667
|
* @property {string} [slug]
|
|
663
668
|
* @property {string} [platform]
|
|
664
669
|
* @property {ConfigurationSchema} [configuration]
|
|
@@ -737,93 +742,108 @@ export = ContentPlatformModel;
|
|
|
737
742
|
*/
|
|
738
743
|
/**
|
|
739
744
|
* @typedef FieldValidations
|
|
740
|
-
* @property {string} [name]
|
|
741
|
-
* @property {string} [type]
|
|
745
|
+
* @property {string} [name] - Name of validation
|
|
746
|
+
* @property {string} [type] - Type of validation
|
|
742
747
|
* @property {Object} [value]
|
|
743
748
|
*/
|
|
744
749
|
/**
|
|
745
750
|
* @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]
|
|
751
|
+
* @property {string} [id] - Unique system generated id
|
|
752
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
753
|
+
* @property {string} [name] - Name of custom field
|
|
754
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
755
|
+
* @property {string} [slug] - Slug of custom field
|
|
756
|
+
* @property {string} [description] - Description of custom field definition
|
|
757
|
+
* @property {string} [type] - Data type of custom field
|
|
758
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
759
|
+
* multivalued or not
|
|
760
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
761
|
+
* @property {string} [company_id] - Id of company
|
|
762
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
763
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
764
|
+
* @property {string} [type_name] - Type of type field
|
|
765
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
765
766
|
*/
|
|
766
767
|
/**
|
|
767
768
|
* @typedef CustomFieldDefinitionsSchema
|
|
768
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
769
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
769
770
|
* @property {Page} [page]
|
|
770
771
|
*/
|
|
771
772
|
/**
|
|
772
773
|
* @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]
|
|
774
|
+
* @property {string} [type] - Data type of custom field
|
|
775
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
776
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
777
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
778
|
+
* multi valued or not
|
|
779
|
+
* @property {string} [name] - Name of custom field definition
|
|
780
|
+
* @property {string} [description] - Description of a custom field definition
|
|
781
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
781
782
|
*/
|
|
782
783
|
/**
|
|
783
784
|
* @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 {
|
|
785
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
786
|
+
* @property {string} [type] - Data type of custom field
|
|
787
|
+
* @property {string} [description] - Description of custom field
|
|
788
|
+
* @property {string} [name] - Name of custom field
|
|
789
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
790
|
+
* valued or not
|
|
791
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
792
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
793
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
794
|
+
* custom field
|
|
792
795
|
* @property {string} [action]
|
|
793
796
|
*/
|
|
794
797
|
/**
|
|
795
798
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
796
|
-
* @property {string} [
|
|
797
|
-
* @property {string} [
|
|
798
|
-
* @property {string} [
|
|
799
|
-
*
|
|
799
|
+
* @property {string} [description] - Description of custom object definiton
|
|
800
|
+
* @property {string} [name] - Name of custom object definition
|
|
801
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
802
|
+
* display key in
|
|
800
803
|
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
801
804
|
*/
|
|
802
805
|
/**
|
|
803
806
|
* @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]
|
|
807
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
808
|
+
* @property {string} [name] - Name of custom field
|
|
809
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
810
|
+
* @property {string} [slug] - Slug of custom field
|
|
811
|
+
* @property {string} [description] - Description regarding custom field
|
|
812
|
+
* @property {string} [type] - Data type of custom field
|
|
813
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
814
|
+
* multi valued or not
|
|
815
|
+
* @property {string} [company_id] - Company Identifer
|
|
816
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
817
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
818
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
819
|
+
* @property {string} [id] - Unique system generated id
|
|
819
820
|
* @property {Object[]} [validations]
|
|
820
|
-
* @property {string} [created_at]
|
|
821
|
-
* @property {string} [updated_at]
|
|
821
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
822
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
823
|
+
*/
|
|
824
|
+
/**
|
|
825
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
826
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
827
|
+
* @property {string} [name] - Name of meta field
|
|
828
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
829
|
+
* @property {string} [slug] - Slug of meta field
|
|
830
|
+
* @property {string} [description] - Description regarding meta field
|
|
831
|
+
* @property {string} [type] - Data type of meta field
|
|
832
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
833
|
+
* multi valued or not
|
|
834
|
+
* @property {string} [company_id] - Company Identifer
|
|
835
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
836
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
837
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
838
|
+
* @property {string} [id] - Unique system generated id
|
|
839
|
+
* @property {Object[]} [validations]
|
|
840
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
841
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
822
842
|
*/
|
|
823
843
|
/**
|
|
824
844
|
* @typedef CustomDataDeleteSchema
|
|
825
|
-
* @property {boolean} [success]
|
|
826
|
-
* @property {string} [message]
|
|
845
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
846
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
827
847
|
*/
|
|
828
848
|
/**
|
|
829
849
|
* @typedef CustomFieldValue
|
|
@@ -831,29 +851,31 @@ export = ContentPlatformModel;
|
|
|
831
851
|
*/
|
|
832
852
|
/**
|
|
833
853
|
* @typedef CustomFieldSchema
|
|
834
|
-
* @property {string} [
|
|
835
|
-
* @property {string} [namespace]
|
|
836
|
-
* @property {string} [
|
|
837
|
-
* @property {string} [resource]
|
|
838
|
-
* @property {string} [creator]
|
|
854
|
+
* @property {string} [id] - Unique system generated id
|
|
855
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
856
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
857
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
839
858
|
* @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]
|
|
859
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
860
|
+
* @property {string} [type] - Data type of custom field
|
|
861
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
862
|
+
* @property {string} [company_id] - Identifer for a company
|
|
845
863
|
* @property {boolean} [has_invalid_values]
|
|
846
864
|
* @property {Object[]} [invalid_value_errors]
|
|
847
|
-
* @property {
|
|
848
|
-
* @property {
|
|
849
|
-
* @property {string} [
|
|
850
|
-
* @property {string} [updated_at]
|
|
865
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
866
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
867
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
851
868
|
*/
|
|
852
869
|
/**
|
|
853
870
|
* @typedef CustomFieldsResponseSchema
|
|
854
871
|
* @property {CustomFieldSchema[]} [items]
|
|
855
872
|
* @property {Page} [page]
|
|
856
873
|
*/
|
|
874
|
+
/**
|
|
875
|
+
* @typedef CustomFieldsDeleteSchema
|
|
876
|
+
* @property {boolean} [success]
|
|
877
|
+
* @property {string} [message]
|
|
878
|
+
*/
|
|
857
879
|
/**
|
|
858
880
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
859
881
|
* @property {CustomFieldSchema[]} [items]
|
|
@@ -861,7 +883,9 @@ export = ContentPlatformModel;
|
|
|
861
883
|
/**
|
|
862
884
|
* @typedef CustomField
|
|
863
885
|
* @property {Object[]} [value]
|
|
864
|
-
* @property {string} [
|
|
886
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
887
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
888
|
+
* creating a custom field definition
|
|
865
889
|
*/
|
|
866
890
|
/**
|
|
867
891
|
* @typedef CustomFieldRequestSchema
|
|
@@ -869,146 +893,140 @@ export = ContentPlatformModel;
|
|
|
869
893
|
*/
|
|
870
894
|
/**
|
|
871
895
|
* @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]
|
|
896
|
+
* @property {string} [id] - Unique system generated id
|
|
897
|
+
* @property {string} [company_id] - Identifer for a company
|
|
898
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
899
|
+
* @property {string} [status] - Status of custom object
|
|
900
|
+
* @property {string} [type] - Slug of custom object definition
|
|
901
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
902
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
903
|
+
* custom object
|
|
904
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
883
905
|
*/
|
|
884
906
|
/**
|
|
885
907
|
* @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]
|
|
908
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
909
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
910
|
+
* @property {string} [description] - Description of custom object definition
|
|
911
|
+
* @property {string} [name] - Name of custom object
|
|
912
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
913
|
+
* for displaying custom object
|
|
914
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
915
|
+
* of custom field definitions belonging to this custom object definition
|
|
916
|
+
*/
|
|
917
|
+
/**
|
|
918
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
919
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
920
|
+
* @property {string} [name] - Display name of custom object definition
|
|
921
|
+
* @property {string} [type] - Type of custom object definiton
|
|
922
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
923
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
924
|
+
* @property {string} [description] - Description of custom object definition
|
|
925
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
926
|
+
* Custom fields inside custom objects
|
|
923
927
|
*/
|
|
924
928
|
/**
|
|
925
929
|
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
926
|
-
* @property {boolean} [success]
|
|
927
|
-
* @property {string} [message]
|
|
930
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
931
|
+
* @property {string} [message] - Response message when custom object definition
|
|
932
|
+
* is deleted.
|
|
928
933
|
*/
|
|
929
934
|
/**
|
|
930
|
-
* @typedef
|
|
931
|
-
* @property {string} [url]
|
|
932
|
-
* @property {number} [total_records]
|
|
935
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
936
|
+
* @property {string} [url] - Signed url of csv
|
|
937
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
933
938
|
*/
|
|
934
939
|
/**
|
|
935
|
-
* @typedef
|
|
936
|
-
* @property {string} [
|
|
937
|
-
* @property {string} [name]
|
|
938
|
-
* @property {string} [type]
|
|
940
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
941
|
+
* @property {string} [id] - Unique system generated id
|
|
942
|
+
* @property {string} [name] - Name of custom object
|
|
943
|
+
* @property {string} [type] - Type of custom object entry
|
|
939
944
|
*/
|
|
940
945
|
/**
|
|
941
946
|
* @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]
|
|
947
|
+
* @property {string} [id] - Unique system generated id
|
|
948
|
+
* @property {string} [status] - Status of custom object
|
|
949
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
950
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
951
|
+
* @property {string} [display_name] - Display name of custom object
|
|
952
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
953
|
+
* @property {number} [references] - References of the custom object entry
|
|
949
954
|
*/
|
|
950
955
|
/**
|
|
951
956
|
* @typedef CustomObjectsSchema
|
|
952
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
957
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
958
|
+
* object entries
|
|
953
959
|
* @property {Page} [page]
|
|
954
960
|
*/
|
|
955
961
|
/**
|
|
956
|
-
* @typedef
|
|
957
|
-
* @property {string} [
|
|
958
|
-
* @property {string} [
|
|
959
|
-
* @property {
|
|
960
|
-
* @property {
|
|
961
|
-
* @property {string} [
|
|
962
|
+
* @typedef CustomObjectFieldDefinition
|
|
963
|
+
* @property {string} [id] - Unique system generate id
|
|
964
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
965
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
966
|
+
* @property {Object[]} [value] - Value of custom field
|
|
967
|
+
* @property {string} [type] - Data type of the custom field
|
|
962
968
|
*/
|
|
963
969
|
/**
|
|
964
|
-
* @typedef
|
|
965
|
-
* @property {string} [
|
|
966
|
-
* @property {string} [status]
|
|
967
|
-
* @property {string} [display_name]
|
|
968
|
-
* @property {
|
|
969
|
-
* @property {Object[]} [references]
|
|
970
|
-
*
|
|
970
|
+
* @typedef CustomObjectBySlugSchema
|
|
971
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
972
|
+
* @property {string} [status] - Status of Custom Object
|
|
973
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
974
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
975
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
976
|
+
* used as a custom field
|
|
977
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
978
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
979
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
980
|
+
* inside the custom object
|
|
971
981
|
*/
|
|
972
982
|
/**
|
|
973
983
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
974
|
-
* @property {string} [message]
|
|
975
|
-
* @property {string} [task_id]
|
|
984
|
+
* @property {string} [message] - Message for the user
|
|
985
|
+
* @property {string} [task_id] - Identifer for a task
|
|
976
986
|
*/
|
|
977
987
|
/**
|
|
978
988
|
* @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]
|
|
989
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
990
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
991
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
992
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
993
|
+
*/
|
|
994
|
+
/**
|
|
995
|
+
* @typedef JobSchema
|
|
996
|
+
* @property {string} [id] - Unique system generated id
|
|
997
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
998
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
999
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1000
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1001
|
+
* @property {string} [company_id] - Company Identifer
|
|
1002
|
+
* @property {string} [status] - Status of job
|
|
1003
|
+
* @property {string} [action_type] - Type of job
|
|
1004
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1005
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1006
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1007
|
+
* @property {number} [error_count] - Number of items in error
|
|
1008
|
+
* @property {number} [success_count] - Number of successful items
|
|
1009
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1010
|
+
* @property {CustomObjectMetaSchema} [meta]
|
|
1011
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1012
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1013
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1014
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
983
1015
|
*/
|
|
984
1016
|
/**
|
|
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]
|
|
1017
|
+
* @typedef CustomFieldBulkEntry
|
|
1018
|
+
* @property {JobSchema[]} [items]
|
|
1019
|
+
* @property {Page} [page]
|
|
1006
1020
|
*/
|
|
1007
1021
|
/**
|
|
1008
1022
|
* @typedef CustomObjectBulkEntry
|
|
1009
|
-
* @property {
|
|
1023
|
+
* @property {JobSchema[]} [items]
|
|
1010
1024
|
* @property {Page} [page]
|
|
1011
1025
|
*/
|
|
1026
|
+
/**
|
|
1027
|
+
* @typedef MetafieldTypesSchema
|
|
1028
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1029
|
+
*/
|
|
1012
1030
|
/**
|
|
1013
1031
|
* @typedef CustomFieldTypeSchema
|
|
1014
1032
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1024,6 +1042,8 @@ export = ContentPlatformModel;
|
|
|
1024
1042
|
* @property {Url} [url]
|
|
1025
1043
|
* @property {Metaobject} [metaobject]
|
|
1026
1044
|
* @property {Product} [product]
|
|
1045
|
+
* @property {HTML} [html]
|
|
1046
|
+
* @property {Duration} [duration]
|
|
1027
1047
|
*/
|
|
1028
1048
|
/**
|
|
1029
1049
|
* @typedef SupportedValidationsMetaExampleSchema
|
|
@@ -1042,117 +1062,149 @@ export = ContentPlatformModel;
|
|
|
1042
1062
|
* @property {boolean} [required]
|
|
1043
1063
|
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1044
1064
|
*/
|
|
1065
|
+
/**
|
|
1066
|
+
* @typedef Duration
|
|
1067
|
+
* @property {string} [name] - Name data type of custom field
|
|
1068
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1069
|
+
* @property {string} [type] - Type of custom field
|
|
1070
|
+
* @property {string} [category] - Category of custom field
|
|
1071
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1072
|
+
* validations available for the field
|
|
1073
|
+
*/
|
|
1074
|
+
/**
|
|
1075
|
+
* @typedef HTML
|
|
1076
|
+
* @property {string} [name] - Name data type of custom field
|
|
1077
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1078
|
+
* @property {string} [type] - Type of custom field
|
|
1079
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1080
|
+
* validations available for the field
|
|
1081
|
+
*/
|
|
1045
1082
|
/**
|
|
1046
1083
|
* @typedef StringSingleLine
|
|
1047
|
-
* @property {string} [name]
|
|
1048
|
-
* @property {boolean} [list_enabled]
|
|
1049
|
-
* @property {string} [category]
|
|
1050
|
-
* @property {string} [type]
|
|
1051
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1084
|
+
* @property {string} [name] - Name data type of custom field
|
|
1085
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1086
|
+
* @property {string} [category] - Category of custom field
|
|
1087
|
+
* @property {string} [type] - Type of custom field
|
|
1088
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1089
|
+
* validations available for the field
|
|
1052
1090
|
*/
|
|
1053
1091
|
/**
|
|
1054
1092
|
* @typedef StringMultiLine
|
|
1055
|
-
* @property {string} [name]
|
|
1056
|
-
* @property {boolean} [list_enabled]
|
|
1057
|
-
* @property {string} [category]
|
|
1058
|
-
* @property {string} [type]
|
|
1059
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1093
|
+
* @property {string} [name] - Name data type of custom field
|
|
1094
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1095
|
+
* @property {string} [category] - Category of custom field
|
|
1096
|
+
* @property {string} [type] - Type of custom field
|
|
1097
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1098
|
+
* validations available for the field
|
|
1060
1099
|
*/
|
|
1061
1100
|
/**
|
|
1062
1101
|
* @typedef Dropdown
|
|
1063
|
-
* @property {string} [name]
|
|
1064
|
-
* @property {boolean} [list_enabled]
|
|
1065
|
-
* @property {string} [category]
|
|
1066
|
-
* @property {string} [type]
|
|
1067
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1102
|
+
* @property {string} [name] - Name data type of custom field
|
|
1103
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1104
|
+
* @property {string} [category] - Category of custom field
|
|
1105
|
+
* @property {string} [type] - Category of custom field
|
|
1106
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1107
|
+
* validations available for the field
|
|
1068
1108
|
*/
|
|
1069
1109
|
/**
|
|
1070
1110
|
* @typedef Integer
|
|
1071
|
-
* @property {string} [name]
|
|
1072
|
-
* @property {boolean} [list_enabled]
|
|
1073
|
-
* @property {string} [type]
|
|
1074
|
-
* @property {string} [category]
|
|
1075
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1111
|
+
* @property {string} [name] - Name data type of custom field
|
|
1112
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1113
|
+
* @property {string} [type] - Type of custom field
|
|
1114
|
+
* @property {string} [category] - Category of custom field
|
|
1115
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1116
|
+
* validations available for the field
|
|
1076
1117
|
*/
|
|
1077
1118
|
/**
|
|
1078
1119
|
* @typedef FloatType
|
|
1079
|
-
* @property {string} [name]
|
|
1080
|
-
* @property {boolean} [list_enabled]
|
|
1081
|
-
* @property {string} [type]
|
|
1082
|
-
* @property {string} [category]
|
|
1083
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1120
|
+
* @property {string} [name] - Name data type of custom field
|
|
1121
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1122
|
+
* @property {string} [type] - Type of custom field
|
|
1123
|
+
* @property {string} [category] - Category of custom field
|
|
1124
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1125
|
+
* validations available for the field
|
|
1084
1126
|
*/
|
|
1085
1127
|
/**
|
|
1086
1128
|
* @typedef BooleanType
|
|
1087
|
-
* @property {string} [name]
|
|
1088
|
-
* @property {string} [category]
|
|
1089
|
-
* @property {boolean} [list_enabled]
|
|
1090
|
-
* @property {string} [type]
|
|
1091
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1129
|
+
* @property {string} [name] - Name data type of custom field
|
|
1130
|
+
* @property {string} [category] - Category of custom field
|
|
1131
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1132
|
+
* @property {string} [type] - Category of custom field
|
|
1133
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1134
|
+
* validations available for the field
|
|
1092
1135
|
*/
|
|
1093
1136
|
/**
|
|
1094
1137
|
* @typedef Date
|
|
1095
|
-
* @property {string} [name]
|
|
1096
|
-
* @property {boolean} [list_enabled]
|
|
1097
|
-
* @property {string} [category]
|
|
1098
|
-
* @property {string} [type]
|
|
1099
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1138
|
+
* @property {string} [name] - Name data type of custom field
|
|
1139
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1140
|
+
* @property {string} [category] - Category of custom field
|
|
1141
|
+
* @property {string} [type] - Type of custom field
|
|
1142
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1143
|
+
* validations available for the field
|
|
1100
1144
|
*/
|
|
1101
1145
|
/**
|
|
1102
1146
|
* @typedef Datetime
|
|
1103
|
-
* @property {string} [name]
|
|
1104
|
-
* @property {string} [category]
|
|
1105
|
-
* @property {boolean} [list_enabled]
|
|
1106
|
-
* @property {string} [type]
|
|
1107
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1147
|
+
* @property {string} [name] - Name data type of custom field
|
|
1148
|
+
* @property {string} [category] - Category of custom field
|
|
1149
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1150
|
+
* @property {string} [type] - Type of custom field
|
|
1151
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1152
|
+
* validations available for the field
|
|
1108
1153
|
*/
|
|
1109
1154
|
/**
|
|
1110
1155
|
* @typedef Json
|
|
1111
|
-
* @property {string} [name]
|
|
1112
|
-
* @property {boolean} [list_enabled]
|
|
1113
|
-
* @property {string} [category]
|
|
1114
|
-
* @property {string} [type]
|
|
1115
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1156
|
+
* @property {string} [name] - Name data type of custom field
|
|
1157
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1158
|
+
* @property {string} [category] - Category of custom field
|
|
1159
|
+
* @property {string} [type] - Type of custom field
|
|
1160
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1161
|
+
* validations available for the field
|
|
1116
1162
|
*/
|
|
1117
1163
|
/**
|
|
1118
1164
|
* @typedef File
|
|
1119
|
-
* @property {string} [name]
|
|
1120
|
-
* @property {string} [category]
|
|
1121
|
-
* @property {boolean} [list_enabled]
|
|
1122
|
-
* @property {string} [type]
|
|
1165
|
+
* @property {string} [name] - Name data type of custom field
|
|
1166
|
+
* @property {string} [category] - Category of custom field
|
|
1167
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1168
|
+
* @property {string} [type] - Type of custom field
|
|
1123
1169
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1124
1170
|
*/
|
|
1125
1171
|
/**
|
|
1126
1172
|
* @typedef Url
|
|
1127
|
-
* @property {string} [name]
|
|
1128
|
-
* @property {boolean} [list_enabled]
|
|
1129
|
-
* @property {string} [type]
|
|
1130
|
-
* @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} [type] - Type of custom field
|
|
1176
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1177
|
+
* validations available for the field
|
|
1131
1178
|
*/
|
|
1132
1179
|
/**
|
|
1133
1180
|
* @typedef Metaobject
|
|
1134
|
-
* @property {string} [name]
|
|
1135
|
-
* @property {boolean} [list_enabled]
|
|
1136
|
-
*
|
|
1137
|
-
* @property {string} [
|
|
1181
|
+
* @property {string} [name] - Name of Custom Object
|
|
1182
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1183
|
+
* multiple list items
|
|
1184
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1185
|
+
* Custom Object belongs to
|
|
1186
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1138
1187
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1139
1188
|
*/
|
|
1140
1189
|
/**
|
|
1141
1190
|
* @typedef Product
|
|
1142
|
-
* @property {string} [name]
|
|
1143
|
-
* @property {boolean} [list_enabled]
|
|
1144
|
-
*
|
|
1145
|
-
* @property {string} [
|
|
1191
|
+
* @property {string} [name] - Name of Product
|
|
1192
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1193
|
+
* multiple list items
|
|
1194
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1195
|
+
* Product is associated with
|
|
1196
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1146
1197
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1147
1198
|
*/
|
|
1148
1199
|
/**
|
|
1149
1200
|
* @typedef CustomObjectEntry
|
|
1150
|
-
* @property {string} [
|
|
1151
|
-
* @property {string} [name]
|
|
1152
|
-
* @property {string} [type]
|
|
1153
|
-
* @property {string} [updated_at]
|
|
1154
|
-
* @property {number} [entries_count]
|
|
1155
|
-
*
|
|
1201
|
+
* @property {string} [id] - Unique system generated id
|
|
1202
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1203
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1204
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1205
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1206
|
+
* Object definition
|
|
1207
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1156
1208
|
*/
|
|
1157
1209
|
/**
|
|
1158
1210
|
* @typedef CustomObjectDefinitionsSchema
|
|
@@ -1161,19 +1213,29 @@ export = ContentPlatformModel;
|
|
|
1161
1213
|
*/
|
|
1162
1214
|
/**
|
|
1163
1215
|
* @typedef CustomObjectEntryFieldSchema
|
|
1164
|
-
* @property {string} [
|
|
1165
|
-
* @property {
|
|
1216
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1217
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1218
|
+
*/
|
|
1219
|
+
/**
|
|
1220
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1221
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1222
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1166
1223
|
*/
|
|
1167
1224
|
/**
|
|
1168
1225
|
* @typedef CustomObjectRequestSchema
|
|
1169
|
-
* @property {string} [status]
|
|
1170
|
-
* @property {string} [
|
|
1171
|
-
* @property {CustomObjectEntryFieldSchema[]} [fields]
|
|
1226
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1227
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1228
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1229
|
+
*/
|
|
1230
|
+
/**
|
|
1231
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1232
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1233
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1172
1234
|
*/
|
|
1173
1235
|
/**
|
|
1174
1236
|
* @typedef CustomObjectBulkSchema
|
|
1175
|
-
* @property {string} [url]
|
|
1176
|
-
* @property {number} [total_records]
|
|
1237
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1238
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1177
1239
|
*/
|
|
1178
1240
|
/**
|
|
1179
1241
|
* @typedef ActionPage
|
|
@@ -1236,8 +1298,20 @@ export = ContentPlatformModel;
|
|
|
1236
1298
|
declare class ContentPlatformModel {
|
|
1237
1299
|
}
|
|
1238
1300
|
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,
|
|
1301
|
+
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, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, SlideshowGetDetails, SlideshowSchema, SlideshowPayload, 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, GenerationEntityType, PageType };
|
|
1240
1302
|
}
|
|
1303
|
+
/** @returns {ValidationError} */
|
|
1304
|
+
declare function ValidationError(): ValidationError;
|
|
1305
|
+
type ValidationError = {
|
|
1306
|
+
/**
|
|
1307
|
+
* - A brief description of the error encountered.
|
|
1308
|
+
*/
|
|
1309
|
+
message: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* - The field in the request that caused the error.
|
|
1312
|
+
*/
|
|
1313
|
+
field: string;
|
|
1314
|
+
};
|
|
1241
1315
|
/** @returns {GenerateSEOContent} */
|
|
1242
1316
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
1243
1317
|
type GenerateSEOContent = {
|
|
@@ -1415,9 +1489,9 @@ type NextSchedule = {
|
|
|
1415
1489
|
start?: string;
|
|
1416
1490
|
end?: string;
|
|
1417
1491
|
};
|
|
1418
|
-
/** @returns {
|
|
1419
|
-
declare function
|
|
1420
|
-
type
|
|
1492
|
+
/** @returns {BlogGetDetails} */
|
|
1493
|
+
declare function BlogGetDetails(): BlogGetDetails;
|
|
1494
|
+
type BlogGetDetails = {
|
|
1421
1495
|
items?: BlogSchema[];
|
|
1422
1496
|
page?: Page;
|
|
1423
1497
|
filters?: BlogFilters;
|
|
@@ -1513,9 +1587,9 @@ type DateMeta = {
|
|
|
1513
1587
|
created_on?: string;
|
|
1514
1588
|
modified_on?: string;
|
|
1515
1589
|
};
|
|
1516
|
-
/** @returns {
|
|
1517
|
-
declare function
|
|
1518
|
-
type
|
|
1590
|
+
/** @returns {BlogPayload} */
|
|
1591
|
+
declare function BlogPayload(): BlogPayload;
|
|
1592
|
+
type BlogPayload = {
|
|
1519
1593
|
application?: string;
|
|
1520
1594
|
_custom_json?: any;
|
|
1521
1595
|
author?: Author;
|
|
@@ -1685,9 +1759,9 @@ declare function DataLoadersSchema(): DataLoadersSchema;
|
|
|
1685
1759
|
type DataLoadersSchema = {
|
|
1686
1760
|
items?: DataLoaderSchema[];
|
|
1687
1761
|
};
|
|
1688
|
-
/** @returns {
|
|
1689
|
-
declare function
|
|
1690
|
-
type
|
|
1762
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
1763
|
+
declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
|
|
1764
|
+
type TagDeleteSuccessDetails = {
|
|
1691
1765
|
success?: boolean;
|
|
1692
1766
|
};
|
|
1693
1767
|
/** @returns {ContentAPIError} */
|
|
@@ -1837,9 +1911,9 @@ type Page = {
|
|
|
1837
1911
|
*/
|
|
1838
1912
|
size?: number;
|
|
1839
1913
|
};
|
|
1840
|
-
/** @returns {
|
|
1841
|
-
declare function
|
|
1842
|
-
type
|
|
1914
|
+
/** @returns {LandingPageGetDetails} */
|
|
1915
|
+
declare function LandingPageGetDetails(): LandingPageGetDetails;
|
|
1916
|
+
type LandingPageGetDetails = {
|
|
1843
1917
|
items?: LandingPageSchema[];
|
|
1844
1918
|
page?: Page;
|
|
1845
1919
|
};
|
|
@@ -1856,14 +1930,14 @@ type LandingPageSchema = {
|
|
|
1856
1930
|
archived?: boolean;
|
|
1857
1931
|
_custom_json?: any;
|
|
1858
1932
|
};
|
|
1859
|
-
/** @returns {
|
|
1860
|
-
declare function
|
|
1861
|
-
type
|
|
1933
|
+
/** @returns {DefaultNavigationDetails} */
|
|
1934
|
+
declare function DefaultNavigationDetails(): DefaultNavigationDetails;
|
|
1935
|
+
type DefaultNavigationDetails = {
|
|
1862
1936
|
items?: NavigationSchema[];
|
|
1863
1937
|
};
|
|
1864
|
-
/** @returns {
|
|
1865
|
-
declare function
|
|
1866
|
-
type
|
|
1938
|
+
/** @returns {NavigationGetDetails} */
|
|
1939
|
+
declare function NavigationGetDetails(): NavigationGetDetails;
|
|
1940
|
+
type NavigationGetDetails = {
|
|
1867
1941
|
items?: NavigationSchema[];
|
|
1868
1942
|
page?: Page;
|
|
1869
1943
|
};
|
|
@@ -1888,18 +1962,18 @@ type NavigationSchema = {
|
|
|
1888
1962
|
version?: number;
|
|
1889
1963
|
navigation?: NavigationReference[];
|
|
1890
1964
|
};
|
|
1891
|
-
/** @returns {
|
|
1892
|
-
declare function
|
|
1893
|
-
type
|
|
1965
|
+
/** @returns {NavigationPayload} */
|
|
1966
|
+
declare function NavigationPayload(): NavigationPayload;
|
|
1967
|
+
type NavigationPayload = {
|
|
1894
1968
|
name?: string;
|
|
1895
1969
|
slug?: string;
|
|
1896
1970
|
platform?: string[];
|
|
1897
1971
|
orientation?: Orientation;
|
|
1898
1972
|
navigation?: NavigationReference[];
|
|
1899
1973
|
};
|
|
1900
|
-
/** @returns {
|
|
1901
|
-
declare function
|
|
1902
|
-
type
|
|
1974
|
+
/** @returns {PageGetDetails} */
|
|
1975
|
+
declare function PageGetDetails(): PageGetDetails;
|
|
1976
|
+
type PageGetDetails = {
|
|
1903
1977
|
items?: PageSchema[];
|
|
1904
1978
|
page?: Page;
|
|
1905
1979
|
};
|
|
@@ -1957,9 +2031,9 @@ declare function CreatedBySchema(): CreatedBySchema;
|
|
|
1957
2031
|
type CreatedBySchema = {
|
|
1958
2032
|
id?: string;
|
|
1959
2033
|
};
|
|
1960
|
-
/** @returns {
|
|
1961
|
-
declare function
|
|
1962
|
-
type
|
|
2034
|
+
/** @returns {PagePayload} */
|
|
2035
|
+
declare function PagePayload(): PagePayload;
|
|
2036
|
+
type PagePayload = {
|
|
1963
2037
|
_schedule?: CronSchedule;
|
|
1964
2038
|
application?: string;
|
|
1965
2039
|
author?: Author;
|
|
@@ -1982,9 +2056,9 @@ type CronSchedule = {
|
|
|
1982
2056
|
end?: string;
|
|
1983
2057
|
duration?: number;
|
|
1984
2058
|
};
|
|
1985
|
-
/** @returns {
|
|
1986
|
-
declare function
|
|
1987
|
-
type
|
|
2059
|
+
/** @returns {PagePublishPayload} */
|
|
2060
|
+
declare function PagePublishPayload(): PagePublishPayload;
|
|
2061
|
+
type PagePublishPayload = {
|
|
1988
2062
|
publish?: boolean;
|
|
1989
2063
|
};
|
|
1990
2064
|
/** @returns {PageMetaSchema} */
|
|
@@ -1994,9 +2068,9 @@ type PageMetaSchema = {
|
|
|
1994
2068
|
custom_pages?: PageSchema[];
|
|
1995
2069
|
application_id?: string;
|
|
1996
2070
|
};
|
|
1997
|
-
/** @returns {
|
|
1998
|
-
declare function
|
|
1999
|
-
type
|
|
2071
|
+
/** @returns {SlideshowGetDetails} */
|
|
2072
|
+
declare function SlideshowGetDetails(): SlideshowGetDetails;
|
|
2073
|
+
type SlideshowGetDetails = {
|
|
2000
2074
|
items?: SlideshowSchema[];
|
|
2001
2075
|
page?: Page;
|
|
2002
2076
|
};
|
|
@@ -2014,9 +2088,9 @@ type SlideshowSchema = {
|
|
|
2014
2088
|
archived?: boolean;
|
|
2015
2089
|
_custom_json?: any;
|
|
2016
2090
|
};
|
|
2017
|
-
/** @returns {
|
|
2018
|
-
declare function
|
|
2019
|
-
type
|
|
2091
|
+
/** @returns {SlideshowPayload} */
|
|
2092
|
+
declare function SlideshowPayload(): SlideshowPayload;
|
|
2093
|
+
type SlideshowPayload = {
|
|
2020
2094
|
slug?: string;
|
|
2021
2095
|
platform?: string;
|
|
2022
2096
|
configuration?: ConfigurationSchema;
|
|
@@ -2116,99 +2190,310 @@ type ResourceSchema = {
|
|
|
2116
2190
|
/** @returns {FieldValidations} */
|
|
2117
2191
|
declare function FieldValidations(): FieldValidations;
|
|
2118
2192
|
type FieldValidations = {
|
|
2193
|
+
/**
|
|
2194
|
+
* - Name of validation
|
|
2195
|
+
*/
|
|
2119
2196
|
name?: string;
|
|
2197
|
+
/**
|
|
2198
|
+
* - Type of validation
|
|
2199
|
+
*/
|
|
2120
2200
|
type?: string;
|
|
2121
2201
|
value?: any;
|
|
2122
2202
|
};
|
|
2123
2203
|
/** @returns {FieldDefinitionSchema} */
|
|
2124
2204
|
declare function FieldDefinitionSchema(): FieldDefinitionSchema;
|
|
2125
2205
|
type FieldDefinitionSchema = {
|
|
2126
|
-
|
|
2127
|
-
|
|
2206
|
+
/**
|
|
2207
|
+
* - Unique system generated id
|
|
2208
|
+
*/
|
|
2209
|
+
id?: string;
|
|
2210
|
+
/**
|
|
2211
|
+
* - Resource type to which custom field belongs
|
|
2212
|
+
*/
|
|
2128
2213
|
resource?: string;
|
|
2214
|
+
/**
|
|
2215
|
+
* - Name of custom field
|
|
2216
|
+
*/
|
|
2129
2217
|
name?: string;
|
|
2218
|
+
/**
|
|
2219
|
+
* - Namespace of custom field
|
|
2220
|
+
*/
|
|
2130
2221
|
namespace?: string;
|
|
2131
|
-
|
|
2222
|
+
/**
|
|
2223
|
+
* - Slug of custom field
|
|
2224
|
+
*/
|
|
2225
|
+
slug?: string;
|
|
2226
|
+
/**
|
|
2227
|
+
* - Description of custom field definition
|
|
2228
|
+
*/
|
|
2132
2229
|
description?: string;
|
|
2230
|
+
/**
|
|
2231
|
+
* - Data type of custom field
|
|
2232
|
+
*/
|
|
2133
2233
|
type?: string;
|
|
2234
|
+
/**
|
|
2235
|
+
* - Flag to denote whether custom field is
|
|
2236
|
+
* multivalued or not
|
|
2237
|
+
*/
|
|
2134
2238
|
multi_value?: boolean;
|
|
2239
|
+
/**
|
|
2240
|
+
* - List of validations applied
|
|
2241
|
+
*/
|
|
2135
2242
|
validations?: FieldValidations[];
|
|
2243
|
+
/**
|
|
2244
|
+
* - Id of company
|
|
2245
|
+
*/
|
|
2136
2246
|
company_id?: string;
|
|
2137
|
-
|
|
2138
|
-
|
|
2247
|
+
/**
|
|
2248
|
+
* - Whether the custom field is required or not
|
|
2249
|
+
*/
|
|
2139
2250
|
required?: boolean;
|
|
2251
|
+
/**
|
|
2252
|
+
* - Whether the custom field is deleted or not
|
|
2253
|
+
*/
|
|
2140
2254
|
is_deleted?: boolean;
|
|
2141
|
-
|
|
2142
|
-
|
|
2255
|
+
/**
|
|
2256
|
+
* - Type of type field
|
|
2257
|
+
*/
|
|
2143
2258
|
type_name?: string;
|
|
2259
|
+
/**
|
|
2260
|
+
* - Count of invalid fields after validation
|
|
2261
|
+
*/
|
|
2144
2262
|
invalid_fields_count?: number;
|
|
2145
2263
|
};
|
|
2146
2264
|
/** @returns {CustomFieldDefinitionsSchema} */
|
|
2147
2265
|
declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
|
|
2148
2266
|
type CustomFieldDefinitionsSchema = {
|
|
2267
|
+
/**
|
|
2268
|
+
* - List of custom field definitions
|
|
2269
|
+
*/
|
|
2149
2270
|
items?: FieldDefinitionSchema[];
|
|
2150
2271
|
page?: Page;
|
|
2151
2272
|
};
|
|
2152
2273
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2153
2274
|
declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
|
|
2154
2275
|
type CustomFieldDefinitionRequestSchema = {
|
|
2155
|
-
|
|
2276
|
+
/**
|
|
2277
|
+
* - Data type of custom field
|
|
2278
|
+
*/
|
|
2156
2279
|
type?: string;
|
|
2157
|
-
|
|
2280
|
+
/**
|
|
2281
|
+
* - Slug of custom field definition
|
|
2282
|
+
*/
|
|
2283
|
+
slug?: string;
|
|
2284
|
+
/**
|
|
2285
|
+
* - Namespace of custom field definition
|
|
2286
|
+
*/
|
|
2158
2287
|
namespace?: string;
|
|
2288
|
+
/**
|
|
2289
|
+
* - Flag to denote whether custom field is
|
|
2290
|
+
* multi valued or not
|
|
2291
|
+
*/
|
|
2159
2292
|
multi_value?: boolean;
|
|
2293
|
+
/**
|
|
2294
|
+
* - Name of custom field definition
|
|
2295
|
+
*/
|
|
2160
2296
|
name?: string;
|
|
2297
|
+
/**
|
|
2298
|
+
* - Description of a custom field definition
|
|
2299
|
+
*/
|
|
2161
2300
|
description?: string;
|
|
2301
|
+
/**
|
|
2302
|
+
* - Validations for a custom field
|
|
2303
|
+
*/
|
|
2162
2304
|
validations?: FieldValidations[];
|
|
2163
2305
|
};
|
|
2164
2306
|
/** @returns {CustomObjectCustomFieldDefinitions} */
|
|
2165
2307
|
declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
|
|
2166
2308
|
type CustomObjectCustomFieldDefinitions = {
|
|
2309
|
+
/**
|
|
2310
|
+
* - Unique identifer for a custom field
|
|
2311
|
+
*/
|
|
2167
2312
|
id?: string;
|
|
2313
|
+
/**
|
|
2314
|
+
* - Data type of custom field
|
|
2315
|
+
*/
|
|
2168
2316
|
type?: string;
|
|
2317
|
+
/**
|
|
2318
|
+
* - Description of custom field
|
|
2319
|
+
*/
|
|
2169
2320
|
description?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* - Name of custom field
|
|
2323
|
+
*/
|
|
2170
2324
|
name?: string;
|
|
2325
|
+
/**
|
|
2326
|
+
* - Flag to denote if cusom field is multi
|
|
2327
|
+
* valued or not
|
|
2328
|
+
*/
|
|
2171
2329
|
multi_value?: boolean;
|
|
2330
|
+
/**
|
|
2331
|
+
* - Whether the field is required or not
|
|
2332
|
+
*/
|
|
2172
2333
|
required?: boolean;
|
|
2173
|
-
|
|
2334
|
+
/**
|
|
2335
|
+
* - Slug of custom field definition
|
|
2336
|
+
*/
|
|
2337
|
+
slug?: string;
|
|
2338
|
+
/**
|
|
2339
|
+
* - Validations added against the
|
|
2340
|
+
* custom field
|
|
2341
|
+
*/
|
|
2174
2342
|
validations?: FieldValidations[];
|
|
2175
2343
|
action?: string;
|
|
2176
2344
|
};
|
|
2177
2345
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2178
2346
|
declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
|
|
2179
2347
|
type CustomObjectDefinitionUpdateRequestSchema = {
|
|
2180
|
-
|
|
2348
|
+
/**
|
|
2349
|
+
* - Description of custom object definiton
|
|
2350
|
+
*/
|
|
2181
2351
|
description?: string;
|
|
2352
|
+
/**
|
|
2353
|
+
* - Name of custom object definition
|
|
2354
|
+
*/
|
|
2182
2355
|
name?: string;
|
|
2356
|
+
/**
|
|
2357
|
+
* - Custom field slug which is used as a
|
|
2358
|
+
* display key in
|
|
2359
|
+
*/
|
|
2183
2360
|
display_name_key?: string;
|
|
2184
2361
|
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2185
2362
|
};
|
|
2186
2363
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2187
2364
|
declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
|
|
2188
2365
|
type CustomFieldDefinitionDetailResSchema = {
|
|
2189
|
-
|
|
2366
|
+
/**
|
|
2367
|
+
* - Resource to which custom field is associated
|
|
2368
|
+
*/
|
|
2190
2369
|
resource?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* - Name of custom field
|
|
2372
|
+
*/
|
|
2191
2373
|
name?: string;
|
|
2374
|
+
/**
|
|
2375
|
+
* - Namespace of custom field
|
|
2376
|
+
*/
|
|
2192
2377
|
namespace?: string;
|
|
2193
|
-
|
|
2378
|
+
/**
|
|
2379
|
+
* - Slug of custom field
|
|
2380
|
+
*/
|
|
2381
|
+
slug?: string;
|
|
2382
|
+
/**
|
|
2383
|
+
* - Description regarding custom field
|
|
2384
|
+
*/
|
|
2194
2385
|
description?: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* - Data type of custom field
|
|
2388
|
+
*/
|
|
2195
2389
|
type?: string;
|
|
2390
|
+
/**
|
|
2391
|
+
* - Flag to denote whether custom field is
|
|
2392
|
+
* multi valued or not
|
|
2393
|
+
*/
|
|
2196
2394
|
multi_value?: boolean;
|
|
2395
|
+
/**
|
|
2396
|
+
* - Company Identifer
|
|
2397
|
+
*/
|
|
2197
2398
|
company_id?: string;
|
|
2399
|
+
/**
|
|
2400
|
+
* - Sales channel identifier
|
|
2401
|
+
*/
|
|
2198
2402
|
application_id?: string;
|
|
2199
|
-
|
|
2200
|
-
|
|
2403
|
+
/**
|
|
2404
|
+
* - Whether the customfield is required or not
|
|
2405
|
+
*/
|
|
2201
2406
|
required?: boolean;
|
|
2407
|
+
/**
|
|
2408
|
+
* - Is custom field deleted
|
|
2409
|
+
*/
|
|
2202
2410
|
is_deleted?: boolean;
|
|
2203
|
-
|
|
2411
|
+
/**
|
|
2412
|
+
* - Unique system generated id
|
|
2413
|
+
*/
|
|
2414
|
+
id?: string;
|
|
2204
2415
|
validations?: any[];
|
|
2416
|
+
/**
|
|
2417
|
+
* - Date time at which field was created
|
|
2418
|
+
*/
|
|
2205
2419
|
created_at?: string;
|
|
2420
|
+
/**
|
|
2421
|
+
* - Date time at for a field's last modification
|
|
2422
|
+
*/
|
|
2423
|
+
updated_at?: string;
|
|
2424
|
+
};
|
|
2425
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
2426
|
+
declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
|
|
2427
|
+
type MetaFieldDefinitionDetailResSchema = {
|
|
2428
|
+
/**
|
|
2429
|
+
* - Resource to which meta field is associated
|
|
2430
|
+
*/
|
|
2431
|
+
resource?: string;
|
|
2432
|
+
/**
|
|
2433
|
+
* - Name of meta field
|
|
2434
|
+
*/
|
|
2435
|
+
name?: string;
|
|
2436
|
+
/**
|
|
2437
|
+
* - Namespace of meta field
|
|
2438
|
+
*/
|
|
2439
|
+
namespace?: string;
|
|
2440
|
+
/**
|
|
2441
|
+
* - Slug of meta field
|
|
2442
|
+
*/
|
|
2443
|
+
slug?: string;
|
|
2444
|
+
/**
|
|
2445
|
+
* - Description regarding meta field
|
|
2446
|
+
*/
|
|
2447
|
+
description?: string;
|
|
2448
|
+
/**
|
|
2449
|
+
* - Data type of meta field
|
|
2450
|
+
*/
|
|
2451
|
+
type?: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* - Flag to denote whether meta field is
|
|
2454
|
+
* multi valued or not
|
|
2455
|
+
*/
|
|
2456
|
+
multi_value?: boolean;
|
|
2457
|
+
/**
|
|
2458
|
+
* - Company Identifer
|
|
2459
|
+
*/
|
|
2460
|
+
company_id?: string;
|
|
2461
|
+
/**
|
|
2462
|
+
* - Sales channel identifier
|
|
2463
|
+
*/
|
|
2464
|
+
application_id?: string;
|
|
2465
|
+
/**
|
|
2466
|
+
* - Whether the field is required or not
|
|
2467
|
+
*/
|
|
2468
|
+
required?: boolean;
|
|
2469
|
+
/**
|
|
2470
|
+
* - Is meta field deleted
|
|
2471
|
+
*/
|
|
2472
|
+
is_deleted?: boolean;
|
|
2473
|
+
/**
|
|
2474
|
+
* - Unique system generated id
|
|
2475
|
+
*/
|
|
2476
|
+
id?: string;
|
|
2477
|
+
validations?: any[];
|
|
2478
|
+
/**
|
|
2479
|
+
* - Date time at which field was created
|
|
2480
|
+
*/
|
|
2481
|
+
created_at?: string;
|
|
2482
|
+
/**
|
|
2483
|
+
* - Date time at for a field's last modification
|
|
2484
|
+
*/
|
|
2206
2485
|
updated_at?: string;
|
|
2207
2486
|
};
|
|
2208
2487
|
/** @returns {CustomDataDeleteSchema} */
|
|
2209
2488
|
declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
|
|
2210
2489
|
type CustomDataDeleteSchema = {
|
|
2490
|
+
/**
|
|
2491
|
+
* - Denotes the success of the delete operation
|
|
2492
|
+
*/
|
|
2211
2493
|
success?: boolean;
|
|
2494
|
+
/**
|
|
2495
|
+
* - Denotes the message of delete operation
|
|
2496
|
+
*/
|
|
2212
2497
|
message?: string;
|
|
2213
2498
|
};
|
|
2214
2499
|
/** @returns {CustomFieldValue} */
|
|
@@ -2219,22 +2504,52 @@ type CustomFieldValue = {
|
|
|
2219
2504
|
/** @returns {CustomFieldSchema} */
|
|
2220
2505
|
declare function CustomFieldSchema(): CustomFieldSchema;
|
|
2221
2506
|
type CustomFieldSchema = {
|
|
2222
|
-
|
|
2507
|
+
/**
|
|
2508
|
+
* - Unique system generated id
|
|
2509
|
+
*/
|
|
2510
|
+
id?: string;
|
|
2511
|
+
/**
|
|
2512
|
+
* - Namespace of custom field definition
|
|
2513
|
+
*/
|
|
2223
2514
|
namespace?: string;
|
|
2224
|
-
|
|
2515
|
+
/**
|
|
2516
|
+
* - Slug of custom field definition
|
|
2517
|
+
*/
|
|
2518
|
+
slug?: string;
|
|
2519
|
+
/**
|
|
2520
|
+
* - The resource for which custom field is being created
|
|
2521
|
+
*/
|
|
2225
2522
|
resource?: string;
|
|
2226
|
-
creator?: string;
|
|
2227
2523
|
value?: CustomFieldValue[];
|
|
2228
|
-
|
|
2524
|
+
/**
|
|
2525
|
+
* - Unique identifier of the resource
|
|
2526
|
+
*/
|
|
2527
|
+
resource_slug?: string;
|
|
2528
|
+
/**
|
|
2529
|
+
* - Data type of custom field
|
|
2530
|
+
*/
|
|
2229
2531
|
type?: string;
|
|
2532
|
+
/**
|
|
2533
|
+
* - Whether custom field is multi valued
|
|
2534
|
+
*/
|
|
2230
2535
|
multi_value?: boolean;
|
|
2536
|
+
/**
|
|
2537
|
+
* - Identifer for a company
|
|
2538
|
+
*/
|
|
2231
2539
|
company_id?: string;
|
|
2232
|
-
definition_id?: string;
|
|
2233
2540
|
has_invalid_values?: boolean;
|
|
2234
2541
|
invalid_value_errors?: any[];
|
|
2235
|
-
|
|
2542
|
+
/**
|
|
2543
|
+
* - Indicates whether custom field is deleted
|
|
2544
|
+
*/
|
|
2236
2545
|
is_deleted?: boolean;
|
|
2546
|
+
/**
|
|
2547
|
+
* - Time at which customer field was created
|
|
2548
|
+
*/
|
|
2237
2549
|
created_at?: string;
|
|
2550
|
+
/**
|
|
2551
|
+
* - Time at which custom field was updated
|
|
2552
|
+
*/
|
|
2238
2553
|
updated_at?: string;
|
|
2239
2554
|
};
|
|
2240
2555
|
/** @returns {CustomFieldsResponseSchema} */
|
|
@@ -2243,6 +2558,12 @@ type CustomFieldsResponseSchema = {
|
|
|
2243
2558
|
items?: CustomFieldSchema[];
|
|
2244
2559
|
page?: Page;
|
|
2245
2560
|
};
|
|
2561
|
+
/** @returns {CustomFieldsDeleteSchema} */
|
|
2562
|
+
declare function CustomFieldsDeleteSchema(): CustomFieldsDeleteSchema;
|
|
2563
|
+
type CustomFieldsDeleteSchema = {
|
|
2564
|
+
success?: boolean;
|
|
2565
|
+
message?: string;
|
|
2566
|
+
};
|
|
2246
2567
|
/** @returns {CustomFieldsResponseByResourceIdSchema} */
|
|
2247
2568
|
declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
|
|
2248
2569
|
type CustomFieldsResponseByResourceIdSchema = {
|
|
@@ -2252,7 +2573,15 @@ type CustomFieldsResponseByResourceIdSchema = {
|
|
|
2252
2573
|
declare function CustomField(): CustomField;
|
|
2253
2574
|
type CustomField = {
|
|
2254
2575
|
value?: any[];
|
|
2255
|
-
|
|
2576
|
+
/**
|
|
2577
|
+
* - This is the namespace to which custom field belongs
|
|
2578
|
+
*/
|
|
2579
|
+
namespace?: string;
|
|
2580
|
+
/**
|
|
2581
|
+
* - This is the slug of custom field used while
|
|
2582
|
+
* creating a custom field definition
|
|
2583
|
+
*/
|
|
2584
|
+
slug?: string;
|
|
2256
2585
|
};
|
|
2257
2586
|
/** @returns {CustomFieldRequestSchema} */
|
|
2258
2587
|
declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
|
|
@@ -2262,160 +2591,368 @@ type CustomFieldRequestSchema = {
|
|
|
2262
2591
|
/** @returns {CustomObjectSchema} */
|
|
2263
2592
|
declare function CustomObjectSchema(): CustomObjectSchema;
|
|
2264
2593
|
type CustomObjectSchema = {
|
|
2265
|
-
|
|
2266
|
-
|
|
2594
|
+
/**
|
|
2595
|
+
* - Unique system generated id
|
|
2596
|
+
*/
|
|
2597
|
+
id?: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* - Identifer for a company
|
|
2600
|
+
*/
|
|
2267
2601
|
company_id?: string;
|
|
2602
|
+
/**
|
|
2603
|
+
* - Identifer for a sales channel
|
|
2604
|
+
*/
|
|
2268
2605
|
application_id?: string;
|
|
2269
|
-
|
|
2270
|
-
|
|
2606
|
+
/**
|
|
2607
|
+
* - Status of custom object
|
|
2608
|
+
*/
|
|
2271
2609
|
status?: string;
|
|
2610
|
+
/**
|
|
2611
|
+
* - Slug of custom object definition
|
|
2612
|
+
*/
|
|
2272
2613
|
type?: string;
|
|
2614
|
+
/**
|
|
2615
|
+
* - Slug for custom object definition
|
|
2616
|
+
*/
|
|
2617
|
+
definition_slug?: string;
|
|
2618
|
+
/**
|
|
2619
|
+
* - Value of custom field used for displaying
|
|
2620
|
+
* custom object
|
|
2621
|
+
*/
|
|
2273
2622
|
display_name?: string;
|
|
2274
|
-
|
|
2623
|
+
/**
|
|
2624
|
+
* - Fields associated to the custom object
|
|
2625
|
+
*/
|
|
2275
2626
|
fields?: CustomFieldSchema[];
|
|
2276
2627
|
};
|
|
2277
2628
|
/** @returns {CustomObjectDefinitionRequestSchema} */
|
|
2278
2629
|
declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
|
|
2279
2630
|
type CustomObjectDefinitionRequestSchema = {
|
|
2631
|
+
/**
|
|
2632
|
+
* - Namespace/Slug of Custom object definition
|
|
2633
|
+
*/
|
|
2280
2634
|
type?: string;
|
|
2635
|
+
/**
|
|
2636
|
+
* - Unique slug for a custom object definition
|
|
2637
|
+
*/
|
|
2638
|
+
definition_slug?: string;
|
|
2639
|
+
/**
|
|
2640
|
+
* - Description of custom object definition
|
|
2641
|
+
*/
|
|
2281
2642
|
description?: string;
|
|
2643
|
+
/**
|
|
2644
|
+
* - Name of custom object
|
|
2645
|
+
*/
|
|
2282
2646
|
name?: string;
|
|
2647
|
+
/**
|
|
2648
|
+
* - Denotes which custom field to be used
|
|
2649
|
+
* for displaying custom object
|
|
2650
|
+
*/
|
|
2283
2651
|
display_name_key?: string;
|
|
2652
|
+
/**
|
|
2653
|
+
* - List
|
|
2654
|
+
* of custom field definitions belonging to this custom object definition
|
|
2655
|
+
*/
|
|
2284
2656
|
field_definitions?: CustomObjectCustomFieldDefinitions[];
|
|
2285
2657
|
};
|
|
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;
|
|
2658
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
2659
|
+
declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
|
|
2660
|
+
type CustomObjectDefinitionSlugSchema = {
|
|
2661
|
+
/**
|
|
2662
|
+
* - Unique system generated custom object definition id
|
|
2663
|
+
*/
|
|
2664
|
+
id?: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* - Display name of custom object definition
|
|
2667
|
+
*/
|
|
2311
2668
|
name?: string;
|
|
2669
|
+
/**
|
|
2670
|
+
* - Type of custom object definiton
|
|
2671
|
+
*/
|
|
2312
2672
|
type?: string;
|
|
2673
|
+
/**
|
|
2674
|
+
* - Slug of custom object definiton
|
|
2675
|
+
*/
|
|
2676
|
+
definition_slug?: string;
|
|
2677
|
+
/**
|
|
2678
|
+
* - Display name of custom object definition
|
|
2679
|
+
*/
|
|
2313
2680
|
display_name_key?: string;
|
|
2681
|
+
/**
|
|
2682
|
+
* - Description of custom object definition
|
|
2683
|
+
*/
|
|
2314
2684
|
description?: string;
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2685
|
+
/**
|
|
2686
|
+
* -
|
|
2687
|
+
* Custom fields inside custom objects
|
|
2688
|
+
*/
|
|
2689
|
+
field_definitions?: CustomFieldDefinitionDetailResSchema[];
|
|
2319
2690
|
};
|
|
2320
2691
|
/** @returns {CustomObjectDefinitionDeleteResponseSchema} */
|
|
2321
2692
|
declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
|
|
2322
2693
|
type CustomObjectDefinitionDeleteResponseSchema = {
|
|
2694
|
+
/**
|
|
2695
|
+
* - Success status of delete custom object definition.
|
|
2696
|
+
*/
|
|
2323
2697
|
success?: boolean;
|
|
2698
|
+
/**
|
|
2699
|
+
* - Response message when custom object definition
|
|
2700
|
+
* is deleted.
|
|
2701
|
+
*/
|
|
2324
2702
|
message?: string;
|
|
2325
2703
|
};
|
|
2326
|
-
/** @returns {
|
|
2327
|
-
declare function
|
|
2328
|
-
type
|
|
2704
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
2705
|
+
declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
|
|
2706
|
+
type CustomObjectEntryBulkUploadDetails = {
|
|
2707
|
+
/**
|
|
2708
|
+
* - Signed url of csv
|
|
2709
|
+
*/
|
|
2329
2710
|
url?: string;
|
|
2711
|
+
/**
|
|
2712
|
+
* - Total no of records in csv file
|
|
2713
|
+
*/
|
|
2330
2714
|
total_records?: number;
|
|
2331
2715
|
};
|
|
2332
|
-
/** @returns {
|
|
2333
|
-
declare function
|
|
2334
|
-
type
|
|
2335
|
-
|
|
2716
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
2717
|
+
declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
|
|
2718
|
+
type CustomObjectListItemDefinitionModel = {
|
|
2719
|
+
/**
|
|
2720
|
+
* - Unique system generated id
|
|
2721
|
+
*/
|
|
2722
|
+
id?: string;
|
|
2723
|
+
/**
|
|
2724
|
+
* - Name of custom object
|
|
2725
|
+
*/
|
|
2336
2726
|
name?: string;
|
|
2727
|
+
/**
|
|
2728
|
+
* - Type of custom object entry
|
|
2729
|
+
*/
|
|
2337
2730
|
type?: string;
|
|
2338
2731
|
};
|
|
2339
2732
|
/** @returns {CustomObjectListItemSchema} */
|
|
2340
2733
|
declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
|
|
2341
2734
|
type CustomObjectListItemSchema = {
|
|
2342
|
-
|
|
2343
|
-
|
|
2735
|
+
/**
|
|
2736
|
+
* - Unique system generated id
|
|
2737
|
+
*/
|
|
2738
|
+
id?: string;
|
|
2739
|
+
/**
|
|
2740
|
+
* - Status of custom object
|
|
2741
|
+
*/
|
|
2344
2742
|
status?: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* - Creation time of custom object document
|
|
2745
|
+
*/
|
|
2746
|
+
created_at?: string;
|
|
2747
|
+
/**
|
|
2748
|
+
* - Updation time of custom object document
|
|
2749
|
+
*/
|
|
2345
2750
|
updated_at?: string;
|
|
2751
|
+
/**
|
|
2752
|
+
* - Display name of custom object
|
|
2753
|
+
*/
|
|
2346
2754
|
display_name?: string;
|
|
2347
|
-
definition?:
|
|
2755
|
+
definition?: CustomObjectListItemDefinitionModel;
|
|
2756
|
+
/**
|
|
2757
|
+
* - References of the custom object entry
|
|
2758
|
+
*/
|
|
2348
2759
|
references?: number;
|
|
2349
2760
|
};
|
|
2350
2761
|
/** @returns {CustomObjectsSchema} */
|
|
2351
2762
|
declare function CustomObjectsSchema(): CustomObjectsSchema;
|
|
2352
2763
|
type CustomObjectsSchema = {
|
|
2764
|
+
/**
|
|
2765
|
+
* - List of paginated custom
|
|
2766
|
+
* object entries
|
|
2767
|
+
*/
|
|
2353
2768
|
items?: CustomObjectListItemSchema[];
|
|
2354
2769
|
page?: Page;
|
|
2355
2770
|
};
|
|
2356
|
-
/** @returns {
|
|
2357
|
-
declare function
|
|
2358
|
-
type
|
|
2359
|
-
|
|
2360
|
-
|
|
2771
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
2772
|
+
declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
|
|
2773
|
+
type CustomObjectFieldDefinition = {
|
|
2774
|
+
/**
|
|
2775
|
+
* - Unique system generate id
|
|
2776
|
+
*/
|
|
2777
|
+
id?: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* - Slug of custom field definition
|
|
2780
|
+
*/
|
|
2781
|
+
slug?: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* - Namespace of custom field definition
|
|
2784
|
+
*/
|
|
2785
|
+
namespace?: string;
|
|
2786
|
+
/**
|
|
2787
|
+
* - Value of custom field
|
|
2788
|
+
*/
|
|
2361
2789
|
value?: any[];
|
|
2790
|
+
/**
|
|
2791
|
+
* - Data type of the custom field
|
|
2792
|
+
*/
|
|
2362
2793
|
type?: string;
|
|
2363
|
-
definition_id?: string;
|
|
2364
2794
|
};
|
|
2365
|
-
/** @returns {
|
|
2366
|
-
declare function
|
|
2367
|
-
type
|
|
2368
|
-
|
|
2795
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
2796
|
+
declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
|
|
2797
|
+
type CustomObjectBySlugSchema = {
|
|
2798
|
+
/**
|
|
2799
|
+
* - Unique system generated identifer for a Custom Object
|
|
2800
|
+
*/
|
|
2801
|
+
id?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* - Status of Custom Object
|
|
2804
|
+
*/
|
|
2369
2805
|
status?: string;
|
|
2806
|
+
/**
|
|
2807
|
+
* - Display name for the Custom Object
|
|
2808
|
+
*/
|
|
2370
2809
|
display_name?: string;
|
|
2371
|
-
definition?:
|
|
2810
|
+
definition?: CustomObjectListItemDefinitionModel;
|
|
2811
|
+
/**
|
|
2812
|
+
* - Places where the custom object has been
|
|
2813
|
+
* used as a custom field
|
|
2814
|
+
*/
|
|
2372
2815
|
references?: any[];
|
|
2373
|
-
|
|
2816
|
+
/**
|
|
2817
|
+
* - Slug of custom object entry
|
|
2818
|
+
*/
|
|
2819
|
+
slug?: string;
|
|
2820
|
+
/**
|
|
2821
|
+
* - Slug of custom object definition
|
|
2822
|
+
*/
|
|
2823
|
+
definition_slug?: string;
|
|
2824
|
+
/**
|
|
2825
|
+
* - List of custom fields
|
|
2826
|
+
* inside the custom object
|
|
2827
|
+
*/
|
|
2828
|
+
fields?: CustomObjectFieldDefinition[];
|
|
2374
2829
|
};
|
|
2375
2830
|
/** @returns {CustomObjectBulkEntryInitiateDownload} */
|
|
2376
2831
|
declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
|
|
2377
2832
|
type CustomObjectBulkEntryInitiateDownload = {
|
|
2833
|
+
/**
|
|
2834
|
+
* - Message for the user
|
|
2835
|
+
*/
|
|
2378
2836
|
message?: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* - Identifer for a task
|
|
2839
|
+
*/
|
|
2379
2840
|
task_id?: string;
|
|
2380
2841
|
};
|
|
2381
2842
|
/** @returns {CustomObjectMetaSchema} */
|
|
2382
2843
|
declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
|
|
2383
2844
|
type CustomObjectMetaSchema = {
|
|
2845
|
+
/**
|
|
2846
|
+
* - Total number of entries in the bulk entry
|
|
2847
|
+
*/
|
|
2384
2848
|
mo_total_count?: number;
|
|
2849
|
+
/**
|
|
2850
|
+
* - Number of entries which were successful
|
|
2851
|
+
*/
|
|
2385
2852
|
mo_success_count?: number;
|
|
2853
|
+
/**
|
|
2854
|
+
* - Number of entries which were failed
|
|
2855
|
+
*/
|
|
2386
2856
|
mo_error_count?: number;
|
|
2857
|
+
/**
|
|
2858
|
+
* - Type of object
|
|
2859
|
+
*/
|
|
2387
2860
|
mo_defintion_type?: string;
|
|
2388
2861
|
};
|
|
2389
|
-
/** @returns {
|
|
2390
|
-
declare function
|
|
2391
|
-
type
|
|
2392
|
-
|
|
2862
|
+
/** @returns {JobSchema} */
|
|
2863
|
+
declare function JobSchema(): JobSchema;
|
|
2864
|
+
type JobSchema = {
|
|
2865
|
+
/**
|
|
2866
|
+
* - Unique system generated id
|
|
2867
|
+
*/
|
|
2868
|
+
id?: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* - List of total jobs
|
|
2871
|
+
*/
|
|
2393
2872
|
jobs?: string[];
|
|
2873
|
+
/**
|
|
2874
|
+
* - List of finished jobs
|
|
2875
|
+
*/
|
|
2394
2876
|
finished_jobs?: string[];
|
|
2877
|
+
/**
|
|
2878
|
+
* - List of jobs which resulted in an error
|
|
2879
|
+
*/
|
|
2395
2880
|
error_jobs?: string[];
|
|
2881
|
+
/**
|
|
2882
|
+
* - List of errors occurred in the job
|
|
2883
|
+
*/
|
|
2396
2884
|
errors_occured?: string[];
|
|
2885
|
+
/**
|
|
2886
|
+
* - Company Identifer
|
|
2887
|
+
*/
|
|
2397
2888
|
company_id?: string;
|
|
2398
|
-
|
|
2399
|
-
|
|
2889
|
+
/**
|
|
2890
|
+
* - Status of job
|
|
2891
|
+
*/
|
|
2400
2892
|
status?: string;
|
|
2893
|
+
/**
|
|
2894
|
+
* - Type of job
|
|
2895
|
+
*/
|
|
2401
2896
|
action_type?: string;
|
|
2897
|
+
/**
|
|
2898
|
+
* - Entity against which job is running
|
|
2899
|
+
*/
|
|
2402
2900
|
entity?: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* - URL which contains the file with errors
|
|
2903
|
+
*/
|
|
2403
2904
|
error_url?: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* - Number of items successfully finished
|
|
2907
|
+
*/
|
|
2404
2908
|
finished_count?: number;
|
|
2909
|
+
/**
|
|
2910
|
+
* - Number of items in error
|
|
2911
|
+
*/
|
|
2405
2912
|
error_count?: number;
|
|
2913
|
+
/**
|
|
2914
|
+
* - Number of successful items
|
|
2915
|
+
*/
|
|
2406
2916
|
success_count?: number;
|
|
2917
|
+
/**
|
|
2918
|
+
* - Total number of jobs
|
|
2919
|
+
*/
|
|
2407
2920
|
total_jobs?: number;
|
|
2408
2921
|
meta?: CustomObjectMetaSchema;
|
|
2922
|
+
/**
|
|
2923
|
+
* - Source from where the bulk job is created
|
|
2924
|
+
*/
|
|
2409
2925
|
created_by?: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* - Date/Time when the job was created
|
|
2928
|
+
*/
|
|
2410
2929
|
created_at?: string;
|
|
2930
|
+
/**
|
|
2931
|
+
* - Date/Time when the job was updated
|
|
2932
|
+
*/
|
|
2411
2933
|
updated_at?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* - Sales Channel Identifier
|
|
2936
|
+
*/
|
|
2937
|
+
application_id?: string;
|
|
2938
|
+
};
|
|
2939
|
+
/** @returns {CustomFieldBulkEntry} */
|
|
2940
|
+
declare function CustomFieldBulkEntry(): CustomFieldBulkEntry;
|
|
2941
|
+
type CustomFieldBulkEntry = {
|
|
2942
|
+
items?: JobSchema[];
|
|
2943
|
+
page?: Page;
|
|
2412
2944
|
};
|
|
2413
2945
|
/** @returns {CustomObjectBulkEntry} */
|
|
2414
2946
|
declare function CustomObjectBulkEntry(): CustomObjectBulkEntry;
|
|
2415
2947
|
type CustomObjectBulkEntry = {
|
|
2416
|
-
items?:
|
|
2948
|
+
items?: JobSchema[];
|
|
2417
2949
|
page?: Page;
|
|
2418
2950
|
};
|
|
2951
|
+
/** @returns {MetafieldTypesSchema} */
|
|
2952
|
+
declare function MetafieldTypesSchema(): MetafieldTypesSchema;
|
|
2953
|
+
type MetafieldTypesSchema = {
|
|
2954
|
+
metafield_types?: CustomFieldTypeSchema;
|
|
2955
|
+
};
|
|
2419
2956
|
/** @returns {CustomFieldTypeSchema} */
|
|
2420
2957
|
declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
|
|
2421
2958
|
type CustomFieldTypeSchema = {
|
|
@@ -2432,6 +2969,8 @@ type CustomFieldTypeSchema = {
|
|
|
2432
2969
|
url?: Url;
|
|
2433
2970
|
metaobject?: Metaobject;
|
|
2434
2971
|
product?: Product;
|
|
2972
|
+
html?: HTML;
|
|
2973
|
+
duration?: Duration;
|
|
2435
2974
|
};
|
|
2436
2975
|
/** @returns {SupportedValidationsMetaExampleSchema} */
|
|
2437
2976
|
declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
|
|
@@ -2453,130 +2992,392 @@ type SupportedValidationsSchema = {
|
|
|
2453
2992
|
required?: boolean;
|
|
2454
2993
|
meta?: SupportedValidationsMetaSchema;
|
|
2455
2994
|
};
|
|
2995
|
+
/** @returns {Duration} */
|
|
2996
|
+
declare function Duration(): Duration;
|
|
2997
|
+
type Duration = {
|
|
2998
|
+
/**
|
|
2999
|
+
* - Name data type of custom field
|
|
3000
|
+
*/
|
|
3001
|
+
name?: string;
|
|
3002
|
+
/**
|
|
3003
|
+
* - Flag for listing enabled or not
|
|
3004
|
+
*/
|
|
3005
|
+
list_enabled?: boolean;
|
|
3006
|
+
/**
|
|
3007
|
+
* - Type of custom field
|
|
3008
|
+
*/
|
|
3009
|
+
type?: string;
|
|
3010
|
+
/**
|
|
3011
|
+
* - Category of custom field
|
|
3012
|
+
*/
|
|
3013
|
+
category?: string;
|
|
3014
|
+
/**
|
|
3015
|
+
* - List of
|
|
3016
|
+
* validations available for the field
|
|
3017
|
+
*/
|
|
3018
|
+
supported_validations?: SupportedValidationsSchema[];
|
|
3019
|
+
};
|
|
3020
|
+
/** @returns {HTML} */
|
|
3021
|
+
declare function HTML(): HTML;
|
|
3022
|
+
type HTML = {
|
|
3023
|
+
/**
|
|
3024
|
+
* - Name data type of custom field
|
|
3025
|
+
*/
|
|
3026
|
+
name?: string;
|
|
3027
|
+
/**
|
|
3028
|
+
* - Flag for listing enabled or not
|
|
3029
|
+
*/
|
|
3030
|
+
list_enabled?: boolean;
|
|
3031
|
+
/**
|
|
3032
|
+
* - Type of custom field
|
|
3033
|
+
*/
|
|
3034
|
+
type?: string;
|
|
3035
|
+
/**
|
|
3036
|
+
* - List of
|
|
3037
|
+
* validations available for the field
|
|
3038
|
+
*/
|
|
3039
|
+
supported_validations?: SupportedValidationsSchema[];
|
|
3040
|
+
};
|
|
2456
3041
|
/** @returns {StringSingleLine} */
|
|
2457
3042
|
declare function StringSingleLine(): StringSingleLine;
|
|
2458
3043
|
type StringSingleLine = {
|
|
3044
|
+
/**
|
|
3045
|
+
* - Name data type of custom field
|
|
3046
|
+
*/
|
|
2459
3047
|
name?: string;
|
|
3048
|
+
/**
|
|
3049
|
+
* - Flag for listing enabled or not
|
|
3050
|
+
*/
|
|
2460
3051
|
list_enabled?: boolean;
|
|
3052
|
+
/**
|
|
3053
|
+
* - Category of custom field
|
|
3054
|
+
*/
|
|
2461
3055
|
category?: string;
|
|
3056
|
+
/**
|
|
3057
|
+
* - Type of custom field
|
|
3058
|
+
*/
|
|
2462
3059
|
type?: string;
|
|
3060
|
+
/**
|
|
3061
|
+
* - List of
|
|
3062
|
+
* validations available for the field
|
|
3063
|
+
*/
|
|
2463
3064
|
supported_validations?: SupportedValidationsSchema[];
|
|
2464
3065
|
};
|
|
2465
3066
|
/** @returns {StringMultiLine} */
|
|
2466
3067
|
declare function StringMultiLine(): StringMultiLine;
|
|
2467
3068
|
type StringMultiLine = {
|
|
3069
|
+
/**
|
|
3070
|
+
* - Name data type of custom field
|
|
3071
|
+
*/
|
|
2468
3072
|
name?: string;
|
|
3073
|
+
/**
|
|
3074
|
+
* - Flag for listing enabled or not
|
|
3075
|
+
*/
|
|
2469
3076
|
list_enabled?: boolean;
|
|
3077
|
+
/**
|
|
3078
|
+
* - Category of custom field
|
|
3079
|
+
*/
|
|
2470
3080
|
category?: string;
|
|
3081
|
+
/**
|
|
3082
|
+
* - Type of custom field
|
|
3083
|
+
*/
|
|
2471
3084
|
type?: string;
|
|
3085
|
+
/**
|
|
3086
|
+
* - List of
|
|
3087
|
+
* validations available for the field
|
|
3088
|
+
*/
|
|
2472
3089
|
supported_validations?: SupportedValidationsSchema[];
|
|
2473
3090
|
};
|
|
2474
3091
|
/** @returns {Dropdown} */
|
|
2475
3092
|
declare function Dropdown(): Dropdown;
|
|
2476
3093
|
type Dropdown = {
|
|
3094
|
+
/**
|
|
3095
|
+
* - Name data type of custom field
|
|
3096
|
+
*/
|
|
2477
3097
|
name?: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* - Flag for listing enabled or not
|
|
3100
|
+
*/
|
|
2478
3101
|
list_enabled?: boolean;
|
|
3102
|
+
/**
|
|
3103
|
+
* - Category of custom field
|
|
3104
|
+
*/
|
|
2479
3105
|
category?: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* - Category of custom field
|
|
3108
|
+
*/
|
|
2480
3109
|
type?: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* - List of
|
|
3112
|
+
* validations available for the field
|
|
3113
|
+
*/
|
|
2481
3114
|
supported_validations?: SupportedValidationsSchema[];
|
|
2482
3115
|
};
|
|
2483
3116
|
/** @returns {Integer} */
|
|
2484
3117
|
declare function Integer(): Integer;
|
|
2485
3118
|
type Integer = {
|
|
3119
|
+
/**
|
|
3120
|
+
* - Name data type of custom field
|
|
3121
|
+
*/
|
|
2486
3122
|
name?: string;
|
|
3123
|
+
/**
|
|
3124
|
+
* - Flag for listing enabled or not
|
|
3125
|
+
*/
|
|
2487
3126
|
list_enabled?: boolean;
|
|
3127
|
+
/**
|
|
3128
|
+
* - Type of custom field
|
|
3129
|
+
*/
|
|
2488
3130
|
type?: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* - Category of custom field
|
|
3133
|
+
*/
|
|
2489
3134
|
category?: string;
|
|
3135
|
+
/**
|
|
3136
|
+
* - List of
|
|
3137
|
+
* validations available for the field
|
|
3138
|
+
*/
|
|
2490
3139
|
supported_validations?: SupportedValidationsSchema[];
|
|
2491
3140
|
};
|
|
2492
3141
|
/** @returns {FloatType} */
|
|
2493
3142
|
declare function FloatType(): FloatType;
|
|
2494
3143
|
type FloatType = {
|
|
3144
|
+
/**
|
|
3145
|
+
* - Name data type of custom field
|
|
3146
|
+
*/
|
|
2495
3147
|
name?: string;
|
|
3148
|
+
/**
|
|
3149
|
+
* - Flag for listing enabled or not
|
|
3150
|
+
*/
|
|
2496
3151
|
list_enabled?: boolean;
|
|
3152
|
+
/**
|
|
3153
|
+
* - Type of custom field
|
|
3154
|
+
*/
|
|
2497
3155
|
type?: string;
|
|
3156
|
+
/**
|
|
3157
|
+
* - Category of custom field
|
|
3158
|
+
*/
|
|
2498
3159
|
category?: string;
|
|
3160
|
+
/**
|
|
3161
|
+
* - List of
|
|
3162
|
+
* validations available for the field
|
|
3163
|
+
*/
|
|
2499
3164
|
supported_validations?: SupportedValidationsSchema[];
|
|
2500
3165
|
};
|
|
2501
3166
|
/** @returns {BooleanType} */
|
|
2502
3167
|
declare function BooleanType(): BooleanType;
|
|
2503
3168
|
type BooleanType = {
|
|
3169
|
+
/**
|
|
3170
|
+
* - Name data type of custom field
|
|
3171
|
+
*/
|
|
2504
3172
|
name?: string;
|
|
3173
|
+
/**
|
|
3174
|
+
* - Category of custom field
|
|
3175
|
+
*/
|
|
2505
3176
|
category?: string;
|
|
3177
|
+
/**
|
|
3178
|
+
* - Flag for listing enabled or not
|
|
3179
|
+
*/
|
|
2506
3180
|
list_enabled?: boolean;
|
|
3181
|
+
/**
|
|
3182
|
+
* - Category of custom field
|
|
3183
|
+
*/
|
|
2507
3184
|
type?: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* - List of
|
|
3187
|
+
* validations available for the field
|
|
3188
|
+
*/
|
|
2508
3189
|
supported_validations?: SupportedValidationsSchema[];
|
|
2509
3190
|
};
|
|
2510
3191
|
/** @returns {Date} */
|
|
2511
3192
|
declare function Date(): Date;
|
|
2512
3193
|
type Date = {
|
|
3194
|
+
/**
|
|
3195
|
+
* - Name data type of custom field
|
|
3196
|
+
*/
|
|
2513
3197
|
name?: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* - Flag for listing enabled or not
|
|
3200
|
+
*/
|
|
2514
3201
|
list_enabled?: boolean;
|
|
3202
|
+
/**
|
|
3203
|
+
* - Category of custom field
|
|
3204
|
+
*/
|
|
2515
3205
|
category?: string;
|
|
3206
|
+
/**
|
|
3207
|
+
* - Type of custom field
|
|
3208
|
+
*/
|
|
2516
3209
|
type?: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* - List of
|
|
3212
|
+
* validations available for the field
|
|
3213
|
+
*/
|
|
2517
3214
|
supported_validations?: SupportedValidationsSchema[];
|
|
2518
3215
|
};
|
|
2519
3216
|
/** @returns {Datetime} */
|
|
2520
3217
|
declare function Datetime(): Datetime;
|
|
2521
3218
|
type Datetime = {
|
|
3219
|
+
/**
|
|
3220
|
+
* - Name data type of custom field
|
|
3221
|
+
*/
|
|
2522
3222
|
name?: string;
|
|
3223
|
+
/**
|
|
3224
|
+
* - Category of custom field
|
|
3225
|
+
*/
|
|
2523
3226
|
category?: string;
|
|
3227
|
+
/**
|
|
3228
|
+
* - Flag for listing enabled or not
|
|
3229
|
+
*/
|
|
2524
3230
|
list_enabled?: boolean;
|
|
3231
|
+
/**
|
|
3232
|
+
* - Type of custom field
|
|
3233
|
+
*/
|
|
2525
3234
|
type?: string;
|
|
3235
|
+
/**
|
|
3236
|
+
* - List of
|
|
3237
|
+
* validations available for the field
|
|
3238
|
+
*/
|
|
2526
3239
|
supported_validations?: SupportedValidationsSchema[];
|
|
2527
3240
|
};
|
|
2528
3241
|
/** @returns {Json} */
|
|
2529
3242
|
declare function Json(): Json;
|
|
2530
3243
|
type Json = {
|
|
3244
|
+
/**
|
|
3245
|
+
* - Name data type of custom field
|
|
3246
|
+
*/
|
|
2531
3247
|
name?: string;
|
|
3248
|
+
/**
|
|
3249
|
+
* - Flag for listing enabled or not
|
|
3250
|
+
*/
|
|
2532
3251
|
list_enabled?: boolean;
|
|
3252
|
+
/**
|
|
3253
|
+
* - Category of custom field
|
|
3254
|
+
*/
|
|
2533
3255
|
category?: string;
|
|
3256
|
+
/**
|
|
3257
|
+
* - Type of custom field
|
|
3258
|
+
*/
|
|
2534
3259
|
type?: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* - List of
|
|
3262
|
+
* validations available for the field
|
|
3263
|
+
*/
|
|
2535
3264
|
supported_validations?: SupportedValidationsSchema[];
|
|
2536
3265
|
};
|
|
2537
3266
|
/** @returns {File} */
|
|
2538
3267
|
declare function File(): File;
|
|
2539
3268
|
type File = {
|
|
3269
|
+
/**
|
|
3270
|
+
* - Name data type of custom field
|
|
3271
|
+
*/
|
|
2540
3272
|
name?: string;
|
|
3273
|
+
/**
|
|
3274
|
+
* - Category of custom field
|
|
3275
|
+
*/
|
|
2541
3276
|
category?: string;
|
|
3277
|
+
/**
|
|
3278
|
+
* - Flag for listing enabled or not
|
|
3279
|
+
*/
|
|
2542
3280
|
list_enabled?: boolean;
|
|
3281
|
+
/**
|
|
3282
|
+
* - Type of custom field
|
|
3283
|
+
*/
|
|
2543
3284
|
type?: string;
|
|
2544
3285
|
supported_validations?: SupportedValidationsSchema[];
|
|
2545
3286
|
};
|
|
2546
3287
|
/** @returns {Url} */
|
|
2547
3288
|
declare function Url(): Url;
|
|
2548
3289
|
type Url = {
|
|
3290
|
+
/**
|
|
3291
|
+
* - Name data type of custom field
|
|
3292
|
+
*/
|
|
2549
3293
|
name?: string;
|
|
3294
|
+
/**
|
|
3295
|
+
* - Flag for listing enabled or not
|
|
3296
|
+
*/
|
|
2550
3297
|
list_enabled?: boolean;
|
|
3298
|
+
/**
|
|
3299
|
+
* - Type of custom field
|
|
3300
|
+
*/
|
|
2551
3301
|
type?: string;
|
|
3302
|
+
/**
|
|
3303
|
+
* - List of
|
|
3304
|
+
* validations available for the field
|
|
3305
|
+
*/
|
|
2552
3306
|
supported_validations?: SupportedValidationsSchema[];
|
|
2553
3307
|
};
|
|
2554
3308
|
/** @returns {Metaobject} */
|
|
2555
3309
|
declare function Metaobject(): Metaobject;
|
|
2556
3310
|
type Metaobject = {
|
|
3311
|
+
/**
|
|
3312
|
+
* - Name of Custom Object
|
|
3313
|
+
*/
|
|
2557
3314
|
name?: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* - Whether the field is allowed to have
|
|
3317
|
+
* multiple list items
|
|
3318
|
+
*/
|
|
2558
3319
|
list_enabled?: boolean;
|
|
3320
|
+
/**
|
|
3321
|
+
* - Category of Custom Object Definition that
|
|
3322
|
+
* Custom Object belongs to
|
|
3323
|
+
*/
|
|
2559
3324
|
category?: string;
|
|
3325
|
+
/**
|
|
3326
|
+
* - Type of Custom Object Definition
|
|
3327
|
+
*/
|
|
2560
3328
|
type?: string;
|
|
2561
3329
|
supported_validations?: SupportedValidationsSchema[];
|
|
2562
3330
|
};
|
|
2563
3331
|
/** @returns {Product} */
|
|
2564
3332
|
declare function Product(): Product;
|
|
2565
3333
|
type Product = {
|
|
3334
|
+
/**
|
|
3335
|
+
* - Name of Product
|
|
3336
|
+
*/
|
|
2566
3337
|
name?: string;
|
|
3338
|
+
/**
|
|
3339
|
+
* - Whether the field is allowed to have
|
|
3340
|
+
* multiple list items
|
|
3341
|
+
*/
|
|
2567
3342
|
list_enabled?: boolean;
|
|
3343
|
+
/**
|
|
3344
|
+
* - Category of Custom Object Definition that
|
|
3345
|
+
* Product is associated with
|
|
3346
|
+
*/
|
|
2568
3347
|
category?: string;
|
|
3348
|
+
/**
|
|
3349
|
+
* - Custom Object Definition that Product is associated with
|
|
3350
|
+
*/
|
|
2569
3351
|
type?: string;
|
|
2570
3352
|
supported_validations?: SupportedValidationsSchema[];
|
|
2571
3353
|
};
|
|
2572
3354
|
/** @returns {CustomObjectEntry} */
|
|
2573
3355
|
declare function CustomObjectEntry(): CustomObjectEntry;
|
|
2574
3356
|
type CustomObjectEntry = {
|
|
2575
|
-
|
|
3357
|
+
/**
|
|
3358
|
+
* - Unique system generated id
|
|
3359
|
+
*/
|
|
3360
|
+
id?: string;
|
|
3361
|
+
/**
|
|
3362
|
+
* - Name of Custom Object definition
|
|
3363
|
+
*/
|
|
2576
3364
|
name?: string;
|
|
3365
|
+
/**
|
|
3366
|
+
* - Type of Custom Object Definition
|
|
3367
|
+
*/
|
|
2577
3368
|
type?: string;
|
|
3369
|
+
/**
|
|
3370
|
+
* - Updation time of a Custom Object
|
|
3371
|
+
*/
|
|
2578
3372
|
updated_at?: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* - Number of entries against the Custom
|
|
3375
|
+
* Object definition
|
|
3376
|
+
*/
|
|
2579
3377
|
entries_count?: number;
|
|
3378
|
+
/**
|
|
3379
|
+
* - Number of fields against a Custom Object definition
|
|
3380
|
+
*/
|
|
2580
3381
|
fields_count?: number;
|
|
2581
3382
|
};
|
|
2582
3383
|
/** @returns {CustomObjectDefinitionsSchema} */
|
|
@@ -2588,20 +3389,65 @@ type CustomObjectDefinitionsSchema = {
|
|
|
2588
3389
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
2589
3390
|
declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
|
|
2590
3391
|
type CustomObjectEntryFieldSchema = {
|
|
2591
|
-
|
|
2592
|
-
|
|
3392
|
+
/**
|
|
3393
|
+
* - This is namespace for a custom field definition
|
|
3394
|
+
*/
|
|
3395
|
+
namespace?: string;
|
|
3396
|
+
/**
|
|
3397
|
+
* - This is slug for a custom field definition
|
|
3398
|
+
*/
|
|
3399
|
+
slug?: string;
|
|
3400
|
+
};
|
|
3401
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3402
|
+
declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
|
|
3403
|
+
type CustomObjectEntryFieldSchemaWithoutID = {
|
|
3404
|
+
/**
|
|
3405
|
+
* - Custom fields belonging to a custom object
|
|
3406
|
+
*/
|
|
3407
|
+
slug?: string;
|
|
3408
|
+
/**
|
|
3409
|
+
* - Value of custom field inside a custom object
|
|
3410
|
+
*/
|
|
3411
|
+
value?: any;
|
|
2593
3412
|
};
|
|
2594
3413
|
/** @returns {CustomObjectRequestSchema} */
|
|
2595
3414
|
declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
|
|
2596
3415
|
type CustomObjectRequestSchema = {
|
|
3416
|
+
/**
|
|
3417
|
+
* - Flag to denote status of Custom Object
|
|
3418
|
+
*/
|
|
2597
3419
|
status?: string;
|
|
2598
|
-
|
|
3420
|
+
/**
|
|
3421
|
+
* - This is slug for a custom field definition
|
|
3422
|
+
*/
|
|
3423
|
+
slug?: string;
|
|
3424
|
+
/**
|
|
3425
|
+
* - List of custom fields
|
|
3426
|
+
*/
|
|
2599
3427
|
fields?: CustomObjectEntryFieldSchema[];
|
|
2600
3428
|
};
|
|
3429
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3430
|
+
declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
|
|
3431
|
+
type CustomObjectRequestSchemaWithoutId = {
|
|
3432
|
+
/**
|
|
3433
|
+
* - Status of the custom object entry.
|
|
3434
|
+
*/
|
|
3435
|
+
status?: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* - List of custom fields
|
|
3438
|
+
*/
|
|
3439
|
+
fields?: CustomObjectEntryFieldSchemaWithoutID[];
|
|
3440
|
+
};
|
|
2601
3441
|
/** @returns {CustomObjectBulkSchema} */
|
|
2602
3442
|
declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
|
|
2603
3443
|
type CustomObjectBulkSchema = {
|
|
3444
|
+
/**
|
|
3445
|
+
* - Full URL for the bulk operations data
|
|
3446
|
+
*/
|
|
2604
3447
|
url?: string;
|
|
3448
|
+
/**
|
|
3449
|
+
* - Total records in the upload.
|
|
3450
|
+
*/
|
|
2605
3451
|
total_records?: number;
|
|
2606
3452
|
};
|
|
2607
3453
|
/** @returns {ActionPage} */
|