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