@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

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.
Files changed (189) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1205 -282
  36. package/sdk/application/Content/ContentApplicationModel.js +341 -277
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1400 -325
  58. package/sdk/application/Order/OrderApplicationModel.js +391 -317
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +28 -7
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +7 -7
  98. package/sdk/partner/PartnerClient.d.ts +8 -0
  99. package/sdk/partner/PartnerClient.js +14 -0
  100. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  102. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  103. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  104. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  105. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  106. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  107. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  108. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  110. package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
  111. package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
  112. package/sdk/platform/Billing/BillingPlatformModel.d.ts +621 -2021
  113. package/sdk/platform/Billing/BillingPlatformModel.js +353 -2405
  114. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
  115. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
  116. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  117. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  118. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  119. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  120. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  121. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  122. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  123. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  124. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  125. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  128. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  130. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +58 -17
  139. package/sdk/platform/Content/ContentPlatformModel.js +28 -15
  140. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  141. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
  145. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1583 -347
  147. package/sdk/platform/Finance/FinancePlatformModel.js +463 -351
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  149. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  150. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  151. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  152. package/sdk/platform/Order/OrderPlatformModel.d.ts +613 -39
  153. package/sdk/platform/Order/OrderPlatformModel.js +359 -41
  154. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  155. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  156. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  157. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  158. package/sdk/platform/PlatformClient.d.ts +8 -0
  159. package/sdk/platform/PlatformClient.js +14 -0
  160. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  161. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  162. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  163. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  164. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +120 -22
  165. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +76 -21
  166. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  167. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  168. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  169. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  170. package/sdk/platform/User/UserPlatformModel.d.ts +18 -18
  171. package/sdk/platform/User/UserPlatformModel.js +9 -9
  172. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +28 -7
  173. package/sdk/platform/Webhook/WebhookPlatformModel.js +7 -7
  174. package/sdk/public/PublicClient.d.ts +0 -4
  175. package/sdk/public/PublicClient.js +0 -8
  176. package/sdk/public/index.d.ts +0 -2
  177. package/sdk/public/index.js +0 -4
  178. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -45
  179. package/sdk/public/Billing/BillingPublicClient.js +0 -269
  180. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -434
  181. package/sdk/public/Billing/BillingPublicModel.js +0 -395
  182. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -34
  183. package/sdk/public/Billing/BillingPublicValidator.js +0 -38
  184. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  185. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  186. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  187. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  188. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  189. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -1,69 +1,87 @@
1
1
  export = ThemeApplicationModel;
2
2
  /**
3
3
  * @typedef AllAvailablePageSchema
4
- * @property {AvailablePageSchema[]} [pages]
4
+ * @property {AvailablePageSchema[]} [pages] - List all the pages.
5
5
  */
6
6
  /**
7
7
  * @typedef AvailablePageSchema
8
- * @property {string} [value]
9
- * @property {string} [text]
10
- * @property {string} [path]
11
- * @property {string} [type]
12
- * @property {AvailablePageSchemaSections[]} [sections]
13
- * @property {AvailablePageSectionMetaAttributes[]} [sections_meta]
14
- * @property {string} [theme]
8
+ * @property {string} [value] - The name of the page. For example, 'about-us'.
9
+ * @property {string} [text] - The textual content associated with the page. For
10
+ * example, 'about us'.
11
+ * @property {string} [path] - The url path for the page. For example, 'about-us'.
12
+ * @property {string} [type] - The type of the page, which can be 'system',
13
+ * 'custom', or 'sections'.
14
+ * @property {AvailablePageSchemaSections[]} [sections] - An array of sections
15
+ * that make up the page.
16
+ * @property {AvailablePageSectionMetaAttributes[]} [sections_meta] - An array
17
+ * of metadata attributes for the sections of the page, each represented by an object.
18
+ * @property {string} [theme] - The unique identifier for the theme associated
19
+ * with the section.
15
20
  * @property {AvailablePageSeo} [seo]
16
- * @property {Object[]} [props]
17
- * @property {string} [_id]
21
+ * @property {Object[]} [props] - An array of properties associated with the
22
+ * object, where each property is represented as an object.
23
+ * @property {string} [_id] - The unique identifier for the object.
18
24
  */
19
25
  /**
20
26
  * @typedef AvailablePageSectionMetaAttributes
21
- * @property {Object} [attributes]
27
+ * @property {Object} [attributes] - A key-value pair object containing metadata
28
+ * attributes for the section.
22
29
  */
23
30
  /**
24
31
  * @typedef SEOMetaItem
25
- * @property {string} [title]
26
- * @property {SEOMetaItems[]} [items]
32
+ * @property {string} [title] - The title of the meta tag item.
33
+ * @property {SEOMetaItems[]} [items] - An array of items within the meta tag,
34
+ * each represented by an object.
27
35
  */
28
36
  /**
29
37
  * @typedef SEOMetaItems
30
- * @property {string} [key]
31
- * @property {string} [value]
38
+ * @property {string} [key] - The key of the meta tag item.
39
+ * @property {string} [value] - The value of the meta tag item.
32
40
  */
33
41
  /**
34
42
  * @typedef SEOSitemap
35
- * @property {number} [priority]
36
- * @property {string} [frequency]
43
+ * @property {number} [priority] - The priority of the page in the sitemap,
44
+ * typically a value between 0.0 And 1.0.
45
+ * @property {string} [frequency] - The frequency with which the content of the
46
+ * page is likely to change, such as 'always', 'hourly', 'daily', 'weekly',
47
+ * 'monthly', 'yearly', or 'never'.
37
48
  */
38
49
  /**
39
50
  * @typedef SEObreadcrumb
40
- * @property {string} [url]
51
+ * @property {string} [url] - The url associated with the breadcrumb.
41
52
  * @property {Action} [action]
42
53
  */
43
54
  /**
44
55
  * @typedef Action
45
- * @property {string} [type]
56
+ * @property {string} [type] - Type of action to be taken e.g, page.
46
57
  * @property {ActionPage} [page]
47
58
  * @property {ActionPage} [popup]
48
59
  */
49
60
  /**
50
61
  * @typedef AvailablePageSeo
51
- * @property {string} [title]
52
- * @property {string} [description]
53
- * @property {string} [canonical_url]
54
- * @property {SEOMetaItem[]} [meta_tags]
62
+ * @property {string} [title] - The seo title of the page.
63
+ * @property {string} [description] - The seo description of the page.
64
+ * @property {string} [canonical_url] - The canonical url of the page.
65
+ * @property {SEOMetaItem[]} [meta_tags] - An array of meta tags for the page,
66
+ * each represented by an object.
55
67
  * @property {SEOSitemap} [sitemap]
56
- * @property {SEObreadcrumb[]} [breadcrumb]
57
- * @property {string} [_id]
68
+ * @property {SEObreadcrumb[]} [breadcrumb] - An array representing breadcrumb
69
+ * navigation, where each item provides information about a step in the
70
+ * navigation path.
71
+ * @property {string} [_id] - The unique identifier for the object.
58
72
  */
59
73
  /**
60
74
  * @typedef AvailablePageSchemaSections
61
- * @property {string} [name]
62
- * @property {string} [label]
63
- * @property {string} [source]
64
- * @property {Object} [props]
65
- * @property {Object[]} [blocks]
66
- * @property {Object} [preset]
75
+ * @property {string} [name] - The name of the section.
76
+ * @property {string} [label] - A label for the section, which can be used for
77
+ * display purposes.
78
+ * @property {string} [source] - The source of the section, for example, 'themebundle'.
79
+ * @property {Object} [props] - An object containing various properties
80
+ * associated with the section.
81
+ * @property {Object[]} [blocks] - An array of blocks within the section, where
82
+ * each block is represented as an object.
83
+ * @property {Object} [preset] - An object containing preset configurations for
84
+ * the section.
67
85
  * @property {AvailablePagePredicate} [predicate]
68
86
  */
69
87
  /**
@@ -73,57 +91,64 @@ export = ThemeApplicationModel;
73
91
  * @property {AvailablePageRoutePredicate} [route]
74
92
  * @property {AvailablePageSchedulePredicate} [schedule]
75
93
  * @property {AvailablePagePlatformPredicate} [platform]
76
- * @property {string[]} [zones] - An array of zone ids associated with the section
94
+ * @property {string[]} [zones] - An array of zone ids associated with the section.
77
95
  */
78
96
  /**
79
97
  * @typedef AvailablePageScreenPredicate
80
- * @property {boolean} [mobile]
81
- * @property {boolean} [desktop]
82
- * @property {boolean} [tablet]
98
+ * @property {boolean} [mobile] - Indicates if the predicate applies to mobile screens.
99
+ * @property {boolean} [desktop] - Indicates if the predicate applies to desktop screens.
100
+ * @property {boolean} [tablet] - Indicates if the predicate applies to tablet screens.
83
101
  */
84
102
  /**
85
103
  * @typedef AvailablePageUserPredicate
86
- * @property {boolean} [authenticated]
87
- * @property {boolean} [anonymous]
104
+ * @property {boolean} [authenticated] - Indicates if the predicate applies to
105
+ * authenticated users.
106
+ * @property {boolean} [anonymous] - Indicates if the predicate applies to
107
+ * anonymous users.
88
108
  */
89
109
  /**
90
110
  * @typedef AvailablePageRoutePredicate
91
- * @property {string} [selected]
92
- * @property {string} [exact_url]
93
- * @property {Object} [query]
111
+ * @property {string} [selected] - Specifies the type of route selection, which
112
+ * can be 'none', 'exact', or 'query'.
113
+ * @property {string} [exact_url] - The exact url for the route when 'selected'
114
+ * is set to 'exact'.
115
+ * @property {Object} [query] - An object representing query parameters for the
116
+ * route when 'selected' is set to 'query'.
94
117
  */
95
118
  /**
96
119
  * @typedef AvailablePageSchedulePredicate
97
- * @property {string} [cron]
98
- * @property {string} [start]
99
- * @property {string} [end]
120
+ * @property {string} [cron] - A cron expression specifying the schedule for the
121
+ * predicate.
122
+ * @property {string} [start] - The start date and time for the schedule, in iso
123
+ * 8601 format.
124
+ * @property {string} [end] - The end date and time for the schedule, in iso 8601 format.
100
125
  */
101
126
  /**
102
127
  * @typedef ThemesSchema
103
128
  * @property {Font} [font]
104
129
  * @property {Config} [config]
105
- * @property {boolean} [applied] - Whether the theme has been applied or not
106
- * @property {boolean} [is_private] - Whether the theme is private or not
107
- * @property {string[]} [tags] - An array of tags associated with the theme
108
- * @property {string} [_id] - The unique identifier of the theme
109
- * @property {string} [application_id] - The ID of the application
110
- * @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
130
+ * @property {boolean} [applied] - Whether the theme has been applied or not.
131
+ * @property {boolean} [is_private] - Whether the theme is private or not.
132
+ * @property {string[]} [tags] - An array of tags associated with the theme.
133
+ * @property {string} [_id] - The unique identifier of the theme.
134
+ * @property {string} [application_id] - The id of the application.
135
+ * @property {string} [marketplace_theme_id] - The id of the theme in the marketplace.
111
136
  * @property {ThemeMeta} [meta]
112
- * @property {string} [name] - The name of the theme
113
- * @property {string} [template_theme_id] - The ID of the template theme
114
- * @property {string} [version] - The version of the theme
115
- * @property {Object} [styles] - The styles associated with the theme
116
- * @property {string} [created_at] - The creation timestamp of the theme
117
- * @property {string} [updated_at] - The last update timestamp of the theme
137
+ * @property {string} [name] - The name of the theme.
138
+ * @property {string} [template_theme_id] - The id of the template theme.
139
+ * @property {string} [version] - The version of the theme.
140
+ * @property {Object} [styles] - The styles associated with the theme.
141
+ * @property {string} [created_at] - The creation timestamp of the theme.
142
+ * @property {string} [updated_at] - The last update timestamp of the theme.
118
143
  * @property {Assets} [assets]
119
- * @property {SectionItem[]} [available_sections] - Available sections information
120
- * @property {string} [theme_type]
121
- * @property {number} [company_id] - The company id in which sales channel exists
144
+ * @property {SectionItem[]} [available_sections] - Available sections information.
145
+ * @property {string} [theme_type] - The theme or category type associated with the page.
146
+ * @property {number} [company_id] - The company id in which sales channel exists.
122
147
  */
123
148
  /**
124
149
  * @typedef Font
125
150
  * @property {FontVariants} variants
126
- * @property {string} family - The font family
151
+ * @property {string} family - The font family.
127
152
  */
128
153
  /**
129
154
  * @typedef FontVariants
@@ -135,21 +160,23 @@ export = ThemeApplicationModel;
135
160
  */
136
161
  /**
137
162
  * @typedef FontVariant
138
- * @property {string} name - The name of the font variant
139
- * @property {string} file - The URL of the font file
163
+ * @property {string} name - The name of the font variant.
164
+ * @property {string} file - The url of the font file.
140
165
  */
141
166
  /**
142
167
  * @typedef Config
143
- * @property {string} current - The current configuration
144
- * @property {ThemeConfiguration[]} list - A list of configurations
168
+ * @property {string} current - The current configuration.
169
+ * @property {ThemeConfiguration[]} list - A list of configurations.
145
170
  * @property {GlobalSchema} [global_schema]
146
171
  * @property {Preset} [preset]
147
172
  */
148
173
  /**
149
174
  * @typedef ThemeConfiguration
150
- * @property {string} [name] - The name of the configuration
151
- * @property {Object} [global_config]
152
- * @property {string[]} [page] - An array of pages
175
+ * @property {string} [name] - The name of the configuration.
176
+ * @property {Object} [global_config] - A global configuration object containing
177
+ * various settings for the theme.
178
+ * @property {string[]} [page] - An array of pages associated with the theme
179
+ * configuration.
153
180
  */
154
181
  /**
155
182
  * @typedef CustomConfig
@@ -157,41 +184,41 @@ export = ThemeApplicationModel;
157
184
  */
158
185
  /**
159
186
  * @typedef CustomProps
160
- * @property {string} [header_bg_color] - The header background color
161
- * @property {string} [header_text_color] - The header text color
162
- * @property {string} [header_border_color] - The header border color
163
- * @property {string} [header_icon_color] - The header icon color
187
+ * @property {string} [header_bg_color] - The header background color.
188
+ * @property {string} [header_text_color] - The header text color.
189
+ * @property {string} [header_border_color] - The header border color.
190
+ * @property {string} [header_icon_color] - The header icon color.
164
191
  * @property {string} [header_cart_notification_bg_color] - The header cart
165
- * notification background color
192
+ * notification background color.
166
193
  * @property {string} [header_cart_notification_text_color] - The header cart
167
- * notification text color
168
- * @property {string} [header_nav_hover_color] - The header navigation hover color
169
- * @property {string} [button_primary_color] - The primary button color
170
- * @property {string} [button_primary_label_color] - The primary button label color
171
- * @property {string} [button_add_to_cart_color] - The add to cart button color
194
+ * notification text color.
195
+ * @property {string} [header_nav_hover_color] - The header navigation hover color.
196
+ * @property {string} [button_primary_color] - The primary button color.
197
+ * @property {string} [button_primary_label_color] - The primary button label color.
198
+ * @property {string} [button_add_to_cart_color] - The add to cart button color.
172
199
  * @property {string} [button_add_to_cart_label_color] - The add to cart button
173
- * label color
174
- * @property {string} [button_secondary_color] - The secondary button color
175
- * @property {string} [button_secondary_label_color] - The secondary button label color
176
- * @property {string} [button_tertiary_color] - The tertiary button color
177
- * @property {string} [button_tertiary_label_color] - The tertiary button label color
178
- * @property {string} [button_tertiary_hover_color] - The tertiary button hover color
200
+ * label color.
201
+ * @property {string} [button_secondary_color] - The secondary button color.
202
+ * @property {string} [button_secondary_label_color] - The secondary button label color.
203
+ * @property {string} [button_tertiary_color] - The tertiary button color.
204
+ * @property {string} [button_tertiary_label_color] - The tertiary button label color.
205
+ * @property {string} [button_tertiary_hover_color] - The tertiary button hover color.
179
206
  * @property {string} [button_tertiary_hover_text_color] - The tertiary button
180
- * hover text color
181
- * @property {string} [text_heading_link_color] - The text heading link color
182
- * @property {string} [text_body_color] - The text body color
183
- * @property {string} [text_price_color] - The text price color
184
- * @property {string} [text_sale_price_color] - The text sale price color
207
+ * hover text color.
208
+ * @property {string} [text_heading_link_color] - The text heading link color.
209
+ * @property {string} [text_body_color] - The text body color.
210
+ * @property {string} [text_price_color] - The text price color.
211
+ * @property {string} [text_sale_price_color] - The text sale price color.
185
212
  * @property {string} [text_strikethrough_price_color] - The text strikethrough
186
- * price color
187
- * @property {string} [text_discount_color] - The text discount color
188
- * @property {string} [footer_bg_color] - The footer background color
189
- * @property {string} [footer_text_color] - The footer text color
190
- * @property {string} [footer_border_color] - The footer border color
191
- * @property {string} [footer_nav_hover_color] - The footer navigation hover color
192
- * @property {boolean} [disable_cart] - Whether to disable the cart or not
193
- * @property {boolean} [is_menu_below_logo] - Whether the menu is below the logo or not
194
- * @property {string} [menu_position] - The position of the menu
213
+ * price color.
214
+ * @property {string} [text_discount_color] - The text discount color.
215
+ * @property {string} [footer_bg_color] - The footer background color.
216
+ * @property {string} [footer_text_color] - The footer text color.
217
+ * @property {string} [footer_border_color] - The footer border color.
218
+ * @property {string} [footer_nav_hover_color] - The footer navigation hover color.
219
+ * @property {boolean} [disable_cart] - Whether to disable the cart or not.
220
+ * @property {boolean} [is_menu_below_logo] - Whether the menu is below the logo or not.
221
+ * @property {string} [menu_position] - The position of the menu.
195
222
  */
196
223
  /**
197
224
  * @typedef GlobalConfig
@@ -215,61 +242,61 @@ export = ThemeApplicationModel;
215
242
  */
216
243
  /**
217
244
  * @typedef UserAlertsSetting
218
- * @property {string} [success_background] - The success background color
219
- * @property {string} [success_text] - The success text color
220
- * @property {string} [error_background] - The error background color
221
- * @property {string} [error_text] - The error text color
222
- * @property {string} [info_background] - The info background color
223
- * @property {string} [info_text] - The info text color
245
+ * @property {string} [success_background] - The success background color.
246
+ * @property {string} [success_text] - The success text color.
247
+ * @property {string} [error_background] - The error background color.
248
+ * @property {string} [error_text] - The error text color.
249
+ * @property {string} [info_background] - The info background color.
250
+ * @property {string} [info_text] - The info text color.
224
251
  */
225
252
  /**
226
253
  * @typedef ThemeSetting
227
- * @property {string} [page_background] - The page background color
228
- * @property {string} [theme_accent] - The theme accent color
254
+ * @property {string} [page_background] - The page background color.
255
+ * @property {string} [theme_accent] - The theme accent color.
229
256
  */
230
257
  /**
231
258
  * @typedef TextSetting
232
- * @property {string} [text_heading] - The text heading color
233
- * @property {string} [text_body] - The text body color
234
- * @property {string} [text_label] - The text label color
235
- * @property {string} [text_secondary] - The secondary text color
259
+ * @property {string} [text_heading] - The text heading color.
260
+ * @property {string} [text_body] - The text body color.
261
+ * @property {string} [text_label] - The text label color.
262
+ * @property {string} [text_secondary] - The secondary text color.
236
263
  */
237
264
  /**
238
265
  * @typedef ButtonSetting
239
- * @property {string} [button_primary] - The primary button color
240
- * @property {string} [button_secondary] - The secondary button color
241
- * @property {string} [button_link] - The button link color
266
+ * @property {string} [button_primary] - The primary button color.
267
+ * @property {string} [button_secondary] - The secondary button color.
268
+ * @property {string} [button_link] - The button link color.
242
269
  */
243
270
  /**
244
271
  * @typedef SaleDiscountSetting
245
- * @property {string} [sale_badge_background] - The sale badge background color
246
- * @property {string} [sale_badge_text] - The sale badge text color
247
- * @property {string} [sale_discount_text] - The sale discount text color
248
- * @property {string} [sale_timer] - The sale timer color
272
+ * @property {string} [sale_badge_background] - The sale badge background color.
273
+ * @property {string} [sale_badge_text] - The sale badge text color.
274
+ * @property {string} [sale_discount_text] - The sale discount text color.
275
+ * @property {string} [sale_timer] - The sale timer color.
249
276
  */
250
277
  /**
251
278
  * @typedef HeaderSetting
252
- * @property {string} [header_background] - The header background color
253
- * @property {string} [header_nav] - The header navigation color
254
- * @property {string} [header_icon] - The header icon color
279
+ * @property {string} [header_background] - The header background color.
280
+ * @property {string} [header_nav] - The header navigation color.
281
+ * @property {string} [header_icon] - The header icon color.
255
282
  */
256
283
  /**
257
284
  * @typedef FooterSetting
258
- * @property {string} [footer_background] - The footer background color
259
- * @property {string} [footer_bottom_background] - The footer bottom background color
260
- * @property {string} [footer_heading_text] - The footer heading text color
261
- * @property {string} [footer_body_text] - The footer body text color
262
- * @property {string} [footer_icon] - The footer icon color
285
+ * @property {string} [footer_background] - The footer background color.
286
+ * @property {string} [footer_bottom_background] - The footer bottom background color.
287
+ * @property {string} [footer_heading_text] - The footer heading text color.
288
+ * @property {string} [footer_body_text] - The footer body text color.
289
+ * @property {string} [footer_icon] - The footer icon color.
263
290
  */
264
291
  /**
265
292
  * @typedef OverlayPopupSetting
266
- * @property {string} [dialog_backgroung] - The dialog background color
267
- * @property {string} [overlay] - The overlay color
293
+ * @property {string} [dialog_backgroung] - The dialog background color.
294
+ * @property {string} [overlay] - The overlay color.
268
295
  */
269
296
  /**
270
297
  * @typedef DividerStrokeHighlightSetting
271
- * @property {string} [divider_strokes] - The divider strokes color
272
- * @property {string} [highlight] - The highlight color
298
+ * @property {string} [divider_strokes] - The divider strokes color.
299
+ * @property {string} [highlight] - The highlight color.
273
300
  */
274
301
  /**
275
302
  * @typedef StaticConfig
@@ -283,17 +310,17 @@ export = ThemeApplicationModel;
283
310
  */
284
311
  /**
285
312
  * @typedef Colors
286
- * @property {string} [primary_color] - The primary color
287
- * @property {string} [secondary_color] - The secondary color
288
- * @property {string} [accent_color] - The accent color
289
- * @property {string} [link_color] - The link color
290
- * @property {string} [button_secondary_color] - The secondary button color
291
- * @property {string} [bg_color] - The background color
313
+ * @property {string} [primary_color] - The primary color.
314
+ * @property {string} [secondary_color] - The secondary color.
315
+ * @property {string} [accent_color] - The accent color.
316
+ * @property {string} [link_color] - The link color.
317
+ * @property {string} [button_secondary_color] - The secondary button color.
318
+ * @property {string} [bg_color] - The background color.
292
319
  */
293
320
  /**
294
321
  * @typedef AuthConfig
295
- * @property {boolean} [show_header_auth] - Whether to show header authentication or not
296
- * @property {boolean} [show_footer_auth] - Whether to show footer authentication or not
322
+ * @property {boolean} [show_header_auth] - Whether to show header authentication or not.
323
+ * @property {boolean} [show_footer_auth] - Whether to show footer authentication or not.
297
324
  */
298
325
  /**
299
326
  * @typedef PaletteConfig
@@ -303,27 +330,27 @@ export = ThemeApplicationModel;
303
330
  /**
304
331
  * @typedef ThemeMeta
305
332
  * @property {ThemePayment} [payment]
306
- * @property {string} [description] - The description of the theme
307
- * @property {string[]} [industry] - An array of industries associated with the theme
333
+ * @property {string} [description] - The description of the theme.
334
+ * @property {string[]} [industry] - An array of industries associated with the theme.
308
335
  * @property {Release} [release]
309
336
  * @property {Images} [images]
310
- * @property {string} [slug] - The slug of the theme
311
- * @property {string} [name] - The name of the theme
337
+ * @property {string} [slug] - The slug of the theme.
338
+ * @property {string} [name] - The name of the theme.
312
339
  */
313
340
  /**
314
341
  * @typedef ThemePayment
315
- * @property {boolean} [is_paid] - Whether the theme is paid or not
316
- * @property {number} [amount] - The amount of the theme
342
+ * @property {boolean} [is_paid] - Whether the theme is paid or not.
343
+ * @property {number} [amount] - The amount of the theme.
317
344
  */
318
345
  /**
319
346
  * @typedef Release
320
- * @property {string} [notes] - The release notes of the theme
321
- * @property {string} [version] - The version of the theme
347
+ * @property {string} [notes] - The release notes of the theme.
348
+ * @property {string} [version] - The version of the theme.
322
349
  */
323
350
  /**
324
351
  * @typedef Images
325
- * @property {string} [desktop] - The URL of the desktop image
326
- * @property {string} [mobile] - The URL of the mobile image
352
+ * @property {string} [desktop] - The url of the desktop image.
353
+ * @property {string} [mobile] - The url of the mobile image.
327
354
  */
328
355
  /**
329
356
  * @typedef Assets
@@ -333,42 +360,46 @@ export = ThemeApplicationModel;
333
360
  */
334
361
  /**
335
362
  * @typedef UMDJs
336
- * @property {string[]} [links]
363
+ * @property {string[]} [links] - An array of strings representing urls or links.
337
364
  */
338
365
  /**
339
366
  * @typedef CommonJS
340
- * @property {string} [link]
367
+ * @property {string} [link] - A string representing the url or link to the
368
+ * commonjs module.
341
369
  */
342
370
  /**
343
371
  * @typedef CSS
344
- * @property {string[]} [links]
372
+ * @property {string[]} [links] - An array of strings representing urls for css assets.
345
373
  */
346
374
  /**
347
375
  * @typedef SectionItem
348
- * @property {Object[]} [props]
349
- * @property {Object[]} [blocks] - Blocks
350
- * @property {string} [name] - Name of the section
351
- * @property {string} [label] - Label for the section
376
+ * @property {Object[]} [props] - An array of objects representing properties or
377
+ * attributes of the section item.
378
+ * @property {Object[]} [blocks] - An array having blocks of the section.
379
+ * @property {string} [name] - Name of the section.
380
+ * @property {string} [label] - Label for the section.
352
381
  */
353
382
  /**
354
383
  * @typedef GlobalSchema
355
- * @property {Prop[]} [props]
384
+ * @property {Prop[]} [props] - An array of properties associated with the
385
+ * global schema, where each property is represented by an object.
356
386
  */
357
387
  /**
358
388
  * @typedef Prop
359
- * @property {string} [type] - The type of the property
360
- * @property {string} [category] - The category of the property
361
- * @property {string} [id] - The ID of the property
362
- * @property {string} [label] - The label of the property
363
- * @property {string} [info] - Additional information about the property
389
+ * @property {string} [type] - The type of the property.
390
+ * @property {string} [category] - The category of the property.
391
+ * @property {string} [id] - The id of the property.
392
+ * @property {string} [label] - The label of the property.
393
+ * @property {string} [info] - Additional information about the property.
364
394
  */
365
395
  /**
366
396
  * @typedef Preset
367
- * @property {Page[]} [pages]
397
+ * @property {Page[]} [pages] - An array of pages included in the preset, each
398
+ * represented by an object.
368
399
  */
369
400
  /**
370
401
  * @typedef Page
371
- * @property {Section[]} [sections]
402
+ * @property {Section[]} [sections] - An array of sections included in the page.
372
403
  * @property {string} [value] - The value of the page.
373
404
  */
374
405
  /**
@@ -380,7 +411,7 @@ export = ThemeApplicationModel;
380
411
  */
381
412
  /**
382
413
  * @typedef SectionPreset
383
- * @property {Block[]} [blocks]
414
+ * @property {Block[]} [blocks] - An array of blocks included in the section preset.
384
415
  */
385
416
  /**
386
417
  * @typedef ImagePickerProp
@@ -390,7 +421,7 @@ export = ThemeApplicationModel;
390
421
  /**
391
422
  * @typedef UrlProp
392
423
  * @property {string} [type] - The type of the property.
393
- * @property {string} [value] - The value of the URL property.
424
+ * @property {string} [value] - The value of the url property.
394
425
  */
395
426
  /**
396
427
  * @typedef BlockProps
@@ -414,7 +445,8 @@ export = ThemeApplicationModel;
414
445
  */
415
446
  /**
416
447
  * @typedef Section
417
- * @property {Block[]} [blocks]
448
+ * @property {Block[]} [blocks] - An array of blocks included in the section,
449
+ * each represented by an object conforming to the block schema.
418
450
  * @property {Predicate} [predicate]
419
451
  * @property {string} [name] - The name of the section.
420
452
  * @property {SectionProps} [props]
@@ -446,27 +478,28 @@ export = ThemeApplicationModel;
446
478
  /**
447
479
  * @typedef Route
448
480
  * @property {string} [selected] - The selected route.
449
- * @property {string} [exact_url] - The exact URL of the route.
481
+ * @property {string} [exact_url] - The exact url of the route.
450
482
  */
451
483
  /**
452
484
  * @typedef AvailablePagePlatformPredicate
453
- * @property {boolean} [ios] - Section visibility on ios platform
454
- * @property {boolean} [android] - Section visibility on android platform
455
- * @property {boolean} [web] - Section visibility on web platform
485
+ * @property {boolean} [ios] - Section visibility on ios platform.
486
+ * @property {boolean} [android] - Section visibility on android platform.
487
+ * @property {boolean} [web] - Section visibility on web platform.
456
488
  */
457
489
  /**
458
490
  * @typedef BlitzkriegInternalServerErrorSchema
459
- * @property {string} [message]
491
+ * @property {string} [message] - A descriptive message detailing the internal
492
+ * server error.
460
493
  */
461
494
  /**
462
495
  * @typedef BlitzkriegApiErrorSchema
463
- * @property {string} [message]
496
+ * @property {string} [message] - A descriptive message detailing the api error.
464
497
  */
465
498
  /**
466
499
  * @typedef ActionPage
467
- * @property {Object} [params]
468
- * @property {Object} [query]
469
- * @property {string} [url]
500
+ * @property {Object} [params] - Parameters that should be considered in path.
501
+ * @property {Object} [query] - Query parameter if any to be added to the action.
502
+ * @property {string} [url] - The URL for the action.
470
503
  * @property {PageType} type
471
504
  */
472
505
  /**
@@ -481,6 +514,7 @@ export = ThemeApplicationModel;
481
514
  * | "category"
482
515
  * | "collection"
483
516
  * | "collections"
517
+ * | "custom"
484
518
  * | "contact-us"
485
519
  * | "external"
486
520
  * | "faq"
@@ -525,54 +559,122 @@ declare namespace ThemeApplicationModel {
525
559
  /** @returns {AllAvailablePageSchema} */
526
560
  declare function AllAvailablePageSchema(): AllAvailablePageSchema;
527
561
  type AllAvailablePageSchema = {
562
+ /**
563
+ * - List all the pages.
564
+ */
528
565
  pages?: AvailablePageSchema[];
529
566
  };
530
567
  /** @returns {AvailablePageSchema} */
531
568
  declare function AvailablePageSchema(): AvailablePageSchema;
532
569
  type AvailablePageSchema = {
570
+ /**
571
+ * - The name of the page. For example, 'about-us'.
572
+ */
533
573
  value?: string;
574
+ /**
575
+ * - The textual content associated with the page. For
576
+ * example, 'about us'.
577
+ */
534
578
  text?: string;
579
+ /**
580
+ * - The url path for the page. For example, 'about-us'.
581
+ */
535
582
  path?: string;
583
+ /**
584
+ * - The type of the page, which can be 'system',
585
+ * 'custom', or 'sections'.
586
+ */
536
587
  type?: string;
588
+ /**
589
+ * - An array of sections
590
+ * that make up the page.
591
+ */
537
592
  sections?: AvailablePageSchemaSections[];
593
+ /**
594
+ * - An array
595
+ * of metadata attributes for the sections of the page, each represented by an object.
596
+ */
538
597
  sections_meta?: AvailablePageSectionMetaAttributes[];
598
+ /**
599
+ * - The unique identifier for the theme associated
600
+ * with the section.
601
+ */
539
602
  theme?: string;
540
603
  seo?: AvailablePageSeo;
604
+ /**
605
+ * - An array of properties associated with the
606
+ * object, where each property is represented as an object.
607
+ */
541
608
  props?: any[];
609
+ /**
610
+ * - The unique identifier for the object.
611
+ */
542
612
  _id?: string;
543
613
  };
544
614
  /** @returns {AvailablePageSectionMetaAttributes} */
545
615
  declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
546
616
  type AvailablePageSectionMetaAttributes = {
617
+ /**
618
+ * - A key-value pair object containing metadata
619
+ * attributes for the section.
620
+ */
547
621
  attributes?: any;
548
622
  };
549
623
  /** @returns {SEOMetaItem} */
550
624
  declare function SEOMetaItem(): SEOMetaItem;
551
625
  type SEOMetaItem = {
626
+ /**
627
+ * - The title of the meta tag item.
628
+ */
552
629
  title?: string;
630
+ /**
631
+ * - An array of items within the meta tag,
632
+ * each represented by an object.
633
+ */
553
634
  items?: SEOMetaItems[];
554
635
  };
555
636
  /** @returns {SEOMetaItems} */
556
637
  declare function SEOMetaItems(): SEOMetaItems;
557
638
  type SEOMetaItems = {
639
+ /**
640
+ * - The key of the meta tag item.
641
+ */
558
642
  key?: string;
643
+ /**
644
+ * - The value of the meta tag item.
645
+ */
559
646
  value?: string;
560
647
  };
561
648
  /** @returns {SEOSitemap} */
562
649
  declare function SEOSitemap(): SEOSitemap;
563
650
  type SEOSitemap = {
651
+ /**
652
+ * - The priority of the page in the sitemap,
653
+ * typically a value between 0.0 And 1.0.
654
+ */
564
655
  priority?: number;
656
+ /**
657
+ * - The frequency with which the content of the
658
+ * page is likely to change, such as 'always', 'hourly', 'daily', 'weekly',
659
+ * 'monthly', 'yearly', or 'never'.
660
+ */
565
661
  frequency?: string;
566
662
  };
567
663
  /** @returns {SEObreadcrumb} */
568
664
  declare function SEObreadcrumb(): SEObreadcrumb;
569
665
  type SEObreadcrumb = {
666
+ /**
667
+ * - The url associated with the breadcrumb.
668
+ */
570
669
  url?: string;
571
670
  action?: Action;
572
671
  };
573
672
  /** @returns {Action} */
574
673
  declare function Action(): Action;
575
674
  type Action = {
675
+ /**
676
+ * - Type of action to be taken e.g, page.
677
+ */
576
678
  type?: string;
577
679
  page?: ActionPage;
578
680
  popup?: ActionPage;
@@ -580,22 +682,65 @@ type Action = {
580
682
  /** @returns {AvailablePageSeo} */
581
683
  declare function AvailablePageSeo(): AvailablePageSeo;
582
684
  type AvailablePageSeo = {
685
+ /**
686
+ * - The seo title of the page.
687
+ */
583
688
  title?: string;
689
+ /**
690
+ * - The seo description of the page.
691
+ */
584
692
  description?: string;
693
+ /**
694
+ * - The canonical url of the page.
695
+ */
585
696
  canonical_url?: string;
697
+ /**
698
+ * - An array of meta tags for the page,
699
+ * each represented by an object.
700
+ */
586
701
  meta_tags?: SEOMetaItem[];
587
702
  sitemap?: SEOSitemap;
703
+ /**
704
+ * - An array representing breadcrumb
705
+ * navigation, where each item provides information about a step in the
706
+ * navigation path.
707
+ */
588
708
  breadcrumb?: SEObreadcrumb[];
709
+ /**
710
+ * - The unique identifier for the object.
711
+ */
589
712
  _id?: string;
590
713
  };
591
714
  /** @returns {AvailablePageSchemaSections} */
592
715
  declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
593
716
  type AvailablePageSchemaSections = {
717
+ /**
718
+ * - The name of the section.
719
+ */
594
720
  name?: string;
721
+ /**
722
+ * - A label for the section, which can be used for
723
+ * display purposes.
724
+ */
595
725
  label?: string;
726
+ /**
727
+ * - The source of the section, for example, 'themebundle'.
728
+ */
596
729
  source?: string;
730
+ /**
731
+ * - An object containing various properties
732
+ * associated with the section.
733
+ */
597
734
  props?: any;
735
+ /**
736
+ * - An array of blocks within the section, where
737
+ * each block is represented as an object.
738
+ */
598
739
  blocks?: any[];
740
+ /**
741
+ * - An object containing preset configurations for
742
+ * the section.
743
+ */
599
744
  preset?: any;
600
745
  predicate?: AvailablePagePredicate;
601
746
  };
@@ -608,35 +753,75 @@ type AvailablePagePredicate = {
608
753
  schedule?: AvailablePageSchedulePredicate;
609
754
  platform?: AvailablePagePlatformPredicate;
610
755
  /**
611
- * - An array of zone ids associated with the section
756
+ * - An array of zone ids associated with the section.
612
757
  */
613
758
  zones?: string[];
614
759
  };
615
760
  /** @returns {AvailablePageScreenPredicate} */
616
761
  declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
617
762
  type AvailablePageScreenPredicate = {
763
+ /**
764
+ * - Indicates if the predicate applies to mobile screens.
765
+ */
618
766
  mobile?: boolean;
767
+ /**
768
+ * - Indicates if the predicate applies to desktop screens.
769
+ */
619
770
  desktop?: boolean;
771
+ /**
772
+ * - Indicates if the predicate applies to tablet screens.
773
+ */
620
774
  tablet?: boolean;
621
775
  };
622
776
  /** @returns {AvailablePageUserPredicate} */
623
777
  declare function AvailablePageUserPredicate(): AvailablePageUserPredicate;
624
778
  type AvailablePageUserPredicate = {
779
+ /**
780
+ * - Indicates if the predicate applies to
781
+ * authenticated users.
782
+ */
625
783
  authenticated?: boolean;
784
+ /**
785
+ * - Indicates if the predicate applies to
786
+ * anonymous users.
787
+ */
626
788
  anonymous?: boolean;
627
789
  };
628
790
  /** @returns {AvailablePageRoutePredicate} */
629
791
  declare function AvailablePageRoutePredicate(): AvailablePageRoutePredicate;
630
792
  type AvailablePageRoutePredicate = {
793
+ /**
794
+ * - Specifies the type of route selection, which
795
+ * can be 'none', 'exact', or 'query'.
796
+ */
631
797
  selected?: string;
798
+ /**
799
+ * - The exact url for the route when 'selected'
800
+ * is set to 'exact'.
801
+ */
632
802
  exact_url?: string;
803
+ /**
804
+ * - An object representing query parameters for the
805
+ * route when 'selected' is set to 'query'.
806
+ */
633
807
  query?: any;
634
808
  };
635
809
  /** @returns {AvailablePageSchedulePredicate} */
636
810
  declare function AvailablePageSchedulePredicate(): AvailablePageSchedulePredicate;
637
811
  type AvailablePageSchedulePredicate = {
812
+ /**
813
+ * - A cron expression specifying the schedule for the
814
+ * predicate.
815
+ */
638
816
  cron?: string;
817
+ /**
818
+ * - The start date and time for the schedule, in iso
819
+ * 8601 format.
820
+ */
639
821
  start?: string;
822
+ /**
823
+ * - The end date and time for the schedule, in iso 8601 format.
824
+ */
640
825
  end?: string;
641
826
  };
642
827
  /** @returns {ThemesSchema} */
@@ -645,62 +830,65 @@ type ThemesSchema = {
645
830
  font?: Font;
646
831
  config?: Config;
647
832
  /**
648
- * - Whether the theme has been applied or not
833
+ * - Whether the theme has been applied or not.
649
834
  */
650
835
  applied?: boolean;
651
836
  /**
652
- * - Whether the theme is private or not
837
+ * - Whether the theme is private or not.
653
838
  */
654
839
  is_private?: boolean;
655
840
  /**
656
- * - An array of tags associated with the theme
841
+ * - An array of tags associated with the theme.
657
842
  */
658
843
  tags?: string[];
659
844
  /**
660
- * - The unique identifier of the theme
845
+ * - The unique identifier of the theme.
661
846
  */
662
847
  _id?: string;
663
848
  /**
664
- * - The ID of the application
849
+ * - The id of the application.
665
850
  */
666
851
  application_id?: string;
667
852
  /**
668
- * - The ID of the theme in the marketplace
853
+ * - The id of the theme in the marketplace.
669
854
  */
670
855
  marketplace_theme_id?: string;
671
856
  meta?: ThemeMeta;
672
857
  /**
673
- * - The name of the theme
858
+ * - The name of the theme.
674
859
  */
675
860
  name?: string;
676
861
  /**
677
- * - The ID of the template theme
862
+ * - The id of the template theme.
678
863
  */
679
864
  template_theme_id?: string;
680
865
  /**
681
- * - The version of the theme
866
+ * - The version of the theme.
682
867
  */
683
868
  version?: string;
684
869
  /**
685
- * - The styles associated with the theme
870
+ * - The styles associated with the theme.
686
871
  */
687
872
  styles?: any;
688
873
  /**
689
- * - The creation timestamp of the theme
874
+ * - The creation timestamp of the theme.
690
875
  */
691
876
  created_at?: string;
692
877
  /**
693
- * - The last update timestamp of the theme
878
+ * - The last update timestamp of the theme.
694
879
  */
695
880
  updated_at?: string;
696
881
  assets?: Assets;
697
882
  /**
698
- * - Available sections information
883
+ * - Available sections information.
699
884
  */
700
885
  available_sections?: SectionItem[];
886
+ /**
887
+ * - The theme or category type associated with the page.
888
+ */
701
889
  theme_type?: string;
702
890
  /**
703
- * - The company id in which sales channel exists
891
+ * - The company id in which sales channel exists.
704
892
  */
705
893
  company_id?: number;
706
894
  };
@@ -709,7 +897,7 @@ declare function Font(): Font;
709
897
  type Font = {
710
898
  variants: FontVariants;
711
899
  /**
712
- * - The font family
900
+ * - The font family.
713
901
  */
714
902
  family: string;
715
903
  };
@@ -726,11 +914,11 @@ type FontVariants = {
726
914
  declare function FontVariant(): FontVariant;
727
915
  type FontVariant = {
728
916
  /**
729
- * - The name of the font variant
917
+ * - The name of the font variant.
730
918
  */
731
919
  name: string;
732
920
  /**
733
- * - The URL of the font file
921
+ * - The url of the font file.
734
922
  */
735
923
  file: string;
736
924
  };
@@ -738,11 +926,11 @@ type FontVariant = {
738
926
  declare function Config(): Config;
739
927
  type Config = {
740
928
  /**
741
- * - The current configuration
929
+ * - The current configuration.
742
930
  */
743
931
  current: string;
744
932
  /**
745
- * - A list of configurations
933
+ * - A list of configurations.
746
934
  */
747
935
  list: ThemeConfiguration[];
748
936
  global_schema?: GlobalSchema;
@@ -752,12 +940,17 @@ type Config = {
752
940
  declare function ThemeConfiguration(): ThemeConfiguration;
753
941
  type ThemeConfiguration = {
754
942
  /**
755
- * - The name of the configuration
943
+ * - The name of the configuration.
756
944
  */
757
945
  name?: string;
946
+ /**
947
+ * - A global configuration object containing
948
+ * various settings for the theme.
949
+ */
758
950
  global_config?: any;
759
951
  /**
760
- * - An array of pages
952
+ * - An array of pages associated with the theme
953
+ * configuration.
761
954
  */
762
955
  page?: string[];
763
956
  };
@@ -770,128 +963,128 @@ type CustomConfig = {
770
963
  declare function CustomProps(): CustomProps;
771
964
  type CustomProps = {
772
965
  /**
773
- * - The header background color
966
+ * - The header background color.
774
967
  */
775
968
  header_bg_color?: string;
776
969
  /**
777
- * - The header text color
970
+ * - The header text color.
778
971
  */
779
972
  header_text_color?: string;
780
973
  /**
781
- * - The header border color
974
+ * - The header border color.
782
975
  */
783
976
  header_border_color?: string;
784
977
  /**
785
- * - The header icon color
978
+ * - The header icon color.
786
979
  */
787
980
  header_icon_color?: string;
788
981
  /**
789
982
  * - The header cart
790
- * notification background color
983
+ * notification background color.
791
984
  */
792
985
  header_cart_notification_bg_color?: string;
793
986
  /**
794
987
  * - The header cart
795
- * notification text color
988
+ * notification text color.
796
989
  */
797
990
  header_cart_notification_text_color?: string;
798
991
  /**
799
- * - The header navigation hover color
992
+ * - The header navigation hover color.
800
993
  */
801
994
  header_nav_hover_color?: string;
802
995
  /**
803
- * - The primary button color
996
+ * - The primary button color.
804
997
  */
805
998
  button_primary_color?: string;
806
999
  /**
807
- * - The primary button label color
1000
+ * - The primary button label color.
808
1001
  */
809
1002
  button_primary_label_color?: string;
810
1003
  /**
811
- * - The add to cart button color
1004
+ * - The add to cart button color.
812
1005
  */
813
1006
  button_add_to_cart_color?: string;
814
1007
  /**
815
1008
  * - The add to cart button
816
- * label color
1009
+ * label color.
817
1010
  */
818
1011
  button_add_to_cart_label_color?: string;
819
1012
  /**
820
- * - The secondary button color
1013
+ * - The secondary button color.
821
1014
  */
822
1015
  button_secondary_color?: string;
823
1016
  /**
824
- * - The secondary button label color
1017
+ * - The secondary button label color.
825
1018
  */
826
1019
  button_secondary_label_color?: string;
827
1020
  /**
828
- * - The tertiary button color
1021
+ * - The tertiary button color.
829
1022
  */
830
1023
  button_tertiary_color?: string;
831
1024
  /**
832
- * - The tertiary button label color
1025
+ * - The tertiary button label color.
833
1026
  */
834
1027
  button_tertiary_label_color?: string;
835
1028
  /**
836
- * - The tertiary button hover color
1029
+ * - The tertiary button hover color.
837
1030
  */
838
1031
  button_tertiary_hover_color?: string;
839
1032
  /**
840
1033
  * - The tertiary button
841
- * hover text color
1034
+ * hover text color.
842
1035
  */
843
1036
  button_tertiary_hover_text_color?: string;
844
1037
  /**
845
- * - The text heading link color
1038
+ * - The text heading link color.
846
1039
  */
847
1040
  text_heading_link_color?: string;
848
1041
  /**
849
- * - The text body color
1042
+ * - The text body color.
850
1043
  */
851
1044
  text_body_color?: string;
852
1045
  /**
853
- * - The text price color
1046
+ * - The text price color.
854
1047
  */
855
1048
  text_price_color?: string;
856
1049
  /**
857
- * - The text sale price color
1050
+ * - The text sale price color.
858
1051
  */
859
1052
  text_sale_price_color?: string;
860
1053
  /**
861
1054
  * - The text strikethrough
862
- * price color
1055
+ * price color.
863
1056
  */
864
1057
  text_strikethrough_price_color?: string;
865
1058
  /**
866
- * - The text discount color
1059
+ * - The text discount color.
867
1060
  */
868
1061
  text_discount_color?: string;
869
1062
  /**
870
- * - The footer background color
1063
+ * - The footer background color.
871
1064
  */
872
1065
  footer_bg_color?: string;
873
1066
  /**
874
- * - The footer text color
1067
+ * - The footer text color.
875
1068
  */
876
1069
  footer_text_color?: string;
877
1070
  /**
878
- * - The footer border color
1071
+ * - The footer border color.
879
1072
  */
880
1073
  footer_border_color?: string;
881
1074
  /**
882
- * - The footer navigation hover color
1075
+ * - The footer navigation hover color.
883
1076
  */
884
1077
  footer_nav_hover_color?: string;
885
1078
  /**
886
- * - Whether to disable the cart or not
1079
+ * - Whether to disable the cart or not.
887
1080
  */
888
1081
  disable_cart?: boolean;
889
1082
  /**
890
- * - Whether the menu is below the logo or not
1083
+ * - Whether the menu is below the logo or not.
891
1084
  */
892
1085
  is_menu_below_logo?: boolean;
893
1086
  /**
894
- * - The position of the menu
1087
+ * - The position of the menu.
895
1088
  */
896
1089
  menu_position?: string;
897
1090
  };
@@ -922,27 +1115,27 @@ type AdvanceSetting = {
922
1115
  declare function UserAlertsSetting(): UserAlertsSetting;
923
1116
  type UserAlertsSetting = {
924
1117
  /**
925
- * - The success background color
1118
+ * - The success background color.
926
1119
  */
927
1120
  success_background?: string;
928
1121
  /**
929
- * - The success text color
1122
+ * - The success text color.
930
1123
  */
931
1124
  success_text?: string;
932
1125
  /**
933
- * - The error background color
1126
+ * - The error background color.
934
1127
  */
935
1128
  error_background?: string;
936
1129
  /**
937
- * - The error text color
1130
+ * - The error text color.
938
1131
  */
939
1132
  error_text?: string;
940
1133
  /**
941
- * - The info background color
1134
+ * - The info background color.
942
1135
  */
943
1136
  info_background?: string;
944
1137
  /**
945
- * - The info text color
1138
+ * - The info text color.
946
1139
  */
947
1140
  info_text?: string;
948
1141
  };
@@ -950,11 +1143,11 @@ type UserAlertsSetting = {
950
1143
  declare function ThemeSetting(): ThemeSetting;
951
1144
  type ThemeSetting = {
952
1145
  /**
953
- * - The page background color
1146
+ * - The page background color.
954
1147
  */
955
1148
  page_background?: string;
956
1149
  /**
957
- * - The theme accent color
1150
+ * - The theme accent color.
958
1151
  */
959
1152
  theme_accent?: string;
960
1153
  };
@@ -962,19 +1155,19 @@ type ThemeSetting = {
962
1155
  declare function TextSetting(): TextSetting;
963
1156
  type TextSetting = {
964
1157
  /**
965
- * - The text heading color
1158
+ * - The text heading color.
966
1159
  */
967
1160
  text_heading?: string;
968
1161
  /**
969
- * - The text body color
1162
+ * - The text body color.
970
1163
  */
971
1164
  text_body?: string;
972
1165
  /**
973
- * - The text label color
1166
+ * - The text label color.
974
1167
  */
975
1168
  text_label?: string;
976
1169
  /**
977
- * - The secondary text color
1170
+ * - The secondary text color.
978
1171
  */
979
1172
  text_secondary?: string;
980
1173
  };
@@ -982,15 +1175,15 @@ type TextSetting = {
982
1175
  declare function ButtonSetting(): ButtonSetting;
983
1176
  type ButtonSetting = {
984
1177
  /**
985
- * - The primary button color
1178
+ * - The primary button color.
986
1179
  */
987
1180
  button_primary?: string;
988
1181
  /**
989
- * - The secondary button color
1182
+ * - The secondary button color.
990
1183
  */
991
1184
  button_secondary?: string;
992
1185
  /**
993
- * - The button link color
1186
+ * - The button link color.
994
1187
  */
995
1188
  button_link?: string;
996
1189
  };
@@ -998,19 +1191,19 @@ type ButtonSetting = {
998
1191
  declare function SaleDiscountSetting(): SaleDiscountSetting;
999
1192
  type SaleDiscountSetting = {
1000
1193
  /**
1001
- * - The sale badge background color
1194
+ * - The sale badge background color.
1002
1195
  */
1003
1196
  sale_badge_background?: string;
1004
1197
  /**
1005
- * - The sale badge text color
1198
+ * - The sale badge text color.
1006
1199
  */
1007
1200
  sale_badge_text?: string;
1008
1201
  /**
1009
- * - The sale discount text color
1202
+ * - The sale discount text color.
1010
1203
  */
1011
1204
  sale_discount_text?: string;
1012
1205
  /**
1013
- * - The sale timer color
1206
+ * - The sale timer color.
1014
1207
  */
1015
1208
  sale_timer?: string;
1016
1209
  };
@@ -1018,15 +1211,15 @@ type SaleDiscountSetting = {
1018
1211
  declare function HeaderSetting(): HeaderSetting;
1019
1212
  type HeaderSetting = {
1020
1213
  /**
1021
- * - The header background color
1214
+ * - The header background color.
1022
1215
  */
1023
1216
  header_background?: string;
1024
1217
  /**
1025
- * - The header navigation color
1218
+ * - The header navigation color.
1026
1219
  */
1027
1220
  header_nav?: string;
1028
1221
  /**
1029
- * - The header icon color
1222
+ * - The header icon color.
1030
1223
  */
1031
1224
  header_icon?: string;
1032
1225
  };
@@ -1034,23 +1227,23 @@ type HeaderSetting = {
1034
1227
  declare function FooterSetting(): FooterSetting;
1035
1228
  type FooterSetting = {
1036
1229
  /**
1037
- * - The footer background color
1230
+ * - The footer background color.
1038
1231
  */
1039
1232
  footer_background?: string;
1040
1233
  /**
1041
- * - The footer bottom background color
1234
+ * - The footer bottom background color.
1042
1235
  */
1043
1236
  footer_bottom_background?: string;
1044
1237
  /**
1045
- * - The footer heading text color
1238
+ * - The footer heading text color.
1046
1239
  */
1047
1240
  footer_heading_text?: string;
1048
1241
  /**
1049
- * - The footer body text color
1242
+ * - The footer body text color.
1050
1243
  */
1051
1244
  footer_body_text?: string;
1052
1245
  /**
1053
- * - The footer icon color
1246
+ * - The footer icon color.
1054
1247
  */
1055
1248
  footer_icon?: string;
1056
1249
  };
@@ -1058,11 +1251,11 @@ type FooterSetting = {
1058
1251
  declare function OverlayPopupSetting(): OverlayPopupSetting;
1059
1252
  type OverlayPopupSetting = {
1060
1253
  /**
1061
- * - The dialog background color
1254
+ * - The dialog background color.
1062
1255
  */
1063
1256
  dialog_backgroung?: string;
1064
1257
  /**
1065
- * - The overlay color
1258
+ * - The overlay color.
1066
1259
  */
1067
1260
  overlay?: string;
1068
1261
  };
@@ -1070,11 +1263,11 @@ type OverlayPopupSetting = {
1070
1263
  declare function DividerStrokeHighlightSetting(): DividerStrokeHighlightSetting;
1071
1264
  type DividerStrokeHighlightSetting = {
1072
1265
  /**
1073
- * - The divider strokes color
1266
+ * - The divider strokes color.
1074
1267
  */
1075
1268
  divider_strokes?: string;
1076
1269
  /**
1077
- * - The highlight color
1270
+ * - The highlight color.
1078
1271
  */
1079
1272
  highlight?: string;
1080
1273
  };
@@ -1094,27 +1287,27 @@ type StaticProps = {
1094
1287
  declare function Colors(): Colors;
1095
1288
  type Colors = {
1096
1289
  /**
1097
- * - The primary color
1290
+ * - The primary color.
1098
1291
  */
1099
1292
  primary_color?: string;
1100
1293
  /**
1101
- * - The secondary color
1294
+ * - The secondary color.
1102
1295
  */
1103
1296
  secondary_color?: string;
1104
1297
  /**
1105
- * - The accent color
1298
+ * - The accent color.
1106
1299
  */
1107
1300
  accent_color?: string;
1108
1301
  /**
1109
- * - The link color
1302
+ * - The link color.
1110
1303
  */
1111
1304
  link_color?: string;
1112
1305
  /**
1113
- * - The secondary button color
1306
+ * - The secondary button color.
1114
1307
  */
1115
1308
  button_secondary_color?: string;
1116
1309
  /**
1117
- * - The background color
1310
+ * - The background color.
1118
1311
  */
1119
1312
  bg_color?: string;
1120
1313
  };
@@ -1122,11 +1315,11 @@ type Colors = {
1122
1315
  declare function AuthConfig(): AuthConfig;
1123
1316
  type AuthConfig = {
1124
1317
  /**
1125
- * - Whether to show header authentication or not
1318
+ * - Whether to show header authentication or not.
1126
1319
  */
1127
1320
  show_header_auth?: boolean;
1128
1321
  /**
1129
- * - Whether to show footer authentication or not
1322
+ * - Whether to show footer authentication or not.
1130
1323
  */
1131
1324
  show_footer_auth?: boolean;
1132
1325
  };
@@ -1141,21 +1334,21 @@ declare function ThemeMeta(): ThemeMeta;
1141
1334
  type ThemeMeta = {
1142
1335
  payment?: ThemePayment;
1143
1336
  /**
1144
- * - The description of the theme
1337
+ * - The description of the theme.
1145
1338
  */
1146
1339
  description?: string;
1147
1340
  /**
1148
- * - An array of industries associated with the theme
1341
+ * - An array of industries associated with the theme.
1149
1342
  */
1150
1343
  industry?: string[];
1151
1344
  release?: Release;
1152
1345
  images?: Images;
1153
1346
  /**
1154
- * - The slug of the theme
1347
+ * - The slug of the theme.
1155
1348
  */
1156
1349
  slug?: string;
1157
1350
  /**
1158
- * - The name of the theme
1351
+ * - The name of the theme.
1159
1352
  */
1160
1353
  name?: string;
1161
1354
  };
@@ -1163,11 +1356,11 @@ type ThemeMeta = {
1163
1356
  declare function ThemePayment(): ThemePayment;
1164
1357
  type ThemePayment = {
1165
1358
  /**
1166
- * - Whether the theme is paid or not
1359
+ * - Whether the theme is paid or not.
1167
1360
  */
1168
1361
  is_paid?: boolean;
1169
1362
  /**
1170
- * - The amount of the theme
1363
+ * - The amount of the theme.
1171
1364
  */
1172
1365
  amount?: number;
1173
1366
  };
@@ -1175,11 +1368,11 @@ type ThemePayment = {
1175
1368
  declare function Release(): Release;
1176
1369
  type Release = {
1177
1370
  /**
1178
- * - The release notes of the theme
1371
+ * - The release notes of the theme.
1179
1372
  */
1180
1373
  notes?: string;
1181
1374
  /**
1182
- * - The version of the theme
1375
+ * - The version of the theme.
1183
1376
  */
1184
1377
  version?: string;
1185
1378
  };
@@ -1187,11 +1380,11 @@ type Release = {
1187
1380
  declare function Images(): Images;
1188
1381
  type Images = {
1189
1382
  /**
1190
- * - The URL of the desktop image
1383
+ * - The url of the desktop image.
1191
1384
  */
1192
1385
  desktop?: string;
1193
1386
  /**
1194
- * - The URL of the mobile image
1387
+ * - The url of the mobile image.
1195
1388
  */
1196
1389
  mobile?: string;
1197
1390
  };
@@ -1205,72 +1398,97 @@ type Assets = {
1205
1398
  /** @returns {UMDJs} */
1206
1399
  declare function UMDJs(): UMDJs;
1207
1400
  type UMDJs = {
1401
+ /**
1402
+ * - An array of strings representing urls or links.
1403
+ */
1208
1404
  links?: string[];
1209
1405
  };
1210
1406
  /** @returns {CommonJS} */
1211
1407
  declare function CommonJS(): CommonJS;
1212
1408
  type CommonJS = {
1409
+ /**
1410
+ * - A string representing the url or link to the
1411
+ * commonjs module.
1412
+ */
1213
1413
  link?: string;
1214
1414
  };
1215
1415
  /** @returns {CSS} */
1216
1416
  declare function CSS(): CSS;
1217
1417
  type CSS = {
1418
+ /**
1419
+ * - An array of strings representing urls for css assets.
1420
+ */
1218
1421
  links?: string[];
1219
1422
  };
1220
1423
  /** @returns {SectionItem} */
1221
1424
  declare function SectionItem(): SectionItem;
1222
1425
  type SectionItem = {
1426
+ /**
1427
+ * - An array of objects representing properties or
1428
+ * attributes of the section item.
1429
+ */
1223
1430
  props?: any[];
1224
1431
  /**
1225
- * - Blocks
1432
+ * - An array having blocks of the section.
1226
1433
  */
1227
1434
  blocks?: any[];
1228
1435
  /**
1229
- * - Name of the section
1436
+ * - Name of the section.
1230
1437
  */
1231
1438
  name?: string;
1232
1439
  /**
1233
- * - Label for the section
1440
+ * - Label for the section.
1234
1441
  */
1235
1442
  label?: string;
1236
1443
  };
1237
1444
  /** @returns {GlobalSchema} */
1238
1445
  declare function GlobalSchema(): GlobalSchema;
1239
1446
  type GlobalSchema = {
1447
+ /**
1448
+ * - An array of properties associated with the
1449
+ * global schema, where each property is represented by an object.
1450
+ */
1240
1451
  props?: Prop[];
1241
1452
  };
1242
1453
  /** @returns {Prop} */
1243
1454
  declare function Prop(): Prop;
1244
1455
  type Prop = {
1245
1456
  /**
1246
- * - The type of the property
1457
+ * - The type of the property.
1247
1458
  */
1248
1459
  type?: string;
1249
1460
  /**
1250
- * - The category of the property
1461
+ * - The category of the property.
1251
1462
  */
1252
1463
  category?: string;
1253
1464
  /**
1254
- * - The ID of the property
1465
+ * - The id of the property.
1255
1466
  */
1256
1467
  id?: string;
1257
1468
  /**
1258
- * - The label of the property
1469
+ * - The label of the property.
1259
1470
  */
1260
1471
  label?: string;
1261
1472
  /**
1262
- * - Additional information about the property
1473
+ * - Additional information about the property.
1263
1474
  */
1264
1475
  info?: string;
1265
1476
  };
1266
1477
  /** @returns {Preset} */
1267
1478
  declare function Preset(): Preset;
1268
1479
  type Preset = {
1480
+ /**
1481
+ * - An array of pages included in the preset, each
1482
+ * represented by an object.
1483
+ */
1269
1484
  pages?: Page[];
1270
1485
  };
1271
1486
  /** @returns {Page} */
1272
1487
  declare function Page(): Page;
1273
1488
  type Page = {
1489
+ /**
1490
+ * - An array of sections included in the page.
1491
+ */
1274
1492
  sections?: Section[];
1275
1493
  /**
1276
1494
  * - The value of the page.
@@ -1288,6 +1506,9 @@ type SectionProps = {
1288
1506
  /** @returns {SectionPreset} */
1289
1507
  declare function SectionPreset(): SectionPreset;
1290
1508
  type SectionPreset = {
1509
+ /**
1510
+ * - An array of blocks included in the section preset.
1511
+ */
1291
1512
  blocks?: Block[];
1292
1513
  };
1293
1514
  /** @returns {ImagePickerProp} */
@@ -1310,7 +1531,7 @@ type UrlProp = {
1310
1531
  */
1311
1532
  type?: string;
1312
1533
  /**
1313
- * - The value of the URL property.
1534
+ * - The value of the url property.
1314
1535
  */
1315
1536
  value?: string;
1316
1537
  };
@@ -1359,6 +1580,10 @@ type RangeProp = {
1359
1580
  /** @returns {Section} */
1360
1581
  declare function Section(): Section;
1361
1582
  type Section = {
1583
+ /**
1584
+ * - An array of blocks included in the section,
1585
+ * each represented by an object conforming to the block schema.
1586
+ */
1362
1587
  blocks?: Block[];
1363
1588
  predicate?: Predicate;
1364
1589
  /**
@@ -1424,7 +1649,7 @@ type Route = {
1424
1649
  */
1425
1650
  selected?: string;
1426
1651
  /**
1427
- * - The exact URL of the route.
1652
+ * - The exact url of the route.
1428
1653
  */
1429
1654
  exact_url?: string;
1430
1655
  };
@@ -1432,33 +1657,49 @@ type Route = {
1432
1657
  declare function AvailablePagePlatformPredicate(): AvailablePagePlatformPredicate;
1433
1658
  type AvailablePagePlatformPredicate = {
1434
1659
  /**
1435
- * - Section visibility on ios platform
1660
+ * - Section visibility on ios platform.
1436
1661
  */
1437
1662
  ios?: boolean;
1438
1663
  /**
1439
- * - Section visibility on android platform
1664
+ * - Section visibility on android platform.
1440
1665
  */
1441
1666
  android?: boolean;
1442
1667
  /**
1443
- * - Section visibility on web platform
1668
+ * - Section visibility on web platform.
1444
1669
  */
1445
1670
  web?: boolean;
1446
1671
  };
1447
1672
  /** @returns {BlitzkriegInternalServerErrorSchema} */
1448
1673
  declare function BlitzkriegInternalServerErrorSchema(): BlitzkriegInternalServerErrorSchema;
1449
1674
  type BlitzkriegInternalServerErrorSchema = {
1675
+ /**
1676
+ * - A descriptive message detailing the internal
1677
+ * server error.
1678
+ */
1450
1679
  message?: string;
1451
1680
  };
1452
1681
  /** @returns {BlitzkriegApiErrorSchema} */
1453
1682
  declare function BlitzkriegApiErrorSchema(): BlitzkriegApiErrorSchema;
1454
1683
  type BlitzkriegApiErrorSchema = {
1684
+ /**
1685
+ * - A descriptive message detailing the api error.
1686
+ */
1455
1687
  message?: string;
1456
1688
  };
1457
1689
  /** @returns {ActionPage} */
1458
1690
  declare function ActionPage(): ActionPage;
1459
1691
  type ActionPage = {
1692
+ /**
1693
+ * - Parameters that should be considered in path.
1694
+ */
1460
1695
  params?: any;
1696
+ /**
1697
+ * - Query parameter if any to be added to the action.
1698
+ */
1461
1699
  query?: any;
1700
+ /**
1701
+ * - The URL for the action.
1702
+ */
1462
1703
  url?: string;
1463
1704
  type: PageType;
1464
1705
  };
@@ -1468,4 +1709,4 @@ type ActionPage = {
1468
1709
  * @returns {PageType}
1469
1710
  */
1470
1711
  declare function PageType(): PageType;
1471
- 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";
1712
+ 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";