@gofynd/fdk-client-javascript 1.4.0-beta.1 → 1.4.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +2 -0
  4. package/sdk/application/Cart/CartApplicationModel.js +2 -0
  5. package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
  6. package/sdk/application/Order/OrderApplicationModel.js +2 -0
  7. package/sdk/partner/Theme/ThemePartnerModel.d.ts +240 -315
  8. package/sdk/partner/Theme/ThemePartnerModel.js +332 -222
  9. package/sdk/platform/Cart/CartPlatformApplicationClient.js +4 -1
  10. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  11. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
  12. package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
  13. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
  14. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
  15. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
  16. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +8 -2
  17. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
  18. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
  19. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -1
  20. package/sdk/platform/Content/ContentPlatformApplicationClient.js +4 -1
  21. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
  22. package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
  23. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
  24. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -44
  25. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +120 -54
  26. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +4 -1
  27. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
  28. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -86
  29. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
  30. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
  31. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
  32. package/sdk/platform/Order/OrderPlatformClient.js +87 -481
  33. package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
  34. package/sdk/platform/Order/OrderPlatformModel.js +483 -169
  35. package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
  36. package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
  37. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -1
  38. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +4 -1
  39. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +4 -1
  40. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +4 -1
  41. package/sdk/platform/Share/SharePlatformApplicationClient.js +4 -1
  42. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -1
  43. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
  44. package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
  45. package/sdk/platform/User/UserPlatformApplicationClient.js +4 -1
  46. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
  47. package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
  48. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
  49. package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
@@ -1,9 +1,16 @@
1
1
  export = ThemePartnerModel;
2
2
  /**
3
- * @typedef AdvanceSetting
4
- * @property {DividerStrokeHighlightSetting} [divider_stroke_highlight]
5
- * @property {OverlayPopupSetting} [overlay_popup]
6
- * @property {UserAlertsSetting} [user_alerts]
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 {PageType} 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 AuthConfig
20
- * @property {boolean} [show_footer_auth] - Whether to show footer authentication or not
21
- * @property {boolean} [show_header_auth] - Whether to show header authentication or not
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 DividerStrokeHighlightSetting
208
- * @property {string} [divider_strokes] - The divider strokes color
209
- * @property {string} [highlight] - The highlight color
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 OverlayPopupSetting
341
- * @property {string} [dialog_backgroung] - The dialog background color
342
- * @property {string} [overlay] - The overlay color
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 StaticConfig
446
- * @property {StaticProps} [props]
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 StaticProps
450
- * @property {AuthConfig} [auth]
451
- * @property {Colors} [colors]
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 TextSetting
460
- * @property {string} [text_body] - The text body color
461
- * @property {string} [text_heading] - The text heading color
462
- * @property {string} [text_label] - The text label color
463
- * @property {string} [text_secondary] - The secondary text color
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 {CustomConfig} [custom]
468
- * @property {GlobalConfig} [global_config]
454
+ * @property {Object} [global_config]
469
455
  * @property {string} [name] - The name of the configuration
470
- * @property {string[]} [page] - An array of pages
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 UserAlertsSetting
550
- * @property {string} [error_background] - The error background color
551
- * @property {string} [error_text] - The error text color
552
- * @property {string} [info_background] - The info background color
553
- * @property {string} [info_text] - The info text color
554
- * @property {string} [success_background] - The success background color
555
- * @property {string} [success_text] - The success text color
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
@@ -561,17 +544,73 @@ export = ThemePartnerModel;
561
544
  * @property {MarketplaceThemeImages} [images]
562
545
  * @property {string} [name] - Variation name
563
546
  */
547
+ /**
548
+ * @typedef {| "about-us"
549
+ * | "addresses"
550
+ * | "blog"
551
+ * | "brands"
552
+ * | "cards"
553
+ * | "cart"
554
+ * | "categories"
555
+ * | "brand"
556
+ * | "category"
557
+ * | "collection"
558
+ * | "collections"
559
+ * | "contact-us"
560
+ * | "external"
561
+ * | "faq"
562
+ * | "freshchat"
563
+ * | "home"
564
+ * | "notification-settings"
565
+ * | "orders"
566
+ * | "page"
567
+ * | "policy"
568
+ * | "product"
569
+ * | "product-request"
570
+ * | "products"
571
+ * | "profile"
572
+ * | "profile-order-shipment"
573
+ * | "profile-basic"
574
+ * | "profile-company"
575
+ * | "profile-emails"
576
+ * | "profile-phones"
577
+ * | "rate-us"
578
+ * | "refer-earn"
579
+ * | "settings"
580
+ * | "shared-cart"
581
+ * | "tnc"
582
+ * | "track-order"
583
+ * | "wishlist"
584
+ * | "sections"
585
+ * | "form"
586
+ * | "cart-delivery"
587
+ * | "cart-payment"
588
+ * | "cart-review"
589
+ * | "login"
590
+ * | "register"
591
+ * | "shipping-policy"
592
+ * | "return-policy"
593
+ * | "order-status"} PageType
594
+ */
564
595
  declare class ThemePartnerModel {
565
596
  }
566
597
  declare namespace ThemePartnerModel {
567
- export { AdvanceSetting, AllAvailablePageSchema, Assets, AuthConfig, AvailablePagePredicate, AvailablePageRoutePredicate, AvailablePageSchema, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageSectionMetaAttributes, AvailablePageSeo, AvailablePageUserPredicate, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, Block, BlockProps, ButtonSetting, CarouselItem, CatalogSize, CheckboxProp, Colors, Comments, CommonJS, Config, ContactInfo, CreateNewTheme, CSS, CustomConfig, CustomProps, DividerStrokeHighlightSetting, Documentation, ExploreInfo, Feature, FeatureItem, Font, FontVariant, FontVariants, FooterSetting, GeneralSetting, GlobalConfig, GlobalSchema, HeaderSetting, Highlight, ImagePickerProp, Images, MarketplaceTheme, MarketplaceThemeImages, MarketplaceThemeSchema, OverlayPopupSetting, Page, PaginationSchema, PaletteConfig, PaymentInfo, Predicate, Preset, Prop, RangeProp, Release, Route, SaleDiscountSetting, Screen, Section, SectionItem, SectionPreset, SectionProps, StaticConfig, StaticProps, TextProp, TextSetting, ThemeConfiguration, ThemeMeta, ThemePayment, ThemeRejectionReasons, ThemeSetting, ThemesSchema, ThemeUserSchema, UMDJs, UpdateThemeRequestBody, UrlProp, UserAlertsSetting, Variation };
598
+ 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, PageType };
568
599
  }
569
- /** @returns {AdvanceSetting} */
570
- declare function AdvanceSetting(): AdvanceSetting;
571
- type AdvanceSetting = {
572
- divider_stroke_highlight?: DividerStrokeHighlightSetting;
573
- overlay_popup?: OverlayPopupSetting;
574
- user_alerts?: UserAlertsSetting;
600
+ /** @returns {Action} */
601
+ declare function Action(): Action;
602
+ type Action = {
603
+ page?: ActionPage;
604
+ popup?: ActionPage;
605
+ type?: string;
606
+ };
607
+ /** @returns {ActionPage} */
608
+ declare function ActionPage(): ActionPage;
609
+ type ActionPage = {
610
+ params?: any;
611
+ query?: any;
612
+ type: PageType;
613
+ url?: string;
575
614
  };
576
615
  /** @returns {AllAvailablePageSchema} */
577
616
  declare function AllAvailablePageSchema(): AllAvailablePageSchema;
@@ -585,24 +624,34 @@ type Assets = {
585
624
  css?: CSS;
586
625
  umd_js?: UMDJs;
587
626
  };
588
- /** @returns {AuthConfig} */
589
- declare function AuthConfig(): AuthConfig;
590
- type AuthConfig = {
627
+ /** @returns {AvailablePagePlatformPredicate} */
628
+ declare function AvailablePagePlatformPredicate(): AvailablePagePlatformPredicate;
629
+ type AvailablePagePlatformPredicate = {
630
+ /**
631
+ * - Section visibility on android platform
632
+ */
633
+ android?: boolean;
591
634
  /**
592
- * - Whether to show footer authentication or not
635
+ * - Section visibility on ios platform
593
636
  */
594
- show_footer_auth?: boolean;
637
+ ios?: boolean;
595
638
  /**
596
- * - Whether to show header authentication or not
639
+ * - Section visibility on web platform
597
640
  */
598
- show_header_auth?: boolean;
641
+ web?: boolean;
599
642
  };
600
643
  /** @returns {AvailablePagePredicate} */
601
644
  declare function AvailablePagePredicate(): AvailablePagePredicate;
602
645
  type AvailablePagePredicate = {
646
+ platform?: AvailablePagePlatformPredicate;
603
647
  route?: AvailablePageRoutePredicate;
648
+ schedule?: AvailablePageSchedulePredicate;
604
649
  screen?: AvailablePageScreenPredicate;
605
650
  user?: AvailablePageUserPredicate;
651
+ /**
652
+ * - An array of zone ids associated with the section
653
+ */
654
+ zones?: string[];
606
655
  };
607
656
  /** @returns {AvailablePageRoutePredicate} */
608
657
  declare function AvailablePageRoutePredicate(): AvailablePageRoutePredicate;
@@ -611,10 +660,21 @@ type AvailablePageRoutePredicate = {
611
660
  query?: any;
612
661
  selected?: string;
613
662
  };
663
+ /** @returns {AvailablePageSchedulePredicate} */
664
+ declare function AvailablePageSchedulePredicate(): AvailablePageSchedulePredicate;
665
+ type AvailablePageSchedulePredicate = {
666
+ cron?: string;
667
+ end?: string;
668
+ start?: string;
669
+ };
614
670
  /** @returns {AvailablePageSchema} */
615
671
  declare function AvailablePageSchema(): AvailablePageSchema;
616
672
  type AvailablePageSchema = {
617
673
  _id?: string;
674
+ /**
675
+ * - The creation timestamp of the page
676
+ */
677
+ created_at?: string;
618
678
  path?: string;
619
679
  props?: any[];
620
680
  sections?: AvailablePageSchemaSections[];
@@ -623,6 +683,10 @@ type AvailablePageSchema = {
623
683
  text?: string;
624
684
  theme?: string;
625
685
  type?: string;
686
+ /**
687
+ * - The last update timestamp of the page
688
+ */
689
+ updated_at?: string;
626
690
  value?: string;
627
691
  };
628
692
  /** @returns {AvailablePageSchemaSections} */
@@ -634,6 +698,7 @@ type AvailablePageSchemaSections = {
634
698
  predicate?: AvailablePagePredicate;
635
699
  preset?: any;
636
700
  props?: any;
701
+ source?: string;
637
702
  };
638
703
  /** @returns {AvailablePageScreenPredicate} */
639
704
  declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
@@ -651,7 +716,10 @@ type AvailablePageSectionMetaAttributes = {
651
716
  declare function AvailablePageSeo(): AvailablePageSeo;
652
717
  type AvailablePageSeo = {
653
718
  _id?: string;
719
+ breadcrumb?: SEObreadcrumb[];
654
720
  description?: string;
721
+ meta_tags?: SEOMetaItem[];
722
+ sitemap?: SEOSitemap;
655
723
  title?: string;
656
724
  };
657
725
  /** @returns {AvailablePageUserPredicate} */
@@ -689,22 +757,6 @@ type BlockProps = {
689
757
  image?: ImagePickerProp;
690
758
  slide_link?: UrlProp;
691
759
  };
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
760
  /** @returns {CarouselItem} */
709
761
  declare function CarouselItem(): CarouselItem;
710
762
  type CarouselItem = {
@@ -741,34 +793,6 @@ type CheckboxProp = {
741
793
  */
742
794
  value?: boolean;
743
795
  };
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
796
  /** @returns {Comments} */
773
797
  declare function Comments(): Comments;
774
798
  type Comments = {
@@ -846,6 +870,7 @@ type CreateNewTheme = {
846
870
  /** @returns {CSS} */
847
871
  declare function CSS(): CSS;
848
872
  type CSS = {
873
+ link?: string;
849
874
  links?: string[];
850
875
  };
851
876
  /** @returns {CustomConfig} */
@@ -982,16 +1007,10 @@ type CustomProps = {
982
1007
  */
983
1008
  text_strikethrough_price_color?: string;
984
1009
  };
985
- /** @returns {DividerStrokeHighlightSetting} */
986
- declare function DividerStrokeHighlightSetting(): DividerStrokeHighlightSetting;
987
- type DividerStrokeHighlightSetting = {
988
- /**
989
- * - The divider strokes color
990
- */
1010
+ /** @returns {DividerStrokeHighlight} */
1011
+ declare function DividerStrokeHighlight(): DividerStrokeHighlight;
1012
+ type DividerStrokeHighlight = {
991
1013
  divider_strokes?: string;
992
- /**
993
- * - The highlight color
994
- */
995
1014
  highlight?: string;
996
1015
  };
997
1016
  /** @returns {Documentation} */
@@ -1069,68 +1088,11 @@ type FontVariants = {
1069
1088
  regular?: FontVariant;
1070
1089
  semi_bold?: FontVariant;
1071
1090
  };
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
1091
  /** @returns {GlobalSchema} */
1114
1092
  declare function GlobalSchema(): GlobalSchema;
1115
1093
  type GlobalSchema = {
1116
1094
  props?: Prop[];
1117
1095
  };
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
1096
  /** @returns {Highlight} */
1135
1097
  declare function Highlight(): Highlight;
1136
1098
  type Highlight = {
@@ -1269,16 +1231,16 @@ type MarketplaceThemeSchema = {
1269
1231
  page?: PaginationSchema;
1270
1232
  themes?: MarketplaceTheme[];
1271
1233
  };
1272
- /** @returns {OverlayPopupSetting} */
1273
- declare function OverlayPopupSetting(): OverlayPopupSetting;
1274
- type OverlayPopupSetting = {
1275
- /**
1276
- * - The dialog background color
1277
- */
1234
+ /** @returns {OrderTracking} */
1235
+ declare function OrderTracking(): OrderTracking;
1236
+ type OrderTracking = {
1237
+ show_footer?: boolean;
1238
+ show_header?: boolean;
1239
+ };
1240
+ /** @returns {OverlayPopup} */
1241
+ declare function OverlayPopup(): OverlayPopup;
1242
+ type OverlayPopup = {
1278
1243
  dialog_backgroung?: string;
1279
- /**
1280
- * - The overlay color
1281
- */
1282
1244
  overlay?: string;
1283
1245
  };
1284
1246
  /** @returns {Page} */
@@ -1301,12 +1263,6 @@ type PaginationSchema = {
1301
1263
  size?: number;
1302
1264
  type?: string;
1303
1265
  };
1304
- /** @returns {PaletteConfig} */
1305
- declare function PaletteConfig(): PaletteConfig;
1306
- type PaletteConfig = {
1307
- advance_setting?: AdvanceSetting;
1308
- general_setting?: GeneralSetting;
1309
- };
1310
1266
  /** @returns {PaymentInfo} */
1311
1267
  declare function PaymentInfo(): PaymentInfo;
1312
1268
  type PaymentInfo = {
@@ -1354,6 +1310,10 @@ type Prop = {
1354
1310
  * - The type of the property
1355
1311
  */
1356
1312
  type?: string;
1313
+ /**
1314
+ * - The value of the property
1315
+ */
1316
+ value?: string;
1357
1317
  };
1358
1318
  /** @returns {RangeProp} */
1359
1319
  declare function RangeProp(): RangeProp;
@@ -1391,26 +1351,6 @@ type Route = {
1391
1351
  */
1392
1352
  selected?: string;
1393
1353
  };
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
1354
  /** @returns {Screen} */
1415
1355
  declare function Screen(): Screen;
1416
1356
  type Screen = {
@@ -1469,16 +1409,29 @@ type SectionProps = {
1469
1409
  slide_interval?: RangeProp;
1470
1410
  title?: TextProp;
1471
1411
  };
1472
- /** @returns {StaticConfig} */
1473
- declare function StaticConfig(): StaticConfig;
1474
- type StaticConfig = {
1475
- props?: StaticProps;
1412
+ /** @returns {SEObreadcrumb} */
1413
+ declare function SEObreadcrumb(): SEObreadcrumb;
1414
+ type SEObreadcrumb = {
1415
+ action?: Action;
1416
+ url?: string;
1417
+ };
1418
+ /** @returns {SEOMetaItem} */
1419
+ declare function SEOMetaItem(): SEOMetaItem;
1420
+ type SEOMetaItem = {
1421
+ items?: SEOMetaItems[];
1422
+ title?: string;
1423
+ };
1424
+ /** @returns {SEOMetaItems} */
1425
+ declare function SEOMetaItems(): SEOMetaItems;
1426
+ type SEOMetaItems = {
1427
+ key?: string;
1428
+ value?: string;
1476
1429
  };
1477
- /** @returns {StaticProps} */
1478
- declare function StaticProps(): StaticProps;
1479
- type StaticProps = {
1480
- auth?: AuthConfig;
1481
- colors?: Colors;
1430
+ /** @returns {SEOSitemap} */
1431
+ declare function SEOSitemap(): SEOSitemap;
1432
+ type SEOSitemap = {
1433
+ frequency?: string;
1434
+ priority?: number;
1482
1435
  };
1483
1436
  /** @returns {TextProp} */
1484
1437
  declare function TextProp(): TextProp;
@@ -1492,31 +1445,24 @@ type TextProp = {
1492
1445
  */
1493
1446
  value?: string;
1494
1447
  };
1495
- /** @returns {TextSetting} */
1496
- declare function TextSetting(): TextSetting;
1497
- type TextSetting = {
1448
+ /** @returns {ThemeConfigListPage} */
1449
+ declare function ThemeConfigListPage(): ThemeConfigListPage;
1450
+ type ThemeConfigListPage = {
1498
1451
  /**
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
1452
+ * - Name of the page
1508
1453
  */
1509
- text_label?: string;
1510
- /**
1511
- * - The secondary text color
1512
- */
1513
- text_secondary?: string;
1454
+ page?: string;
1455
+ settings?: ThemeConfigListPageSettingsProps;
1456
+ };
1457
+ /** @returns {ThemeConfigListPageSettingsProps} */
1458
+ declare function ThemeConfigListPageSettingsProps(): ThemeConfigListPageSettingsProps;
1459
+ type ThemeConfigListPageSettingsProps = {
1460
+ props?: any;
1514
1461
  };
1515
1462
  /** @returns {ThemeConfiguration} */
1516
1463
  declare function ThemeConfiguration(): ThemeConfiguration;
1517
1464
  type ThemeConfiguration = {
1518
- custom?: CustomConfig;
1519
- global_config?: GlobalConfig;
1465
+ global_config?: any;
1520
1466
  /**
1521
1467
  * - The name of the configuration
1522
1468
  */
@@ -1524,7 +1470,7 @@ type ThemeConfiguration = {
1524
1470
  /**
1525
1471
  * - An array of pages
1526
1472
  */
1527
- page?: string[];
1473
+ page?: ThemeConfigListPage[];
1528
1474
  };
1529
1475
  /** @returns {ThemeMeta} */
1530
1476
  declare function ThemeMeta(): ThemeMeta;
@@ -1604,18 +1550,6 @@ type ThemeRejectionReasons = {
1604
1550
  */
1605
1551
  user_id: string;
1606
1552
  };
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
1553
  /** @returns {ThemesSchema} */
1620
1554
  declare function ThemesSchema(): ThemesSchema;
1621
1555
  type ThemesSchema = {
@@ -1659,6 +1593,7 @@ type ThemesSchema = {
1659
1593
  * - The name of the theme
1660
1594
  */
1661
1595
  name?: string;
1596
+ src?: string;
1662
1597
  /**
1663
1598
  * - The styles associated with the theme
1664
1599
  */
@@ -1696,6 +1631,7 @@ type ThemeUserSchema = {
1696
1631
  /** @returns {UMDJs} */
1697
1632
  declare function UMDJs(): UMDJs;
1698
1633
  type UMDJs = {
1634
+ link?: string;
1699
1635
  links?: string[];
1700
1636
  };
1701
1637
  /** @returns {UpdateThemeRequestBody} */
@@ -1716,32 +1652,14 @@ type UrlProp = {
1716
1652
  */
1717
1653
  value?: string;
1718
1654
  };
1719
- /** @returns {UserAlertsSetting} */
1720
- declare function UserAlertsSetting(): UserAlertsSetting;
1721
- type UserAlertsSetting = {
1722
- /**
1723
- * - The error background color
1724
- */
1655
+ /** @returns {UserAlerts} */
1656
+ declare function UserAlerts(): UserAlerts;
1657
+ type UserAlerts = {
1725
1658
  error_background?: string;
1726
- /**
1727
- * - The error text color
1728
- */
1729
1659
  error_text?: string;
1730
- /**
1731
- * - The info background color
1732
- */
1733
1660
  info_background?: string;
1734
- /**
1735
- * - The info text color
1736
- */
1737
1661
  info_text?: string;
1738
- /**
1739
- * - The success background color
1740
- */
1741
1662
  success_background?: string;
1742
- /**
1743
- * - The success text color
1744
- */
1745
1663
  success_text?: string;
1746
1664
  };
1747
1665
  /** @returns {Variation} */
@@ -1761,3 +1679,10 @@ type Variation = {
1761
1679
  */
1762
1680
  name?: string;
1763
1681
  };
1682
+ /**
1683
+ * Enum: PageType Used By: Theme
1684
+ *
1685
+ * @returns {PageType}
1686
+ */
1687
+ declare function PageType(): PageType;
1688
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";