@gofynd/fdk-client-javascript 1.3.11-beta.8 → 1.4.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +2 -0
- package/sdk/application/Cart/CartApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
- package/sdk/application/Order/OrderApplicationModel.js +2 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +3 -15
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +185 -315
- package/sdk/partner/Theme/ThemePartnerModel.js +182 -222
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
- package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -1
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +14 -3
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +14 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +13 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +14 -3
- package/sdk/platform/Content/ContentPlatformModel.d.ts +6 -0
- package/sdk/platform/Content/ContentPlatformModel.js +6 -0
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +12 -3
- package/sdk/platform/Content/ContentPlatformValidator.js +11 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +118 -58
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +122 -68
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
- package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
- package/sdk/platform/Order/OrderPlatformClient.js +87 -481
- package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
- package/sdk/platform/Order/OrderPlatformModel.js +483 -169
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
- package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
- package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
- package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
|
@@ -1,9 +1,16 @@
|
|
|
1
1
|
export = ThemePartnerModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
5
|
-
* @property {
|
|
6
|
-
* @property {
|
|
3
|
+
* @typedef Action
|
|
4
|
+
* @property {ActionPage} [page]
|
|
5
|
+
* @property {ActionPage} [popup]
|
|
6
|
+
* @property {string} [type]
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* @typedef ActionPage
|
|
10
|
+
* @property {Object} [params]
|
|
11
|
+
* @property {Object} [query]
|
|
12
|
+
* @property {string} [type]
|
|
13
|
+
* @property {string} [url]
|
|
7
14
|
*/
|
|
8
15
|
/**
|
|
9
16
|
* @typedef AllAvailablePageSchema
|
|
@@ -16,15 +23,19 @@ export = ThemePartnerModel;
|
|
|
16
23
|
* @property {UMDJs} [umd_js]
|
|
17
24
|
*/
|
|
18
25
|
/**
|
|
19
|
-
* @typedef
|
|
20
|
-
* @property {boolean} [
|
|
21
|
-
* @property {boolean} [
|
|
26
|
+
* @typedef AvailablePagePlatformPredicate
|
|
27
|
+
* @property {boolean} [android] - Section visibility on android platform
|
|
28
|
+
* @property {boolean} [ios] - Section visibility on ios platform
|
|
29
|
+
* @property {boolean} [web] - Section visibility on web platform
|
|
22
30
|
*/
|
|
23
31
|
/**
|
|
24
32
|
* @typedef AvailablePagePredicate
|
|
33
|
+
* @property {AvailablePagePlatformPredicate} [platform]
|
|
25
34
|
* @property {AvailablePageRoutePredicate} [route]
|
|
35
|
+
* @property {AvailablePageSchedulePredicate} [schedule]
|
|
26
36
|
* @property {AvailablePageScreenPredicate} [screen]
|
|
27
37
|
* @property {AvailablePageUserPredicate} [user]
|
|
38
|
+
* @property {string[]} [zones] - An array of zone ids associated with the section
|
|
28
39
|
*/
|
|
29
40
|
/**
|
|
30
41
|
* @typedef AvailablePageRoutePredicate
|
|
@@ -32,9 +43,16 @@ export = ThemePartnerModel;
|
|
|
32
43
|
* @property {Object} [query]
|
|
33
44
|
* @property {string} [selected]
|
|
34
45
|
*/
|
|
46
|
+
/**
|
|
47
|
+
* @typedef AvailablePageSchedulePredicate
|
|
48
|
+
* @property {string} [cron]
|
|
49
|
+
* @property {string} [end]
|
|
50
|
+
* @property {string} [start]
|
|
51
|
+
*/
|
|
35
52
|
/**
|
|
36
53
|
* @typedef AvailablePageSchema
|
|
37
54
|
* @property {string} [_id]
|
|
55
|
+
* @property {string} [created_at] - The creation timestamp of the page
|
|
38
56
|
* @property {string} [path]
|
|
39
57
|
* @property {Object[]} [props]
|
|
40
58
|
* @property {AvailablePageSchemaSections[]} [sections]
|
|
@@ -43,6 +61,7 @@ export = ThemePartnerModel;
|
|
|
43
61
|
* @property {string} [text]
|
|
44
62
|
* @property {string} [theme]
|
|
45
63
|
* @property {string} [type]
|
|
64
|
+
* @property {string} [updated_at] - The last update timestamp of the page
|
|
46
65
|
* @property {string} [value]
|
|
47
66
|
*/
|
|
48
67
|
/**
|
|
@@ -53,6 +72,7 @@ export = ThemePartnerModel;
|
|
|
53
72
|
* @property {AvailablePagePredicate} [predicate]
|
|
54
73
|
* @property {Object} [preset]
|
|
55
74
|
* @property {Object} [props]
|
|
75
|
+
* @property {string} [source]
|
|
56
76
|
*/
|
|
57
77
|
/**
|
|
58
78
|
* @typedef AvailablePageScreenPredicate
|
|
@@ -67,7 +87,10 @@ export = ThemePartnerModel;
|
|
|
67
87
|
/**
|
|
68
88
|
* @typedef AvailablePageSeo
|
|
69
89
|
* @property {string} [_id]
|
|
90
|
+
* @property {SEObreadcrumb[]} [breadcrumb]
|
|
70
91
|
* @property {string} [description]
|
|
92
|
+
* @property {SEOMetaItem[]} [meta_tags]
|
|
93
|
+
* @property {SEOSitemap} [sitemap]
|
|
71
94
|
* @property {string} [title]
|
|
72
95
|
*/
|
|
73
96
|
/**
|
|
@@ -94,12 +117,6 @@ export = ThemePartnerModel;
|
|
|
94
117
|
* @property {ImagePickerProp} [image]
|
|
95
118
|
* @property {UrlProp} [slide_link]
|
|
96
119
|
*/
|
|
97
|
-
/**
|
|
98
|
-
* @typedef ButtonSetting
|
|
99
|
-
* @property {string} [button_link] - The button link color
|
|
100
|
-
* @property {string} [button_primary] - The primary button color
|
|
101
|
-
* @property {string} [button_secondary] - The secondary button color
|
|
102
|
-
*/
|
|
103
120
|
/**
|
|
104
121
|
* @typedef CarouselItem
|
|
105
122
|
* @property {string} [desktop] - Desktop carousel image URL
|
|
@@ -115,15 +132,6 @@ export = ThemePartnerModel;
|
|
|
115
132
|
* @property {string} [type] - The type of the property.
|
|
116
133
|
* @property {boolean} [value] - The value of the checkbox property.
|
|
117
134
|
*/
|
|
118
|
-
/**
|
|
119
|
-
* @typedef Colors
|
|
120
|
-
* @property {string} [accent_color] - The accent color
|
|
121
|
-
* @property {string} [bg_color] - The background color
|
|
122
|
-
* @property {string} [button_secondary_color] - The secondary button color
|
|
123
|
-
* @property {string} [link_color] - The link color
|
|
124
|
-
* @property {string} [primary_color] - The primary color
|
|
125
|
-
* @property {string} [secondary_color] - The secondary color
|
|
126
|
-
*/
|
|
127
135
|
/**
|
|
128
136
|
* @typedef Comments
|
|
129
137
|
* @property {string} [developer_remark] - Developer remark
|
|
@@ -159,6 +167,7 @@ export = ThemePartnerModel;
|
|
|
159
167
|
*/
|
|
160
168
|
/**
|
|
161
169
|
* @typedef CSS
|
|
170
|
+
* @property {string} [link]
|
|
162
171
|
* @property {string[]} [links]
|
|
163
172
|
*/
|
|
164
173
|
/**
|
|
@@ -204,9 +213,9 @@ export = ThemePartnerModel;
|
|
|
204
213
|
* price color
|
|
205
214
|
*/
|
|
206
215
|
/**
|
|
207
|
-
* @typedef
|
|
208
|
-
* @property {string} [divider_strokes]
|
|
209
|
-
* @property {string} [highlight]
|
|
216
|
+
* @typedef DividerStrokeHighlight
|
|
217
|
+
* @property {string} [divider_strokes]
|
|
218
|
+
* @property {string} [highlight]
|
|
210
219
|
*/
|
|
211
220
|
/**
|
|
212
221
|
* @typedef Documentation
|
|
@@ -246,39 +255,10 @@ export = ThemePartnerModel;
|
|
|
246
255
|
* @property {FontVariant} [regular]
|
|
247
256
|
* @property {FontVariant} [semi_bold]
|
|
248
257
|
*/
|
|
249
|
-
/**
|
|
250
|
-
* @typedef FooterSetting
|
|
251
|
-
* @property {string} [footer_background] - The footer background color
|
|
252
|
-
* @property {string} [footer_body_text] - The footer body text color
|
|
253
|
-
* @property {string} [footer_bottom_background] - The footer bottom background color
|
|
254
|
-
* @property {string} [footer_heading_text] - The footer heading text color
|
|
255
|
-
* @property {string} [footer_icon] - The footer icon color
|
|
256
|
-
*/
|
|
257
|
-
/**
|
|
258
|
-
* @typedef GeneralSetting
|
|
259
|
-
* @property {ButtonSetting} [button]
|
|
260
|
-
* @property {FooterSetting} [footer]
|
|
261
|
-
* @property {HeaderSetting} [header]
|
|
262
|
-
* @property {SaleDiscountSetting} [sale_discount]
|
|
263
|
-
* @property {TextSetting} [text]
|
|
264
|
-
* @property {ThemeSetting} [theme]
|
|
265
|
-
*/
|
|
266
|
-
/**
|
|
267
|
-
* @typedef GlobalConfig
|
|
268
|
-
* @property {AuthConfig} [auth]
|
|
269
|
-
* @property {PaletteConfig} [palette]
|
|
270
|
-
* @property {StaticConfig} [statics]
|
|
271
|
-
*/
|
|
272
258
|
/**
|
|
273
259
|
* @typedef GlobalSchema
|
|
274
260
|
* @property {Prop[]} [props]
|
|
275
261
|
*/
|
|
276
|
-
/**
|
|
277
|
-
* @typedef HeaderSetting
|
|
278
|
-
* @property {string} [header_background] - The header background color
|
|
279
|
-
* @property {string} [header_icon] - The header icon color
|
|
280
|
-
* @property {string} [header_nav] - The header navigation color
|
|
281
|
-
*/
|
|
282
262
|
/**
|
|
283
263
|
* @typedef Highlight
|
|
284
264
|
* @property {string} [description] - Highlight description
|
|
@@ -337,9 +317,14 @@ export = ThemePartnerModel;
|
|
|
337
317
|
* @property {MarketplaceTheme[]} [themes]
|
|
338
318
|
*/
|
|
339
319
|
/**
|
|
340
|
-
* @typedef
|
|
341
|
-
* @property {
|
|
342
|
-
* @property {
|
|
320
|
+
* @typedef OrderTracking
|
|
321
|
+
* @property {boolean} [show_footer]
|
|
322
|
+
* @property {boolean} [show_header]
|
|
323
|
+
*/
|
|
324
|
+
/**
|
|
325
|
+
* @typedef OverlayPopup
|
|
326
|
+
* @property {string} [dialog_backgroung]
|
|
327
|
+
* @property {string} [overlay]
|
|
343
328
|
*/
|
|
344
329
|
/**
|
|
345
330
|
* @typedef Page
|
|
@@ -359,11 +344,6 @@ export = ThemePartnerModel;
|
|
|
359
344
|
* @property {number} [size]
|
|
360
345
|
* @property {string} [type]
|
|
361
346
|
*/
|
|
362
|
-
/**
|
|
363
|
-
* @typedef PaletteConfig
|
|
364
|
-
* @property {AdvanceSetting} [advance_setting]
|
|
365
|
-
* @property {GeneralSetting} [general_setting]
|
|
366
|
-
*/
|
|
367
347
|
/**
|
|
368
348
|
* @typedef PaymentInfo
|
|
369
349
|
* @property {number} [amount] - Amount of payment
|
|
@@ -386,6 +366,7 @@ export = ThemePartnerModel;
|
|
|
386
366
|
* @property {string} [info] - Additional information about the property
|
|
387
367
|
* @property {string} [label] - The label of the property
|
|
388
368
|
* @property {string} [type] - The type of the property
|
|
369
|
+
* @property {string} [value] - The value of the property
|
|
389
370
|
*/
|
|
390
371
|
/**
|
|
391
372
|
* @typedef RangeProp
|
|
@@ -402,13 +383,6 @@ export = ThemePartnerModel;
|
|
|
402
383
|
* @property {string} [exact_url] - The exact URL of the route.
|
|
403
384
|
* @property {string} [selected] - The selected route.
|
|
404
385
|
*/
|
|
405
|
-
/**
|
|
406
|
-
* @typedef SaleDiscountSetting
|
|
407
|
-
* @property {string} [sale_badge_background] - The sale badge background color
|
|
408
|
-
* @property {string} [sale_badge_text] - The sale badge text color
|
|
409
|
-
* @property {string} [sale_discount_text] - The sale discount text color
|
|
410
|
-
* @property {string} [sale_timer] - The sale timer color
|
|
411
|
-
*/
|
|
412
386
|
/**
|
|
413
387
|
* @typedef Screen
|
|
414
388
|
* @property {boolean} [desktop] - True if the screen is a desktop device.
|
|
@@ -442,13 +416,24 @@ export = ThemePartnerModel;
|
|
|
442
416
|
* @property {TextProp} [title]
|
|
443
417
|
*/
|
|
444
418
|
/**
|
|
445
|
-
* @typedef
|
|
446
|
-
* @property {
|
|
419
|
+
* @typedef SEObreadcrumb
|
|
420
|
+
* @property {Action} [action]
|
|
421
|
+
* @property {string} [url]
|
|
422
|
+
*/
|
|
423
|
+
/**
|
|
424
|
+
* @typedef SEOMetaItem
|
|
425
|
+
* @property {SEOMetaItems[]} [items]
|
|
426
|
+
* @property {string} [title]
|
|
427
|
+
*/
|
|
428
|
+
/**
|
|
429
|
+
* @typedef SEOMetaItems
|
|
430
|
+
* @property {string} [key]
|
|
431
|
+
* @property {string} [value]
|
|
447
432
|
*/
|
|
448
433
|
/**
|
|
449
|
-
* @typedef
|
|
450
|
-
* @property {
|
|
451
|
-
* @property {
|
|
434
|
+
* @typedef SEOSitemap
|
|
435
|
+
* @property {string} [frequency]
|
|
436
|
+
* @property {number} [priority]
|
|
452
437
|
*/
|
|
453
438
|
/**
|
|
454
439
|
* @typedef TextProp
|
|
@@ -456,18 +441,19 @@ export = ThemePartnerModel;
|
|
|
456
441
|
* @property {string} [value] - The value of the text property.
|
|
457
442
|
*/
|
|
458
443
|
/**
|
|
459
|
-
* @typedef
|
|
460
|
-
* @property {string} [
|
|
461
|
-
* @property {
|
|
462
|
-
|
|
463
|
-
|
|
444
|
+
* @typedef ThemeConfigListPage
|
|
445
|
+
* @property {string} [page] - Name of the page
|
|
446
|
+
* @property {ThemeConfigListPageSettingsProps} [settings]
|
|
447
|
+
*/
|
|
448
|
+
/**
|
|
449
|
+
* @typedef ThemeConfigListPageSettingsProps
|
|
450
|
+
* @property {Object} [props]
|
|
464
451
|
*/
|
|
465
452
|
/**
|
|
466
453
|
* @typedef ThemeConfiguration
|
|
467
|
-
* @property {
|
|
468
|
-
* @property {GlobalConfig} [global_config]
|
|
454
|
+
* @property {Object} [global_config]
|
|
469
455
|
* @property {string} [name] - The name of the configuration
|
|
470
|
-
* @property {
|
|
456
|
+
* @property {ThemeConfigListPage[]} [page] - An array of pages
|
|
471
457
|
*/
|
|
472
458
|
/**
|
|
473
459
|
* @typedef ThemeMeta
|
|
@@ -499,11 +485,6 @@ export = ThemePartnerModel;
|
|
|
499
485
|
* reasons object was last updated
|
|
500
486
|
* @property {string} user_id - The ID of the user who submitted the theme
|
|
501
487
|
*/
|
|
502
|
-
/**
|
|
503
|
-
* @typedef ThemeSetting
|
|
504
|
-
* @property {string} [page_background] - The page background color
|
|
505
|
-
* @property {string} [theme_accent] - The theme accent color
|
|
506
|
-
*/
|
|
507
488
|
/**
|
|
508
489
|
* @typedef ThemesSchema
|
|
509
490
|
* @property {string} [_id] - The unique identifier of the theme
|
|
@@ -519,6 +500,7 @@ export = ThemePartnerModel;
|
|
|
519
500
|
* @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
|
|
520
501
|
* @property {ThemeMeta} [meta]
|
|
521
502
|
* @property {string} [name] - The name of the theme
|
|
503
|
+
* @property {string} [src]
|
|
522
504
|
* @property {Object} [styles] - The styles associated with the theme
|
|
523
505
|
* @property {string[]} [tags] - An array of tags associated with the theme
|
|
524
506
|
* @property {string} [template_theme_id] - The ID of the template theme
|
|
@@ -533,6 +515,7 @@ export = ThemePartnerModel;
|
|
|
533
515
|
*/
|
|
534
516
|
/**
|
|
535
517
|
* @typedef UMDJs
|
|
518
|
+
* @property {string} [link]
|
|
536
519
|
* @property {string[]} [links]
|
|
537
520
|
*/
|
|
538
521
|
/**
|
|
@@ -546,13 +529,13 @@ export = ThemePartnerModel;
|
|
|
546
529
|
* @property {string} [value] - The value of the URL property.
|
|
547
530
|
*/
|
|
548
531
|
/**
|
|
549
|
-
* @typedef
|
|
550
|
-
* @property {string} [error_background]
|
|
551
|
-
* @property {string} [error_text]
|
|
552
|
-
* @property {string} [info_background]
|
|
553
|
-
* @property {string} [info_text]
|
|
554
|
-
* @property {string} [success_background]
|
|
555
|
-
* @property {string} [success_text]
|
|
532
|
+
* @typedef UserAlerts
|
|
533
|
+
* @property {string} [error_background]
|
|
534
|
+
* @property {string} [error_text]
|
|
535
|
+
* @property {string} [info_background]
|
|
536
|
+
* @property {string} [info_text]
|
|
537
|
+
* @property {string} [success_background]
|
|
538
|
+
* @property {string} [success_text]
|
|
556
539
|
*/
|
|
557
540
|
/**
|
|
558
541
|
* @typedef Variation
|
|
@@ -564,14 +547,22 @@ export = ThemePartnerModel;
|
|
|
564
547
|
declare class ThemePartnerModel {
|
|
565
548
|
}
|
|
566
549
|
declare namespace ThemePartnerModel {
|
|
567
|
-
export {
|
|
550
|
+
export { Action, ActionPage, AllAvailablePageSchema, Assets, AvailablePagePlatformPredicate, AvailablePagePredicate, AvailablePageRoutePredicate, AvailablePageSchedulePredicate, AvailablePageSchema, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageSectionMetaAttributes, AvailablePageSeo, AvailablePageUserPredicate, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, Block, BlockProps, CarouselItem, CatalogSize, CheckboxProp, Comments, CommonJS, Config, ContactInfo, CreateNewTheme, CSS, CustomConfig, CustomProps, DividerStrokeHighlight, Documentation, ExploreInfo, Feature, FeatureItem, Font, FontVariant, FontVariants, GlobalSchema, Highlight, ImagePickerProp, Images, MarketplaceTheme, MarketplaceThemeImages, MarketplaceThemeSchema, OrderTracking, OverlayPopup, Page, PaginationSchema, PaymentInfo, Predicate, Preset, Prop, RangeProp, Release, Route, Screen, Section, SectionItem, SectionPreset, SectionProps, SEObreadcrumb, SEOMetaItem, SEOMetaItems, SEOSitemap, TextProp, ThemeConfigListPage, ThemeConfigListPageSettingsProps, ThemeConfiguration, ThemeMeta, ThemePayment, ThemeRejectionReasons, ThemesSchema, ThemeUserSchema, UMDJs, UpdateThemeRequestBody, UrlProp, UserAlerts, Variation };
|
|
568
551
|
}
|
|
569
|
-
/** @returns {
|
|
570
|
-
declare function
|
|
571
|
-
type
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
552
|
+
/** @returns {Action} */
|
|
553
|
+
declare function Action(): Action;
|
|
554
|
+
type Action = {
|
|
555
|
+
page?: ActionPage;
|
|
556
|
+
popup?: ActionPage;
|
|
557
|
+
type?: string;
|
|
558
|
+
};
|
|
559
|
+
/** @returns {ActionPage} */
|
|
560
|
+
declare function ActionPage(): ActionPage;
|
|
561
|
+
type ActionPage = {
|
|
562
|
+
params?: any;
|
|
563
|
+
query?: any;
|
|
564
|
+
type?: string;
|
|
565
|
+
url?: string;
|
|
575
566
|
};
|
|
576
567
|
/** @returns {AllAvailablePageSchema} */
|
|
577
568
|
declare function AllAvailablePageSchema(): AllAvailablePageSchema;
|
|
@@ -585,24 +576,34 @@ type Assets = {
|
|
|
585
576
|
css?: CSS;
|
|
586
577
|
umd_js?: UMDJs;
|
|
587
578
|
};
|
|
588
|
-
/** @returns {
|
|
589
|
-
declare function
|
|
590
|
-
type
|
|
579
|
+
/** @returns {AvailablePagePlatformPredicate} */
|
|
580
|
+
declare function AvailablePagePlatformPredicate(): AvailablePagePlatformPredicate;
|
|
581
|
+
type AvailablePagePlatformPredicate = {
|
|
582
|
+
/**
|
|
583
|
+
* - Section visibility on android platform
|
|
584
|
+
*/
|
|
585
|
+
android?: boolean;
|
|
591
586
|
/**
|
|
592
|
-
* -
|
|
587
|
+
* - Section visibility on ios platform
|
|
593
588
|
*/
|
|
594
|
-
|
|
589
|
+
ios?: boolean;
|
|
595
590
|
/**
|
|
596
|
-
* -
|
|
591
|
+
* - Section visibility on web platform
|
|
597
592
|
*/
|
|
598
|
-
|
|
593
|
+
web?: boolean;
|
|
599
594
|
};
|
|
600
595
|
/** @returns {AvailablePagePredicate} */
|
|
601
596
|
declare function AvailablePagePredicate(): AvailablePagePredicate;
|
|
602
597
|
type AvailablePagePredicate = {
|
|
598
|
+
platform?: AvailablePagePlatformPredicate;
|
|
603
599
|
route?: AvailablePageRoutePredicate;
|
|
600
|
+
schedule?: AvailablePageSchedulePredicate;
|
|
604
601
|
screen?: AvailablePageScreenPredicate;
|
|
605
602
|
user?: AvailablePageUserPredicate;
|
|
603
|
+
/**
|
|
604
|
+
* - An array of zone ids associated with the section
|
|
605
|
+
*/
|
|
606
|
+
zones?: string[];
|
|
606
607
|
};
|
|
607
608
|
/** @returns {AvailablePageRoutePredicate} */
|
|
608
609
|
declare function AvailablePageRoutePredicate(): AvailablePageRoutePredicate;
|
|
@@ -611,10 +612,21 @@ type AvailablePageRoutePredicate = {
|
|
|
611
612
|
query?: any;
|
|
612
613
|
selected?: string;
|
|
613
614
|
};
|
|
615
|
+
/** @returns {AvailablePageSchedulePredicate} */
|
|
616
|
+
declare function AvailablePageSchedulePredicate(): AvailablePageSchedulePredicate;
|
|
617
|
+
type AvailablePageSchedulePredicate = {
|
|
618
|
+
cron?: string;
|
|
619
|
+
end?: string;
|
|
620
|
+
start?: string;
|
|
621
|
+
};
|
|
614
622
|
/** @returns {AvailablePageSchema} */
|
|
615
623
|
declare function AvailablePageSchema(): AvailablePageSchema;
|
|
616
624
|
type AvailablePageSchema = {
|
|
617
625
|
_id?: string;
|
|
626
|
+
/**
|
|
627
|
+
* - The creation timestamp of the page
|
|
628
|
+
*/
|
|
629
|
+
created_at?: string;
|
|
618
630
|
path?: string;
|
|
619
631
|
props?: any[];
|
|
620
632
|
sections?: AvailablePageSchemaSections[];
|
|
@@ -623,6 +635,10 @@ type AvailablePageSchema = {
|
|
|
623
635
|
text?: string;
|
|
624
636
|
theme?: string;
|
|
625
637
|
type?: string;
|
|
638
|
+
/**
|
|
639
|
+
* - The last update timestamp of the page
|
|
640
|
+
*/
|
|
641
|
+
updated_at?: string;
|
|
626
642
|
value?: string;
|
|
627
643
|
};
|
|
628
644
|
/** @returns {AvailablePageSchemaSections} */
|
|
@@ -634,6 +650,7 @@ type AvailablePageSchemaSections = {
|
|
|
634
650
|
predicate?: AvailablePagePredicate;
|
|
635
651
|
preset?: any;
|
|
636
652
|
props?: any;
|
|
653
|
+
source?: string;
|
|
637
654
|
};
|
|
638
655
|
/** @returns {AvailablePageScreenPredicate} */
|
|
639
656
|
declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
|
|
@@ -651,7 +668,10 @@ type AvailablePageSectionMetaAttributes = {
|
|
|
651
668
|
declare function AvailablePageSeo(): AvailablePageSeo;
|
|
652
669
|
type AvailablePageSeo = {
|
|
653
670
|
_id?: string;
|
|
671
|
+
breadcrumb?: SEObreadcrumb[];
|
|
654
672
|
description?: string;
|
|
673
|
+
meta_tags?: SEOMetaItem[];
|
|
674
|
+
sitemap?: SEOSitemap;
|
|
655
675
|
title?: string;
|
|
656
676
|
};
|
|
657
677
|
/** @returns {AvailablePageUserPredicate} */
|
|
@@ -689,22 +709,6 @@ type BlockProps = {
|
|
|
689
709
|
image?: ImagePickerProp;
|
|
690
710
|
slide_link?: UrlProp;
|
|
691
711
|
};
|
|
692
|
-
/** @returns {ButtonSetting} */
|
|
693
|
-
declare function ButtonSetting(): ButtonSetting;
|
|
694
|
-
type ButtonSetting = {
|
|
695
|
-
/**
|
|
696
|
-
* - The button link color
|
|
697
|
-
*/
|
|
698
|
-
button_link?: string;
|
|
699
|
-
/**
|
|
700
|
-
* - The primary button color
|
|
701
|
-
*/
|
|
702
|
-
button_primary?: string;
|
|
703
|
-
/**
|
|
704
|
-
* - The secondary button color
|
|
705
|
-
*/
|
|
706
|
-
button_secondary?: string;
|
|
707
|
-
};
|
|
708
712
|
/** @returns {CarouselItem} */
|
|
709
713
|
declare function CarouselItem(): CarouselItem;
|
|
710
714
|
type CarouselItem = {
|
|
@@ -741,34 +745,6 @@ type CheckboxProp = {
|
|
|
741
745
|
*/
|
|
742
746
|
value?: boolean;
|
|
743
747
|
};
|
|
744
|
-
/** @returns {Colors} */
|
|
745
|
-
declare function Colors(): Colors;
|
|
746
|
-
type Colors = {
|
|
747
|
-
/**
|
|
748
|
-
* - The accent color
|
|
749
|
-
*/
|
|
750
|
-
accent_color?: string;
|
|
751
|
-
/**
|
|
752
|
-
* - The background color
|
|
753
|
-
*/
|
|
754
|
-
bg_color?: string;
|
|
755
|
-
/**
|
|
756
|
-
* - The secondary button color
|
|
757
|
-
*/
|
|
758
|
-
button_secondary_color?: string;
|
|
759
|
-
/**
|
|
760
|
-
* - The link color
|
|
761
|
-
*/
|
|
762
|
-
link_color?: string;
|
|
763
|
-
/**
|
|
764
|
-
* - The primary color
|
|
765
|
-
*/
|
|
766
|
-
primary_color?: string;
|
|
767
|
-
/**
|
|
768
|
-
* - The secondary color
|
|
769
|
-
*/
|
|
770
|
-
secondary_color?: string;
|
|
771
|
-
};
|
|
772
748
|
/** @returns {Comments} */
|
|
773
749
|
declare function Comments(): Comments;
|
|
774
750
|
type Comments = {
|
|
@@ -846,6 +822,7 @@ type CreateNewTheme = {
|
|
|
846
822
|
/** @returns {CSS} */
|
|
847
823
|
declare function CSS(): CSS;
|
|
848
824
|
type CSS = {
|
|
825
|
+
link?: string;
|
|
849
826
|
links?: string[];
|
|
850
827
|
};
|
|
851
828
|
/** @returns {CustomConfig} */
|
|
@@ -982,16 +959,10 @@ type CustomProps = {
|
|
|
982
959
|
*/
|
|
983
960
|
text_strikethrough_price_color?: string;
|
|
984
961
|
};
|
|
985
|
-
/** @returns {
|
|
986
|
-
declare function
|
|
987
|
-
type
|
|
988
|
-
/**
|
|
989
|
-
* - The divider strokes color
|
|
990
|
-
*/
|
|
962
|
+
/** @returns {DividerStrokeHighlight} */
|
|
963
|
+
declare function DividerStrokeHighlight(): DividerStrokeHighlight;
|
|
964
|
+
type DividerStrokeHighlight = {
|
|
991
965
|
divider_strokes?: string;
|
|
992
|
-
/**
|
|
993
|
-
* - The highlight color
|
|
994
|
-
*/
|
|
995
966
|
highlight?: string;
|
|
996
967
|
};
|
|
997
968
|
/** @returns {Documentation} */
|
|
@@ -1069,68 +1040,11 @@ type FontVariants = {
|
|
|
1069
1040
|
regular?: FontVariant;
|
|
1070
1041
|
semi_bold?: FontVariant;
|
|
1071
1042
|
};
|
|
1072
|
-
/** @returns {FooterSetting} */
|
|
1073
|
-
declare function FooterSetting(): FooterSetting;
|
|
1074
|
-
type FooterSetting = {
|
|
1075
|
-
/**
|
|
1076
|
-
* - The footer background color
|
|
1077
|
-
*/
|
|
1078
|
-
footer_background?: string;
|
|
1079
|
-
/**
|
|
1080
|
-
* - The footer body text color
|
|
1081
|
-
*/
|
|
1082
|
-
footer_body_text?: string;
|
|
1083
|
-
/**
|
|
1084
|
-
* - The footer bottom background color
|
|
1085
|
-
*/
|
|
1086
|
-
footer_bottom_background?: string;
|
|
1087
|
-
/**
|
|
1088
|
-
* - The footer heading text color
|
|
1089
|
-
*/
|
|
1090
|
-
footer_heading_text?: string;
|
|
1091
|
-
/**
|
|
1092
|
-
* - The footer icon color
|
|
1093
|
-
*/
|
|
1094
|
-
footer_icon?: string;
|
|
1095
|
-
};
|
|
1096
|
-
/** @returns {GeneralSetting} */
|
|
1097
|
-
declare function GeneralSetting(): GeneralSetting;
|
|
1098
|
-
type GeneralSetting = {
|
|
1099
|
-
button?: ButtonSetting;
|
|
1100
|
-
footer?: FooterSetting;
|
|
1101
|
-
header?: HeaderSetting;
|
|
1102
|
-
sale_discount?: SaleDiscountSetting;
|
|
1103
|
-
text?: TextSetting;
|
|
1104
|
-
theme?: ThemeSetting;
|
|
1105
|
-
};
|
|
1106
|
-
/** @returns {GlobalConfig} */
|
|
1107
|
-
declare function GlobalConfig(): GlobalConfig;
|
|
1108
|
-
type GlobalConfig = {
|
|
1109
|
-
auth?: AuthConfig;
|
|
1110
|
-
palette?: PaletteConfig;
|
|
1111
|
-
statics?: StaticConfig;
|
|
1112
|
-
};
|
|
1113
1043
|
/** @returns {GlobalSchema} */
|
|
1114
1044
|
declare function GlobalSchema(): GlobalSchema;
|
|
1115
1045
|
type GlobalSchema = {
|
|
1116
1046
|
props?: Prop[];
|
|
1117
1047
|
};
|
|
1118
|
-
/** @returns {HeaderSetting} */
|
|
1119
|
-
declare function HeaderSetting(): HeaderSetting;
|
|
1120
|
-
type HeaderSetting = {
|
|
1121
|
-
/**
|
|
1122
|
-
* - The header background color
|
|
1123
|
-
*/
|
|
1124
|
-
header_background?: string;
|
|
1125
|
-
/**
|
|
1126
|
-
* - The header icon color
|
|
1127
|
-
*/
|
|
1128
|
-
header_icon?: string;
|
|
1129
|
-
/**
|
|
1130
|
-
* - The header navigation color
|
|
1131
|
-
*/
|
|
1132
|
-
header_nav?: string;
|
|
1133
|
-
};
|
|
1134
1048
|
/** @returns {Highlight} */
|
|
1135
1049
|
declare function Highlight(): Highlight;
|
|
1136
1050
|
type Highlight = {
|
|
@@ -1269,16 +1183,16 @@ type MarketplaceThemeSchema = {
|
|
|
1269
1183
|
page?: PaginationSchema;
|
|
1270
1184
|
themes?: MarketplaceTheme[];
|
|
1271
1185
|
};
|
|
1272
|
-
/** @returns {
|
|
1273
|
-
declare function
|
|
1274
|
-
type
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1186
|
+
/** @returns {OrderTracking} */
|
|
1187
|
+
declare function OrderTracking(): OrderTracking;
|
|
1188
|
+
type OrderTracking = {
|
|
1189
|
+
show_footer?: boolean;
|
|
1190
|
+
show_header?: boolean;
|
|
1191
|
+
};
|
|
1192
|
+
/** @returns {OverlayPopup} */
|
|
1193
|
+
declare function OverlayPopup(): OverlayPopup;
|
|
1194
|
+
type OverlayPopup = {
|
|
1278
1195
|
dialog_backgroung?: string;
|
|
1279
|
-
/**
|
|
1280
|
-
* - The overlay color
|
|
1281
|
-
*/
|
|
1282
1196
|
overlay?: string;
|
|
1283
1197
|
};
|
|
1284
1198
|
/** @returns {Page} */
|
|
@@ -1301,12 +1215,6 @@ type PaginationSchema = {
|
|
|
1301
1215
|
size?: number;
|
|
1302
1216
|
type?: string;
|
|
1303
1217
|
};
|
|
1304
|
-
/** @returns {PaletteConfig} */
|
|
1305
|
-
declare function PaletteConfig(): PaletteConfig;
|
|
1306
|
-
type PaletteConfig = {
|
|
1307
|
-
advance_setting?: AdvanceSetting;
|
|
1308
|
-
general_setting?: GeneralSetting;
|
|
1309
|
-
};
|
|
1310
1218
|
/** @returns {PaymentInfo} */
|
|
1311
1219
|
declare function PaymentInfo(): PaymentInfo;
|
|
1312
1220
|
type PaymentInfo = {
|
|
@@ -1354,6 +1262,10 @@ type Prop = {
|
|
|
1354
1262
|
* - The type of the property
|
|
1355
1263
|
*/
|
|
1356
1264
|
type?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* - The value of the property
|
|
1267
|
+
*/
|
|
1268
|
+
value?: string;
|
|
1357
1269
|
};
|
|
1358
1270
|
/** @returns {RangeProp} */
|
|
1359
1271
|
declare function RangeProp(): RangeProp;
|
|
@@ -1391,26 +1303,6 @@ type Route = {
|
|
|
1391
1303
|
*/
|
|
1392
1304
|
selected?: string;
|
|
1393
1305
|
};
|
|
1394
|
-
/** @returns {SaleDiscountSetting} */
|
|
1395
|
-
declare function SaleDiscountSetting(): SaleDiscountSetting;
|
|
1396
|
-
type SaleDiscountSetting = {
|
|
1397
|
-
/**
|
|
1398
|
-
* - The sale badge background color
|
|
1399
|
-
*/
|
|
1400
|
-
sale_badge_background?: string;
|
|
1401
|
-
/**
|
|
1402
|
-
* - The sale badge text color
|
|
1403
|
-
*/
|
|
1404
|
-
sale_badge_text?: string;
|
|
1405
|
-
/**
|
|
1406
|
-
* - The sale discount text color
|
|
1407
|
-
*/
|
|
1408
|
-
sale_discount_text?: string;
|
|
1409
|
-
/**
|
|
1410
|
-
* - The sale timer color
|
|
1411
|
-
*/
|
|
1412
|
-
sale_timer?: string;
|
|
1413
|
-
};
|
|
1414
1306
|
/** @returns {Screen} */
|
|
1415
1307
|
declare function Screen(): Screen;
|
|
1416
1308
|
type Screen = {
|
|
@@ -1469,16 +1361,29 @@ type SectionProps = {
|
|
|
1469
1361
|
slide_interval?: RangeProp;
|
|
1470
1362
|
title?: TextProp;
|
|
1471
1363
|
};
|
|
1472
|
-
/** @returns {
|
|
1473
|
-
declare function
|
|
1474
|
-
type
|
|
1475
|
-
|
|
1364
|
+
/** @returns {SEObreadcrumb} */
|
|
1365
|
+
declare function SEObreadcrumb(): SEObreadcrumb;
|
|
1366
|
+
type SEObreadcrumb = {
|
|
1367
|
+
action?: Action;
|
|
1368
|
+
url?: string;
|
|
1369
|
+
};
|
|
1370
|
+
/** @returns {SEOMetaItem} */
|
|
1371
|
+
declare function SEOMetaItem(): SEOMetaItem;
|
|
1372
|
+
type SEOMetaItem = {
|
|
1373
|
+
items?: SEOMetaItems[];
|
|
1374
|
+
title?: string;
|
|
1375
|
+
};
|
|
1376
|
+
/** @returns {SEOMetaItems} */
|
|
1377
|
+
declare function SEOMetaItems(): SEOMetaItems;
|
|
1378
|
+
type SEOMetaItems = {
|
|
1379
|
+
key?: string;
|
|
1380
|
+
value?: string;
|
|
1476
1381
|
};
|
|
1477
|
-
/** @returns {
|
|
1478
|
-
declare function
|
|
1479
|
-
type
|
|
1480
|
-
|
|
1481
|
-
|
|
1382
|
+
/** @returns {SEOSitemap} */
|
|
1383
|
+
declare function SEOSitemap(): SEOSitemap;
|
|
1384
|
+
type SEOSitemap = {
|
|
1385
|
+
frequency?: string;
|
|
1386
|
+
priority?: number;
|
|
1482
1387
|
};
|
|
1483
1388
|
/** @returns {TextProp} */
|
|
1484
1389
|
declare function TextProp(): TextProp;
|
|
@@ -1492,31 +1397,24 @@ type TextProp = {
|
|
|
1492
1397
|
*/
|
|
1493
1398
|
value?: string;
|
|
1494
1399
|
};
|
|
1495
|
-
/** @returns {
|
|
1496
|
-
declare function
|
|
1497
|
-
type
|
|
1498
|
-
/**
|
|
1499
|
-
* - The text body color
|
|
1500
|
-
*/
|
|
1501
|
-
text_body?: string;
|
|
1502
|
-
/**
|
|
1503
|
-
* - The text heading color
|
|
1504
|
-
*/
|
|
1505
|
-
text_heading?: string;
|
|
1506
|
-
/**
|
|
1507
|
-
* - The text label color
|
|
1508
|
-
*/
|
|
1509
|
-
text_label?: string;
|
|
1400
|
+
/** @returns {ThemeConfigListPage} */
|
|
1401
|
+
declare function ThemeConfigListPage(): ThemeConfigListPage;
|
|
1402
|
+
type ThemeConfigListPage = {
|
|
1510
1403
|
/**
|
|
1511
|
-
* -
|
|
1404
|
+
* - Name of the page
|
|
1512
1405
|
*/
|
|
1513
|
-
|
|
1406
|
+
page?: string;
|
|
1407
|
+
settings?: ThemeConfigListPageSettingsProps;
|
|
1408
|
+
};
|
|
1409
|
+
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1410
|
+
declare function ThemeConfigListPageSettingsProps(): ThemeConfigListPageSettingsProps;
|
|
1411
|
+
type ThemeConfigListPageSettingsProps = {
|
|
1412
|
+
props?: any;
|
|
1514
1413
|
};
|
|
1515
1414
|
/** @returns {ThemeConfiguration} */
|
|
1516
1415
|
declare function ThemeConfiguration(): ThemeConfiguration;
|
|
1517
1416
|
type ThemeConfiguration = {
|
|
1518
|
-
|
|
1519
|
-
global_config?: GlobalConfig;
|
|
1417
|
+
global_config?: any;
|
|
1520
1418
|
/**
|
|
1521
1419
|
* - The name of the configuration
|
|
1522
1420
|
*/
|
|
@@ -1524,7 +1422,7 @@ type ThemeConfiguration = {
|
|
|
1524
1422
|
/**
|
|
1525
1423
|
* - An array of pages
|
|
1526
1424
|
*/
|
|
1527
|
-
page?:
|
|
1425
|
+
page?: ThemeConfigListPage[];
|
|
1528
1426
|
};
|
|
1529
1427
|
/** @returns {ThemeMeta} */
|
|
1530
1428
|
declare function ThemeMeta(): ThemeMeta;
|
|
@@ -1604,18 +1502,6 @@ type ThemeRejectionReasons = {
|
|
|
1604
1502
|
*/
|
|
1605
1503
|
user_id: string;
|
|
1606
1504
|
};
|
|
1607
|
-
/** @returns {ThemeSetting} */
|
|
1608
|
-
declare function ThemeSetting(): ThemeSetting;
|
|
1609
|
-
type ThemeSetting = {
|
|
1610
|
-
/**
|
|
1611
|
-
* - The page background color
|
|
1612
|
-
*/
|
|
1613
|
-
page_background?: string;
|
|
1614
|
-
/**
|
|
1615
|
-
* - The theme accent color
|
|
1616
|
-
*/
|
|
1617
|
-
theme_accent?: string;
|
|
1618
|
-
};
|
|
1619
1505
|
/** @returns {ThemesSchema} */
|
|
1620
1506
|
declare function ThemesSchema(): ThemesSchema;
|
|
1621
1507
|
type ThemesSchema = {
|
|
@@ -1659,6 +1545,7 @@ type ThemesSchema = {
|
|
|
1659
1545
|
* - The name of the theme
|
|
1660
1546
|
*/
|
|
1661
1547
|
name?: string;
|
|
1548
|
+
src?: string;
|
|
1662
1549
|
/**
|
|
1663
1550
|
* - The styles associated with the theme
|
|
1664
1551
|
*/
|
|
@@ -1696,6 +1583,7 @@ type ThemeUserSchema = {
|
|
|
1696
1583
|
/** @returns {UMDJs} */
|
|
1697
1584
|
declare function UMDJs(): UMDJs;
|
|
1698
1585
|
type UMDJs = {
|
|
1586
|
+
link?: string;
|
|
1699
1587
|
links?: string[];
|
|
1700
1588
|
};
|
|
1701
1589
|
/** @returns {UpdateThemeRequestBody} */
|
|
@@ -1716,32 +1604,14 @@ type UrlProp = {
|
|
|
1716
1604
|
*/
|
|
1717
1605
|
value?: string;
|
|
1718
1606
|
};
|
|
1719
|
-
/** @returns {
|
|
1720
|
-
declare function
|
|
1721
|
-
type
|
|
1722
|
-
/**
|
|
1723
|
-
* - The error background color
|
|
1724
|
-
*/
|
|
1607
|
+
/** @returns {UserAlerts} */
|
|
1608
|
+
declare function UserAlerts(): UserAlerts;
|
|
1609
|
+
type UserAlerts = {
|
|
1725
1610
|
error_background?: string;
|
|
1726
|
-
/**
|
|
1727
|
-
* - The error text color
|
|
1728
|
-
*/
|
|
1729
1611
|
error_text?: string;
|
|
1730
|
-
/**
|
|
1731
|
-
* - The info background color
|
|
1732
|
-
*/
|
|
1733
1612
|
info_background?: string;
|
|
1734
|
-
/**
|
|
1735
|
-
* - The info text color
|
|
1736
|
-
*/
|
|
1737
1613
|
info_text?: string;
|
|
1738
|
-
/**
|
|
1739
|
-
* - The success background color
|
|
1740
|
-
*/
|
|
1741
1614
|
success_background?: string;
|
|
1742
|
-
/**
|
|
1743
|
-
* - The success text color
|
|
1744
|
-
*/
|
|
1745
1615
|
success_text?: string;
|
|
1746
1616
|
};
|
|
1747
1617
|
/** @returns {Variation} */
|