@gofynd/fdk-client-javascript 1.4.15-beta.2 → 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 +5046 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1979 -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 +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- 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,2133 +0,0 @@
|
|
|
1
|
-
export = ContentApplicationModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef ApplicationLegal
|
|
4
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
5
|
-
* @property {string} [tnc] - Content for Terms and Conditions page on storefront.
|
|
6
|
-
* @property {string} [policy] - Content for Privacy Policy page on storefront.
|
|
7
|
-
* @property {string} [shipping] - Content for Shipping Policy page on storefront.
|
|
8
|
-
* @property {string} [returns] - Content for Return policy page on storefront.
|
|
9
|
-
* @property {ApplicationLegalFAQ[]} [faq] - FAQs of an application.
|
|
10
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
11
|
-
* @property {string} [updated_at] - Timestamp which represent when was the last
|
|
12
|
-
* time when data was updated.
|
|
13
|
-
* @property {string} [created_at] - Timestamp which represent the time when
|
|
14
|
-
* data was created.
|
|
15
|
-
*/
|
|
16
|
-
/**
|
|
17
|
-
* @typedef ApplicationLegalFAQ
|
|
18
|
-
* @property {string} [question] - The contents of a question of a FAQ.
|
|
19
|
-
* @property {string} [answer] - The contents of a answer of a FAQ.
|
|
20
|
-
*/
|
|
21
|
-
/**
|
|
22
|
-
* @typedef SeoComponent
|
|
23
|
-
* @property {SeoSchema} [seo]
|
|
24
|
-
*/
|
|
25
|
-
/**
|
|
26
|
-
* @typedef SeoSchema
|
|
27
|
-
* @property {string} [app] - Application ID - Identifier for a Sales channel.
|
|
28
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
29
|
-
* @property {string} [robots_txt] - Contents of robots.txt file of a sales channel.
|
|
30
|
-
* @property {boolean} [sitemap_enabled] - Whether sitemaps is enabled or not
|
|
31
|
-
* for a sales channel's website.
|
|
32
|
-
* @property {string} [additonal_sitemap] - Contents of additional sitemap.
|
|
33
|
-
* @property {boolean} [cannonical_enabled] - Whether canonical tags is enabled
|
|
34
|
-
* or not for a sales channel's website.
|
|
35
|
-
* @property {CustomMetaTag[]} [custom_meta_tags] - Custom meta tags for a sales
|
|
36
|
-
* channel website.
|
|
37
|
-
* @property {Detail} [details]
|
|
38
|
-
* @property {string} [created_at] - Timestamp which represent the time when
|
|
39
|
-
* data was created.
|
|
40
|
-
* @property {string} [updated_at] - Timestamp which represent when was the last
|
|
41
|
-
* time when data was updated.
|
|
42
|
-
*/
|
|
43
|
-
/**
|
|
44
|
-
* @typedef CustomMetaTag
|
|
45
|
-
* @property {string} [name] - Name of the custom meta tag group.
|
|
46
|
-
* @property {string} [content] - Contents of the custom meta tag group.
|
|
47
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
48
|
-
*/
|
|
49
|
-
/**
|
|
50
|
-
* @typedef Detail
|
|
51
|
-
* @property {string} [title] - Contents of the og:title of a sales channel website.
|
|
52
|
-
* @property {string} [description] - Contents of the og:description of a sales
|
|
53
|
-
* channel website.
|
|
54
|
-
* @property {string} [image_url] - URL of the og:image of a sales channel website.
|
|
55
|
-
*/
|
|
56
|
-
/**
|
|
57
|
-
* @typedef SeoSchemaComponent
|
|
58
|
-
* @property {SEOSchemaMarkupTemplate[]} [items] - List of SEO Markup Schemas
|
|
59
|
-
* for a sales channel website.
|
|
60
|
-
*/
|
|
61
|
-
/**
|
|
62
|
-
* @typedef SEOSchemaMarkupTemplate
|
|
63
|
-
* @property {string} [id] - Unique identifier for an entry.
|
|
64
|
-
* @property {string} [title] - Title of the SEO Schema template.
|
|
65
|
-
* @property {string} [page_type] - Page Type for the SEO Schema Template where
|
|
66
|
-
* it'll be rendered.
|
|
67
|
-
* @property {string} [description] - Description of the SEO Schema Template.
|
|
68
|
-
* @property {string} [schema] - Contents of the SEO Schema template in nunjucks format.
|
|
69
|
-
* @property {boolean} [active] - Whether SEO Schema template is active or not.
|
|
70
|
-
* @property {string} [created_at] - Timestamp which represent the time when
|
|
71
|
-
* data was created.
|
|
72
|
-
* @property {string} [updated_at] - Timestamp which represent when was the last
|
|
73
|
-
* time when data was updated.
|
|
74
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
75
|
-
*/
|
|
76
|
-
/**
|
|
77
|
-
* @typedef ScheduleSchema
|
|
78
|
-
* @property {string} [cron] - String representing the cron expression.
|
|
79
|
-
* @property {string} [start] - Start time of schedule.
|
|
80
|
-
* @property {string} [end] - End time of schedule.
|
|
81
|
-
* @property {number} [duration] - Duration of the scheduled entity.
|
|
82
|
-
* @property {NextSchedule[]} [next_schedule] - Details regarding the next
|
|
83
|
-
* trigger point of schedule.
|
|
84
|
-
*/
|
|
85
|
-
/**
|
|
86
|
-
* @typedef NextSchedule
|
|
87
|
-
* @property {string} [start] - Start time of next trigger point of schedule.
|
|
88
|
-
* @property {string} [end] - End time of next trigger point of schedule.
|
|
89
|
-
*/
|
|
90
|
-
/**
|
|
91
|
-
* @typedef AnnouncementSchema
|
|
92
|
-
* @property {string} [announcement] - Details regarding the announcement bar contents.
|
|
93
|
-
* @property {ScheduleStartSchema} [schedule]
|
|
94
|
-
*/
|
|
95
|
-
/**
|
|
96
|
-
* @typedef ScheduleStartSchema
|
|
97
|
-
* @property {string} [start] - Start time of schedule.
|
|
98
|
-
* @property {string} [end] - End time of schedule.
|
|
99
|
-
*/
|
|
100
|
-
/**
|
|
101
|
-
* @typedef BlogGetResponse
|
|
102
|
-
* @property {BlogSchema[]} [items] - List of blogs with details.
|
|
103
|
-
* @property {Page} [page]
|
|
104
|
-
* @property {BlogFilters} [filters]
|
|
105
|
-
*/
|
|
106
|
-
/**
|
|
107
|
-
* @typedef BlogFilters
|
|
108
|
-
* @property {string[]} [tags] - All tags present under blogs.
|
|
109
|
-
*/
|
|
110
|
-
/**
|
|
111
|
-
* @typedef ResourceContent
|
|
112
|
-
* @property {string} [type] - The type of content of blogs - html.
|
|
113
|
-
* @property {string} [value] - The contents of blog.
|
|
114
|
-
*/
|
|
115
|
-
/**
|
|
116
|
-
* @typedef Asset
|
|
117
|
-
* @property {string} [aspect_ratio] - Aspect ratio of the image.
|
|
118
|
-
* @property {string} [id] - Unique identifier for an entry.
|
|
119
|
-
* @property {string} [secure_url] - URL of the image.
|
|
120
|
-
*/
|
|
121
|
-
/**
|
|
122
|
-
* @typedef Author
|
|
123
|
-
* @property {string} [designation] - Description of the author of blog.
|
|
124
|
-
* @property {string} [id] - Unique Identifier of the author of blog.
|
|
125
|
-
* @property {string} [name] - Name of the author of blog.
|
|
126
|
-
*/
|
|
127
|
-
/**
|
|
128
|
-
* @typedef BlogSchema
|
|
129
|
-
* @property {string} [_id] - Unique identifier for an entry.
|
|
130
|
-
* @property {Object} [_custom_json] - Custom JSON object for specific use cases.
|
|
131
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
132
|
-
* @property {boolean} [archived] - Boolean flag denoting whether blog is archived or not.
|
|
133
|
-
* @property {Author} [author]
|
|
134
|
-
* @property {ResourceContent[]} [content] - Contents of blog.
|
|
135
|
-
* @property {Asset} [feature_image]
|
|
136
|
-
* @property {boolean} [published] - Boolean flag denoting whether blog is
|
|
137
|
-
* published or not.
|
|
138
|
-
* @property {string} [reading_time] - Estimated time required to read the blog.
|
|
139
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
140
|
-
* @property {string[]} [tags] - Tags under a blog.
|
|
141
|
-
* @property {string} [publish_date] - Timestamp denoting when the blog was published.
|
|
142
|
-
* @property {SEO} [seo]
|
|
143
|
-
* @property {string} [title] - Title of the Blog.
|
|
144
|
-
* @property {DateMeta} [date_meta]
|
|
145
|
-
* @property {string} [summary] - A brief description of blog.
|
|
146
|
-
*/
|
|
147
|
-
/**
|
|
148
|
-
* @typedef SEO
|
|
149
|
-
* @property {string} [description] - The contents of og:description.
|
|
150
|
-
* @property {SEOImage} [image]
|
|
151
|
-
* @property {string} [title] - The contents of og:title.
|
|
152
|
-
* @property {SEOMetaItem[]} [meta_tags] - List of meta tags.
|
|
153
|
-
* @property {SEOSitemap} [sitemap]
|
|
154
|
-
* @property {SEObreadcrumb[]} [breadcrumb] - List of action objects which can
|
|
155
|
-
* power breadcrumbs on website.
|
|
156
|
-
* @property {string} [canonical_url] - The canonical URL for canonical link element.
|
|
157
|
-
*/
|
|
158
|
-
/**
|
|
159
|
-
* @typedef SEOImage
|
|
160
|
-
* @property {string} [url] - The url of image.
|
|
161
|
-
*/
|
|
162
|
-
/**
|
|
163
|
-
* @typedef SEOMetaItem
|
|
164
|
-
* @property {string} [title] - Title of the custom meta tags group.
|
|
165
|
-
* @property {SEOMetaItems[]} [items] - List of key value pairs to power meta tags.
|
|
166
|
-
*/
|
|
167
|
-
/**
|
|
168
|
-
* @typedef SEOMetaItems
|
|
169
|
-
* @property {string} [key] - The key denoting the attribute name of SEO meta tag.
|
|
170
|
-
* @property {string} [value] - The key denoting the attribute value of SEO meta tag.
|
|
171
|
-
*/
|
|
172
|
-
/**
|
|
173
|
-
* @typedef SEOSitemap
|
|
174
|
-
* @property {number} [priority] - Value of sitemap priority randing from 0.0 to 1.0.
|
|
175
|
-
* @property {string} [frequency] - Value of sitemap frequency change denoting
|
|
176
|
-
* how frequently the content changes.
|
|
177
|
-
*/
|
|
178
|
-
/**
|
|
179
|
-
* @typedef SEObreadcrumb
|
|
180
|
-
* @property {string} [url] - URL of where the breadcrumb link redirects to.
|
|
181
|
-
* @property {Action} [action]
|
|
182
|
-
*/
|
|
183
|
-
/**
|
|
184
|
-
* @typedef DateMeta
|
|
185
|
-
* @property {string} [created_on] - Timestamp which represent the time when
|
|
186
|
-
* data was created.
|
|
187
|
-
* @property {string} [modified_on] - Timestamp which represent when was the
|
|
188
|
-
* last time when data was updated.
|
|
189
|
-
*/
|
|
190
|
-
/**
|
|
191
|
-
* @typedef LocaleLanguage
|
|
192
|
-
* @property {Language} [hi]
|
|
193
|
-
* @property {Language} [ar]
|
|
194
|
-
* @property {Language} [en_us]
|
|
195
|
-
*/
|
|
196
|
-
/**
|
|
197
|
-
* @typedef Language
|
|
198
|
-
* @property {string} [display] - Name of an entry in a specific language.
|
|
199
|
-
*/
|
|
200
|
-
/**
|
|
201
|
-
* @typedef Action
|
|
202
|
-
* @property {string} [type] - Type of action to be taken e.g, page.
|
|
203
|
-
* @property {ActionPage} [page]
|
|
204
|
-
* @property {ActionPage} [popup]
|
|
205
|
-
*/
|
|
206
|
-
/**
|
|
207
|
-
* @typedef NavigationReference
|
|
208
|
-
* @property {string[]} [acl] - Details regarding the authorization level to
|
|
209
|
-
* access the navigation item.
|
|
210
|
-
* @property {string[]} [tags] - List of tags under a navigation link.
|
|
211
|
-
* @property {LocaleLanguage} [_locale_language]
|
|
212
|
-
* @property {string} [image] - URL of an image associated with a navigation link.
|
|
213
|
-
* @property {string} [type] - Type of action to be taken e.g, page.
|
|
214
|
-
* @property {Action} [action]
|
|
215
|
-
* @property {boolean} [active] - Whether navigation is active or not.
|
|
216
|
-
* @property {string} [display] - Display name of the navigation link.
|
|
217
|
-
* @property {number} [sort_order] - Number denoting the position of navigation link.
|
|
218
|
-
* @property {NavigationReference[]} [sub_navigation] - List of sub links and
|
|
219
|
-
* details under a navigation.
|
|
220
|
-
*/
|
|
221
|
-
/**
|
|
222
|
-
* @typedef ConfigurationSchema
|
|
223
|
-
* @property {number} [sleep_time] - Amount of time in seconds after which
|
|
224
|
-
* slideshow/screensaver is run.
|
|
225
|
-
* @property {boolean} [start_on_launch] - Flag denoting whether screensaver
|
|
226
|
-
* needs to be shown on launch of website/app.
|
|
227
|
-
* @property {number} [duration] - Duration of the slideshow/screensaver.
|
|
228
|
-
* @property {string} [slide_direction] - Direction of the slideshow.
|
|
229
|
-
*/
|
|
230
|
-
/**
|
|
231
|
-
* @typedef SlideshowMedia
|
|
232
|
-
* @property {string} [type] - Type of Media.
|
|
233
|
-
* @property {string} [url] - URL of Media where it's hosted.
|
|
234
|
-
* @property {string} [bg_color] - Background colour of Media.
|
|
235
|
-
* @property {number} [duration] - Amount of time in seconds for which Media has
|
|
236
|
-
* to appear.
|
|
237
|
-
* @property {boolean} [auto_decide_duration] - Whether the duration for each
|
|
238
|
-
* media is to be decided by system or not. If true, it'll equally divide time
|
|
239
|
-
* in all medias.
|
|
240
|
-
* @property {Action} [action]
|
|
241
|
-
*/
|
|
242
|
-
/**
|
|
243
|
-
* @typedef AnnouncementsResponseSchema
|
|
244
|
-
* @property {Object} [announcements] - List all the announcement bar details
|
|
245
|
-
* and its contents.
|
|
246
|
-
* @property {number} [refresh_rate] - Number of seconds after which api should
|
|
247
|
-
* hit again to fetch new announcements.
|
|
248
|
-
* @property {string[]} [refresh_pages] - List of page slugs on which
|
|
249
|
-
* announcement should be fetched as soon as they are loaded.
|
|
250
|
-
*/
|
|
251
|
-
/**
|
|
252
|
-
* @typedef FaqResponseSchema
|
|
253
|
-
* @property {FaqSchema[]} [faqs] - List of FAQs.
|
|
254
|
-
*/
|
|
255
|
-
/**
|
|
256
|
-
* @typedef DataLoaderSchema
|
|
257
|
-
* @property {string} [name] - Name of dataloader.
|
|
258
|
-
* @property {string} [service] - Service of data loader which overrides the
|
|
259
|
-
* default method.
|
|
260
|
-
* @property {string} [operation_id] - Operation ID of the method which data
|
|
261
|
-
* loader is overriding.
|
|
262
|
-
* @property {string} [type] - Type of data loader.
|
|
263
|
-
* @property {string} [url] - URL at which data loader redirects.
|
|
264
|
-
* @property {string} [content] - Content of a data loader.
|
|
265
|
-
* @property {DataLoaderSourceSchema} [__source]
|
|
266
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
267
|
-
*/
|
|
268
|
-
/**
|
|
269
|
-
* @typedef DataLoaderSourceSchema
|
|
270
|
-
* @property {string} [type] - Type of creator.
|
|
271
|
-
* @property {string} [id] - Identifier of an extension.
|
|
272
|
-
*/
|
|
273
|
-
/**
|
|
274
|
-
* @typedef DataLoadersSchema
|
|
275
|
-
* @property {DataLoaderSchema[]} [items] - List of data loaders.
|
|
276
|
-
*/
|
|
277
|
-
/**
|
|
278
|
-
* @typedef ContentAPIError
|
|
279
|
-
* @property {string} [message] - Error message.
|
|
280
|
-
* @property {number} [status] - HTTP Status code of the error.
|
|
281
|
-
* @property {string} [code] - Status code of an error.
|
|
282
|
-
* @property {string} [exception] - Exception class name.
|
|
283
|
-
* @property {string} [info] - Details regarding the error.
|
|
284
|
-
* @property {string} [request_id] - The identifier denoting request.
|
|
285
|
-
* @property {string} [stack_trace] - Report of a stack frame to debug the issue.
|
|
286
|
-
* @property {Object} [meta] - Metadata related to an error.
|
|
287
|
-
*/
|
|
288
|
-
/**
|
|
289
|
-
* @typedef CommonError
|
|
290
|
-
* @property {string} [message] - Error message.
|
|
291
|
-
*/
|
|
292
|
-
/**
|
|
293
|
-
* @typedef CategorySchema
|
|
294
|
-
* @property {number} [index] - Order of FAQ Category.
|
|
295
|
-
* @property {string} [title] - Title of the FAQ category.
|
|
296
|
-
* @property {string} [description] - Details of the FAQ category.
|
|
297
|
-
* @property {string[]} [children] - List of FAQs.
|
|
298
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
299
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
300
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
301
|
-
* @property {string} [icon_url] - URL of the image associated with FAQ Category.
|
|
302
|
-
* @property {Object} [_custom_json] - Custom JSON object for specific use cases.
|
|
303
|
-
*/
|
|
304
|
-
/**
|
|
305
|
-
* @typedef ChildrenSchema
|
|
306
|
-
* @property {string} [question] - The contents of a question of a FAQ.
|
|
307
|
-
* @property {string} [answer] - The contents of a answer of a FAQ.
|
|
308
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
309
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
310
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
311
|
-
*/
|
|
312
|
-
/**
|
|
313
|
-
* @typedef FAQCategorySchema
|
|
314
|
-
* @property {number} [index] - Order of FAQ Category.
|
|
315
|
-
* @property {string} [title] - Title of a FAQ Category.
|
|
316
|
-
* @property {string} [description] - Details of the FAQ category.
|
|
317
|
-
* @property {ChildrenSchema[]} [children] - Details regarding a FAQs stored
|
|
318
|
-
* under a FAQs category.
|
|
319
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
320
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
321
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
322
|
-
* @property {string} [icon_url] - URL of the image associated with FAQ Category.
|
|
323
|
-
* @property {Object} [_custom_json] - Custom JSON object for specific use cases.
|
|
324
|
-
*/
|
|
325
|
-
/**
|
|
326
|
-
* @typedef FaqSchema
|
|
327
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
328
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
329
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
330
|
-
* @property {string} [question] - The contents of a question of a FAQ.
|
|
331
|
-
* @property {string} [answer] - The contents of a answer of a FAQ.
|
|
332
|
-
* @property {string[]} [tags] - Tags under a FAQ.
|
|
333
|
-
*/
|
|
334
|
-
/**
|
|
335
|
-
* @typedef GetFaqSchema
|
|
336
|
-
* @property {FaqSchema[]} [faqs] - List of FAQs.
|
|
337
|
-
*/
|
|
338
|
-
/**
|
|
339
|
-
* @typedef GetFaqCategoriesSchema
|
|
340
|
-
* @property {CategorySchema[]} [categories] - List of FAQ Categories.
|
|
341
|
-
*/
|
|
342
|
-
/**
|
|
343
|
-
* @typedef GetFaqCategoryBySlugSchema
|
|
344
|
-
* @property {FAQCategorySchema} [category]
|
|
345
|
-
*/
|
|
346
|
-
/**
|
|
347
|
-
* @typedef Page
|
|
348
|
-
* @property {number} [item_total] - The total number of items on the page.
|
|
349
|
-
* @property {string} [next_id] - The identifier for the next page.
|
|
350
|
-
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
351
|
-
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
352
|
-
* @property {number} [current] - The current page number.
|
|
353
|
-
* @property {string} type - The type of the page, such as 'PageType'.
|
|
354
|
-
* @property {number} [size] - The number of items per page.
|
|
355
|
-
*/
|
|
356
|
-
/**
|
|
357
|
-
* @typedef LandingPageSchema
|
|
358
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
359
|
-
* @property {Action} [action]
|
|
360
|
-
* @property {string[]} [platform] - List of platforms linked to this landing page.
|
|
361
|
-
* @property {CreatedBySchema} [created_by]
|
|
362
|
-
* @property {DateMeta} [date_meta]
|
|
363
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
364
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
365
|
-
* @property {boolean} [archived] - Whether landing page is archived or not.
|
|
366
|
-
* @property {Object} [_custom_json] - Custom JSON object for specific use cases.
|
|
367
|
-
*/
|
|
368
|
-
/**
|
|
369
|
-
* @typedef NavigationGetResponse
|
|
370
|
-
* @property {NavigationSchema[]} [items] - List of navigation items.
|
|
371
|
-
* @property {Page} [page]
|
|
372
|
-
*/
|
|
373
|
-
/**
|
|
374
|
-
* @typedef Orientation
|
|
375
|
-
* @property {string[]} [portrait] - Data related to devices where navigation is
|
|
376
|
-
* assigned in portrait mode.
|
|
377
|
-
* @property {string[]} [landscape] - Data related to devices where navigation
|
|
378
|
-
* is assigned in landscape mode.
|
|
379
|
-
*/
|
|
380
|
-
/**
|
|
381
|
-
* @typedef NavigationSchema
|
|
382
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
383
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
384
|
-
* @property {boolean} [archived] - Whether navigation is archived or not.
|
|
385
|
-
* @property {string} [name] - Name of the navigation link.
|
|
386
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
387
|
-
* @property {string[]} [platform] - Details regarding the platforms for which
|
|
388
|
-
* this navigation is to applied on.
|
|
389
|
-
* @property {CreatedBySchema} [created_by]
|
|
390
|
-
* @property {DateMeta} [date_meta]
|
|
391
|
-
* @property {Orientation} [orientation]
|
|
392
|
-
* @property {number} [version] - A hardcoded key for internally managing
|
|
393
|
-
* navigation versions.
|
|
394
|
-
* @property {NavigationReference[]} [navigation] - List of all navigations
|
|
395
|
-
* links and relevant details.
|
|
396
|
-
*/
|
|
397
|
-
/**
|
|
398
|
-
* @typedef PageGetResponse
|
|
399
|
-
* @property {PageSchema[]} [items] - List of details of custom pages.
|
|
400
|
-
* @property {Page} [page]
|
|
401
|
-
*/
|
|
402
|
-
/**
|
|
403
|
-
* @typedef PageSchema
|
|
404
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
405
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
406
|
-
* @property {string[]} [component_ids] - Components can be used to store
|
|
407
|
-
* multiple components.
|
|
408
|
-
* @property {Object[]} [content] - Contents of a custom page.
|
|
409
|
-
* @property {string} [content_path] - A CDN URL at which the entire html
|
|
410
|
-
* content can be fetched from.
|
|
411
|
-
* @property {CreatedBySchema} [created_by]
|
|
412
|
-
* @property {DateMeta} [date_meta]
|
|
413
|
-
* @property {string} [description] - Description about the page.
|
|
414
|
-
* @property {Asset} [feature_image]
|
|
415
|
-
* @property {Object[]} [page_meta] - List of Custom JSON object for specific use cases.
|
|
416
|
-
* @property {ScheduleSchema} [_schedule]
|
|
417
|
-
* @property {Object} [_custom_json] - Custom JSON object for specific use cases.
|
|
418
|
-
* @property {string} [orientation] - Orientation for Custom Pages - Landscape
|
|
419
|
-
* or portrait.
|
|
420
|
-
* @property {string} [platform] - Platform for Custom Pages - Denotes the device type.
|
|
421
|
-
* @property {boolean} [published] - Whether page is active or not on website.
|
|
422
|
-
* @property {string} [slug] - A short, human-readable, URL-friendly identifier.
|
|
423
|
-
* @property {string[]} [tags] - Tags under a page.
|
|
424
|
-
* @property {string} [title] - The title of the page.
|
|
425
|
-
* @property {string} [type] - Type of editor through which the page was created
|
|
426
|
-
* so appropriate rendering engine is used.
|
|
427
|
-
* @property {SEO} [seo]
|
|
428
|
-
* @property {Object} [visibility] - Visibility of Page.
|
|
429
|
-
* @property {boolean} [archived] - Flag denoting whether the page is archived or not.
|
|
430
|
-
*/
|
|
431
|
-
/**
|
|
432
|
-
* @typedef CreatedBySchema
|
|
433
|
-
* @property {string} [id] - Details containing the creator of custom page.
|
|
434
|
-
*/
|
|
435
|
-
/**
|
|
436
|
-
* @typedef SlideshowGetResponse
|
|
437
|
-
* @property {SlideshowSchema[]} [items] - Details related to slideshow/screensaver.
|
|
438
|
-
* @property {Page} [page]
|
|
439
|
-
*/
|
|
440
|
-
/**
|
|
441
|
-
* @typedef SlideshowSchema
|
|
442
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
443
|
-
* @property {string} [slug] - Details related to slideshow/screensaver.
|
|
444
|
-
* @property {DateMeta} [date_meta]
|
|
445
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
446
|
-
* @property {string} [platform] - Details related to slideshow/screensaver.
|
|
447
|
-
* @property {ConfigurationSchema} [configuration]
|
|
448
|
-
* @property {SlideshowMedia[]} [media] - Details related to slideshow/screensaver.
|
|
449
|
-
* @property {boolean} [active] - Details related to slideshow/screensaver.
|
|
450
|
-
* @property {boolean} [archived] - Whether slideshow is deleted or not.
|
|
451
|
-
* @property {Object} [_custom_json] - Custom JSON object for specific use cases.
|
|
452
|
-
*/
|
|
453
|
-
/**
|
|
454
|
-
* @typedef Support
|
|
455
|
-
* @property {boolean} [created] - Whether support contact details are created or not.
|
|
456
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
457
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
458
|
-
* @property {string} [created_at] - Timestamp which represent the time when
|
|
459
|
-
* data was created.
|
|
460
|
-
* @property {string} [updated_at] - Timestamp which represent when was the last
|
|
461
|
-
* time when data was updated.
|
|
462
|
-
* @property {ContactSchema} [contact]
|
|
463
|
-
*/
|
|
464
|
-
/**
|
|
465
|
-
* @typedef PhoneProperties
|
|
466
|
-
* @property {string} [key] - Name of the Contact SPOC.
|
|
467
|
-
* @property {string} [code] - International dial Code.
|
|
468
|
-
* @property {string} [number] - Phone Number.
|
|
469
|
-
* @property {string} [phone_type] - Denotes the type of phone number.
|
|
470
|
-
*/
|
|
471
|
-
/**
|
|
472
|
-
* @typedef PhoneSchema
|
|
473
|
-
* @property {boolean} [active] - Flag denoting whether contact detail is active or not.
|
|
474
|
-
* @property {PhoneProperties[]} [phone] - Details related to phone contact of SPOC.
|
|
475
|
-
*/
|
|
476
|
-
/**
|
|
477
|
-
* @typedef EmailProperties
|
|
478
|
-
* @property {string} [key] - Name of email SPOC.
|
|
479
|
-
* @property {string} [value] - Email Id of the SPOC.
|
|
480
|
-
*/
|
|
481
|
-
/**
|
|
482
|
-
* @typedef EmailSchema
|
|
483
|
-
* @property {boolean} [active] - Whether contact detail is active or not.
|
|
484
|
-
* @property {EmailProperties[]} [email] - Details related to email contact of SPOC.
|
|
485
|
-
*/
|
|
486
|
-
/**
|
|
487
|
-
* @typedef ContactSchema
|
|
488
|
-
* @property {PhoneSchema} [phone]
|
|
489
|
-
* @property {EmailSchema} [email]
|
|
490
|
-
*/
|
|
491
|
-
/**
|
|
492
|
-
* @typedef TagsSchema
|
|
493
|
-
* @property {string} [application] - Application ID - Identifier for a Sales channel.
|
|
494
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
495
|
-
* @property {TagSchema[]} [tags] - List of Third party injectable html tags.
|
|
496
|
-
*/
|
|
497
|
-
/**
|
|
498
|
-
* @typedef TagSchema
|
|
499
|
-
* @property {string} [name] - Name of the html tag.
|
|
500
|
-
* @property {string} [url] - URL at which css or js might be hosted.
|
|
501
|
-
* @property {string} [type] - Whether Tag is JS or CSS.
|
|
502
|
-
* @property {string} [sub_type] - Whether js/css is external or inline.
|
|
503
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
504
|
-
* @property {string} [position] - Position where Tag is so to be placed.
|
|
505
|
-
* @property {Object} [attributes] - Custom JSON object for specific use cases.
|
|
506
|
-
* @property {string} [content] - Content of tag.
|
|
507
|
-
* @property {Object[]} [pages] - List of all the page where tag is to be added.
|
|
508
|
-
* @property {TagSourceSchema} [__source]
|
|
509
|
-
*/
|
|
510
|
-
/**
|
|
511
|
-
* @typedef TagSourceSchema
|
|
512
|
-
* @property {string} [type] - Type of creator of tag.
|
|
513
|
-
* @property {string} [id] - Identifier of an extension.
|
|
514
|
-
*/
|
|
515
|
-
/**
|
|
516
|
-
* @typedef CustomObjectFieldValue
|
|
517
|
-
* @property {Object} [value] - Value of custom field.
|
|
518
|
-
*/
|
|
519
|
-
/**
|
|
520
|
-
* @typedef CustomObjectListItemDefinationSchema
|
|
521
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
522
|
-
* @property {string} [name] - Name of definition of custom field.
|
|
523
|
-
* @property {string} [type] - Data type of the custom field.
|
|
524
|
-
*/
|
|
525
|
-
/**
|
|
526
|
-
* @typedef CustomObjectFieldSchema
|
|
527
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
528
|
-
* @property {string} [key] - Key of custom field inside custom object.
|
|
529
|
-
* @property {CustomObjectFieldValue[]} [value] - Value of custom field inside
|
|
530
|
-
* custom object.
|
|
531
|
-
* @property {string} [type] - Data type of custom field inside custom object.
|
|
532
|
-
* @property {string} [definition_id] - Definition id of custom field inside
|
|
533
|
-
* custom object.
|
|
534
|
-
*/
|
|
535
|
-
/**
|
|
536
|
-
* @typedef CustomObjectByIdSchema
|
|
537
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
538
|
-
* @property {string} [status] - String denoting whether custom object is active
|
|
539
|
-
* or inactive.
|
|
540
|
-
* @property {string} [display_name] - Unique Display name of a custom object
|
|
541
|
-
* which is system generated: Concatenation of string definition name and _id.
|
|
542
|
-
* @property {CustomObjectListItemDefinationSchema} [definition]
|
|
543
|
-
* @property {Object[]} [references] - List of custom fields ids where the
|
|
544
|
-
* custom object is added as a field.
|
|
545
|
-
* @property {CustomObjectFieldSchema[]} [fields] - List of custom fields
|
|
546
|
-
* against a Custom Object.
|
|
547
|
-
*/
|
|
548
|
-
/**
|
|
549
|
-
* @typedef CustomFieldValue
|
|
550
|
-
* @property {Object} [value] - Array containing value(s) of custom field.
|
|
551
|
-
*/
|
|
552
|
-
/**
|
|
553
|
-
* @typedef CustomFieldSchema
|
|
554
|
-
* @property {string} [_id] - Unique identifier of an entry.
|
|
555
|
-
* @property {string} [namespace] - Namespace under which custom field is present.
|
|
556
|
-
* @property {string} [key] - Unique identifier for a custom field.
|
|
557
|
-
* @property {string} [resource] - Type of an entity under which custom field is defined.
|
|
558
|
-
* @property {string} [creator] - Denotes where the custom field has been
|
|
559
|
-
* defined - within a company or within a sales channel.
|
|
560
|
-
* @property {CustomFieldValue[]} [value] - Array containing values of custom field.
|
|
561
|
-
* @property {string} [resource_id] - Unique identifier for the entity under
|
|
562
|
-
* which custom field is defined.
|
|
563
|
-
* @property {string} [type] - The type type of custom field.
|
|
564
|
-
* @property {boolean} [multi_value] - Whether custom field can have multiple
|
|
565
|
-
* values or not.
|
|
566
|
-
* @property {string} [company_id] - Unique Identifier for a company.
|
|
567
|
-
* @property {string} [application_id] - Application ID - Identifier for a Sales channel.
|
|
568
|
-
* @property {string} [definition_id] - Unique identifier for a custom field definition.
|
|
569
|
-
* @property {boolean} [has_invalid_values] - Whether the custom field has invalid values.
|
|
570
|
-
* @property {Object[]} [invalid_value_errors] - Array denoting if there's a
|
|
571
|
-
* validation failure on a custom field inside a custom object.
|
|
572
|
-
* @property {string} [created_by] - Details of the owner of custom field creator.
|
|
573
|
-
* @property {boolean} [is_deleted] - Whether the custom field definition is deleted.
|
|
574
|
-
* @property {string} [created_at] - Timestamp which represent the time when
|
|
575
|
-
* data was created.
|
|
576
|
-
* @property {string} [updated_at] - Timestamp which represent when was the last
|
|
577
|
-
* time when data was updated.
|
|
578
|
-
*/
|
|
579
|
-
/**
|
|
580
|
-
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
581
|
-
* @property {CustomFieldSchema[]} [items] - List of custom fields against a resource.
|
|
582
|
-
*/
|
|
583
|
-
/**
|
|
584
|
-
* @typedef ActionPage
|
|
585
|
-
* @property {Object} [params] - Parameters that should be considered in path.
|
|
586
|
-
* @property {Object} [query] - Query parameter if any to be added to the action.
|
|
587
|
-
* @property {string} [url] - The URL for the action.
|
|
588
|
-
* @property {PageType} type
|
|
589
|
-
*/
|
|
590
|
-
/**
|
|
591
|
-
* @typedef {| "about-us"
|
|
592
|
-
* | "addresses"
|
|
593
|
-
* | "blog"
|
|
594
|
-
* | "brands"
|
|
595
|
-
* | "cards"
|
|
596
|
-
* | "cart"
|
|
597
|
-
* | "categories"
|
|
598
|
-
* | "brand"
|
|
599
|
-
* | "category"
|
|
600
|
-
* | "collection"
|
|
601
|
-
* | "collections"
|
|
602
|
-
* | "custom"
|
|
603
|
-
* | "contact-us"
|
|
604
|
-
* | "external"
|
|
605
|
-
* | "faq"
|
|
606
|
-
* | "freshchat"
|
|
607
|
-
* | "home"
|
|
608
|
-
* | "notification-settings"
|
|
609
|
-
* | "orders"
|
|
610
|
-
* | "page"
|
|
611
|
-
* | "policy"
|
|
612
|
-
* | "product"
|
|
613
|
-
* | "product-request"
|
|
614
|
-
* | "products"
|
|
615
|
-
* | "profile"
|
|
616
|
-
* | "profile-order-shipment"
|
|
617
|
-
* | "profile-basic"
|
|
618
|
-
* | "profile-company"
|
|
619
|
-
* | "profile-emails"
|
|
620
|
-
* | "profile-phones"
|
|
621
|
-
* | "rate-us"
|
|
622
|
-
* | "refer-earn"
|
|
623
|
-
* | "settings"
|
|
624
|
-
* | "shared-cart"
|
|
625
|
-
* | "tnc"
|
|
626
|
-
* | "track-order"
|
|
627
|
-
* | "wishlist"
|
|
628
|
-
* | "sections"
|
|
629
|
-
* | "form"
|
|
630
|
-
* | "cart-delivery"
|
|
631
|
-
* | "cart-payment"
|
|
632
|
-
* | "cart-review"
|
|
633
|
-
* | "login"
|
|
634
|
-
* | "register"
|
|
635
|
-
* | "shipping-policy"
|
|
636
|
-
* | "return-policy"
|
|
637
|
-
* | "order-status"
|
|
638
|
-
* | "locate-us"} PageType
|
|
639
|
-
*/
|
|
640
|
-
declare class ContentApplicationModel {
|
|
641
|
-
}
|
|
642
|
-
declare namespace ContentApplicationModel {
|
|
643
|
-
export { ApplicationLegal, ApplicationLegalFAQ, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, AnnouncementSchema, ScheduleStartSchema, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, LocaleLanguage, Language, Action, NavigationReference, ConfigurationSchema, SlideshowMedia, AnnouncementsResponseSchema, FaqResponseSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, FAQCategorySchema, FaqSchema, GetFaqSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageSchema, NavigationGetResponse, Orientation, NavigationSchema, PageGetResponse, PageSchema, CreatedBySchema, SlideshowGetResponse, SlideshowSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, CustomObjectFieldValue, CustomObjectListItemDefinationSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseByResourceIdSchema, ActionPage, PageType };
|
|
644
|
-
}
|
|
645
|
-
/** @returns {ApplicationLegal} */
|
|
646
|
-
declare function ApplicationLegal(): ApplicationLegal;
|
|
647
|
-
type ApplicationLegal = {
|
|
648
|
-
/**
|
|
649
|
-
* - Application ID - Identifier for a Sales channel.
|
|
650
|
-
*/
|
|
651
|
-
application?: string;
|
|
652
|
-
/**
|
|
653
|
-
* - Content for Terms and Conditions page on storefront.
|
|
654
|
-
*/
|
|
655
|
-
tnc?: string;
|
|
656
|
-
/**
|
|
657
|
-
* - Content for Privacy Policy page on storefront.
|
|
658
|
-
*/
|
|
659
|
-
policy?: string;
|
|
660
|
-
/**
|
|
661
|
-
* - Content for Shipping Policy page on storefront.
|
|
662
|
-
*/
|
|
663
|
-
shipping?: string;
|
|
664
|
-
/**
|
|
665
|
-
* - Content for Return policy page on storefront.
|
|
666
|
-
*/
|
|
667
|
-
returns?: string;
|
|
668
|
-
/**
|
|
669
|
-
* - FAQs of an application.
|
|
670
|
-
*/
|
|
671
|
-
faq?: ApplicationLegalFAQ[];
|
|
672
|
-
/**
|
|
673
|
-
* - Unique identifier of an entry.
|
|
674
|
-
*/
|
|
675
|
-
_id?: string;
|
|
676
|
-
/**
|
|
677
|
-
* - Timestamp which represent when was the last
|
|
678
|
-
* time when data was updated.
|
|
679
|
-
*/
|
|
680
|
-
updated_at?: string;
|
|
681
|
-
/**
|
|
682
|
-
* - Timestamp which represent the time when
|
|
683
|
-
* data was created.
|
|
684
|
-
*/
|
|
685
|
-
created_at?: string;
|
|
686
|
-
};
|
|
687
|
-
/** @returns {ApplicationLegalFAQ} */
|
|
688
|
-
declare function ApplicationLegalFAQ(): ApplicationLegalFAQ;
|
|
689
|
-
type ApplicationLegalFAQ = {
|
|
690
|
-
/**
|
|
691
|
-
* - The contents of a question of a FAQ.
|
|
692
|
-
*/
|
|
693
|
-
question?: string;
|
|
694
|
-
/**
|
|
695
|
-
* - The contents of a answer of a FAQ.
|
|
696
|
-
*/
|
|
697
|
-
answer?: string;
|
|
698
|
-
};
|
|
699
|
-
/** @returns {SeoComponent} */
|
|
700
|
-
declare function SeoComponent(): SeoComponent;
|
|
701
|
-
type SeoComponent = {
|
|
702
|
-
seo?: SeoSchema;
|
|
703
|
-
};
|
|
704
|
-
/** @returns {SeoSchema} */
|
|
705
|
-
declare function SeoSchema(): SeoSchema;
|
|
706
|
-
type SeoSchema = {
|
|
707
|
-
/**
|
|
708
|
-
* - Application ID - Identifier for a Sales channel.
|
|
709
|
-
*/
|
|
710
|
-
app?: string;
|
|
711
|
-
/**
|
|
712
|
-
* - Unique identifier of an entry.
|
|
713
|
-
*/
|
|
714
|
-
_id?: string;
|
|
715
|
-
/**
|
|
716
|
-
* - Contents of robots.txt file of a sales channel.
|
|
717
|
-
*/
|
|
718
|
-
robots_txt?: string;
|
|
719
|
-
/**
|
|
720
|
-
* - Whether sitemaps is enabled or not
|
|
721
|
-
* for a sales channel's website.
|
|
722
|
-
*/
|
|
723
|
-
sitemap_enabled?: boolean;
|
|
724
|
-
/**
|
|
725
|
-
* - Contents of additional sitemap.
|
|
726
|
-
*/
|
|
727
|
-
additonal_sitemap?: string;
|
|
728
|
-
/**
|
|
729
|
-
* - Whether canonical tags is enabled
|
|
730
|
-
* or not for a sales channel's website.
|
|
731
|
-
*/
|
|
732
|
-
cannonical_enabled?: boolean;
|
|
733
|
-
/**
|
|
734
|
-
* - Custom meta tags for a sales
|
|
735
|
-
* channel website.
|
|
736
|
-
*/
|
|
737
|
-
custom_meta_tags?: CustomMetaTag[];
|
|
738
|
-
details?: Detail;
|
|
739
|
-
/**
|
|
740
|
-
* - Timestamp which represent the time when
|
|
741
|
-
* data was created.
|
|
742
|
-
*/
|
|
743
|
-
created_at?: string;
|
|
744
|
-
/**
|
|
745
|
-
* - Timestamp which represent when was the last
|
|
746
|
-
* time when data was updated.
|
|
747
|
-
*/
|
|
748
|
-
updated_at?: string;
|
|
749
|
-
};
|
|
750
|
-
/** @returns {CustomMetaTag} */
|
|
751
|
-
declare function CustomMetaTag(): CustomMetaTag;
|
|
752
|
-
type CustomMetaTag = {
|
|
753
|
-
/**
|
|
754
|
-
* - Name of the custom meta tag group.
|
|
755
|
-
*/
|
|
756
|
-
name?: string;
|
|
757
|
-
/**
|
|
758
|
-
* - Contents of the custom meta tag group.
|
|
759
|
-
*/
|
|
760
|
-
content?: string;
|
|
761
|
-
/**
|
|
762
|
-
* - Unique identifier of an entry.
|
|
763
|
-
*/
|
|
764
|
-
_id?: string;
|
|
765
|
-
};
|
|
766
|
-
/** @returns {Detail} */
|
|
767
|
-
declare function Detail(): Detail;
|
|
768
|
-
type Detail = {
|
|
769
|
-
/**
|
|
770
|
-
* - Contents of the og:title of a sales channel website.
|
|
771
|
-
*/
|
|
772
|
-
title?: string;
|
|
773
|
-
/**
|
|
774
|
-
* - Contents of the og:description of a sales
|
|
775
|
-
* channel website.
|
|
776
|
-
*/
|
|
777
|
-
description?: string;
|
|
778
|
-
/**
|
|
779
|
-
* - URL of the og:image of a sales channel website.
|
|
780
|
-
*/
|
|
781
|
-
image_url?: string;
|
|
782
|
-
};
|
|
783
|
-
/** @returns {SeoSchemaComponent} */
|
|
784
|
-
declare function SeoSchemaComponent(): SeoSchemaComponent;
|
|
785
|
-
type SeoSchemaComponent = {
|
|
786
|
-
/**
|
|
787
|
-
* - List of SEO Markup Schemas
|
|
788
|
-
* for a sales channel website.
|
|
789
|
-
*/
|
|
790
|
-
items?: SEOSchemaMarkupTemplate[];
|
|
791
|
-
};
|
|
792
|
-
/** @returns {SEOSchemaMarkupTemplate} */
|
|
793
|
-
declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
|
|
794
|
-
type SEOSchemaMarkupTemplate = {
|
|
795
|
-
/**
|
|
796
|
-
* - Unique identifier for an entry.
|
|
797
|
-
*/
|
|
798
|
-
id?: string;
|
|
799
|
-
/**
|
|
800
|
-
* - Title of the SEO Schema template.
|
|
801
|
-
*/
|
|
802
|
-
title?: string;
|
|
803
|
-
/**
|
|
804
|
-
* - Page Type for the SEO Schema Template where
|
|
805
|
-
* it'll be rendered.
|
|
806
|
-
*/
|
|
807
|
-
page_type?: string;
|
|
808
|
-
/**
|
|
809
|
-
* - Description of the SEO Schema Template.
|
|
810
|
-
*/
|
|
811
|
-
description?: string;
|
|
812
|
-
/**
|
|
813
|
-
* - Contents of the SEO Schema template in nunjucks format.
|
|
814
|
-
*/
|
|
815
|
-
schema?: string;
|
|
816
|
-
/**
|
|
817
|
-
* - Whether SEO Schema template is active or not.
|
|
818
|
-
*/
|
|
819
|
-
active?: boolean;
|
|
820
|
-
/**
|
|
821
|
-
* - Timestamp which represent the time when
|
|
822
|
-
* data was created.
|
|
823
|
-
*/
|
|
824
|
-
created_at?: string;
|
|
825
|
-
/**
|
|
826
|
-
* - Timestamp which represent when was the last
|
|
827
|
-
* time when data was updated.
|
|
828
|
-
*/
|
|
829
|
-
updated_at?: string;
|
|
830
|
-
/**
|
|
831
|
-
* - Application ID - Identifier for a Sales channel.
|
|
832
|
-
*/
|
|
833
|
-
application?: string;
|
|
834
|
-
};
|
|
835
|
-
/** @returns {ScheduleSchema} */
|
|
836
|
-
declare function ScheduleSchema(): ScheduleSchema;
|
|
837
|
-
type ScheduleSchema = {
|
|
838
|
-
/**
|
|
839
|
-
* - String representing the cron expression.
|
|
840
|
-
*/
|
|
841
|
-
cron?: string;
|
|
842
|
-
/**
|
|
843
|
-
* - Start time of schedule.
|
|
844
|
-
*/
|
|
845
|
-
start?: string;
|
|
846
|
-
/**
|
|
847
|
-
* - End time of schedule.
|
|
848
|
-
*/
|
|
849
|
-
end?: string;
|
|
850
|
-
/**
|
|
851
|
-
* - Duration of the scheduled entity.
|
|
852
|
-
*/
|
|
853
|
-
duration?: number;
|
|
854
|
-
/**
|
|
855
|
-
* - Details regarding the next
|
|
856
|
-
* trigger point of schedule.
|
|
857
|
-
*/
|
|
858
|
-
next_schedule?: NextSchedule[];
|
|
859
|
-
};
|
|
860
|
-
/** @returns {NextSchedule} */
|
|
861
|
-
declare function NextSchedule(): NextSchedule;
|
|
862
|
-
type NextSchedule = {
|
|
863
|
-
/**
|
|
864
|
-
* - Start time of next trigger point of schedule.
|
|
865
|
-
*/
|
|
866
|
-
start?: string;
|
|
867
|
-
/**
|
|
868
|
-
* - End time of next trigger point of schedule.
|
|
869
|
-
*/
|
|
870
|
-
end?: string;
|
|
871
|
-
};
|
|
872
|
-
/** @returns {AnnouncementSchema} */
|
|
873
|
-
declare function AnnouncementSchema(): AnnouncementSchema;
|
|
874
|
-
type AnnouncementSchema = {
|
|
875
|
-
/**
|
|
876
|
-
* - Details regarding the announcement bar contents.
|
|
877
|
-
*/
|
|
878
|
-
announcement?: string;
|
|
879
|
-
schedule?: ScheduleStartSchema;
|
|
880
|
-
};
|
|
881
|
-
/** @returns {ScheduleStartSchema} */
|
|
882
|
-
declare function ScheduleStartSchema(): ScheduleStartSchema;
|
|
883
|
-
type ScheduleStartSchema = {
|
|
884
|
-
/**
|
|
885
|
-
* - Start time of schedule.
|
|
886
|
-
*/
|
|
887
|
-
start?: string;
|
|
888
|
-
/**
|
|
889
|
-
* - End time of schedule.
|
|
890
|
-
*/
|
|
891
|
-
end?: string;
|
|
892
|
-
};
|
|
893
|
-
/** @returns {BlogGetResponse} */
|
|
894
|
-
declare function BlogGetResponse(): BlogGetResponse;
|
|
895
|
-
type BlogGetResponse = {
|
|
896
|
-
/**
|
|
897
|
-
* - List of blogs with details.
|
|
898
|
-
*/
|
|
899
|
-
items?: BlogSchema[];
|
|
900
|
-
page?: Page;
|
|
901
|
-
filters?: BlogFilters;
|
|
902
|
-
};
|
|
903
|
-
/** @returns {BlogFilters} */
|
|
904
|
-
declare function BlogFilters(): BlogFilters;
|
|
905
|
-
type BlogFilters = {
|
|
906
|
-
/**
|
|
907
|
-
* - All tags present under blogs.
|
|
908
|
-
*/
|
|
909
|
-
tags?: string[];
|
|
910
|
-
};
|
|
911
|
-
/** @returns {ResourceContent} */
|
|
912
|
-
declare function ResourceContent(): ResourceContent;
|
|
913
|
-
type ResourceContent = {
|
|
914
|
-
/**
|
|
915
|
-
* - The type of content of blogs - html.
|
|
916
|
-
*/
|
|
917
|
-
type?: string;
|
|
918
|
-
/**
|
|
919
|
-
* - The contents of blog.
|
|
920
|
-
*/
|
|
921
|
-
value?: string;
|
|
922
|
-
};
|
|
923
|
-
/** @returns {Asset} */
|
|
924
|
-
declare function Asset(): Asset;
|
|
925
|
-
type Asset = {
|
|
926
|
-
/**
|
|
927
|
-
* - Aspect ratio of the image.
|
|
928
|
-
*/
|
|
929
|
-
aspect_ratio?: string;
|
|
930
|
-
/**
|
|
931
|
-
* - Unique identifier for an entry.
|
|
932
|
-
*/
|
|
933
|
-
id?: string;
|
|
934
|
-
/**
|
|
935
|
-
* - URL of the image.
|
|
936
|
-
*/
|
|
937
|
-
secure_url?: string;
|
|
938
|
-
};
|
|
939
|
-
/** @returns {Author} */
|
|
940
|
-
declare function Author(): Author;
|
|
941
|
-
type Author = {
|
|
942
|
-
/**
|
|
943
|
-
* - Description of the author of blog.
|
|
944
|
-
*/
|
|
945
|
-
designation?: string;
|
|
946
|
-
/**
|
|
947
|
-
* - Unique Identifier of the author of blog.
|
|
948
|
-
*/
|
|
949
|
-
id?: string;
|
|
950
|
-
/**
|
|
951
|
-
* - Name of the author of blog.
|
|
952
|
-
*/
|
|
953
|
-
name?: string;
|
|
954
|
-
};
|
|
955
|
-
/** @returns {BlogSchema} */
|
|
956
|
-
declare function BlogSchema(): BlogSchema;
|
|
957
|
-
type BlogSchema = {
|
|
958
|
-
/**
|
|
959
|
-
* - Unique identifier for an entry.
|
|
960
|
-
*/
|
|
961
|
-
_id?: string;
|
|
962
|
-
/**
|
|
963
|
-
* - Custom JSON object for specific use cases.
|
|
964
|
-
*/
|
|
965
|
-
_custom_json?: any;
|
|
966
|
-
/**
|
|
967
|
-
* - Application ID - Identifier for a Sales channel.
|
|
968
|
-
*/
|
|
969
|
-
application?: string;
|
|
970
|
-
/**
|
|
971
|
-
* - Boolean flag denoting whether blog is archived or not.
|
|
972
|
-
*/
|
|
973
|
-
archived?: boolean;
|
|
974
|
-
author?: Author;
|
|
975
|
-
/**
|
|
976
|
-
* - Contents of blog.
|
|
977
|
-
*/
|
|
978
|
-
content?: ResourceContent[];
|
|
979
|
-
feature_image?: Asset;
|
|
980
|
-
/**
|
|
981
|
-
* - Boolean flag denoting whether blog is
|
|
982
|
-
* published or not.
|
|
983
|
-
*/
|
|
984
|
-
published?: boolean;
|
|
985
|
-
/**
|
|
986
|
-
* - Estimated time required to read the blog.
|
|
987
|
-
*/
|
|
988
|
-
reading_time?: string;
|
|
989
|
-
/**
|
|
990
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
991
|
-
*/
|
|
992
|
-
slug?: string;
|
|
993
|
-
/**
|
|
994
|
-
* - Tags under a blog.
|
|
995
|
-
*/
|
|
996
|
-
tags?: string[];
|
|
997
|
-
/**
|
|
998
|
-
* - Timestamp denoting when the blog was published.
|
|
999
|
-
*/
|
|
1000
|
-
publish_date?: string;
|
|
1001
|
-
seo?: SEO;
|
|
1002
|
-
/**
|
|
1003
|
-
* - Title of the Blog.
|
|
1004
|
-
*/
|
|
1005
|
-
title?: string;
|
|
1006
|
-
date_meta?: DateMeta;
|
|
1007
|
-
/**
|
|
1008
|
-
* - A brief description of blog.
|
|
1009
|
-
*/
|
|
1010
|
-
summary?: string;
|
|
1011
|
-
};
|
|
1012
|
-
/** @returns {SEO} */
|
|
1013
|
-
declare function SEO(): SEO;
|
|
1014
|
-
type SEO = {
|
|
1015
|
-
/**
|
|
1016
|
-
* - The contents of og:description.
|
|
1017
|
-
*/
|
|
1018
|
-
description?: string;
|
|
1019
|
-
image?: SEOImage;
|
|
1020
|
-
/**
|
|
1021
|
-
* - The contents of og:title.
|
|
1022
|
-
*/
|
|
1023
|
-
title?: string;
|
|
1024
|
-
/**
|
|
1025
|
-
* - List of meta tags.
|
|
1026
|
-
*/
|
|
1027
|
-
meta_tags?: SEOMetaItem[];
|
|
1028
|
-
sitemap?: SEOSitemap;
|
|
1029
|
-
/**
|
|
1030
|
-
* - List of action objects which can
|
|
1031
|
-
* power breadcrumbs on website.
|
|
1032
|
-
*/
|
|
1033
|
-
breadcrumb?: SEObreadcrumb[];
|
|
1034
|
-
/**
|
|
1035
|
-
* - The canonical URL for canonical link element.
|
|
1036
|
-
*/
|
|
1037
|
-
canonical_url?: string;
|
|
1038
|
-
};
|
|
1039
|
-
/** @returns {SEOImage} */
|
|
1040
|
-
declare function SEOImage(): SEOImage;
|
|
1041
|
-
type SEOImage = {
|
|
1042
|
-
/**
|
|
1043
|
-
* - The url of image.
|
|
1044
|
-
*/
|
|
1045
|
-
url?: string;
|
|
1046
|
-
};
|
|
1047
|
-
/** @returns {SEOMetaItem} */
|
|
1048
|
-
declare function SEOMetaItem(): SEOMetaItem;
|
|
1049
|
-
type SEOMetaItem = {
|
|
1050
|
-
/**
|
|
1051
|
-
* - Title of the custom meta tags group.
|
|
1052
|
-
*/
|
|
1053
|
-
title?: string;
|
|
1054
|
-
/**
|
|
1055
|
-
* - List of key value pairs to power meta tags.
|
|
1056
|
-
*/
|
|
1057
|
-
items?: SEOMetaItems[];
|
|
1058
|
-
};
|
|
1059
|
-
/** @returns {SEOMetaItems} */
|
|
1060
|
-
declare function SEOMetaItems(): SEOMetaItems;
|
|
1061
|
-
type SEOMetaItems = {
|
|
1062
|
-
/**
|
|
1063
|
-
* - The key denoting the attribute name of SEO meta tag.
|
|
1064
|
-
*/
|
|
1065
|
-
key?: string;
|
|
1066
|
-
/**
|
|
1067
|
-
* - The key denoting the attribute value of SEO meta tag.
|
|
1068
|
-
*/
|
|
1069
|
-
value?: string;
|
|
1070
|
-
};
|
|
1071
|
-
/** @returns {SEOSitemap} */
|
|
1072
|
-
declare function SEOSitemap(): SEOSitemap;
|
|
1073
|
-
type SEOSitemap = {
|
|
1074
|
-
/**
|
|
1075
|
-
* - Value of sitemap priority randing from 0.0 to 1.0.
|
|
1076
|
-
*/
|
|
1077
|
-
priority?: number;
|
|
1078
|
-
/**
|
|
1079
|
-
* - Value of sitemap frequency change denoting
|
|
1080
|
-
* how frequently the content changes.
|
|
1081
|
-
*/
|
|
1082
|
-
frequency?: string;
|
|
1083
|
-
};
|
|
1084
|
-
/** @returns {SEObreadcrumb} */
|
|
1085
|
-
declare function SEObreadcrumb(): SEObreadcrumb;
|
|
1086
|
-
type SEObreadcrumb = {
|
|
1087
|
-
/**
|
|
1088
|
-
* - URL of where the breadcrumb link redirects to.
|
|
1089
|
-
*/
|
|
1090
|
-
url?: string;
|
|
1091
|
-
action?: Action;
|
|
1092
|
-
};
|
|
1093
|
-
/** @returns {DateMeta} */
|
|
1094
|
-
declare function DateMeta(): DateMeta;
|
|
1095
|
-
type DateMeta = {
|
|
1096
|
-
/**
|
|
1097
|
-
* - Timestamp which represent the time when
|
|
1098
|
-
* data was created.
|
|
1099
|
-
*/
|
|
1100
|
-
created_on?: string;
|
|
1101
|
-
/**
|
|
1102
|
-
* - Timestamp which represent when was the
|
|
1103
|
-
* last time when data was updated.
|
|
1104
|
-
*/
|
|
1105
|
-
modified_on?: string;
|
|
1106
|
-
};
|
|
1107
|
-
/** @returns {LocaleLanguage} */
|
|
1108
|
-
declare function LocaleLanguage(): LocaleLanguage;
|
|
1109
|
-
type LocaleLanguage = {
|
|
1110
|
-
hi?: Language;
|
|
1111
|
-
ar?: Language;
|
|
1112
|
-
en_us?: Language;
|
|
1113
|
-
};
|
|
1114
|
-
/** @returns {Language} */
|
|
1115
|
-
declare function Language(): Language;
|
|
1116
|
-
type Language = {
|
|
1117
|
-
/**
|
|
1118
|
-
* - Name of an entry in a specific language.
|
|
1119
|
-
*/
|
|
1120
|
-
display?: string;
|
|
1121
|
-
};
|
|
1122
|
-
/** @returns {Action} */
|
|
1123
|
-
declare function Action(): Action;
|
|
1124
|
-
type Action = {
|
|
1125
|
-
/**
|
|
1126
|
-
* - Type of action to be taken e.g, page.
|
|
1127
|
-
*/
|
|
1128
|
-
type?: string;
|
|
1129
|
-
page?: ActionPage;
|
|
1130
|
-
popup?: ActionPage;
|
|
1131
|
-
};
|
|
1132
|
-
/** @returns {NavigationReference} */
|
|
1133
|
-
declare function NavigationReference(): NavigationReference;
|
|
1134
|
-
type NavigationReference = {
|
|
1135
|
-
/**
|
|
1136
|
-
* - Details regarding the authorization level to
|
|
1137
|
-
* access the navigation item.
|
|
1138
|
-
*/
|
|
1139
|
-
acl?: string[];
|
|
1140
|
-
/**
|
|
1141
|
-
* - List of tags under a navigation link.
|
|
1142
|
-
*/
|
|
1143
|
-
tags?: string[];
|
|
1144
|
-
_locale_language?: LocaleLanguage;
|
|
1145
|
-
/**
|
|
1146
|
-
* - URL of an image associated with a navigation link.
|
|
1147
|
-
*/
|
|
1148
|
-
image?: string;
|
|
1149
|
-
/**
|
|
1150
|
-
* - Type of action to be taken e.g, page.
|
|
1151
|
-
*/
|
|
1152
|
-
type?: string;
|
|
1153
|
-
action?: Action;
|
|
1154
|
-
/**
|
|
1155
|
-
* - Whether navigation is active or not.
|
|
1156
|
-
*/
|
|
1157
|
-
active?: boolean;
|
|
1158
|
-
/**
|
|
1159
|
-
* - Display name of the navigation link.
|
|
1160
|
-
*/
|
|
1161
|
-
display?: string;
|
|
1162
|
-
/**
|
|
1163
|
-
* - Number denoting the position of navigation link.
|
|
1164
|
-
*/
|
|
1165
|
-
sort_order?: number;
|
|
1166
|
-
/**
|
|
1167
|
-
* - List of sub links and
|
|
1168
|
-
* details under a navigation.
|
|
1169
|
-
*/
|
|
1170
|
-
sub_navigation?: NavigationReference[];
|
|
1171
|
-
};
|
|
1172
|
-
/** @returns {ConfigurationSchema} */
|
|
1173
|
-
declare function ConfigurationSchema(): ConfigurationSchema;
|
|
1174
|
-
type ConfigurationSchema = {
|
|
1175
|
-
/**
|
|
1176
|
-
* - Amount of time in seconds after which
|
|
1177
|
-
* slideshow/screensaver is run.
|
|
1178
|
-
*/
|
|
1179
|
-
sleep_time?: number;
|
|
1180
|
-
/**
|
|
1181
|
-
* - Flag denoting whether screensaver
|
|
1182
|
-
* needs to be shown on launch of website/app.
|
|
1183
|
-
*/
|
|
1184
|
-
start_on_launch?: boolean;
|
|
1185
|
-
/**
|
|
1186
|
-
* - Duration of the slideshow/screensaver.
|
|
1187
|
-
*/
|
|
1188
|
-
duration?: number;
|
|
1189
|
-
/**
|
|
1190
|
-
* - Direction of the slideshow.
|
|
1191
|
-
*/
|
|
1192
|
-
slide_direction?: string;
|
|
1193
|
-
};
|
|
1194
|
-
/** @returns {SlideshowMedia} */
|
|
1195
|
-
declare function SlideshowMedia(): SlideshowMedia;
|
|
1196
|
-
type SlideshowMedia = {
|
|
1197
|
-
/**
|
|
1198
|
-
* - Type of Media.
|
|
1199
|
-
*/
|
|
1200
|
-
type?: string;
|
|
1201
|
-
/**
|
|
1202
|
-
* - URL of Media where it's hosted.
|
|
1203
|
-
*/
|
|
1204
|
-
url?: string;
|
|
1205
|
-
/**
|
|
1206
|
-
* - Background colour of Media.
|
|
1207
|
-
*/
|
|
1208
|
-
bg_color?: string;
|
|
1209
|
-
/**
|
|
1210
|
-
* - Amount of time in seconds for which Media has
|
|
1211
|
-
* to appear.
|
|
1212
|
-
*/
|
|
1213
|
-
duration?: number;
|
|
1214
|
-
/**
|
|
1215
|
-
* - Whether the duration for each
|
|
1216
|
-
* media is to be decided by system or not. If true, it'll equally divide time
|
|
1217
|
-
* in all medias.
|
|
1218
|
-
*/
|
|
1219
|
-
auto_decide_duration?: boolean;
|
|
1220
|
-
action?: Action;
|
|
1221
|
-
};
|
|
1222
|
-
/** @returns {AnnouncementsResponseSchema} */
|
|
1223
|
-
declare function AnnouncementsResponseSchema(): AnnouncementsResponseSchema;
|
|
1224
|
-
type AnnouncementsResponseSchema = {
|
|
1225
|
-
/**
|
|
1226
|
-
* - List all the announcement bar details
|
|
1227
|
-
* and its contents.
|
|
1228
|
-
*/
|
|
1229
|
-
announcements?: any;
|
|
1230
|
-
/**
|
|
1231
|
-
* - Number of seconds after which api should
|
|
1232
|
-
* hit again to fetch new announcements.
|
|
1233
|
-
*/
|
|
1234
|
-
refresh_rate?: number;
|
|
1235
|
-
/**
|
|
1236
|
-
* - List of page slugs on which
|
|
1237
|
-
* announcement should be fetched as soon as they are loaded.
|
|
1238
|
-
*/
|
|
1239
|
-
refresh_pages?: string[];
|
|
1240
|
-
};
|
|
1241
|
-
/** @returns {FaqResponseSchema} */
|
|
1242
|
-
declare function FaqResponseSchema(): FaqResponseSchema;
|
|
1243
|
-
type FaqResponseSchema = {
|
|
1244
|
-
/**
|
|
1245
|
-
* - List of FAQs.
|
|
1246
|
-
*/
|
|
1247
|
-
faqs?: FaqSchema[];
|
|
1248
|
-
};
|
|
1249
|
-
/** @returns {DataLoaderSchema} */
|
|
1250
|
-
declare function DataLoaderSchema(): DataLoaderSchema;
|
|
1251
|
-
type DataLoaderSchema = {
|
|
1252
|
-
/**
|
|
1253
|
-
* - Name of dataloader.
|
|
1254
|
-
*/
|
|
1255
|
-
name?: string;
|
|
1256
|
-
/**
|
|
1257
|
-
* - Service of data loader which overrides the
|
|
1258
|
-
* default method.
|
|
1259
|
-
*/
|
|
1260
|
-
service?: string;
|
|
1261
|
-
/**
|
|
1262
|
-
* - Operation ID of the method which data
|
|
1263
|
-
* loader is overriding.
|
|
1264
|
-
*/
|
|
1265
|
-
operation_id?: string;
|
|
1266
|
-
/**
|
|
1267
|
-
* - Type of data loader.
|
|
1268
|
-
*/
|
|
1269
|
-
type?: string;
|
|
1270
|
-
/**
|
|
1271
|
-
* - URL at which data loader redirects.
|
|
1272
|
-
*/
|
|
1273
|
-
url?: string;
|
|
1274
|
-
/**
|
|
1275
|
-
* - Content of a data loader.
|
|
1276
|
-
*/
|
|
1277
|
-
content?: string;
|
|
1278
|
-
__source?: DataLoaderSourceSchema;
|
|
1279
|
-
/**
|
|
1280
|
-
* - Unique identifier of an entry.
|
|
1281
|
-
*/
|
|
1282
|
-
_id?: string;
|
|
1283
|
-
};
|
|
1284
|
-
/** @returns {DataLoaderSourceSchema} */
|
|
1285
|
-
declare function DataLoaderSourceSchema(): DataLoaderSourceSchema;
|
|
1286
|
-
type DataLoaderSourceSchema = {
|
|
1287
|
-
/**
|
|
1288
|
-
* - Type of creator.
|
|
1289
|
-
*/
|
|
1290
|
-
type?: string;
|
|
1291
|
-
/**
|
|
1292
|
-
* - Identifier of an extension.
|
|
1293
|
-
*/
|
|
1294
|
-
id?: string;
|
|
1295
|
-
};
|
|
1296
|
-
/** @returns {DataLoadersSchema} */
|
|
1297
|
-
declare function DataLoadersSchema(): DataLoadersSchema;
|
|
1298
|
-
type DataLoadersSchema = {
|
|
1299
|
-
/**
|
|
1300
|
-
* - List of data loaders.
|
|
1301
|
-
*/
|
|
1302
|
-
items?: DataLoaderSchema[];
|
|
1303
|
-
};
|
|
1304
|
-
/** @returns {ContentAPIError} */
|
|
1305
|
-
declare function ContentAPIError(): ContentAPIError;
|
|
1306
|
-
type ContentAPIError = {
|
|
1307
|
-
/**
|
|
1308
|
-
* - Error message.
|
|
1309
|
-
*/
|
|
1310
|
-
message?: string;
|
|
1311
|
-
/**
|
|
1312
|
-
* - HTTP Status code of the error.
|
|
1313
|
-
*/
|
|
1314
|
-
status?: number;
|
|
1315
|
-
/**
|
|
1316
|
-
* - Status code of an error.
|
|
1317
|
-
*/
|
|
1318
|
-
code?: string;
|
|
1319
|
-
/**
|
|
1320
|
-
* - Exception class name.
|
|
1321
|
-
*/
|
|
1322
|
-
exception?: string;
|
|
1323
|
-
/**
|
|
1324
|
-
* - Details regarding the error.
|
|
1325
|
-
*/
|
|
1326
|
-
info?: string;
|
|
1327
|
-
/**
|
|
1328
|
-
* - The identifier denoting request.
|
|
1329
|
-
*/
|
|
1330
|
-
request_id?: string;
|
|
1331
|
-
/**
|
|
1332
|
-
* - Report of a stack frame to debug the issue.
|
|
1333
|
-
*/
|
|
1334
|
-
stack_trace?: string;
|
|
1335
|
-
/**
|
|
1336
|
-
* - Metadata related to an error.
|
|
1337
|
-
*/
|
|
1338
|
-
meta?: any;
|
|
1339
|
-
};
|
|
1340
|
-
/** @returns {CommonError} */
|
|
1341
|
-
declare function CommonError(): CommonError;
|
|
1342
|
-
type CommonError = {
|
|
1343
|
-
/**
|
|
1344
|
-
* - Error message.
|
|
1345
|
-
*/
|
|
1346
|
-
message?: string;
|
|
1347
|
-
};
|
|
1348
|
-
/** @returns {CategorySchema} */
|
|
1349
|
-
declare function CategorySchema(): CategorySchema;
|
|
1350
|
-
type CategorySchema = {
|
|
1351
|
-
/**
|
|
1352
|
-
* - Order of FAQ Category.
|
|
1353
|
-
*/
|
|
1354
|
-
index?: number;
|
|
1355
|
-
/**
|
|
1356
|
-
* - Title of the FAQ category.
|
|
1357
|
-
*/
|
|
1358
|
-
title?: string;
|
|
1359
|
-
/**
|
|
1360
|
-
* - Details of the FAQ category.
|
|
1361
|
-
*/
|
|
1362
|
-
description?: string;
|
|
1363
|
-
/**
|
|
1364
|
-
* - List of FAQs.
|
|
1365
|
-
*/
|
|
1366
|
-
children?: string[];
|
|
1367
|
-
/**
|
|
1368
|
-
* - Unique identifier of an entry.
|
|
1369
|
-
*/
|
|
1370
|
-
_id?: string;
|
|
1371
|
-
/**
|
|
1372
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1373
|
-
*/
|
|
1374
|
-
slug?: string;
|
|
1375
|
-
/**
|
|
1376
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1377
|
-
*/
|
|
1378
|
-
application?: string;
|
|
1379
|
-
/**
|
|
1380
|
-
* - URL of the image associated with FAQ Category.
|
|
1381
|
-
*/
|
|
1382
|
-
icon_url?: string;
|
|
1383
|
-
/**
|
|
1384
|
-
* - Custom JSON object for specific use cases.
|
|
1385
|
-
*/
|
|
1386
|
-
_custom_json?: any;
|
|
1387
|
-
};
|
|
1388
|
-
/** @returns {ChildrenSchema} */
|
|
1389
|
-
declare function ChildrenSchema(): ChildrenSchema;
|
|
1390
|
-
type ChildrenSchema = {
|
|
1391
|
-
/**
|
|
1392
|
-
* - The contents of a question of a FAQ.
|
|
1393
|
-
*/
|
|
1394
|
-
question?: string;
|
|
1395
|
-
/**
|
|
1396
|
-
* - The contents of a answer of a FAQ.
|
|
1397
|
-
*/
|
|
1398
|
-
answer?: string;
|
|
1399
|
-
/**
|
|
1400
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1401
|
-
*/
|
|
1402
|
-
slug?: string;
|
|
1403
|
-
/**
|
|
1404
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1405
|
-
*/
|
|
1406
|
-
application?: string;
|
|
1407
|
-
/**
|
|
1408
|
-
* - Unique identifier of an entry.
|
|
1409
|
-
*/
|
|
1410
|
-
_id?: string;
|
|
1411
|
-
};
|
|
1412
|
-
/** @returns {FAQCategorySchema} */
|
|
1413
|
-
declare function FAQCategorySchema(): FAQCategorySchema;
|
|
1414
|
-
type FAQCategorySchema = {
|
|
1415
|
-
/**
|
|
1416
|
-
* - Order of FAQ Category.
|
|
1417
|
-
*/
|
|
1418
|
-
index?: number;
|
|
1419
|
-
/**
|
|
1420
|
-
* - Title of a FAQ Category.
|
|
1421
|
-
*/
|
|
1422
|
-
title?: string;
|
|
1423
|
-
/**
|
|
1424
|
-
* - Details of the FAQ category.
|
|
1425
|
-
*/
|
|
1426
|
-
description?: string;
|
|
1427
|
-
/**
|
|
1428
|
-
* - Details regarding a FAQs stored
|
|
1429
|
-
* under a FAQs category.
|
|
1430
|
-
*/
|
|
1431
|
-
children?: ChildrenSchema[];
|
|
1432
|
-
/**
|
|
1433
|
-
* - Unique identifier of an entry.
|
|
1434
|
-
*/
|
|
1435
|
-
_id?: string;
|
|
1436
|
-
/**
|
|
1437
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1438
|
-
*/
|
|
1439
|
-
slug?: string;
|
|
1440
|
-
/**
|
|
1441
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1442
|
-
*/
|
|
1443
|
-
application?: string;
|
|
1444
|
-
/**
|
|
1445
|
-
* - URL of the image associated with FAQ Category.
|
|
1446
|
-
*/
|
|
1447
|
-
icon_url?: string;
|
|
1448
|
-
/**
|
|
1449
|
-
* - Custom JSON object for specific use cases.
|
|
1450
|
-
*/
|
|
1451
|
-
_custom_json?: any;
|
|
1452
|
-
};
|
|
1453
|
-
/** @returns {FaqSchema} */
|
|
1454
|
-
declare function FaqSchema(): FaqSchema;
|
|
1455
|
-
type FaqSchema = {
|
|
1456
|
-
/**
|
|
1457
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1458
|
-
*/
|
|
1459
|
-
slug?: string;
|
|
1460
|
-
/**
|
|
1461
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1462
|
-
*/
|
|
1463
|
-
application?: string;
|
|
1464
|
-
/**
|
|
1465
|
-
* - Unique identifier of an entry.
|
|
1466
|
-
*/
|
|
1467
|
-
_id?: string;
|
|
1468
|
-
/**
|
|
1469
|
-
* - The contents of a question of a FAQ.
|
|
1470
|
-
*/
|
|
1471
|
-
question?: string;
|
|
1472
|
-
/**
|
|
1473
|
-
* - The contents of a answer of a FAQ.
|
|
1474
|
-
*/
|
|
1475
|
-
answer?: string;
|
|
1476
|
-
/**
|
|
1477
|
-
* - Tags under a FAQ.
|
|
1478
|
-
*/
|
|
1479
|
-
tags?: string[];
|
|
1480
|
-
};
|
|
1481
|
-
/** @returns {GetFaqSchema} */
|
|
1482
|
-
declare function GetFaqSchema(): GetFaqSchema;
|
|
1483
|
-
type GetFaqSchema = {
|
|
1484
|
-
/**
|
|
1485
|
-
* - List of FAQs.
|
|
1486
|
-
*/
|
|
1487
|
-
faqs?: FaqSchema[];
|
|
1488
|
-
};
|
|
1489
|
-
/** @returns {GetFaqCategoriesSchema} */
|
|
1490
|
-
declare function GetFaqCategoriesSchema(): GetFaqCategoriesSchema;
|
|
1491
|
-
type GetFaqCategoriesSchema = {
|
|
1492
|
-
/**
|
|
1493
|
-
* - List of FAQ Categories.
|
|
1494
|
-
*/
|
|
1495
|
-
categories?: CategorySchema[];
|
|
1496
|
-
};
|
|
1497
|
-
/** @returns {GetFaqCategoryBySlugSchema} */
|
|
1498
|
-
declare function GetFaqCategoryBySlugSchema(): GetFaqCategoryBySlugSchema;
|
|
1499
|
-
type GetFaqCategoryBySlugSchema = {
|
|
1500
|
-
category?: FAQCategorySchema;
|
|
1501
|
-
};
|
|
1502
|
-
/** @returns {Page} */
|
|
1503
|
-
declare function Page(): Page;
|
|
1504
|
-
type Page = {
|
|
1505
|
-
/**
|
|
1506
|
-
* - The total number of items on the page.
|
|
1507
|
-
*/
|
|
1508
|
-
item_total?: number;
|
|
1509
|
-
/**
|
|
1510
|
-
* - The identifier for the next page.
|
|
1511
|
-
*/
|
|
1512
|
-
next_id?: string;
|
|
1513
|
-
/**
|
|
1514
|
-
* - Indicates whether there is a previous page.
|
|
1515
|
-
*/
|
|
1516
|
-
has_previous?: boolean;
|
|
1517
|
-
/**
|
|
1518
|
-
* - Indicates whether there is a next page.
|
|
1519
|
-
*/
|
|
1520
|
-
has_next?: boolean;
|
|
1521
|
-
/**
|
|
1522
|
-
* - The current page number.
|
|
1523
|
-
*/
|
|
1524
|
-
current?: number;
|
|
1525
|
-
/**
|
|
1526
|
-
* - The type of the page, such as 'PageType'.
|
|
1527
|
-
*/
|
|
1528
|
-
type: string;
|
|
1529
|
-
/**
|
|
1530
|
-
* - The number of items per page.
|
|
1531
|
-
*/
|
|
1532
|
-
size?: number;
|
|
1533
|
-
};
|
|
1534
|
-
/** @returns {LandingPageSchema} */
|
|
1535
|
-
declare function LandingPageSchema(): LandingPageSchema;
|
|
1536
|
-
type LandingPageSchema = {
|
|
1537
|
-
/**
|
|
1538
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1539
|
-
*/
|
|
1540
|
-
slug?: string;
|
|
1541
|
-
action?: Action;
|
|
1542
|
-
/**
|
|
1543
|
-
* - List of platforms linked to this landing page.
|
|
1544
|
-
*/
|
|
1545
|
-
platform?: string[];
|
|
1546
|
-
created_by?: CreatedBySchema;
|
|
1547
|
-
date_meta?: DateMeta;
|
|
1548
|
-
/**
|
|
1549
|
-
* - Unique identifier of an entry.
|
|
1550
|
-
*/
|
|
1551
|
-
_id?: string;
|
|
1552
|
-
/**
|
|
1553
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1554
|
-
*/
|
|
1555
|
-
application?: string;
|
|
1556
|
-
/**
|
|
1557
|
-
* - Whether landing page is archived or not.
|
|
1558
|
-
*/
|
|
1559
|
-
archived?: boolean;
|
|
1560
|
-
/**
|
|
1561
|
-
* - Custom JSON object for specific use cases.
|
|
1562
|
-
*/
|
|
1563
|
-
_custom_json?: any;
|
|
1564
|
-
};
|
|
1565
|
-
/** @returns {NavigationGetResponse} */
|
|
1566
|
-
declare function NavigationGetResponse(): NavigationGetResponse;
|
|
1567
|
-
type NavigationGetResponse = {
|
|
1568
|
-
/**
|
|
1569
|
-
* - List of navigation items.
|
|
1570
|
-
*/
|
|
1571
|
-
items?: NavigationSchema[];
|
|
1572
|
-
page?: Page;
|
|
1573
|
-
};
|
|
1574
|
-
/** @returns {Orientation} */
|
|
1575
|
-
declare function Orientation(): Orientation;
|
|
1576
|
-
type Orientation = {
|
|
1577
|
-
/**
|
|
1578
|
-
* - Data related to devices where navigation is
|
|
1579
|
-
* assigned in portrait mode.
|
|
1580
|
-
*/
|
|
1581
|
-
portrait?: string[];
|
|
1582
|
-
/**
|
|
1583
|
-
* - Data related to devices where navigation
|
|
1584
|
-
* is assigned in landscape mode.
|
|
1585
|
-
*/
|
|
1586
|
-
landscape?: string[];
|
|
1587
|
-
};
|
|
1588
|
-
/** @returns {NavigationSchema} */
|
|
1589
|
-
declare function NavigationSchema(): NavigationSchema;
|
|
1590
|
-
type NavigationSchema = {
|
|
1591
|
-
/**
|
|
1592
|
-
* - Unique identifier of an entry.
|
|
1593
|
-
*/
|
|
1594
|
-
_id?: string;
|
|
1595
|
-
/**
|
|
1596
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1597
|
-
*/
|
|
1598
|
-
application?: string;
|
|
1599
|
-
/**
|
|
1600
|
-
* - Whether navigation is archived or not.
|
|
1601
|
-
*/
|
|
1602
|
-
archived?: boolean;
|
|
1603
|
-
/**
|
|
1604
|
-
* - Name of the navigation link.
|
|
1605
|
-
*/
|
|
1606
|
-
name?: string;
|
|
1607
|
-
/**
|
|
1608
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1609
|
-
*/
|
|
1610
|
-
slug?: string;
|
|
1611
|
-
/**
|
|
1612
|
-
* - Details regarding the platforms for which
|
|
1613
|
-
* this navigation is to applied on.
|
|
1614
|
-
*/
|
|
1615
|
-
platform?: string[];
|
|
1616
|
-
created_by?: CreatedBySchema;
|
|
1617
|
-
date_meta?: DateMeta;
|
|
1618
|
-
orientation?: Orientation;
|
|
1619
|
-
/**
|
|
1620
|
-
* - A hardcoded key for internally managing
|
|
1621
|
-
* navigation versions.
|
|
1622
|
-
*/
|
|
1623
|
-
version?: number;
|
|
1624
|
-
/**
|
|
1625
|
-
* - List of all navigations
|
|
1626
|
-
* links and relevant details.
|
|
1627
|
-
*/
|
|
1628
|
-
navigation?: NavigationReference[];
|
|
1629
|
-
};
|
|
1630
|
-
/** @returns {PageGetResponse} */
|
|
1631
|
-
declare function PageGetResponse(): PageGetResponse;
|
|
1632
|
-
type PageGetResponse = {
|
|
1633
|
-
/**
|
|
1634
|
-
* - List of details of custom pages.
|
|
1635
|
-
*/
|
|
1636
|
-
items?: PageSchema[];
|
|
1637
|
-
page?: Page;
|
|
1638
|
-
};
|
|
1639
|
-
/** @returns {PageSchema} */
|
|
1640
|
-
declare function PageSchema(): PageSchema;
|
|
1641
|
-
type PageSchema = {
|
|
1642
|
-
/**
|
|
1643
|
-
* - Unique identifier of an entry.
|
|
1644
|
-
*/
|
|
1645
|
-
_id?: string;
|
|
1646
|
-
/**
|
|
1647
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1648
|
-
*/
|
|
1649
|
-
application?: string;
|
|
1650
|
-
/**
|
|
1651
|
-
* - Components can be used to store
|
|
1652
|
-
* multiple components.
|
|
1653
|
-
*/
|
|
1654
|
-
component_ids?: string[];
|
|
1655
|
-
/**
|
|
1656
|
-
* - Contents of a custom page.
|
|
1657
|
-
*/
|
|
1658
|
-
content?: any[];
|
|
1659
|
-
/**
|
|
1660
|
-
* - A CDN URL at which the entire html
|
|
1661
|
-
* content can be fetched from.
|
|
1662
|
-
*/
|
|
1663
|
-
content_path?: string;
|
|
1664
|
-
created_by?: CreatedBySchema;
|
|
1665
|
-
date_meta?: DateMeta;
|
|
1666
|
-
/**
|
|
1667
|
-
* - Description about the page.
|
|
1668
|
-
*/
|
|
1669
|
-
description?: string;
|
|
1670
|
-
feature_image?: Asset;
|
|
1671
|
-
/**
|
|
1672
|
-
* - List of Custom JSON object for specific use cases.
|
|
1673
|
-
*/
|
|
1674
|
-
page_meta?: any[];
|
|
1675
|
-
_schedule?: ScheduleSchema;
|
|
1676
|
-
/**
|
|
1677
|
-
* - Custom JSON object for specific use cases.
|
|
1678
|
-
*/
|
|
1679
|
-
_custom_json?: any;
|
|
1680
|
-
/**
|
|
1681
|
-
* - Orientation for Custom Pages - Landscape
|
|
1682
|
-
* or portrait.
|
|
1683
|
-
*/
|
|
1684
|
-
orientation?: string;
|
|
1685
|
-
/**
|
|
1686
|
-
* - Platform for Custom Pages - Denotes the device type.
|
|
1687
|
-
*/
|
|
1688
|
-
platform?: string;
|
|
1689
|
-
/**
|
|
1690
|
-
* - Whether page is active or not on website.
|
|
1691
|
-
*/
|
|
1692
|
-
published?: boolean;
|
|
1693
|
-
/**
|
|
1694
|
-
* - A short, human-readable, URL-friendly identifier.
|
|
1695
|
-
*/
|
|
1696
|
-
slug?: string;
|
|
1697
|
-
/**
|
|
1698
|
-
* - Tags under a page.
|
|
1699
|
-
*/
|
|
1700
|
-
tags?: string[];
|
|
1701
|
-
/**
|
|
1702
|
-
* - The title of the page.
|
|
1703
|
-
*/
|
|
1704
|
-
title?: string;
|
|
1705
|
-
/**
|
|
1706
|
-
* - Type of editor through which the page was created
|
|
1707
|
-
* so appropriate rendering engine is used.
|
|
1708
|
-
*/
|
|
1709
|
-
type?: string;
|
|
1710
|
-
seo?: SEO;
|
|
1711
|
-
/**
|
|
1712
|
-
* - Visibility of Page.
|
|
1713
|
-
*/
|
|
1714
|
-
visibility?: any;
|
|
1715
|
-
/**
|
|
1716
|
-
* - Flag denoting whether the page is archived or not.
|
|
1717
|
-
*/
|
|
1718
|
-
archived?: boolean;
|
|
1719
|
-
};
|
|
1720
|
-
/** @returns {CreatedBySchema} */
|
|
1721
|
-
declare function CreatedBySchema(): CreatedBySchema;
|
|
1722
|
-
type CreatedBySchema = {
|
|
1723
|
-
/**
|
|
1724
|
-
* - Details containing the creator of custom page.
|
|
1725
|
-
*/
|
|
1726
|
-
id?: string;
|
|
1727
|
-
};
|
|
1728
|
-
/** @returns {SlideshowGetResponse} */
|
|
1729
|
-
declare function SlideshowGetResponse(): SlideshowGetResponse;
|
|
1730
|
-
type SlideshowGetResponse = {
|
|
1731
|
-
/**
|
|
1732
|
-
* - Details related to slideshow/screensaver.
|
|
1733
|
-
*/
|
|
1734
|
-
items?: SlideshowSchema[];
|
|
1735
|
-
page?: Page;
|
|
1736
|
-
};
|
|
1737
|
-
/** @returns {SlideshowSchema} */
|
|
1738
|
-
declare function SlideshowSchema(): SlideshowSchema;
|
|
1739
|
-
type SlideshowSchema = {
|
|
1740
|
-
/**
|
|
1741
|
-
* - Unique identifier of an entry.
|
|
1742
|
-
*/
|
|
1743
|
-
_id?: string;
|
|
1744
|
-
/**
|
|
1745
|
-
* - Details related to slideshow/screensaver.
|
|
1746
|
-
*/
|
|
1747
|
-
slug?: string;
|
|
1748
|
-
date_meta?: DateMeta;
|
|
1749
|
-
/**
|
|
1750
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1751
|
-
*/
|
|
1752
|
-
application?: string;
|
|
1753
|
-
/**
|
|
1754
|
-
* - Details related to slideshow/screensaver.
|
|
1755
|
-
*/
|
|
1756
|
-
platform?: string;
|
|
1757
|
-
configuration?: ConfigurationSchema;
|
|
1758
|
-
/**
|
|
1759
|
-
* - Details related to slideshow/screensaver.
|
|
1760
|
-
*/
|
|
1761
|
-
media?: SlideshowMedia[];
|
|
1762
|
-
/**
|
|
1763
|
-
* - Details related to slideshow/screensaver.
|
|
1764
|
-
*/
|
|
1765
|
-
active?: boolean;
|
|
1766
|
-
/**
|
|
1767
|
-
* - Whether slideshow is deleted or not.
|
|
1768
|
-
*/
|
|
1769
|
-
archived?: boolean;
|
|
1770
|
-
/**
|
|
1771
|
-
* - Custom JSON object for specific use cases.
|
|
1772
|
-
*/
|
|
1773
|
-
_custom_json?: any;
|
|
1774
|
-
};
|
|
1775
|
-
/** @returns {Support} */
|
|
1776
|
-
declare function Support(): Support;
|
|
1777
|
-
type Support = {
|
|
1778
|
-
/**
|
|
1779
|
-
* - Whether support contact details are created or not.
|
|
1780
|
-
*/
|
|
1781
|
-
created?: boolean;
|
|
1782
|
-
/**
|
|
1783
|
-
* - Unique identifier of an entry.
|
|
1784
|
-
*/
|
|
1785
|
-
_id?: string;
|
|
1786
|
-
/**
|
|
1787
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1788
|
-
*/
|
|
1789
|
-
application?: string;
|
|
1790
|
-
/**
|
|
1791
|
-
* - Timestamp which represent the time when
|
|
1792
|
-
* data was created.
|
|
1793
|
-
*/
|
|
1794
|
-
created_at?: string;
|
|
1795
|
-
/**
|
|
1796
|
-
* - Timestamp which represent when was the last
|
|
1797
|
-
* time when data was updated.
|
|
1798
|
-
*/
|
|
1799
|
-
updated_at?: string;
|
|
1800
|
-
contact?: ContactSchema;
|
|
1801
|
-
};
|
|
1802
|
-
/** @returns {PhoneProperties} */
|
|
1803
|
-
declare function PhoneProperties(): PhoneProperties;
|
|
1804
|
-
type PhoneProperties = {
|
|
1805
|
-
/**
|
|
1806
|
-
* - Name of the Contact SPOC.
|
|
1807
|
-
*/
|
|
1808
|
-
key?: string;
|
|
1809
|
-
/**
|
|
1810
|
-
* - International dial Code.
|
|
1811
|
-
*/
|
|
1812
|
-
code?: string;
|
|
1813
|
-
/**
|
|
1814
|
-
* - Phone Number.
|
|
1815
|
-
*/
|
|
1816
|
-
number?: string;
|
|
1817
|
-
/**
|
|
1818
|
-
* - Denotes the type of phone number.
|
|
1819
|
-
*/
|
|
1820
|
-
phone_type?: string;
|
|
1821
|
-
};
|
|
1822
|
-
/** @returns {PhoneSchema} */
|
|
1823
|
-
declare function PhoneSchema(): PhoneSchema;
|
|
1824
|
-
type PhoneSchema = {
|
|
1825
|
-
/**
|
|
1826
|
-
* - Flag denoting whether contact detail is active or not.
|
|
1827
|
-
*/
|
|
1828
|
-
active?: boolean;
|
|
1829
|
-
/**
|
|
1830
|
-
* - Details related to phone contact of SPOC.
|
|
1831
|
-
*/
|
|
1832
|
-
phone?: PhoneProperties[];
|
|
1833
|
-
};
|
|
1834
|
-
/** @returns {EmailProperties} */
|
|
1835
|
-
declare function EmailProperties(): EmailProperties;
|
|
1836
|
-
type EmailProperties = {
|
|
1837
|
-
/**
|
|
1838
|
-
* - Name of email SPOC.
|
|
1839
|
-
*/
|
|
1840
|
-
key?: string;
|
|
1841
|
-
/**
|
|
1842
|
-
* - Email Id of the SPOC.
|
|
1843
|
-
*/
|
|
1844
|
-
value?: string;
|
|
1845
|
-
};
|
|
1846
|
-
/** @returns {EmailSchema} */
|
|
1847
|
-
declare function EmailSchema(): EmailSchema;
|
|
1848
|
-
type EmailSchema = {
|
|
1849
|
-
/**
|
|
1850
|
-
* - Whether contact detail is active or not.
|
|
1851
|
-
*/
|
|
1852
|
-
active?: boolean;
|
|
1853
|
-
/**
|
|
1854
|
-
* - Details related to email contact of SPOC.
|
|
1855
|
-
*/
|
|
1856
|
-
email?: EmailProperties[];
|
|
1857
|
-
};
|
|
1858
|
-
/** @returns {ContactSchema} */
|
|
1859
|
-
declare function ContactSchema(): ContactSchema;
|
|
1860
|
-
type ContactSchema = {
|
|
1861
|
-
phone?: PhoneSchema;
|
|
1862
|
-
email?: EmailSchema;
|
|
1863
|
-
};
|
|
1864
|
-
/** @returns {TagsSchema} */
|
|
1865
|
-
declare function TagsSchema(): TagsSchema;
|
|
1866
|
-
type TagsSchema = {
|
|
1867
|
-
/**
|
|
1868
|
-
* - Application ID - Identifier for a Sales channel.
|
|
1869
|
-
*/
|
|
1870
|
-
application?: string;
|
|
1871
|
-
/**
|
|
1872
|
-
* - Unique identifier of an entry.
|
|
1873
|
-
*/
|
|
1874
|
-
_id?: string;
|
|
1875
|
-
/**
|
|
1876
|
-
* - List of Third party injectable html tags.
|
|
1877
|
-
*/
|
|
1878
|
-
tags?: TagSchema[];
|
|
1879
|
-
};
|
|
1880
|
-
/** @returns {TagSchema} */
|
|
1881
|
-
declare function TagSchema(): TagSchema;
|
|
1882
|
-
type TagSchema = {
|
|
1883
|
-
/**
|
|
1884
|
-
* - Name of the html tag.
|
|
1885
|
-
*/
|
|
1886
|
-
name?: string;
|
|
1887
|
-
/**
|
|
1888
|
-
* - URL at which css or js might be hosted.
|
|
1889
|
-
*/
|
|
1890
|
-
url?: string;
|
|
1891
|
-
/**
|
|
1892
|
-
* - Whether Tag is JS or CSS.
|
|
1893
|
-
*/
|
|
1894
|
-
type?: string;
|
|
1895
|
-
/**
|
|
1896
|
-
* - Whether js/css is external or inline.
|
|
1897
|
-
*/
|
|
1898
|
-
sub_type?: string;
|
|
1899
|
-
/**
|
|
1900
|
-
* - Unique identifier of an entry.
|
|
1901
|
-
*/
|
|
1902
|
-
_id?: string;
|
|
1903
|
-
/**
|
|
1904
|
-
* - Position where Tag is so to be placed.
|
|
1905
|
-
*/
|
|
1906
|
-
position?: string;
|
|
1907
|
-
/**
|
|
1908
|
-
* - Custom JSON object for specific use cases.
|
|
1909
|
-
*/
|
|
1910
|
-
attributes?: any;
|
|
1911
|
-
/**
|
|
1912
|
-
* - Content of tag.
|
|
1913
|
-
*/
|
|
1914
|
-
content?: string;
|
|
1915
|
-
/**
|
|
1916
|
-
* - List of all the page where tag is to be added.
|
|
1917
|
-
*/
|
|
1918
|
-
pages?: any[];
|
|
1919
|
-
__source?: TagSourceSchema;
|
|
1920
|
-
};
|
|
1921
|
-
/** @returns {TagSourceSchema} */
|
|
1922
|
-
declare function TagSourceSchema(): TagSourceSchema;
|
|
1923
|
-
type TagSourceSchema = {
|
|
1924
|
-
/**
|
|
1925
|
-
* - Type of creator of tag.
|
|
1926
|
-
*/
|
|
1927
|
-
type?: string;
|
|
1928
|
-
/**
|
|
1929
|
-
* - Identifier of an extension.
|
|
1930
|
-
*/
|
|
1931
|
-
id?: string;
|
|
1932
|
-
};
|
|
1933
|
-
/** @returns {CustomObjectFieldValue} */
|
|
1934
|
-
declare function CustomObjectFieldValue(): CustomObjectFieldValue;
|
|
1935
|
-
type CustomObjectFieldValue = {
|
|
1936
|
-
/**
|
|
1937
|
-
* - Value of custom field.
|
|
1938
|
-
*/
|
|
1939
|
-
value?: any;
|
|
1940
|
-
};
|
|
1941
|
-
/** @returns {CustomObjectListItemDefinationSchema} */
|
|
1942
|
-
declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
|
|
1943
|
-
type CustomObjectListItemDefinationSchema = {
|
|
1944
|
-
/**
|
|
1945
|
-
* - Unique identifier of an entry.
|
|
1946
|
-
*/
|
|
1947
|
-
_id?: string;
|
|
1948
|
-
/**
|
|
1949
|
-
* - Name of definition of custom field.
|
|
1950
|
-
*/
|
|
1951
|
-
name?: string;
|
|
1952
|
-
/**
|
|
1953
|
-
* - Data type of the custom field.
|
|
1954
|
-
*/
|
|
1955
|
-
type?: string;
|
|
1956
|
-
};
|
|
1957
|
-
/** @returns {CustomObjectFieldSchema} */
|
|
1958
|
-
declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
|
|
1959
|
-
type CustomObjectFieldSchema = {
|
|
1960
|
-
/**
|
|
1961
|
-
* - Unique identifier of an entry.
|
|
1962
|
-
*/
|
|
1963
|
-
_id?: string;
|
|
1964
|
-
/**
|
|
1965
|
-
* - Key of custom field inside custom object.
|
|
1966
|
-
*/
|
|
1967
|
-
key?: string;
|
|
1968
|
-
/**
|
|
1969
|
-
* - Value of custom field inside
|
|
1970
|
-
* custom object.
|
|
1971
|
-
*/
|
|
1972
|
-
value?: CustomObjectFieldValue[];
|
|
1973
|
-
/**
|
|
1974
|
-
* - Data type of custom field inside custom object.
|
|
1975
|
-
*/
|
|
1976
|
-
type?: string;
|
|
1977
|
-
/**
|
|
1978
|
-
* - Definition id of custom field inside
|
|
1979
|
-
* custom object.
|
|
1980
|
-
*/
|
|
1981
|
-
definition_id?: string;
|
|
1982
|
-
};
|
|
1983
|
-
/** @returns {CustomObjectByIdSchema} */
|
|
1984
|
-
declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
|
|
1985
|
-
type CustomObjectByIdSchema = {
|
|
1986
|
-
/**
|
|
1987
|
-
* - Unique identifier of an entry.
|
|
1988
|
-
*/
|
|
1989
|
-
_id?: string;
|
|
1990
|
-
/**
|
|
1991
|
-
* - String denoting whether custom object is active
|
|
1992
|
-
* or inactive.
|
|
1993
|
-
*/
|
|
1994
|
-
status?: string;
|
|
1995
|
-
/**
|
|
1996
|
-
* - Unique Display name of a custom object
|
|
1997
|
-
* which is system generated: Concatenation of string definition name and _id.
|
|
1998
|
-
*/
|
|
1999
|
-
display_name?: string;
|
|
2000
|
-
definition?: CustomObjectListItemDefinationSchema;
|
|
2001
|
-
/**
|
|
2002
|
-
* - List of custom fields ids where the
|
|
2003
|
-
* custom object is added as a field.
|
|
2004
|
-
*/
|
|
2005
|
-
references?: any[];
|
|
2006
|
-
/**
|
|
2007
|
-
* - List of custom fields
|
|
2008
|
-
* against a Custom Object.
|
|
2009
|
-
*/
|
|
2010
|
-
fields?: CustomObjectFieldSchema[];
|
|
2011
|
-
};
|
|
2012
|
-
/** @returns {CustomFieldValue} */
|
|
2013
|
-
declare function CustomFieldValue(): CustomFieldValue;
|
|
2014
|
-
type CustomFieldValue = {
|
|
2015
|
-
/**
|
|
2016
|
-
* - Array containing value(s) of custom field.
|
|
2017
|
-
*/
|
|
2018
|
-
value?: any;
|
|
2019
|
-
};
|
|
2020
|
-
/** @returns {CustomFieldSchema} */
|
|
2021
|
-
declare function CustomFieldSchema(): CustomFieldSchema;
|
|
2022
|
-
type CustomFieldSchema = {
|
|
2023
|
-
/**
|
|
2024
|
-
* - Unique identifier of an entry.
|
|
2025
|
-
*/
|
|
2026
|
-
_id?: string;
|
|
2027
|
-
/**
|
|
2028
|
-
* - Namespace under which custom field is present.
|
|
2029
|
-
*/
|
|
2030
|
-
namespace?: string;
|
|
2031
|
-
/**
|
|
2032
|
-
* - Unique identifier for a custom field.
|
|
2033
|
-
*/
|
|
2034
|
-
key?: string;
|
|
2035
|
-
/**
|
|
2036
|
-
* - Type of an entity under which custom field is defined.
|
|
2037
|
-
*/
|
|
2038
|
-
resource?: string;
|
|
2039
|
-
/**
|
|
2040
|
-
* - Denotes where the custom field has been
|
|
2041
|
-
* defined - within a company or within a sales channel.
|
|
2042
|
-
*/
|
|
2043
|
-
creator?: string;
|
|
2044
|
-
/**
|
|
2045
|
-
* - Array containing values of custom field.
|
|
2046
|
-
*/
|
|
2047
|
-
value?: CustomFieldValue[];
|
|
2048
|
-
/**
|
|
2049
|
-
* - Unique identifier for the entity under
|
|
2050
|
-
* which custom field is defined.
|
|
2051
|
-
*/
|
|
2052
|
-
resource_id?: string;
|
|
2053
|
-
/**
|
|
2054
|
-
* - The type type of custom field.
|
|
2055
|
-
*/
|
|
2056
|
-
type?: string;
|
|
2057
|
-
/**
|
|
2058
|
-
* - Whether custom field can have multiple
|
|
2059
|
-
* values or not.
|
|
2060
|
-
*/
|
|
2061
|
-
multi_value?: boolean;
|
|
2062
|
-
/**
|
|
2063
|
-
* - Unique Identifier for a company.
|
|
2064
|
-
*/
|
|
2065
|
-
company_id?: string;
|
|
2066
|
-
/**
|
|
2067
|
-
* - Application ID - Identifier for a Sales channel.
|
|
2068
|
-
*/
|
|
2069
|
-
application_id?: string;
|
|
2070
|
-
/**
|
|
2071
|
-
* - Unique identifier for a custom field definition.
|
|
2072
|
-
*/
|
|
2073
|
-
definition_id?: string;
|
|
2074
|
-
/**
|
|
2075
|
-
* - Whether the custom field has invalid values.
|
|
2076
|
-
*/
|
|
2077
|
-
has_invalid_values?: boolean;
|
|
2078
|
-
/**
|
|
2079
|
-
* - Array denoting if there's a
|
|
2080
|
-
* validation failure on a custom field inside a custom object.
|
|
2081
|
-
*/
|
|
2082
|
-
invalid_value_errors?: any[];
|
|
2083
|
-
/**
|
|
2084
|
-
* - Details of the owner of custom field creator.
|
|
2085
|
-
*/
|
|
2086
|
-
created_by?: string;
|
|
2087
|
-
/**
|
|
2088
|
-
* - Whether the custom field definition is deleted.
|
|
2089
|
-
*/
|
|
2090
|
-
is_deleted?: boolean;
|
|
2091
|
-
/**
|
|
2092
|
-
* - Timestamp which represent the time when
|
|
2093
|
-
* data was created.
|
|
2094
|
-
*/
|
|
2095
|
-
created_at?: string;
|
|
2096
|
-
/**
|
|
2097
|
-
* - Timestamp which represent when was the last
|
|
2098
|
-
* time when data was updated.
|
|
2099
|
-
*/
|
|
2100
|
-
updated_at?: string;
|
|
2101
|
-
};
|
|
2102
|
-
/** @returns {CustomFieldsResponseByResourceIdSchema} */
|
|
2103
|
-
declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
|
|
2104
|
-
type CustomFieldsResponseByResourceIdSchema = {
|
|
2105
|
-
/**
|
|
2106
|
-
* - List of custom fields against a resource.
|
|
2107
|
-
*/
|
|
2108
|
-
items?: CustomFieldSchema[];
|
|
2109
|
-
};
|
|
2110
|
-
/** @returns {ActionPage} */
|
|
2111
|
-
declare function ActionPage(): ActionPage;
|
|
2112
|
-
type ActionPage = {
|
|
2113
|
-
/**
|
|
2114
|
-
* - Parameters that should be considered in path.
|
|
2115
|
-
*/
|
|
2116
|
-
params?: any;
|
|
2117
|
-
/**
|
|
2118
|
-
* - Query parameter if any to be added to the action.
|
|
2119
|
-
*/
|
|
2120
|
-
query?: any;
|
|
2121
|
-
/**
|
|
2122
|
-
* - The URL for the action.
|
|
2123
|
-
*/
|
|
2124
|
-
url?: string;
|
|
2125
|
-
type: PageType;
|
|
2126
|
-
};
|
|
2127
|
-
/**
|
|
2128
|
-
* Enum: PageType Used By: Content
|
|
2129
|
-
*
|
|
2130
|
-
* @returns {PageType}
|
|
2131
|
-
*/
|
|
2132
|
-
declare function PageType(): PageType;
|
|
2133
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
|