@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.4

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