@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
- package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
- package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
- package/sdk/application/Content/ContentApplicationModel.js +757 -757
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
- package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
- package/sdk/application/Order/OrderApplicationModel.d.ts +852 -846
- package/sdk/application/Order/OrderApplicationModel.js +828 -822
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +2176 -2145
- package/sdk/application/Payment/PaymentApplicationModel.js +1474 -1453
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
- package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
- package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
- package/sdk/application/User/UserApplicationClient.d.ts +2 -2
- package/sdk/application/User/UserApplicationClient.js +4 -7
- package/sdk/application/User/UserApplicationModel.d.ts +769 -764
- package/sdk/application/User/UserApplicationModel.js +731 -741
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
- package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
- package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
- package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
- package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
- package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +26 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -980
- package/sdk/platform/Catalog/CatalogPlatformModel.js +977 -933
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1842 -1825
- package/sdk/platform/Content/ContentPlatformModel.js +1868 -1848
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
- package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +882 -869
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +894 -878
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
- package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
- package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5192 -5176
- package/sdk/platform/Order/OrderPlatformModel.js +4752 -4736
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2693 -2657
- package/sdk/platform/Payment/PaymentPlatformModel.js +1842 -1819
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1674 -1539
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1663 -1534
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
- package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
- package/sdk/platform/User/UserPlatformModel.d.ts +823 -753
- package/sdk/platform/User/UserPlatformModel.js +731 -661
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
- package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
- package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
- package/sdk/public/Billing/BillingPublicModel.js +51 -51
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
- package/sdk/public/Content/ContentPublicModel.js +28 -28
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
- package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
|
@@ -1,341 +1,309 @@
|
|
|
1
1
|
export = ThemePlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
5
|
-
*
|
|
6
|
-
* @property {string} [type]
|
|
3
|
+
* @typedef ThemeReq
|
|
4
|
+
* @property {string} [marketplace_theme_id] - The ID of the marketplace theme
|
|
5
|
+
* to apply to the company.
|
|
7
6
|
*/
|
|
8
7
|
/**
|
|
9
|
-
* @typedef
|
|
10
|
-
* @property {
|
|
11
|
-
* @property {
|
|
12
|
-
* @property {
|
|
13
|
-
* @property {
|
|
8
|
+
* @typedef CompanyThemeSchema
|
|
9
|
+
* @property {string} [_id] - The unique identifier for the theme.
|
|
10
|
+
* @property {string} [name] - The name of the theme.
|
|
11
|
+
* @property {MarketplaceThemeId} [marketplace_theme_id]
|
|
12
|
+
* @property {number} [company_id] - The ID of the company that the theme belongs to.
|
|
13
|
+
* @property {CompanyThemeMeta} [meta]
|
|
14
|
+
* @property {string} [created_at] - The timestamp when the theme was created.
|
|
15
|
+
* @property {string} [updated_at] - The timestamp when the theme was last updated.
|
|
16
|
+
* @property {AppliedThemes[]} [applied_themes]
|
|
14
17
|
*/
|
|
15
18
|
/**
|
|
16
|
-
* @typedef
|
|
17
|
-
* @property {string} [
|
|
19
|
+
* @typedef MarketplaceThemeId
|
|
20
|
+
* @property {string} [_id] - The unique identifier for the marketplace theme.
|
|
21
|
+
* @property {boolean} [is_default] - Whether the theme is the default theme.
|
|
22
|
+
* @property {Release} [release]
|
|
23
|
+
* @property {string} [created_at] - Creation date of the theme
|
|
24
|
+
* @property {string} [updated_at] - Update date of the theme
|
|
18
25
|
*/
|
|
19
26
|
/**
|
|
20
|
-
* @typedef
|
|
21
|
-
* @property {
|
|
27
|
+
* @typedef CompanyThemeMeta
|
|
28
|
+
* @property {ThemePayment} [payment]
|
|
29
|
+
* @property {string[]} [industry] - A list of industry categories the theme is
|
|
30
|
+
* suitable for.
|
|
31
|
+
* @property {string} [description] - A description of the theme.
|
|
32
|
+
* @property {ThemeImages} [images]
|
|
33
|
+
* @property {string} [slug] - The slug for the theme.
|
|
22
34
|
*/
|
|
23
35
|
/**
|
|
24
|
-
* @typedef
|
|
25
|
-
* @property {
|
|
26
|
-
* @property {
|
|
36
|
+
* @typedef ThemePayment
|
|
37
|
+
* @property {boolean} [is_paid] - Whether the theme is a paid theme.
|
|
38
|
+
* @property {number} [amount] - The amount to be paid for the theme.
|
|
27
39
|
*/
|
|
28
40
|
/**
|
|
29
|
-
* @typedef
|
|
30
|
-
* @property {
|
|
31
|
-
* @property {
|
|
32
|
-
* @property {UMDJs} [umd_js]
|
|
41
|
+
* @typedef ThemeImages
|
|
42
|
+
* @property {string} [desktop] - The URL of the desktop image for the theme.
|
|
43
|
+
* @property {string} [mobile] - The URL of the mobile image for the theme.
|
|
33
44
|
*/
|
|
34
45
|
/**
|
|
35
|
-
* @typedef
|
|
36
|
-
* @property {
|
|
37
|
-
* @property {
|
|
38
|
-
* @property {
|
|
46
|
+
* @typedef AvailablePageSchema
|
|
47
|
+
* @property {string} [value]
|
|
48
|
+
* @property {string} [text]
|
|
49
|
+
* @property {string} [path]
|
|
50
|
+
* @property {string} [type]
|
|
51
|
+
* @property {AvailablePageSchemaSections[]} [sections]
|
|
52
|
+
* @property {AvailablePageSectionMetaAttributes[]} [sections_meta]
|
|
53
|
+
* @property {string} [theme]
|
|
54
|
+
* @property {AvailablePageSeo} [seo]
|
|
55
|
+
* @property {Object[]} [props]
|
|
56
|
+
* @property {string} [_id]
|
|
57
|
+
* @property {string} [created_at] - The creation timestamp of the page
|
|
58
|
+
* @property {string} [updated_at] - The last update timestamp of the page
|
|
39
59
|
*/
|
|
40
60
|
/**
|
|
41
|
-
* @typedef
|
|
42
|
-
* @property {
|
|
43
|
-
* @property {AvailablePageRoutePredicate} [route]
|
|
44
|
-
* @property {AvailablePageSchedulePredicate} [schedule]
|
|
45
|
-
* @property {AvailablePageScreenPredicate} [screen]
|
|
46
|
-
* @property {AvailablePageUserPredicate} [user]
|
|
47
|
-
* @property {string[]} [zones] - An array of zone ids associated with the section
|
|
61
|
+
* @typedef AvailablePageSectionMetaAttributes
|
|
62
|
+
* @property {Object} [attributes]
|
|
48
63
|
*/
|
|
49
64
|
/**
|
|
50
|
-
* @typedef
|
|
51
|
-
* @property {string} [
|
|
52
|
-
* @property {
|
|
53
|
-
* @property {string} [selected]
|
|
65
|
+
* @typedef SEOMetaItem
|
|
66
|
+
* @property {string} [title]
|
|
67
|
+
* @property {SEOMetaItems[]} [items]
|
|
54
68
|
*/
|
|
55
69
|
/**
|
|
56
|
-
* @typedef
|
|
57
|
-
* @property {string} [
|
|
58
|
-
* @property {string} [
|
|
59
|
-
* @property {string} [start]
|
|
70
|
+
* @typedef SEOMetaItems
|
|
71
|
+
* @property {string} [key]
|
|
72
|
+
* @property {string} [value]
|
|
60
73
|
*/
|
|
61
74
|
/**
|
|
62
|
-
* @typedef
|
|
63
|
-
* @property {
|
|
64
|
-
* @property {string} [
|
|
65
|
-
* @property {string} [path]
|
|
66
|
-
* @property {Object[]} [props]
|
|
67
|
-
* @property {AvailablePageSchemaSections[]} [sections]
|
|
68
|
-
* @property {AvailablePageSectionMetaAttributes[]} [sections_meta]
|
|
69
|
-
* @property {AvailablePageSeo} [seo]
|
|
70
|
-
* @property {string} [text]
|
|
71
|
-
* @property {string} [theme]
|
|
72
|
-
* @property {string} [type]
|
|
73
|
-
* @property {string} [updated_at] - The last update timestamp of the page
|
|
74
|
-
* @property {string} [value]
|
|
75
|
+
* @typedef SEOSitemap
|
|
76
|
+
* @property {number} [priority]
|
|
77
|
+
* @property {string} [frequency]
|
|
75
78
|
*/
|
|
76
79
|
/**
|
|
77
|
-
* @typedef
|
|
78
|
-
* @property {
|
|
79
|
-
* @property {
|
|
80
|
-
* @property {string} [name]
|
|
81
|
-
* @property {AvailablePagePredicate} [predicate]
|
|
82
|
-
* @property {Object} [preset]
|
|
83
|
-
* @property {Object} [props]
|
|
84
|
-
* @property {string} [source]
|
|
80
|
+
* @typedef SEObreadcrumb
|
|
81
|
+
* @property {string} [url]
|
|
82
|
+
* @property {Action} [action]
|
|
85
83
|
*/
|
|
86
84
|
/**
|
|
87
|
-
* @typedef
|
|
88
|
-
* @property {
|
|
89
|
-
* @property {
|
|
90
|
-
* @property {
|
|
85
|
+
* @typedef Action
|
|
86
|
+
* @property {ActionPage} [page]
|
|
87
|
+
* @property {ActionPage} [popup]
|
|
88
|
+
* @property {string} [type]
|
|
91
89
|
*/
|
|
92
90
|
/**
|
|
93
|
-
* @typedef
|
|
94
|
-
* @property {Object} [
|
|
91
|
+
* @typedef ActionPage
|
|
92
|
+
* @property {Object} [params]
|
|
93
|
+
* @property {Object} [query]
|
|
94
|
+
* @property {string} [url]
|
|
95
|
+
* @property {PageType} type
|
|
95
96
|
*/
|
|
96
97
|
/**
|
|
97
98
|
* @typedef AvailablePageSeo
|
|
98
|
-
* @property {string} [
|
|
99
|
-
* @property {SEObreadcrumb[]} [breadcrumb]
|
|
99
|
+
* @property {string} [title]
|
|
100
100
|
* @property {string} [description]
|
|
101
101
|
* @property {SEOMetaItem[]} [meta_tags]
|
|
102
102
|
* @property {SEOSitemap} [sitemap]
|
|
103
|
-
* @property {
|
|
103
|
+
* @property {SEObreadcrumb[]} [breadcrumb]
|
|
104
|
+
* @property {string} [_id]
|
|
104
105
|
*/
|
|
105
106
|
/**
|
|
106
|
-
* @typedef
|
|
107
|
-
* @property {
|
|
108
|
-
* @property {
|
|
107
|
+
* @typedef AvailablePageSchemaSections
|
|
108
|
+
* @property {string} [name]
|
|
109
|
+
* @property {string} [label]
|
|
110
|
+
* @property {Object} [props]
|
|
111
|
+
* @property {Object[]} [blocks]
|
|
112
|
+
* @property {Object} [preset]
|
|
113
|
+
* @property {AvailablePagePredicate} [predicate]
|
|
114
|
+
* @property {string} [source]
|
|
109
115
|
*/
|
|
110
116
|
/**
|
|
111
|
-
* @typedef
|
|
112
|
-
* @property {
|
|
117
|
+
* @typedef AvailablePagePredicate
|
|
118
|
+
* @property {AvailablePageScreenPredicate} [screen]
|
|
119
|
+
* @property {AvailablePageUserPredicate} [user]
|
|
120
|
+
* @property {AvailablePageRoutePredicate} [route]
|
|
121
|
+
* @property {AvailablePageSchedulePredicate} [schedule]
|
|
122
|
+
* @property {AvailablePagePlatformPredicate} [platform]
|
|
123
|
+
* @property {string[]} [zones] - An array of zone ids associated with the section
|
|
113
124
|
*/
|
|
114
125
|
/**
|
|
115
|
-
* @typedef
|
|
116
|
-
* @property {
|
|
126
|
+
* @typedef AvailablePageScreenPredicate
|
|
127
|
+
* @property {boolean} [mobile]
|
|
128
|
+
* @property {boolean} [desktop]
|
|
129
|
+
* @property {boolean} [tablet]
|
|
117
130
|
*/
|
|
118
131
|
/**
|
|
119
|
-
* @typedef
|
|
120
|
-
* @property {
|
|
121
|
-
* @property {
|
|
122
|
-
* @property {string} [type] - The type of the block.
|
|
132
|
+
* @typedef AvailablePageUserPredicate
|
|
133
|
+
* @property {boolean} [authenticated]
|
|
134
|
+
* @property {boolean} [anonymous]
|
|
123
135
|
*/
|
|
124
136
|
/**
|
|
125
|
-
* @typedef
|
|
126
|
-
* @property {
|
|
127
|
-
* @property {
|
|
137
|
+
* @typedef AvailablePageRoutePredicate
|
|
138
|
+
* @property {string} [selected]
|
|
139
|
+
* @property {string} [exact_url]
|
|
140
|
+
* @property {Object} [query]
|
|
128
141
|
*/
|
|
129
142
|
/**
|
|
130
|
-
* @typedef
|
|
131
|
-
* @property {
|
|
132
|
-
* @property {boolean} [
|
|
143
|
+
* @typedef AvailablePagePlatformPredicate
|
|
144
|
+
* @property {boolean} [ios] - Section visibility on ios platform
|
|
145
|
+
* @property {boolean} [android] - Section visibility on android platform
|
|
146
|
+
* @property {boolean} [web] - Section visibility on web platform
|
|
133
147
|
*/
|
|
134
148
|
/**
|
|
135
|
-
* @typedef
|
|
136
|
-
* @property {string} [
|
|
149
|
+
* @typedef AvailablePageSchedulePredicate
|
|
150
|
+
* @property {string} [cron]
|
|
151
|
+
* @property {string} [start]
|
|
152
|
+
* @property {string} [end]
|
|
137
153
|
*/
|
|
138
154
|
/**
|
|
139
|
-
* @typedef
|
|
140
|
-
* @property {
|
|
141
|
-
* @property {string} [application_id] - Identifier for the application
|
|
142
|
-
* @property {boolean} [applied] - Whether the theme is applied or not
|
|
143
|
-
* @property {string} [created_at] - Date and time when the theme was created
|
|
144
|
-
* @property {boolean} [is_private] - Whether the theme is private or not
|
|
145
|
-
* @property {CompanyThemeMeta} [meta]
|
|
146
|
-
* @property {string} [name] - Name of the theme
|
|
147
|
-
* @property {string} [theme_type] - Type of the theme
|
|
148
|
-
* @property {string} [updated_at] - Date and time when the theme was last updated
|
|
149
|
-
* @property {string} [version] - Version of the theme
|
|
155
|
+
* @typedef AllAvailablePageSchema
|
|
156
|
+
* @property {AvailablePageSchema[]} [pages]
|
|
150
157
|
*/
|
|
151
158
|
/**
|
|
152
|
-
* @typedef
|
|
153
|
-
* @property {string} [
|
|
154
|
-
* @property {ThemeImages} [images]
|
|
155
|
-
* @property {string[]} [industry] - A list of industry categories the theme is
|
|
156
|
-
* suitable for.
|
|
157
|
-
* @property {ThemePayment} [payment]
|
|
158
|
-
* @property {string} [slug] - The slug for the theme.
|
|
159
|
+
* @typedef AddThemeRequestSchema
|
|
160
|
+
* @property {string} [theme_id]
|
|
159
161
|
*/
|
|
160
162
|
/**
|
|
161
|
-
* @typedef
|
|
162
|
-
* @property {
|
|
163
|
-
* @property {
|
|
164
|
-
* @property {number} [company_id] - The ID of the company that the theme belongs to.
|
|
165
|
-
* @property {string} [created_at] - The timestamp when the theme was created.
|
|
166
|
-
* @property {MarketplaceThemeId} [marketplace_theme_id]
|
|
167
|
-
* @property {CompanyThemeMeta} [meta]
|
|
168
|
-
* @property {string} [name] - The name of the theme.
|
|
169
|
-
* @property {string} [updated_at] - The timestamp when the theme was last updated.
|
|
163
|
+
* @typedef FontsSchema
|
|
164
|
+
* @property {FontsSchemaItems} [items]
|
|
165
|
+
* @property {string} [kind]
|
|
170
166
|
*/
|
|
171
167
|
/**
|
|
172
|
-
* @typedef
|
|
173
|
-
* @property {string}
|
|
174
|
-
* @property {GlobalSchema} [global_schema]
|
|
175
|
-
* @property {ThemeConfiguration[]} list - A list of configurations
|
|
176
|
-
* @property {Preset} [preset]
|
|
168
|
+
* @typedef BlitzkriegApiErrorSchema
|
|
169
|
+
* @property {string} [message]
|
|
177
170
|
*/
|
|
178
171
|
/**
|
|
179
|
-
* @typedef
|
|
180
|
-
* @property {string} [
|
|
181
|
-
* @property {string[]} [links]
|
|
172
|
+
* @typedef BlitzkriegInternalServerErrorSchema
|
|
173
|
+
* @property {string} [message]
|
|
182
174
|
*/
|
|
183
175
|
/**
|
|
184
|
-
* @typedef
|
|
185
|
-
* @property {
|
|
176
|
+
* @typedef FontsSchemaItems
|
|
177
|
+
* @property {string} [family]
|
|
178
|
+
* @property {string[]} [variants]
|
|
179
|
+
* @property {string[]} [subsets]
|
|
180
|
+
* @property {string} [version]
|
|
181
|
+
* @property {string} [last_modified]
|
|
182
|
+
* @property {FontsSchemaItemsFiles} [files]
|
|
183
|
+
* @property {string} [category]
|
|
184
|
+
* @property {string} [kind]
|
|
186
185
|
*/
|
|
187
186
|
/**
|
|
188
|
-
* @typedef
|
|
189
|
-
* @property {string} [
|
|
190
|
-
* @property {string} [
|
|
191
|
-
*
|
|
192
|
-
* @property {string} [button_primary_color] - The primary button color
|
|
193
|
-
* @property {string} [button_primary_label_color] - The primary button label color
|
|
194
|
-
* @property {string} [button_secondary_color] - The secondary button color
|
|
195
|
-
* @property {string} [button_secondary_label_color] - The secondary button label color
|
|
196
|
-
* @property {string} [button_tertiary_color] - The tertiary button color
|
|
197
|
-
* @property {string} [button_tertiary_hover_color] - The tertiary button hover color
|
|
198
|
-
* @property {string} [button_tertiary_hover_text_color] - The tertiary button
|
|
199
|
-
* hover text color
|
|
200
|
-
* @property {string} [button_tertiary_label_color] - The tertiary button label color
|
|
201
|
-
* @property {boolean} [disable_cart] - Whether to disable the cart or not
|
|
202
|
-
* @property {string} [footer_bg_color] - The footer background color
|
|
203
|
-
* @property {string} [footer_border_color] - The footer border color
|
|
204
|
-
* @property {string} [footer_nav_hover_color] - The footer navigation hover color
|
|
205
|
-
* @property {string} [footer_text_color] - The footer text color
|
|
206
|
-
* @property {string} [header_bg_color] - The header background color
|
|
207
|
-
* @property {string} [header_border_color] - The header border color
|
|
208
|
-
* @property {string} [header_cart_notification_bg_color] - The header cart
|
|
209
|
-
* notification background color
|
|
210
|
-
* @property {string} [header_cart_notification_text_color] - The header cart
|
|
211
|
-
* notification text color
|
|
212
|
-
* @property {string} [header_icon_color] - The header icon color
|
|
213
|
-
* @property {string} [header_nav_hover_color] - The header navigation hover color
|
|
214
|
-
* @property {string} [header_text_color] - The header text color
|
|
215
|
-
* @property {boolean} [is_menu_below_logo] - Whether the menu is below the logo or not
|
|
216
|
-
* @property {string} [menu_position] - The position of the menu
|
|
217
|
-
* @property {string} [text_body_color] - The text body color
|
|
218
|
-
* @property {string} [text_discount_color] - The text discount color
|
|
219
|
-
* @property {string} [text_heading_link_color] - The text heading link color
|
|
220
|
-
* @property {string} [text_price_color] - The text price color
|
|
221
|
-
* @property {string} [text_sale_price_color] - The text sale price color
|
|
222
|
-
* @property {string} [text_strikethrough_price_color] - The text strikethrough
|
|
223
|
-
* price color
|
|
224
|
-
*/
|
|
225
|
-
/**
|
|
226
|
-
* @typedef DividerStrokeHighlight
|
|
227
|
-
* @property {string} [divider_strokes]
|
|
228
|
-
* @property {string} [highlight]
|
|
229
|
-
*/
|
|
230
|
-
/**
|
|
231
|
-
* @typedef DummyResponse
|
|
232
|
-
* @property {string} [message]
|
|
187
|
+
* @typedef FontsSchemaItemsFiles
|
|
188
|
+
* @property {string} [regular]
|
|
189
|
+
* @property {string} [italic]
|
|
190
|
+
* @property {string} [bold]
|
|
233
191
|
*/
|
|
234
192
|
/**
|
|
235
|
-
* @typedef
|
|
236
|
-
* @property {
|
|
237
|
-
* @property {
|
|
193
|
+
* @typedef ThemesSchema
|
|
194
|
+
* @property {Font} [font]
|
|
195
|
+
* @property {Config} [config]
|
|
196
|
+
* @property {boolean} [applied] - Whether the theme has been applied or not
|
|
197
|
+
* @property {boolean} [is_private] - Whether the theme is private or not
|
|
198
|
+
* @property {string[]} [tags] - An array of tags associated with the theme
|
|
199
|
+
* @property {string} [_id] - The unique identifier of the theme
|
|
200
|
+
* @property {string} [application_id] - The ID of the application
|
|
201
|
+
* @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
|
|
202
|
+
* @property {ThemeMeta} [meta]
|
|
203
|
+
* @property {string} [name] - The name of the theme
|
|
204
|
+
* @property {string} [template_theme_id] - The ID of the template theme
|
|
205
|
+
* @property {string} [version] - The version of the theme
|
|
206
|
+
* @property {Object} [styles] - The styles associated with the theme
|
|
207
|
+
* @property {string} [created_at] - The creation timestamp of the theme
|
|
208
|
+
* @property {string} [updated_at] - The last update timestamp of the theme
|
|
209
|
+
* @property {Assets} [assets]
|
|
210
|
+
* @property {SectionItem[]} [available_sections] - Available sections information
|
|
211
|
+
* @property {string} [theme_type]
|
|
212
|
+
* @property {number} [company_id] - The company id in which sales channel exists
|
|
213
|
+
* @property {string} [src]
|
|
238
214
|
*/
|
|
239
215
|
/**
|
|
240
|
-
* @typedef
|
|
241
|
-
* @property {
|
|
242
|
-
* @property {
|
|
216
|
+
* @typedef ThemeUpgradableResponse
|
|
217
|
+
* @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
|
|
218
|
+
* @property {ThemeVersions} [versions]
|
|
219
|
+
* @property {string} [message] - A message describing the theme upgrade status
|
|
243
220
|
*/
|
|
244
221
|
/**
|
|
245
|
-
* @typedef
|
|
246
|
-
* @property {string} [
|
|
247
|
-
* @property {string} [family]
|
|
248
|
-
* @property {FontsSchemaItemsFiles} [files]
|
|
249
|
-
* @property {string} [kind]
|
|
250
|
-
* @property {string} [last_modified]
|
|
251
|
-
* @property {string[]} [subsets]
|
|
252
|
-
* @property {string[]} [variants]
|
|
253
|
-
* @property {string} [version]
|
|
222
|
+
* @typedef UpdateThemeNameRequestBody
|
|
223
|
+
* @property {string} [name] - The new name of the theme.
|
|
254
224
|
*/
|
|
255
225
|
/**
|
|
256
|
-
* @typedef
|
|
257
|
-
* @property {
|
|
258
|
-
* @property {
|
|
259
|
-
* @property {string} [regular]
|
|
226
|
+
* @typedef UpdateThemeRequestBody
|
|
227
|
+
* @property {Config} [config]
|
|
228
|
+
* @property {Font} [font]
|
|
260
229
|
*/
|
|
261
230
|
/**
|
|
262
|
-
* @typedef
|
|
263
|
-
* @property {
|
|
264
|
-
* @property {string}
|
|
231
|
+
* @typedef Font
|
|
232
|
+
* @property {FontVariants} variants
|
|
233
|
+
* @property {string} family - The font family
|
|
265
234
|
*/
|
|
266
235
|
/**
|
|
267
236
|
* @typedef FontVariants
|
|
268
|
-
* @property {FontVariant} [bold]
|
|
269
237
|
* @property {FontVariant} [light]
|
|
270
|
-
* @property {FontVariant} [medium]
|
|
271
238
|
* @property {FontVariant} [regular]
|
|
239
|
+
* @property {FontVariant} [medium]
|
|
272
240
|
* @property {FontVariant} [semi_bold]
|
|
241
|
+
* @property {FontVariant} [bold]
|
|
273
242
|
*/
|
|
274
243
|
/**
|
|
275
|
-
* @typedef
|
|
276
|
-
* @property {
|
|
244
|
+
* @typedef FontVariant
|
|
245
|
+
* @property {string} name - The name of the font variant
|
|
246
|
+
* @property {string} file - The URL of the font file
|
|
277
247
|
*/
|
|
278
248
|
/**
|
|
279
|
-
* @typedef
|
|
280
|
-
* @property {string}
|
|
281
|
-
* @property {
|
|
249
|
+
* @typedef Config
|
|
250
|
+
* @property {string} current - The current configuration
|
|
251
|
+
* @property {ThemeConfiguration[]} list - A list of configurations
|
|
252
|
+
* @property {GlobalSchema} [global_schema]
|
|
253
|
+
* @property {Preset} [preset]
|
|
282
254
|
*/
|
|
283
255
|
/**
|
|
284
|
-
* @typedef
|
|
285
|
-
* @property {string} [
|
|
286
|
-
* @property {
|
|
256
|
+
* @typedef ThemeConfiguration
|
|
257
|
+
* @property {string} [name] - The name of the configuration
|
|
258
|
+
* @property {Object} [global_config]
|
|
259
|
+
* @property {ThemeConfigListPage[]} [page] - An array of pages
|
|
287
260
|
*/
|
|
288
261
|
/**
|
|
289
|
-
* @typedef
|
|
290
|
-
* @property {string} [
|
|
291
|
-
* @property {string} [
|
|
292
|
-
* @property {boolean} [is_default] - Whether the theme is the default theme.
|
|
293
|
-
* @property {Release} [release]
|
|
294
|
-
* @property {string} [updated_at] - Update date of the theme
|
|
262
|
+
* @typedef OverlayPopup
|
|
263
|
+
* @property {string} [dialog_backgroung]
|
|
264
|
+
* @property {string} [overlay]
|
|
295
265
|
*/
|
|
296
266
|
/**
|
|
297
|
-
* @typedef
|
|
298
|
-
* @property {
|
|
299
|
-
* @property {
|
|
267
|
+
* @typedef DividerStrokeHighlight
|
|
268
|
+
* @property {string} [divider_strokes]
|
|
269
|
+
* @property {string} [highlight]
|
|
300
270
|
*/
|
|
301
271
|
/**
|
|
302
|
-
* @typedef
|
|
303
|
-
* @property {string} [
|
|
304
|
-
* @property {string} [
|
|
272
|
+
* @typedef UserAlerts
|
|
273
|
+
* @property {string} [success_background]
|
|
274
|
+
* @property {string} [success_text]
|
|
275
|
+
* @property {string} [error_background]
|
|
276
|
+
* @property {string} [error_text]
|
|
277
|
+
* @property {string} [info_background]
|
|
278
|
+
* @property {string} [info_text]
|
|
305
279
|
*/
|
|
306
280
|
/**
|
|
307
|
-
* @typedef
|
|
308
|
-
* @property {
|
|
309
|
-
* @property {boolean} [
|
|
310
|
-
* @property {boolean} [has_previous]
|
|
311
|
-
* @property {number} [item_total]
|
|
312
|
-
* @property {string} [next_id]
|
|
313
|
-
* @property {number} [size]
|
|
314
|
-
* @property {string} type
|
|
281
|
+
* @typedef OrderTracking
|
|
282
|
+
* @property {boolean} [show_header]
|
|
283
|
+
* @property {boolean} [show_footer]
|
|
315
284
|
*/
|
|
316
285
|
/**
|
|
317
|
-
* @typedef
|
|
318
|
-
* @property {
|
|
319
|
-
* @property {
|
|
320
|
-
* @property {ThemeUserSchema} [user]
|
|
286
|
+
* @typedef ThemeConfigListPage
|
|
287
|
+
* @property {string} [page] - Name of the page
|
|
288
|
+
* @property {ThemeConfigListPageSettingsProps} [settings]
|
|
321
289
|
*/
|
|
322
290
|
/**
|
|
323
|
-
* @typedef
|
|
324
|
-
* @property {
|
|
291
|
+
* @typedef ThemeConfigListPageSettingsProps
|
|
292
|
+
* @property {Object} [props]
|
|
325
293
|
*/
|
|
326
294
|
/**
|
|
327
|
-
* @typedef
|
|
328
|
-
* @property {
|
|
329
|
-
* @property {string} [id] - The ID of the property
|
|
330
|
-
* @property {string} [info] - Additional information about the property
|
|
331
|
-
* @property {string} [label] - The label of the property
|
|
332
|
-
* @property {string} [type] - The type of the property
|
|
333
|
-
* @property {string} [value] - The value of the property
|
|
295
|
+
* @typedef CustomConfig
|
|
296
|
+
* @property {CustomProps} [props]
|
|
334
297
|
*/
|
|
335
298
|
/**
|
|
336
|
-
* @typedef
|
|
337
|
-
* @property {
|
|
338
|
-
* @property {
|
|
299
|
+
* @typedef ThemeMeta
|
|
300
|
+
* @property {ThemePayment} [payment]
|
|
301
|
+
* @property {string} [description] - The description of the theme
|
|
302
|
+
* @property {string[]} [industry] - An array of industries associated with the theme
|
|
303
|
+
* @property {Release} [release]
|
|
304
|
+
* @property {Images} [images]
|
|
305
|
+
* @property {string} [slug] - The slug of the theme
|
|
306
|
+
* @property {string} [name] - The name of the theme
|
|
339
307
|
*/
|
|
340
308
|
/**
|
|
341
309
|
* @typedef Release
|
|
@@ -343,159 +311,173 @@ export = ThemePlatformModel;
|
|
|
343
311
|
* @property {string} [version] - The version of the theme
|
|
344
312
|
*/
|
|
345
313
|
/**
|
|
346
|
-
* @typedef
|
|
347
|
-
* @property {string} [
|
|
348
|
-
* @property {string} [
|
|
314
|
+
* @typedef Images
|
|
315
|
+
* @property {string} [desktop] - The URL of the desktop image
|
|
316
|
+
* @property {string} [mobile] - The URL of the mobile image
|
|
349
317
|
*/
|
|
350
318
|
/**
|
|
351
|
-
* @typedef
|
|
352
|
-
* @property {
|
|
353
|
-
* @property {
|
|
354
|
-
* @property {
|
|
319
|
+
* @typedef CustomProps
|
|
320
|
+
* @property {string} [header_bg_color] - The header background color
|
|
321
|
+
* @property {string} [header_text_color] - The header text color
|
|
322
|
+
* @property {string} [header_border_color] - The header border color
|
|
323
|
+
* @property {string} [header_icon_color] - The header icon color
|
|
324
|
+
* @property {string} [header_cart_notification_bg_color] - The header cart
|
|
325
|
+
* notification background color
|
|
326
|
+
* @property {string} [header_cart_notification_text_color] - The header cart
|
|
327
|
+
* notification text color
|
|
328
|
+
* @property {string} [header_nav_hover_color] - The header navigation hover color
|
|
329
|
+
* @property {string} [button_primary_color] - The primary button color
|
|
330
|
+
* @property {string} [button_primary_label_color] - The primary button label color
|
|
331
|
+
* @property {string} [button_add_to_cart_color] - The add to cart button color
|
|
332
|
+
* @property {string} [button_add_to_cart_label_color] - The add to cart button
|
|
333
|
+
* label color
|
|
334
|
+
* @property {string} [button_secondary_color] - The secondary button color
|
|
335
|
+
* @property {string} [button_secondary_label_color] - The secondary button label color
|
|
336
|
+
* @property {string} [button_tertiary_color] - The tertiary button color
|
|
337
|
+
* @property {string} [button_tertiary_label_color] - The tertiary button label color
|
|
338
|
+
* @property {string} [button_tertiary_hover_color] - The tertiary button hover color
|
|
339
|
+
* @property {string} [button_tertiary_hover_text_color] - The tertiary button
|
|
340
|
+
* hover text color
|
|
341
|
+
* @property {string} [text_heading_link_color] - The text heading link color
|
|
342
|
+
* @property {string} [text_body_color] - The text body color
|
|
343
|
+
* @property {string} [text_price_color] - The text price color
|
|
344
|
+
* @property {string} [text_sale_price_color] - The text sale price color
|
|
345
|
+
* @property {string} [text_strikethrough_price_color] - The text strikethrough
|
|
346
|
+
* price color
|
|
347
|
+
* @property {string} [text_discount_color] - The text discount color
|
|
348
|
+
* @property {string} [footer_bg_color] - The footer background color
|
|
349
|
+
* @property {string} [footer_text_color] - The footer text color
|
|
350
|
+
* @property {string} [footer_border_color] - The footer border color
|
|
351
|
+
* @property {string} [footer_nav_hover_color] - The footer navigation hover color
|
|
352
|
+
* @property {boolean} [disable_cart] - Whether to disable the cart or not
|
|
353
|
+
* @property {boolean} [is_menu_below_logo] - Whether the menu is below the logo or not
|
|
354
|
+
* @property {string} [menu_position] - The position of the menu
|
|
355
355
|
*/
|
|
356
356
|
/**
|
|
357
|
-
* @typedef
|
|
358
|
-
* @property {
|
|
359
|
-
* @property {string} [name] - The name of the section.
|
|
360
|
-
* @property {Predicate} [predicate]
|
|
361
|
-
* @property {SectionPreset} [preset]
|
|
362
|
-
* @property {SectionProps} [props]
|
|
357
|
+
* @typedef GlobalSchema
|
|
358
|
+
* @property {Prop[]} [props]
|
|
363
359
|
*/
|
|
364
360
|
/**
|
|
365
|
-
* @typedef
|
|
366
|
-
* @property {
|
|
367
|
-
* @property {string} [
|
|
368
|
-
* @property {string} [
|
|
369
|
-
* @property {
|
|
361
|
+
* @typedef Prop
|
|
362
|
+
* @property {string} [type] - The type of the property
|
|
363
|
+
* @property {string} [category] - The category of the property
|
|
364
|
+
* @property {string} [value] - The value of the property
|
|
365
|
+
* @property {string} [id] - The ID of the property
|
|
366
|
+
* @property {string} [label] - The label of the property
|
|
367
|
+
* @property {string} [info] - Additional information about the property
|
|
370
368
|
*/
|
|
371
369
|
/**
|
|
372
|
-
* @typedef
|
|
373
|
-
* @property {
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
* @typedef SectionProps
|
|
377
|
-
* @property {CheckboxProp} [autoplay]
|
|
378
|
-
* @property {TextProp} [item_margin]
|
|
379
|
-
* @property {RangeProp} [slide_interval]
|
|
380
|
-
* @property {TextProp} [title]
|
|
370
|
+
* @typedef Assets
|
|
371
|
+
* @property {UMDJs} [umd_js]
|
|
372
|
+
* @property {CommonJS} [common_js]
|
|
373
|
+
* @property {CSS} [css]
|
|
381
374
|
*/
|
|
382
375
|
/**
|
|
383
|
-
* @typedef
|
|
384
|
-
* @property {
|
|
385
|
-
* @property {string} [
|
|
376
|
+
* @typedef UMDJs
|
|
377
|
+
* @property {string} [link]
|
|
378
|
+
* @property {string[]} [links] - An array of pages
|
|
386
379
|
*/
|
|
387
380
|
/**
|
|
388
|
-
* @typedef
|
|
389
|
-
* @property {
|
|
390
|
-
* @property {string} [title]
|
|
381
|
+
* @typedef CommonJS
|
|
382
|
+
* @property {string} [link]
|
|
391
383
|
*/
|
|
392
384
|
/**
|
|
393
|
-
* @typedef
|
|
394
|
-
* @property {string} [
|
|
395
|
-
* @property {string} [
|
|
385
|
+
* @typedef CSS
|
|
386
|
+
* @property {string} [link]
|
|
387
|
+
* @property {string[]} [links]
|
|
396
388
|
*/
|
|
397
389
|
/**
|
|
398
|
-
* @typedef
|
|
399
|
-
* @property {
|
|
400
|
-
* @property {
|
|
390
|
+
* @typedef SectionItem
|
|
391
|
+
* @property {Object[]} [props]
|
|
392
|
+
* @property {Object[]} [blocks] - Blocks
|
|
393
|
+
* @property {string} [name] - Name of the section
|
|
394
|
+
* @property {string} [label] - Label for the section
|
|
401
395
|
*/
|
|
402
396
|
/**
|
|
403
|
-
* @typedef
|
|
404
|
-
* @property {
|
|
405
|
-
* @property {string} [value] - The value of the text property.
|
|
397
|
+
* @typedef Preset
|
|
398
|
+
* @property {Page[]} [pages]
|
|
406
399
|
*/
|
|
407
400
|
/**
|
|
408
|
-
* @typedef
|
|
409
|
-
* @property {
|
|
410
|
-
* @property {
|
|
401
|
+
* @typedef Page
|
|
402
|
+
* @property {number} [item_total]
|
|
403
|
+
* @property {string} [next_id]
|
|
404
|
+
* @property {boolean} [has_previous]
|
|
405
|
+
* @property {boolean} [has_next]
|
|
406
|
+
* @property {number} [current]
|
|
407
|
+
* @property {string} type
|
|
408
|
+
* @property {number} [size]
|
|
411
409
|
*/
|
|
412
410
|
/**
|
|
413
|
-
* @typedef
|
|
414
|
-
* @property {
|
|
411
|
+
* @typedef Section
|
|
412
|
+
* @property {Block[]} [blocks]
|
|
413
|
+
* @property {Predicate} [predicate]
|
|
414
|
+
* @property {string} [name] - The name of the section.
|
|
415
|
+
* @property {SectionProps} [props]
|
|
416
|
+
* @property {SectionPreset} [preset]
|
|
415
417
|
*/
|
|
416
418
|
/**
|
|
417
|
-
* @typedef
|
|
418
|
-
* @property {
|
|
419
|
-
* @property {string} [name] - The name of the
|
|
420
|
-
* @property {
|
|
419
|
+
* @typedef Block
|
|
420
|
+
* @property {string} [type] - The type of the block.
|
|
421
|
+
* @property {string} [name] - The name of the block.
|
|
422
|
+
* @property {BlockProps} [props]
|
|
421
423
|
*/
|
|
422
424
|
/**
|
|
423
|
-
* @typedef
|
|
424
|
-
* @property {
|
|
425
|
-
* @property {
|
|
425
|
+
* @typedef Predicate
|
|
426
|
+
* @property {Screen} [screen]
|
|
427
|
+
* @property {ThemeUserSchema} [user]
|
|
428
|
+
* @property {Route} [route]
|
|
426
429
|
*/
|
|
427
430
|
/**
|
|
428
|
-
* @typedef
|
|
429
|
-
* @property {
|
|
430
|
-
* @property {
|
|
431
|
-
* @property {
|
|
432
|
-
* @property {string} [name] - The name of the theme
|
|
433
|
-
* @property {ThemePayment} [payment]
|
|
434
|
-
* @property {Release} [release]
|
|
435
|
-
* @property {string} [slug] - The slug of the theme
|
|
431
|
+
* @typedef Screen
|
|
432
|
+
* @property {boolean} [mobile] - True if the screen is a mobile device.
|
|
433
|
+
* @property {boolean} [desktop] - True if the screen is a desktop device.
|
|
434
|
+
* @property {boolean} [tablet] - True if the screen is a tablet device.
|
|
436
435
|
*/
|
|
437
436
|
/**
|
|
438
|
-
* @typedef
|
|
439
|
-
* @property {
|
|
440
|
-
* @property {boolean} [
|
|
437
|
+
* @typedef ThemeUserSchema
|
|
438
|
+
* @property {boolean} [authenticated] - True if the user is authenticated.
|
|
439
|
+
* @property {boolean} [anonymous] - True if the user is anonymous.
|
|
441
440
|
*/
|
|
442
441
|
/**
|
|
443
|
-
* @typedef
|
|
444
|
-
* @property {string} [
|
|
445
|
-
*
|
|
442
|
+
* @typedef Route
|
|
443
|
+
* @property {string} [selected] - The selected route.
|
|
444
|
+
* @property {string} [exact_url] - The exact URL of the route.
|
|
446
445
|
*/
|
|
447
446
|
/**
|
|
448
|
-
* @typedef
|
|
449
|
-
* @property {
|
|
450
|
-
* @property {
|
|
451
|
-
* @property {
|
|
452
|
-
* @property {
|
|
453
|
-
* @property {SectionItem[]} [available_sections] - Available sections information
|
|
454
|
-
* @property {number} [company_id] - The company id in which sales channel exists
|
|
455
|
-
* @property {Config} [config]
|
|
456
|
-
* @property {string} [created_at] - The creation timestamp of the theme
|
|
457
|
-
* @property {Font} [font]
|
|
458
|
-
* @property {boolean} [is_private] - Whether the theme is private or not
|
|
459
|
-
* @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
|
|
460
|
-
* @property {ThemeMeta} [meta]
|
|
461
|
-
* @property {string} [name] - The name of the theme
|
|
462
|
-
* @property {string} [src]
|
|
463
|
-
* @property {Object} [styles] - The styles associated with the theme
|
|
464
|
-
* @property {string[]} [tags] - An array of tags associated with the theme
|
|
465
|
-
* @property {string} [template_theme_id] - The ID of the template theme
|
|
466
|
-
* @property {string} [theme_type]
|
|
467
|
-
* @property {string} [updated_at] - The last update timestamp of the theme
|
|
468
|
-
* @property {string} [version] - The version of the theme
|
|
447
|
+
* @typedef SectionProps
|
|
448
|
+
* @property {TextProp} [title]
|
|
449
|
+
* @property {TextProp} [item_margin]
|
|
450
|
+
* @property {CheckboxProp} [autoplay]
|
|
451
|
+
* @property {RangeProp} [slide_interval]
|
|
469
452
|
*/
|
|
470
453
|
/**
|
|
471
|
-
* @typedef
|
|
472
|
-
* @property {
|
|
473
|
-
* @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
|
|
474
|
-
* @property {ThemeVersions} [versions]
|
|
454
|
+
* @typedef SectionPreset
|
|
455
|
+
* @property {Block[]} [blocks]
|
|
475
456
|
*/
|
|
476
457
|
/**
|
|
477
|
-
* @typedef
|
|
478
|
-
* @property {
|
|
479
|
-
* @property {
|
|
458
|
+
* @typedef BlockProps
|
|
459
|
+
* @property {ImagePickerProp} [image]
|
|
460
|
+
* @property {UrlProp} [slide_link]
|
|
480
461
|
*/
|
|
481
462
|
/**
|
|
482
|
-
* @typedef
|
|
483
|
-
* @property {string} [
|
|
484
|
-
* @property {string} [
|
|
463
|
+
* @typedef TextProp
|
|
464
|
+
* @property {string} [value] - The value of the text property.
|
|
465
|
+
* @property {string} [type] - The type of the property.
|
|
485
466
|
*/
|
|
486
467
|
/**
|
|
487
|
-
* @typedef
|
|
488
|
-
* @property {
|
|
489
|
-
* @property {string
|
|
468
|
+
* @typedef CheckboxProp
|
|
469
|
+
* @property {boolean} [value] - The value of the checkbox property.
|
|
470
|
+
* @property {string} [type] - The type of the property.
|
|
490
471
|
*/
|
|
491
472
|
/**
|
|
492
|
-
* @typedef
|
|
493
|
-
* @property {
|
|
473
|
+
* @typedef RangeProp
|
|
474
|
+
* @property {number} [value] - The value of the range property.
|
|
475
|
+
* @property {string} [type] - The type of the property.
|
|
494
476
|
*/
|
|
495
477
|
/**
|
|
496
|
-
* @typedef
|
|
497
|
-
* @property {
|
|
498
|
-
* @property {
|
|
478
|
+
* @typedef ImagePickerProp
|
|
479
|
+
* @property {string} [type] - The type of the property.
|
|
480
|
+
* @property {string} [value] - The value of the image picker property.
|
|
499
481
|
*/
|
|
500
482
|
/**
|
|
501
483
|
* @typedef UrlProp
|
|
@@ -503,13 +485,31 @@ export = ThemePlatformModel;
|
|
|
503
485
|
* @property {string} [value] - The value of the URL property.
|
|
504
486
|
*/
|
|
505
487
|
/**
|
|
506
|
-
* @typedef
|
|
507
|
-
* @property {string} [
|
|
508
|
-
* @property {string} [
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
* @
|
|
512
|
-
* @property {string} [
|
|
488
|
+
* @typedef ThemeVersions
|
|
489
|
+
* @property {string} [parent_theme] - The version of the parent theme
|
|
490
|
+
* @property {string} [applied_theme] - The version of the applied theme
|
|
491
|
+
*/
|
|
492
|
+
/**
|
|
493
|
+
* @typedef DummyResponse
|
|
494
|
+
* @property {string} [message]
|
|
495
|
+
*/
|
|
496
|
+
/**
|
|
497
|
+
* @typedef AppliedThemes
|
|
498
|
+
* @property {string} [_id] - ID of the application theme
|
|
499
|
+
* @property {string} [application_id] - ID of the application
|
|
500
|
+
*/
|
|
501
|
+
/**
|
|
502
|
+
* @typedef CompanyPrivateTheme
|
|
503
|
+
* @property {string} [theme_type] - Type of the theme
|
|
504
|
+
* @property {string} [_id] - Unique identifier for the theme
|
|
505
|
+
* @property {string} [name] - Name of the theme
|
|
506
|
+
* @property {string} [version] - Version of the theme
|
|
507
|
+
* @property {string} [application_id] - Identifier for the application
|
|
508
|
+
* @property {string} [created_at] - Date and time when the theme was created
|
|
509
|
+
* @property {string} [updated_at] - Date and time when the theme was last updated
|
|
510
|
+
* @property {boolean} [applied] - Whether the theme is applied or not
|
|
511
|
+
* @property {boolean} [is_private] - Whether the theme is private or not
|
|
512
|
+
* @property {CompanyThemeMeta} [meta]
|
|
513
513
|
*/
|
|
514
514
|
/**
|
|
515
515
|
* @typedef {| "about-us"
|
|
@@ -562,442 +562,451 @@ export = ThemePlatformModel;
|
|
|
562
562
|
declare class ThemePlatformModel {
|
|
563
563
|
}
|
|
564
564
|
declare namespace ThemePlatformModel {
|
|
565
|
-
export {
|
|
565
|
+
export { ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, ActionPage, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, PageType };
|
|
566
566
|
}
|
|
567
|
-
/** @returns {
|
|
568
|
-
declare function
|
|
569
|
-
type
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
declare function ActionPage(): ActionPage;
|
|
576
|
-
type ActionPage = {
|
|
577
|
-
params?: any;
|
|
578
|
-
query?: any;
|
|
579
|
-
type: PageType;
|
|
580
|
-
url?: string;
|
|
581
|
-
};
|
|
582
|
-
/** @returns {AddThemeRequestSchema} */
|
|
583
|
-
declare function AddThemeRequestSchema(): AddThemeRequestSchema;
|
|
584
|
-
type AddThemeRequestSchema = {
|
|
585
|
-
theme_id?: string;
|
|
586
|
-
};
|
|
587
|
-
/** @returns {AllAvailablePageSchema} */
|
|
588
|
-
declare function AllAvailablePageSchema(): AllAvailablePageSchema;
|
|
589
|
-
type AllAvailablePageSchema = {
|
|
590
|
-
pages?: AvailablePageSchema[];
|
|
567
|
+
/** @returns {ThemeReq} */
|
|
568
|
+
declare function ThemeReq(): ThemeReq;
|
|
569
|
+
type ThemeReq = {
|
|
570
|
+
/**
|
|
571
|
+
* - The ID of the marketplace theme
|
|
572
|
+
* to apply to the company.
|
|
573
|
+
*/
|
|
574
|
+
marketplace_theme_id?: string;
|
|
591
575
|
};
|
|
592
|
-
/** @returns {
|
|
593
|
-
declare function
|
|
594
|
-
type
|
|
576
|
+
/** @returns {CompanyThemeSchema} */
|
|
577
|
+
declare function CompanyThemeSchema(): CompanyThemeSchema;
|
|
578
|
+
type CompanyThemeSchema = {
|
|
595
579
|
/**
|
|
596
|
-
* -
|
|
580
|
+
* - The unique identifier for the theme.
|
|
597
581
|
*/
|
|
598
582
|
_id?: string;
|
|
599
583
|
/**
|
|
600
|
-
* -
|
|
584
|
+
* - The name of the theme.
|
|
601
585
|
*/
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
/** @returns {Assets} */
|
|
605
|
-
declare function Assets(): Assets;
|
|
606
|
-
type Assets = {
|
|
607
|
-
common_js?: CommonJS;
|
|
608
|
-
css?: CSS;
|
|
609
|
-
umd_js?: UMDJs;
|
|
610
|
-
};
|
|
611
|
-
/** @returns {AvailablePagePlatformPredicate} */
|
|
612
|
-
declare function AvailablePagePlatformPredicate(): AvailablePagePlatformPredicate;
|
|
613
|
-
type AvailablePagePlatformPredicate = {
|
|
586
|
+
name?: string;
|
|
587
|
+
marketplace_theme_id?: MarketplaceThemeId;
|
|
614
588
|
/**
|
|
615
|
-
* -
|
|
589
|
+
* - The ID of the company that the theme belongs to.
|
|
616
590
|
*/
|
|
617
|
-
|
|
591
|
+
company_id?: number;
|
|
592
|
+
meta?: CompanyThemeMeta;
|
|
618
593
|
/**
|
|
619
|
-
* -
|
|
620
|
-
*/
|
|
621
|
-
ios?: boolean;
|
|
622
|
-
/**
|
|
623
|
-
* - Section visibility on web platform
|
|
624
|
-
*/
|
|
625
|
-
web?: boolean;
|
|
626
|
-
};
|
|
627
|
-
/** @returns {AvailablePagePredicate} */
|
|
628
|
-
declare function AvailablePagePredicate(): AvailablePagePredicate;
|
|
629
|
-
type AvailablePagePredicate = {
|
|
630
|
-
platform?: AvailablePagePlatformPredicate;
|
|
631
|
-
route?: AvailablePageRoutePredicate;
|
|
632
|
-
schedule?: AvailablePageSchedulePredicate;
|
|
633
|
-
screen?: AvailablePageScreenPredicate;
|
|
634
|
-
user?: AvailablePageUserPredicate;
|
|
635
|
-
/**
|
|
636
|
-
* - An array of zone ids associated with the section
|
|
637
|
-
*/
|
|
638
|
-
zones?: string[];
|
|
639
|
-
};
|
|
640
|
-
/** @returns {AvailablePageRoutePredicate} */
|
|
641
|
-
declare function AvailablePageRoutePredicate(): AvailablePageRoutePredicate;
|
|
642
|
-
type AvailablePageRoutePredicate = {
|
|
643
|
-
exact_url?: string;
|
|
644
|
-
query?: any;
|
|
645
|
-
selected?: string;
|
|
646
|
-
};
|
|
647
|
-
/** @returns {AvailablePageSchedulePredicate} */
|
|
648
|
-
declare function AvailablePageSchedulePredicate(): AvailablePageSchedulePredicate;
|
|
649
|
-
type AvailablePageSchedulePredicate = {
|
|
650
|
-
cron?: string;
|
|
651
|
-
end?: string;
|
|
652
|
-
start?: string;
|
|
653
|
-
};
|
|
654
|
-
/** @returns {AvailablePageSchema} */
|
|
655
|
-
declare function AvailablePageSchema(): AvailablePageSchema;
|
|
656
|
-
type AvailablePageSchema = {
|
|
657
|
-
_id?: string;
|
|
658
|
-
/**
|
|
659
|
-
* - The creation timestamp of the page
|
|
594
|
+
* - The timestamp when the theme was created.
|
|
660
595
|
*/
|
|
661
596
|
created_at?: string;
|
|
662
|
-
path?: string;
|
|
663
|
-
props?: any[];
|
|
664
|
-
sections?: AvailablePageSchemaSections[];
|
|
665
|
-
sections_meta?: AvailablePageSectionMetaAttributes[];
|
|
666
|
-
seo?: AvailablePageSeo;
|
|
667
|
-
text?: string;
|
|
668
|
-
theme?: string;
|
|
669
|
-
type?: string;
|
|
670
597
|
/**
|
|
671
|
-
* - The
|
|
598
|
+
* - The timestamp when the theme was last updated.
|
|
672
599
|
*/
|
|
673
600
|
updated_at?: string;
|
|
674
|
-
|
|
675
|
-
};
|
|
676
|
-
/** @returns {AvailablePageSchemaSections} */
|
|
677
|
-
declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
|
|
678
|
-
type AvailablePageSchemaSections = {
|
|
679
|
-
blocks?: any[];
|
|
680
|
-
label?: string;
|
|
681
|
-
name?: string;
|
|
682
|
-
predicate?: AvailablePagePredicate;
|
|
683
|
-
preset?: any;
|
|
684
|
-
props?: any;
|
|
685
|
-
source?: string;
|
|
686
|
-
};
|
|
687
|
-
/** @returns {AvailablePageScreenPredicate} */
|
|
688
|
-
declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
|
|
689
|
-
type AvailablePageScreenPredicate = {
|
|
690
|
-
desktop?: boolean;
|
|
691
|
-
mobile?: boolean;
|
|
692
|
-
tablet?: boolean;
|
|
693
|
-
};
|
|
694
|
-
/** @returns {AvailablePageSectionMetaAttributes} */
|
|
695
|
-
declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
|
|
696
|
-
type AvailablePageSectionMetaAttributes = {
|
|
697
|
-
attributes?: any;
|
|
698
|
-
};
|
|
699
|
-
/** @returns {AvailablePageSeo} */
|
|
700
|
-
declare function AvailablePageSeo(): AvailablePageSeo;
|
|
701
|
-
type AvailablePageSeo = {
|
|
702
|
-
_id?: string;
|
|
703
|
-
breadcrumb?: SEObreadcrumb[];
|
|
704
|
-
description?: string;
|
|
705
|
-
meta_tags?: SEOMetaItem[];
|
|
706
|
-
sitemap?: SEOSitemap;
|
|
707
|
-
title?: string;
|
|
708
|
-
};
|
|
709
|
-
/** @returns {AvailablePageUserPredicate} */
|
|
710
|
-
declare function AvailablePageUserPredicate(): AvailablePageUserPredicate;
|
|
711
|
-
type AvailablePageUserPredicate = {
|
|
712
|
-
anonymous?: boolean;
|
|
713
|
-
authenticated?: boolean;
|
|
714
|
-
};
|
|
715
|
-
/** @returns {BlitzkriegApiErrorSchema} */
|
|
716
|
-
declare function BlitzkriegApiErrorSchema(): BlitzkriegApiErrorSchema;
|
|
717
|
-
type BlitzkriegApiErrorSchema = {
|
|
718
|
-
message?: string;
|
|
719
|
-
};
|
|
720
|
-
/** @returns {BlitzkriegInternalServerErrorSchema} */
|
|
721
|
-
declare function BlitzkriegInternalServerErrorSchema(): BlitzkriegInternalServerErrorSchema;
|
|
722
|
-
type BlitzkriegInternalServerErrorSchema = {
|
|
723
|
-
message?: string;
|
|
724
|
-
};
|
|
725
|
-
/** @returns {Block} */
|
|
726
|
-
declare function Block(): Block;
|
|
727
|
-
type Block = {
|
|
728
|
-
/**
|
|
729
|
-
* - The name of the block.
|
|
730
|
-
*/
|
|
731
|
-
name?: string;
|
|
732
|
-
props?: BlockProps;
|
|
733
|
-
/**
|
|
734
|
-
* - The type of the block.
|
|
735
|
-
*/
|
|
736
|
-
type?: string;
|
|
737
|
-
};
|
|
738
|
-
/** @returns {BlockProps} */
|
|
739
|
-
declare function BlockProps(): BlockProps;
|
|
740
|
-
type BlockProps = {
|
|
741
|
-
image?: ImagePickerProp;
|
|
742
|
-
slide_link?: UrlProp;
|
|
743
|
-
};
|
|
744
|
-
/** @returns {CheckboxProp} */
|
|
745
|
-
declare function CheckboxProp(): CheckboxProp;
|
|
746
|
-
type CheckboxProp = {
|
|
747
|
-
/**
|
|
748
|
-
* - The type of the property.
|
|
749
|
-
*/
|
|
750
|
-
type?: string;
|
|
751
|
-
/**
|
|
752
|
-
* - The value of the checkbox property.
|
|
753
|
-
*/
|
|
754
|
-
value?: boolean;
|
|
755
|
-
};
|
|
756
|
-
/** @returns {CommonJS} */
|
|
757
|
-
declare function CommonJS(): CommonJS;
|
|
758
|
-
type CommonJS = {
|
|
759
|
-
link?: string;
|
|
601
|
+
applied_themes?: AppliedThemes[];
|
|
760
602
|
};
|
|
761
|
-
/** @returns {
|
|
762
|
-
declare function
|
|
763
|
-
type
|
|
603
|
+
/** @returns {MarketplaceThemeId} */
|
|
604
|
+
declare function MarketplaceThemeId(): MarketplaceThemeId;
|
|
605
|
+
type MarketplaceThemeId = {
|
|
764
606
|
/**
|
|
765
|
-
* -
|
|
607
|
+
* - The unique identifier for the marketplace theme.
|
|
766
608
|
*/
|
|
767
609
|
_id?: string;
|
|
768
610
|
/**
|
|
769
|
-
* -
|
|
770
|
-
*/
|
|
771
|
-
application_id?: string;
|
|
772
|
-
/**
|
|
773
|
-
* - Whether the theme is applied or not
|
|
611
|
+
* - Whether the theme is the default theme.
|
|
774
612
|
*/
|
|
775
|
-
|
|
613
|
+
is_default?: boolean;
|
|
614
|
+
release?: Release;
|
|
776
615
|
/**
|
|
777
|
-
* -
|
|
616
|
+
* - Creation date of the theme
|
|
778
617
|
*/
|
|
779
618
|
created_at?: string;
|
|
780
619
|
/**
|
|
781
|
-
* -
|
|
782
|
-
*/
|
|
783
|
-
is_private?: boolean;
|
|
784
|
-
meta?: CompanyThemeMeta;
|
|
785
|
-
/**
|
|
786
|
-
* - Name of the theme
|
|
787
|
-
*/
|
|
788
|
-
name?: string;
|
|
789
|
-
/**
|
|
790
|
-
* - Type of the theme
|
|
791
|
-
*/
|
|
792
|
-
theme_type?: string;
|
|
793
|
-
/**
|
|
794
|
-
* - Date and time when the theme was last updated
|
|
620
|
+
* - Update date of the theme
|
|
795
621
|
*/
|
|
796
622
|
updated_at?: string;
|
|
797
|
-
/**
|
|
798
|
-
* - Version of the theme
|
|
799
|
-
*/
|
|
800
|
-
version?: string;
|
|
801
623
|
};
|
|
802
624
|
/** @returns {CompanyThemeMeta} */
|
|
803
625
|
declare function CompanyThemeMeta(): CompanyThemeMeta;
|
|
804
626
|
type CompanyThemeMeta = {
|
|
805
|
-
|
|
806
|
-
* - A description of the theme.
|
|
807
|
-
*/
|
|
808
|
-
description?: string;
|
|
809
|
-
images?: ThemeImages;
|
|
627
|
+
payment?: ThemePayment;
|
|
810
628
|
/**
|
|
811
629
|
* - A list of industry categories the theme is
|
|
812
630
|
* suitable for.
|
|
813
631
|
*/
|
|
814
632
|
industry?: string[];
|
|
815
|
-
|
|
633
|
+
/**
|
|
634
|
+
* - A description of the theme.
|
|
635
|
+
*/
|
|
636
|
+
description?: string;
|
|
637
|
+
images?: ThemeImages;
|
|
816
638
|
/**
|
|
817
639
|
* - The slug for the theme.
|
|
818
640
|
*/
|
|
819
641
|
slug?: string;
|
|
820
642
|
};
|
|
821
|
-
/** @returns {
|
|
822
|
-
declare function
|
|
823
|
-
type
|
|
643
|
+
/** @returns {ThemePayment} */
|
|
644
|
+
declare function ThemePayment(): ThemePayment;
|
|
645
|
+
type ThemePayment = {
|
|
824
646
|
/**
|
|
825
|
-
* -
|
|
647
|
+
* - Whether the theme is a paid theme.
|
|
826
648
|
*/
|
|
827
|
-
|
|
828
|
-
applied_themes?: AppliedThemes[];
|
|
649
|
+
is_paid?: boolean;
|
|
829
650
|
/**
|
|
830
|
-
* - The
|
|
651
|
+
* - The amount to be paid for the theme.
|
|
831
652
|
*/
|
|
832
|
-
|
|
653
|
+
amount?: number;
|
|
654
|
+
};
|
|
655
|
+
/** @returns {ThemeImages} */
|
|
656
|
+
declare function ThemeImages(): ThemeImages;
|
|
657
|
+
type ThemeImages = {
|
|
833
658
|
/**
|
|
834
|
-
* - The
|
|
659
|
+
* - The URL of the desktop image for the theme.
|
|
835
660
|
*/
|
|
836
|
-
|
|
837
|
-
marketplace_theme_id?: MarketplaceThemeId;
|
|
838
|
-
meta?: CompanyThemeMeta;
|
|
661
|
+
desktop?: string;
|
|
839
662
|
/**
|
|
840
|
-
* - The
|
|
663
|
+
* - The URL of the mobile image for the theme.
|
|
841
664
|
*/
|
|
842
|
-
|
|
665
|
+
mobile?: string;
|
|
666
|
+
};
|
|
667
|
+
/** @returns {AvailablePageSchema} */
|
|
668
|
+
declare function AvailablePageSchema(): AvailablePageSchema;
|
|
669
|
+
type AvailablePageSchema = {
|
|
670
|
+
value?: string;
|
|
671
|
+
text?: string;
|
|
672
|
+
path?: string;
|
|
673
|
+
type?: string;
|
|
674
|
+
sections?: AvailablePageSchemaSections[];
|
|
675
|
+
sections_meta?: AvailablePageSectionMetaAttributes[];
|
|
676
|
+
theme?: string;
|
|
677
|
+
seo?: AvailablePageSeo;
|
|
678
|
+
props?: any[];
|
|
679
|
+
_id?: string;
|
|
843
680
|
/**
|
|
844
|
-
* - The timestamp
|
|
681
|
+
* - The creation timestamp of the page
|
|
682
|
+
*/
|
|
683
|
+
created_at?: string;
|
|
684
|
+
/**
|
|
685
|
+
* - The last update timestamp of the page
|
|
845
686
|
*/
|
|
846
687
|
updated_at?: string;
|
|
847
688
|
};
|
|
848
|
-
/** @returns {
|
|
849
|
-
declare function
|
|
850
|
-
type
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
689
|
+
/** @returns {AvailablePageSectionMetaAttributes} */
|
|
690
|
+
declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
|
|
691
|
+
type AvailablePageSectionMetaAttributes = {
|
|
692
|
+
attributes?: any;
|
|
693
|
+
};
|
|
694
|
+
/** @returns {SEOMetaItem} */
|
|
695
|
+
declare function SEOMetaItem(): SEOMetaItem;
|
|
696
|
+
type SEOMetaItem = {
|
|
697
|
+
title?: string;
|
|
698
|
+
items?: SEOMetaItems[];
|
|
699
|
+
};
|
|
700
|
+
/** @returns {SEOMetaItems} */
|
|
701
|
+
declare function SEOMetaItems(): SEOMetaItems;
|
|
702
|
+
type SEOMetaItems = {
|
|
703
|
+
key?: string;
|
|
704
|
+
value?: string;
|
|
705
|
+
};
|
|
706
|
+
/** @returns {SEOSitemap} */
|
|
707
|
+
declare function SEOSitemap(): SEOSitemap;
|
|
708
|
+
type SEOSitemap = {
|
|
709
|
+
priority?: number;
|
|
710
|
+
frequency?: string;
|
|
711
|
+
};
|
|
712
|
+
/** @returns {SEObreadcrumb} */
|
|
713
|
+
declare function SEObreadcrumb(): SEObreadcrumb;
|
|
714
|
+
type SEObreadcrumb = {
|
|
715
|
+
url?: string;
|
|
716
|
+
action?: Action;
|
|
717
|
+
};
|
|
718
|
+
/** @returns {Action} */
|
|
719
|
+
declare function Action(): Action;
|
|
720
|
+
type Action = {
|
|
721
|
+
page?: ActionPage;
|
|
722
|
+
popup?: ActionPage;
|
|
723
|
+
type?: string;
|
|
724
|
+
};
|
|
725
|
+
/** @returns {ActionPage} */
|
|
726
|
+
declare function ActionPage(): ActionPage;
|
|
727
|
+
type ActionPage = {
|
|
728
|
+
params?: any;
|
|
729
|
+
query?: any;
|
|
730
|
+
url?: string;
|
|
731
|
+
type: PageType;
|
|
732
|
+
};
|
|
733
|
+
/** @returns {AvailablePageSeo} */
|
|
734
|
+
declare function AvailablePageSeo(): AvailablePageSeo;
|
|
735
|
+
type AvailablePageSeo = {
|
|
736
|
+
title?: string;
|
|
737
|
+
description?: string;
|
|
738
|
+
meta_tags?: SEOMetaItem[];
|
|
739
|
+
sitemap?: SEOSitemap;
|
|
740
|
+
breadcrumb?: SEObreadcrumb[];
|
|
741
|
+
_id?: string;
|
|
742
|
+
};
|
|
743
|
+
/** @returns {AvailablePageSchemaSections} */
|
|
744
|
+
declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
|
|
745
|
+
type AvailablePageSchemaSections = {
|
|
746
|
+
name?: string;
|
|
747
|
+
label?: string;
|
|
748
|
+
props?: any;
|
|
749
|
+
blocks?: any[];
|
|
750
|
+
preset?: any;
|
|
751
|
+
predicate?: AvailablePagePredicate;
|
|
752
|
+
source?: string;
|
|
753
|
+
};
|
|
754
|
+
/** @returns {AvailablePagePredicate} */
|
|
755
|
+
declare function AvailablePagePredicate(): AvailablePagePredicate;
|
|
756
|
+
type AvailablePagePredicate = {
|
|
757
|
+
screen?: AvailablePageScreenPredicate;
|
|
758
|
+
user?: AvailablePageUserPredicate;
|
|
759
|
+
route?: AvailablePageRoutePredicate;
|
|
760
|
+
schedule?: AvailablePageSchedulePredicate;
|
|
761
|
+
platform?: AvailablePagePlatformPredicate;
|
|
856
762
|
/**
|
|
857
|
-
* -
|
|
763
|
+
* - An array of zone ids associated with the section
|
|
858
764
|
*/
|
|
859
|
-
|
|
860
|
-
preset?: Preset;
|
|
765
|
+
zones?: string[];
|
|
861
766
|
};
|
|
862
|
-
/** @returns {
|
|
863
|
-
declare function
|
|
864
|
-
type
|
|
865
|
-
|
|
866
|
-
|
|
767
|
+
/** @returns {AvailablePageScreenPredicate} */
|
|
768
|
+
declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
|
|
769
|
+
type AvailablePageScreenPredicate = {
|
|
770
|
+
mobile?: boolean;
|
|
771
|
+
desktop?: boolean;
|
|
772
|
+
tablet?: boolean;
|
|
867
773
|
};
|
|
868
|
-
/** @returns {
|
|
869
|
-
declare function
|
|
870
|
-
type
|
|
871
|
-
|
|
774
|
+
/** @returns {AvailablePageUserPredicate} */
|
|
775
|
+
declare function AvailablePageUserPredicate(): AvailablePageUserPredicate;
|
|
776
|
+
type AvailablePageUserPredicate = {
|
|
777
|
+
authenticated?: boolean;
|
|
778
|
+
anonymous?: boolean;
|
|
872
779
|
};
|
|
873
|
-
/** @returns {
|
|
874
|
-
declare function
|
|
875
|
-
type
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
*/
|
|
884
|
-
button_add_to_cart_label_color?: string;
|
|
885
|
-
/**
|
|
886
|
-
* - The primary button color
|
|
887
|
-
*/
|
|
888
|
-
button_primary_color?: string;
|
|
780
|
+
/** @returns {AvailablePageRoutePredicate} */
|
|
781
|
+
declare function AvailablePageRoutePredicate(): AvailablePageRoutePredicate;
|
|
782
|
+
type AvailablePageRoutePredicate = {
|
|
783
|
+
selected?: string;
|
|
784
|
+
exact_url?: string;
|
|
785
|
+
query?: any;
|
|
786
|
+
};
|
|
787
|
+
/** @returns {AvailablePagePlatformPredicate} */
|
|
788
|
+
declare function AvailablePagePlatformPredicate(): AvailablePagePlatformPredicate;
|
|
789
|
+
type AvailablePagePlatformPredicate = {
|
|
889
790
|
/**
|
|
890
|
-
* -
|
|
791
|
+
* - Section visibility on ios platform
|
|
891
792
|
*/
|
|
892
|
-
|
|
793
|
+
ios?: boolean;
|
|
893
794
|
/**
|
|
894
|
-
* -
|
|
795
|
+
* - Section visibility on android platform
|
|
895
796
|
*/
|
|
896
|
-
|
|
797
|
+
android?: boolean;
|
|
897
798
|
/**
|
|
898
|
-
* -
|
|
799
|
+
* - Section visibility on web platform
|
|
899
800
|
*/
|
|
900
|
-
|
|
801
|
+
web?: boolean;
|
|
802
|
+
};
|
|
803
|
+
/** @returns {AvailablePageSchedulePredicate} */
|
|
804
|
+
declare function AvailablePageSchedulePredicate(): AvailablePageSchedulePredicate;
|
|
805
|
+
type AvailablePageSchedulePredicate = {
|
|
806
|
+
cron?: string;
|
|
807
|
+
start?: string;
|
|
808
|
+
end?: string;
|
|
809
|
+
};
|
|
810
|
+
/** @returns {AllAvailablePageSchema} */
|
|
811
|
+
declare function AllAvailablePageSchema(): AllAvailablePageSchema;
|
|
812
|
+
type AllAvailablePageSchema = {
|
|
813
|
+
pages?: AvailablePageSchema[];
|
|
814
|
+
};
|
|
815
|
+
/** @returns {AddThemeRequestSchema} */
|
|
816
|
+
declare function AddThemeRequestSchema(): AddThemeRequestSchema;
|
|
817
|
+
type AddThemeRequestSchema = {
|
|
818
|
+
theme_id?: string;
|
|
819
|
+
};
|
|
820
|
+
/** @returns {FontsSchema} */
|
|
821
|
+
declare function FontsSchema(): FontsSchema;
|
|
822
|
+
type FontsSchema = {
|
|
823
|
+
items?: FontsSchemaItems;
|
|
824
|
+
kind?: string;
|
|
825
|
+
};
|
|
826
|
+
/** @returns {BlitzkriegApiErrorSchema} */
|
|
827
|
+
declare function BlitzkriegApiErrorSchema(): BlitzkriegApiErrorSchema;
|
|
828
|
+
type BlitzkriegApiErrorSchema = {
|
|
829
|
+
message?: string;
|
|
830
|
+
};
|
|
831
|
+
/** @returns {BlitzkriegInternalServerErrorSchema} */
|
|
832
|
+
declare function BlitzkriegInternalServerErrorSchema(): BlitzkriegInternalServerErrorSchema;
|
|
833
|
+
type BlitzkriegInternalServerErrorSchema = {
|
|
834
|
+
message?: string;
|
|
835
|
+
};
|
|
836
|
+
/** @returns {FontsSchemaItems} */
|
|
837
|
+
declare function FontsSchemaItems(): FontsSchemaItems;
|
|
838
|
+
type FontsSchemaItems = {
|
|
839
|
+
family?: string;
|
|
840
|
+
variants?: string[];
|
|
841
|
+
subsets?: string[];
|
|
842
|
+
version?: string;
|
|
843
|
+
last_modified?: string;
|
|
844
|
+
files?: FontsSchemaItemsFiles;
|
|
845
|
+
category?: string;
|
|
846
|
+
kind?: string;
|
|
847
|
+
};
|
|
848
|
+
/** @returns {FontsSchemaItemsFiles} */
|
|
849
|
+
declare function FontsSchemaItemsFiles(): FontsSchemaItemsFiles;
|
|
850
|
+
type FontsSchemaItemsFiles = {
|
|
851
|
+
regular?: string;
|
|
852
|
+
italic?: string;
|
|
853
|
+
bold?: string;
|
|
854
|
+
};
|
|
855
|
+
/** @returns {ThemesSchema} */
|
|
856
|
+
declare function ThemesSchema(): ThemesSchema;
|
|
857
|
+
type ThemesSchema = {
|
|
858
|
+
font?: Font;
|
|
859
|
+
config?: Config;
|
|
901
860
|
/**
|
|
902
|
-
* -
|
|
861
|
+
* - Whether the theme has been applied or not
|
|
903
862
|
*/
|
|
904
|
-
|
|
863
|
+
applied?: boolean;
|
|
905
864
|
/**
|
|
906
|
-
* -
|
|
865
|
+
* - Whether the theme is private or not
|
|
907
866
|
*/
|
|
908
|
-
|
|
867
|
+
is_private?: boolean;
|
|
909
868
|
/**
|
|
910
|
-
* -
|
|
911
|
-
* hover text color
|
|
869
|
+
* - An array of tags associated with the theme
|
|
912
870
|
*/
|
|
913
|
-
|
|
871
|
+
tags?: string[];
|
|
914
872
|
/**
|
|
915
|
-
* - The
|
|
873
|
+
* - The unique identifier of the theme
|
|
916
874
|
*/
|
|
917
|
-
|
|
875
|
+
_id?: string;
|
|
918
876
|
/**
|
|
919
|
-
* -
|
|
877
|
+
* - The ID of the application
|
|
920
878
|
*/
|
|
921
|
-
|
|
879
|
+
application_id?: string;
|
|
922
880
|
/**
|
|
923
|
-
* - The
|
|
881
|
+
* - The ID of the theme in the marketplace
|
|
924
882
|
*/
|
|
925
|
-
|
|
883
|
+
marketplace_theme_id?: string;
|
|
884
|
+
meta?: ThemeMeta;
|
|
926
885
|
/**
|
|
927
|
-
* - The
|
|
886
|
+
* - The name of the theme
|
|
928
887
|
*/
|
|
929
|
-
|
|
888
|
+
name?: string;
|
|
930
889
|
/**
|
|
931
|
-
* - The
|
|
890
|
+
* - The ID of the template theme
|
|
932
891
|
*/
|
|
933
|
-
|
|
892
|
+
template_theme_id?: string;
|
|
934
893
|
/**
|
|
935
|
-
* - The
|
|
894
|
+
* - The version of the theme
|
|
936
895
|
*/
|
|
937
|
-
|
|
896
|
+
version?: string;
|
|
938
897
|
/**
|
|
939
|
-
* - The
|
|
898
|
+
* - The styles associated with the theme
|
|
940
899
|
*/
|
|
941
|
-
|
|
900
|
+
styles?: any;
|
|
942
901
|
/**
|
|
943
|
-
* - The
|
|
902
|
+
* - The creation timestamp of the theme
|
|
944
903
|
*/
|
|
945
|
-
|
|
904
|
+
created_at?: string;
|
|
946
905
|
/**
|
|
947
|
-
* - The
|
|
948
|
-
* notification background color
|
|
906
|
+
* - The last update timestamp of the theme
|
|
949
907
|
*/
|
|
950
|
-
|
|
908
|
+
updated_at?: string;
|
|
909
|
+
assets?: Assets;
|
|
951
910
|
/**
|
|
952
|
-
* -
|
|
953
|
-
* notification text color
|
|
911
|
+
* - Available sections information
|
|
954
912
|
*/
|
|
955
|
-
|
|
913
|
+
available_sections?: SectionItem[];
|
|
914
|
+
theme_type?: string;
|
|
956
915
|
/**
|
|
957
|
-
* - The
|
|
916
|
+
* - The company id in which sales channel exists
|
|
958
917
|
*/
|
|
959
|
-
|
|
918
|
+
company_id?: number;
|
|
919
|
+
src?: string;
|
|
920
|
+
};
|
|
921
|
+
/** @returns {ThemeUpgradableResponse} */
|
|
922
|
+
declare function ThemeUpgradableResponse(): ThemeUpgradableResponse;
|
|
923
|
+
type ThemeUpgradableResponse = {
|
|
960
924
|
/**
|
|
961
|
-
* -
|
|
925
|
+
* - Indicates if the theme is upgradable or not
|
|
962
926
|
*/
|
|
963
|
-
|
|
927
|
+
upgrade?: boolean;
|
|
928
|
+
versions?: ThemeVersions;
|
|
964
929
|
/**
|
|
965
|
-
* -
|
|
930
|
+
* - A message describing the theme upgrade status
|
|
966
931
|
*/
|
|
967
|
-
|
|
932
|
+
message?: string;
|
|
933
|
+
};
|
|
934
|
+
/** @returns {UpdateThemeNameRequestBody} */
|
|
935
|
+
declare function UpdateThemeNameRequestBody(): UpdateThemeNameRequestBody;
|
|
936
|
+
type UpdateThemeNameRequestBody = {
|
|
968
937
|
/**
|
|
969
|
-
* -
|
|
938
|
+
* - The new name of the theme.
|
|
970
939
|
*/
|
|
971
|
-
|
|
940
|
+
name?: string;
|
|
941
|
+
};
|
|
942
|
+
/** @returns {UpdateThemeRequestBody} */
|
|
943
|
+
declare function UpdateThemeRequestBody(): UpdateThemeRequestBody;
|
|
944
|
+
type UpdateThemeRequestBody = {
|
|
945
|
+
config?: Config;
|
|
946
|
+
font?: Font;
|
|
947
|
+
};
|
|
948
|
+
/** @returns {Font} */
|
|
949
|
+
declare function Font(): Font;
|
|
950
|
+
type Font = {
|
|
951
|
+
variants: FontVariants;
|
|
972
952
|
/**
|
|
973
|
-
* - The
|
|
953
|
+
* - The font family
|
|
974
954
|
*/
|
|
975
|
-
|
|
955
|
+
family: string;
|
|
956
|
+
};
|
|
957
|
+
/** @returns {FontVariants} */
|
|
958
|
+
declare function FontVariants(): FontVariants;
|
|
959
|
+
type FontVariants = {
|
|
960
|
+
light?: FontVariant;
|
|
961
|
+
regular?: FontVariant;
|
|
962
|
+
medium?: FontVariant;
|
|
963
|
+
semi_bold?: FontVariant;
|
|
964
|
+
bold?: FontVariant;
|
|
965
|
+
};
|
|
966
|
+
/** @returns {FontVariant} */
|
|
967
|
+
declare function FontVariant(): FontVariant;
|
|
968
|
+
type FontVariant = {
|
|
976
969
|
/**
|
|
977
|
-
* - The
|
|
970
|
+
* - The name of the font variant
|
|
978
971
|
*/
|
|
979
|
-
|
|
972
|
+
name: string;
|
|
980
973
|
/**
|
|
981
|
-
* - The
|
|
974
|
+
* - The URL of the font file
|
|
982
975
|
*/
|
|
983
|
-
|
|
976
|
+
file: string;
|
|
977
|
+
};
|
|
978
|
+
/** @returns {Config} */
|
|
979
|
+
declare function Config(): Config;
|
|
980
|
+
type Config = {
|
|
984
981
|
/**
|
|
985
|
-
* - The
|
|
982
|
+
* - The current configuration
|
|
986
983
|
*/
|
|
987
|
-
|
|
984
|
+
current: string;
|
|
988
985
|
/**
|
|
989
|
-
* -
|
|
986
|
+
* - A list of configurations
|
|
990
987
|
*/
|
|
991
|
-
|
|
988
|
+
list: ThemeConfiguration[];
|
|
989
|
+
global_schema?: GlobalSchema;
|
|
990
|
+
preset?: Preset;
|
|
991
|
+
};
|
|
992
|
+
/** @returns {ThemeConfiguration} */
|
|
993
|
+
declare function ThemeConfiguration(): ThemeConfiguration;
|
|
994
|
+
type ThemeConfiguration = {
|
|
992
995
|
/**
|
|
993
|
-
* - The
|
|
996
|
+
* - The name of the configuration
|
|
994
997
|
*/
|
|
995
|
-
|
|
998
|
+
name?: string;
|
|
999
|
+
global_config?: any;
|
|
996
1000
|
/**
|
|
997
|
-
* -
|
|
998
|
-
* price color
|
|
1001
|
+
* - An array of pages
|
|
999
1002
|
*/
|
|
1000
|
-
|
|
1003
|
+
page?: ThemeConfigListPage[];
|
|
1004
|
+
};
|
|
1005
|
+
/** @returns {OverlayPopup} */
|
|
1006
|
+
declare function OverlayPopup(): OverlayPopup;
|
|
1007
|
+
type OverlayPopup = {
|
|
1008
|
+
dialog_backgroung?: string;
|
|
1009
|
+
overlay?: string;
|
|
1001
1010
|
};
|
|
1002
1011
|
/** @returns {DividerStrokeHighlight} */
|
|
1003
1012
|
declare function DividerStrokeHighlight(): DividerStrokeHighlight;
|
|
@@ -1005,82 +1014,75 @@ type DividerStrokeHighlight = {
|
|
|
1005
1014
|
divider_strokes?: string;
|
|
1006
1015
|
highlight?: string;
|
|
1007
1016
|
};
|
|
1008
|
-
/** @returns {
|
|
1009
|
-
declare function
|
|
1010
|
-
type
|
|
1011
|
-
|
|
1017
|
+
/** @returns {UserAlerts} */
|
|
1018
|
+
declare function UserAlerts(): UserAlerts;
|
|
1019
|
+
type UserAlerts = {
|
|
1020
|
+
success_background?: string;
|
|
1021
|
+
success_text?: string;
|
|
1022
|
+
error_background?: string;
|
|
1023
|
+
error_text?: string;
|
|
1024
|
+
info_background?: string;
|
|
1025
|
+
info_text?: string;
|
|
1012
1026
|
};
|
|
1013
|
-
/** @returns {
|
|
1014
|
-
declare function
|
|
1015
|
-
type
|
|
1027
|
+
/** @returns {OrderTracking} */
|
|
1028
|
+
declare function OrderTracking(): OrderTracking;
|
|
1029
|
+
type OrderTracking = {
|
|
1030
|
+
show_header?: boolean;
|
|
1031
|
+
show_footer?: boolean;
|
|
1032
|
+
};
|
|
1033
|
+
/** @returns {ThemeConfigListPage} */
|
|
1034
|
+
declare function ThemeConfigListPage(): ThemeConfigListPage;
|
|
1035
|
+
type ThemeConfigListPage = {
|
|
1016
1036
|
/**
|
|
1017
|
-
* -
|
|
1037
|
+
* - Name of the page
|
|
1018
1038
|
*/
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
};
|
|
1022
|
-
/** @returns {FontsSchema} */
|
|
1023
|
-
declare function FontsSchema(): FontsSchema;
|
|
1024
|
-
type FontsSchema = {
|
|
1025
|
-
items?: FontsSchemaItems;
|
|
1026
|
-
kind?: string;
|
|
1039
|
+
page?: string;
|
|
1040
|
+
settings?: ThemeConfigListPageSettingsProps;
|
|
1027
1041
|
};
|
|
1028
|
-
/** @returns {
|
|
1029
|
-
declare function
|
|
1030
|
-
type
|
|
1031
|
-
|
|
1032
|
-
family?: string;
|
|
1033
|
-
files?: FontsSchemaItemsFiles;
|
|
1034
|
-
kind?: string;
|
|
1035
|
-
last_modified?: string;
|
|
1036
|
-
subsets?: string[];
|
|
1037
|
-
variants?: string[];
|
|
1038
|
-
version?: string;
|
|
1042
|
+
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1043
|
+
declare function ThemeConfigListPageSettingsProps(): ThemeConfigListPageSettingsProps;
|
|
1044
|
+
type ThemeConfigListPageSettingsProps = {
|
|
1045
|
+
props?: any;
|
|
1039
1046
|
};
|
|
1040
|
-
/** @returns {
|
|
1041
|
-
declare function
|
|
1042
|
-
type
|
|
1043
|
-
|
|
1044
|
-
italic?: string;
|
|
1045
|
-
regular?: string;
|
|
1047
|
+
/** @returns {CustomConfig} */
|
|
1048
|
+
declare function CustomConfig(): CustomConfig;
|
|
1049
|
+
type CustomConfig = {
|
|
1050
|
+
props?: CustomProps;
|
|
1046
1051
|
};
|
|
1047
|
-
/** @returns {
|
|
1048
|
-
declare function
|
|
1049
|
-
type
|
|
1052
|
+
/** @returns {ThemeMeta} */
|
|
1053
|
+
declare function ThemeMeta(): ThemeMeta;
|
|
1054
|
+
type ThemeMeta = {
|
|
1055
|
+
payment?: ThemePayment;
|
|
1050
1056
|
/**
|
|
1051
|
-
* - The
|
|
1057
|
+
* - The description of the theme
|
|
1052
1058
|
*/
|
|
1053
|
-
|
|
1059
|
+
description?: string;
|
|
1054
1060
|
/**
|
|
1055
|
-
* -
|
|
1061
|
+
* - An array of industries associated with the theme
|
|
1056
1062
|
*/
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
/** @returns {GlobalSchema} */
|
|
1069
|
-
declare function GlobalSchema(): GlobalSchema;
|
|
1070
|
-
type GlobalSchema = {
|
|
1071
|
-
props?: Prop[];
|
|
1063
|
+
industry?: string[];
|
|
1064
|
+
release?: Release;
|
|
1065
|
+
images?: Images;
|
|
1066
|
+
/**
|
|
1067
|
+
* - The slug of the theme
|
|
1068
|
+
*/
|
|
1069
|
+
slug?: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* - The name of the theme
|
|
1072
|
+
*/
|
|
1073
|
+
name?: string;
|
|
1072
1074
|
};
|
|
1073
|
-
/** @returns {
|
|
1074
|
-
declare function
|
|
1075
|
-
type
|
|
1075
|
+
/** @returns {Release} */
|
|
1076
|
+
declare function Release(): Release;
|
|
1077
|
+
type Release = {
|
|
1076
1078
|
/**
|
|
1077
|
-
* - The
|
|
1079
|
+
* - The release notes of the theme
|
|
1078
1080
|
*/
|
|
1079
|
-
|
|
1081
|
+
notes?: string;
|
|
1080
1082
|
/**
|
|
1081
|
-
* - The
|
|
1083
|
+
* - The version of the theme
|
|
1082
1084
|
*/
|
|
1083
|
-
|
|
1085
|
+
version?: string;
|
|
1084
1086
|
};
|
|
1085
1087
|
/** @returns {Images} */
|
|
1086
1088
|
declare function Images(): Images;
|
|
@@ -1094,450 +1096,448 @@ type Images = {
|
|
|
1094
1096
|
*/
|
|
1095
1097
|
mobile?: string;
|
|
1096
1098
|
};
|
|
1097
|
-
/** @returns {
|
|
1098
|
-
declare function
|
|
1099
|
-
type
|
|
1099
|
+
/** @returns {CustomProps} */
|
|
1100
|
+
declare function CustomProps(): CustomProps;
|
|
1101
|
+
type CustomProps = {
|
|
1100
1102
|
/**
|
|
1101
|
-
* - The
|
|
1103
|
+
* - The header background color
|
|
1102
1104
|
*/
|
|
1103
|
-
|
|
1105
|
+
header_bg_color?: string;
|
|
1104
1106
|
/**
|
|
1105
|
-
* -
|
|
1107
|
+
* - The header text color
|
|
1106
1108
|
*/
|
|
1107
|
-
|
|
1109
|
+
header_text_color?: string;
|
|
1108
1110
|
/**
|
|
1109
|
-
* -
|
|
1111
|
+
* - The header border color
|
|
1110
1112
|
*/
|
|
1111
|
-
|
|
1112
|
-
release?: Release;
|
|
1113
|
+
header_border_color?: string;
|
|
1113
1114
|
/**
|
|
1114
|
-
* -
|
|
1115
|
+
* - The header icon color
|
|
1115
1116
|
*/
|
|
1116
|
-
|
|
1117
|
-
};
|
|
1118
|
-
/** @returns {OrderTracking} */
|
|
1119
|
-
declare function OrderTracking(): OrderTracking;
|
|
1120
|
-
type OrderTracking = {
|
|
1121
|
-
show_footer?: boolean;
|
|
1122
|
-
show_header?: boolean;
|
|
1123
|
-
};
|
|
1124
|
-
/** @returns {OverlayPopup} */
|
|
1125
|
-
declare function OverlayPopup(): OverlayPopup;
|
|
1126
|
-
type OverlayPopup = {
|
|
1127
|
-
dialog_backgroung?: string;
|
|
1128
|
-
overlay?: string;
|
|
1129
|
-
};
|
|
1130
|
-
/** @returns {Page} */
|
|
1131
|
-
declare function Page(): Page;
|
|
1132
|
-
type Page = {
|
|
1133
|
-
current?: number;
|
|
1134
|
-
has_next?: boolean;
|
|
1135
|
-
has_previous?: boolean;
|
|
1136
|
-
item_total?: number;
|
|
1137
|
-
next_id?: string;
|
|
1138
|
-
size?: number;
|
|
1139
|
-
type: string;
|
|
1140
|
-
};
|
|
1141
|
-
/** @returns {Predicate} */
|
|
1142
|
-
declare function Predicate(): Predicate;
|
|
1143
|
-
type Predicate = {
|
|
1144
|
-
route?: Route;
|
|
1145
|
-
screen?: Screen;
|
|
1146
|
-
user?: ThemeUserSchema;
|
|
1147
|
-
};
|
|
1148
|
-
/** @returns {Preset} */
|
|
1149
|
-
declare function Preset(): Preset;
|
|
1150
|
-
type Preset = {
|
|
1151
|
-
pages?: Page[];
|
|
1152
|
-
};
|
|
1153
|
-
/** @returns {Prop} */
|
|
1154
|
-
declare function Prop(): Prop;
|
|
1155
|
-
type Prop = {
|
|
1117
|
+
header_icon_color?: string;
|
|
1156
1118
|
/**
|
|
1157
|
-
* - The
|
|
1119
|
+
* - The header cart
|
|
1120
|
+
* notification background color
|
|
1158
1121
|
*/
|
|
1159
|
-
|
|
1122
|
+
header_cart_notification_bg_color?: string;
|
|
1160
1123
|
/**
|
|
1161
|
-
* - The
|
|
1124
|
+
* - The header cart
|
|
1125
|
+
* notification text color
|
|
1162
1126
|
*/
|
|
1163
|
-
|
|
1127
|
+
header_cart_notification_text_color?: string;
|
|
1164
1128
|
/**
|
|
1165
|
-
* -
|
|
1129
|
+
* - The header navigation hover color
|
|
1166
1130
|
*/
|
|
1167
|
-
|
|
1131
|
+
header_nav_hover_color?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* - The primary button color
|
|
1134
|
+
*/
|
|
1135
|
+
button_primary_color?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* - The primary button label color
|
|
1138
|
+
*/
|
|
1139
|
+
button_primary_label_color?: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* - The add to cart button color
|
|
1142
|
+
*/
|
|
1143
|
+
button_add_to_cart_color?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* - The add to cart button
|
|
1146
|
+
* label color
|
|
1147
|
+
*/
|
|
1148
|
+
button_add_to_cart_label_color?: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* - The secondary button color
|
|
1151
|
+
*/
|
|
1152
|
+
button_secondary_color?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* - The secondary button label color
|
|
1155
|
+
*/
|
|
1156
|
+
button_secondary_label_color?: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* - The tertiary button color
|
|
1159
|
+
*/
|
|
1160
|
+
button_tertiary_color?: string;
|
|
1168
1161
|
/**
|
|
1169
|
-
* - The
|
|
1162
|
+
* - The tertiary button label color
|
|
1170
1163
|
*/
|
|
1171
|
-
|
|
1164
|
+
button_tertiary_label_color?: string;
|
|
1172
1165
|
/**
|
|
1173
|
-
* - The
|
|
1166
|
+
* - The tertiary button hover color
|
|
1174
1167
|
*/
|
|
1175
|
-
|
|
1168
|
+
button_tertiary_hover_color?: string;
|
|
1176
1169
|
/**
|
|
1177
|
-
* - The
|
|
1170
|
+
* - The tertiary button
|
|
1171
|
+
* hover text color
|
|
1178
1172
|
*/
|
|
1179
|
-
|
|
1180
|
-
};
|
|
1181
|
-
/** @returns {RangeProp} */
|
|
1182
|
-
declare function RangeProp(): RangeProp;
|
|
1183
|
-
type RangeProp = {
|
|
1173
|
+
button_tertiary_hover_text_color?: string;
|
|
1184
1174
|
/**
|
|
1185
|
-
* - The
|
|
1175
|
+
* - The text heading link color
|
|
1186
1176
|
*/
|
|
1187
|
-
|
|
1177
|
+
text_heading_link_color?: string;
|
|
1188
1178
|
/**
|
|
1189
|
-
* - The
|
|
1179
|
+
* - The text body color
|
|
1190
1180
|
*/
|
|
1191
|
-
|
|
1192
|
-
};
|
|
1193
|
-
/** @returns {Release} */
|
|
1194
|
-
declare function Release(): Release;
|
|
1195
|
-
type Release = {
|
|
1181
|
+
text_body_color?: string;
|
|
1196
1182
|
/**
|
|
1197
|
-
* - The
|
|
1183
|
+
* - The text price color
|
|
1198
1184
|
*/
|
|
1199
|
-
|
|
1185
|
+
text_price_color?: string;
|
|
1200
1186
|
/**
|
|
1201
|
-
* - The
|
|
1187
|
+
* - The text sale price color
|
|
1202
1188
|
*/
|
|
1203
|
-
|
|
1204
|
-
};
|
|
1205
|
-
/** @returns {Route} */
|
|
1206
|
-
declare function Route(): Route;
|
|
1207
|
-
type Route = {
|
|
1189
|
+
text_sale_price_color?: string;
|
|
1208
1190
|
/**
|
|
1209
|
-
* - The
|
|
1191
|
+
* - The text strikethrough
|
|
1192
|
+
* price color
|
|
1210
1193
|
*/
|
|
1211
|
-
|
|
1194
|
+
text_strikethrough_price_color?: string;
|
|
1212
1195
|
/**
|
|
1213
|
-
* - The
|
|
1196
|
+
* - The text discount color
|
|
1214
1197
|
*/
|
|
1215
|
-
|
|
1216
|
-
};
|
|
1217
|
-
/** @returns {Screen} */
|
|
1218
|
-
declare function Screen(): Screen;
|
|
1219
|
-
type Screen = {
|
|
1198
|
+
text_discount_color?: string;
|
|
1220
1199
|
/**
|
|
1221
|
-
* -
|
|
1200
|
+
* - The footer background color
|
|
1222
1201
|
*/
|
|
1223
|
-
|
|
1202
|
+
footer_bg_color?: string;
|
|
1224
1203
|
/**
|
|
1225
|
-
* -
|
|
1204
|
+
* - The footer text color
|
|
1226
1205
|
*/
|
|
1227
|
-
|
|
1206
|
+
footer_text_color?: string;
|
|
1228
1207
|
/**
|
|
1229
|
-
* -
|
|
1208
|
+
* - The footer border color
|
|
1230
1209
|
*/
|
|
1231
|
-
|
|
1232
|
-
};
|
|
1233
|
-
/** @returns {Section} */
|
|
1234
|
-
declare function Section(): Section;
|
|
1235
|
-
type Section = {
|
|
1236
|
-
blocks?: Block[];
|
|
1210
|
+
footer_border_color?: string;
|
|
1237
1211
|
/**
|
|
1238
|
-
* - The
|
|
1212
|
+
* - The footer navigation hover color
|
|
1239
1213
|
*/
|
|
1240
|
-
|
|
1241
|
-
predicate?: Predicate;
|
|
1242
|
-
preset?: SectionPreset;
|
|
1243
|
-
props?: SectionProps;
|
|
1244
|
-
};
|
|
1245
|
-
/** @returns {SectionItem} */
|
|
1246
|
-
declare function SectionItem(): SectionItem;
|
|
1247
|
-
type SectionItem = {
|
|
1214
|
+
footer_nav_hover_color?: string;
|
|
1248
1215
|
/**
|
|
1249
|
-
* -
|
|
1216
|
+
* - Whether to disable the cart or not
|
|
1250
1217
|
*/
|
|
1251
|
-
|
|
1218
|
+
disable_cart?: boolean;
|
|
1252
1219
|
/**
|
|
1253
|
-
* -
|
|
1220
|
+
* - Whether the menu is below the logo or not
|
|
1254
1221
|
*/
|
|
1255
|
-
|
|
1222
|
+
is_menu_below_logo?: boolean;
|
|
1256
1223
|
/**
|
|
1257
|
-
* -
|
|
1224
|
+
* - The position of the menu
|
|
1258
1225
|
*/
|
|
1259
|
-
|
|
1260
|
-
props?: any[];
|
|
1261
|
-
};
|
|
1262
|
-
/** @returns {SectionPreset} */
|
|
1263
|
-
declare function SectionPreset(): SectionPreset;
|
|
1264
|
-
type SectionPreset = {
|
|
1265
|
-
blocks?: Block[];
|
|
1266
|
-
};
|
|
1267
|
-
/** @returns {SectionProps} */
|
|
1268
|
-
declare function SectionProps(): SectionProps;
|
|
1269
|
-
type SectionProps = {
|
|
1270
|
-
autoplay?: CheckboxProp;
|
|
1271
|
-
item_margin?: TextProp;
|
|
1272
|
-
slide_interval?: RangeProp;
|
|
1273
|
-
title?: TextProp;
|
|
1274
|
-
};
|
|
1275
|
-
/** @returns {SEObreadcrumb} */
|
|
1276
|
-
declare function SEObreadcrumb(): SEObreadcrumb;
|
|
1277
|
-
type SEObreadcrumb = {
|
|
1278
|
-
action?: Action;
|
|
1279
|
-
url?: string;
|
|
1280
|
-
};
|
|
1281
|
-
/** @returns {SEOMetaItem} */
|
|
1282
|
-
declare function SEOMetaItem(): SEOMetaItem;
|
|
1283
|
-
type SEOMetaItem = {
|
|
1284
|
-
items?: SEOMetaItems[];
|
|
1285
|
-
title?: string;
|
|
1286
|
-
};
|
|
1287
|
-
/** @returns {SEOMetaItems} */
|
|
1288
|
-
declare function SEOMetaItems(): SEOMetaItems;
|
|
1289
|
-
type SEOMetaItems = {
|
|
1290
|
-
key?: string;
|
|
1291
|
-
value?: string;
|
|
1226
|
+
menu_position?: string;
|
|
1292
1227
|
};
|
|
1293
|
-
/** @returns {
|
|
1294
|
-
declare function
|
|
1295
|
-
type
|
|
1296
|
-
|
|
1297
|
-
priority?: number;
|
|
1228
|
+
/** @returns {GlobalSchema} */
|
|
1229
|
+
declare function GlobalSchema(): GlobalSchema;
|
|
1230
|
+
type GlobalSchema = {
|
|
1231
|
+
props?: Prop[];
|
|
1298
1232
|
};
|
|
1299
|
-
/** @returns {
|
|
1300
|
-
declare function
|
|
1301
|
-
type
|
|
1233
|
+
/** @returns {Prop} */
|
|
1234
|
+
declare function Prop(): Prop;
|
|
1235
|
+
type Prop = {
|
|
1302
1236
|
/**
|
|
1303
|
-
* - The type of the property
|
|
1237
|
+
* - The type of the property
|
|
1304
1238
|
*/
|
|
1305
1239
|
type?: string;
|
|
1306
1240
|
/**
|
|
1307
|
-
* - The
|
|
1241
|
+
* - The category of the property
|
|
1308
1242
|
*/
|
|
1309
|
-
|
|
1310
|
-
};
|
|
1311
|
-
/** @returns {ThemeConfigListPage} */
|
|
1312
|
-
declare function ThemeConfigListPage(): ThemeConfigListPage;
|
|
1313
|
-
type ThemeConfigListPage = {
|
|
1243
|
+
category?: string;
|
|
1314
1244
|
/**
|
|
1315
|
-
* -
|
|
1245
|
+
* - The value of the property
|
|
1316
1246
|
*/
|
|
1317
|
-
|
|
1318
|
-
settings?: ThemeConfigListPageSettingsProps;
|
|
1319
|
-
};
|
|
1320
|
-
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1321
|
-
declare function ThemeConfigListPageSettingsProps(): ThemeConfigListPageSettingsProps;
|
|
1322
|
-
type ThemeConfigListPageSettingsProps = {
|
|
1323
|
-
props?: any;
|
|
1324
|
-
};
|
|
1325
|
-
/** @returns {ThemeConfiguration} */
|
|
1326
|
-
declare function ThemeConfiguration(): ThemeConfiguration;
|
|
1327
|
-
type ThemeConfiguration = {
|
|
1328
|
-
global_config?: any;
|
|
1247
|
+
value?: string;
|
|
1329
1248
|
/**
|
|
1330
|
-
* - The
|
|
1249
|
+
* - The ID of the property
|
|
1331
1250
|
*/
|
|
1332
|
-
|
|
1251
|
+
id?: string;
|
|
1333
1252
|
/**
|
|
1334
|
-
* -
|
|
1253
|
+
* - The label of the property
|
|
1335
1254
|
*/
|
|
1336
|
-
|
|
1337
|
-
};
|
|
1338
|
-
/** @returns {ThemeImages} */
|
|
1339
|
-
declare function ThemeImages(): ThemeImages;
|
|
1340
|
-
type ThemeImages = {
|
|
1255
|
+
label?: string;
|
|
1341
1256
|
/**
|
|
1342
|
-
* -
|
|
1257
|
+
* - Additional information about the property
|
|
1343
1258
|
*/
|
|
1344
|
-
|
|
1259
|
+
info?: string;
|
|
1260
|
+
};
|
|
1261
|
+
/** @returns {Assets} */
|
|
1262
|
+
declare function Assets(): Assets;
|
|
1263
|
+
type Assets = {
|
|
1264
|
+
umd_js?: UMDJs;
|
|
1265
|
+
common_js?: CommonJS;
|
|
1266
|
+
css?: CSS;
|
|
1267
|
+
};
|
|
1268
|
+
/** @returns {UMDJs} */
|
|
1269
|
+
declare function UMDJs(): UMDJs;
|
|
1270
|
+
type UMDJs = {
|
|
1271
|
+
link?: string;
|
|
1345
1272
|
/**
|
|
1346
|
-
* -
|
|
1273
|
+
* - An array of pages
|
|
1347
1274
|
*/
|
|
1348
|
-
|
|
1275
|
+
links?: string[];
|
|
1349
1276
|
};
|
|
1350
|
-
/** @returns {
|
|
1351
|
-
declare function
|
|
1352
|
-
type
|
|
1277
|
+
/** @returns {CommonJS} */
|
|
1278
|
+
declare function CommonJS(): CommonJS;
|
|
1279
|
+
type CommonJS = {
|
|
1280
|
+
link?: string;
|
|
1281
|
+
};
|
|
1282
|
+
/** @returns {CSS} */
|
|
1283
|
+
declare function CSS(): CSS;
|
|
1284
|
+
type CSS = {
|
|
1285
|
+
link?: string;
|
|
1286
|
+
links?: string[];
|
|
1287
|
+
};
|
|
1288
|
+
/** @returns {SectionItem} */
|
|
1289
|
+
declare function SectionItem(): SectionItem;
|
|
1290
|
+
type SectionItem = {
|
|
1291
|
+
props?: any[];
|
|
1353
1292
|
/**
|
|
1354
|
-
* -
|
|
1293
|
+
* - Blocks
|
|
1355
1294
|
*/
|
|
1356
|
-
|
|
1357
|
-
images?: Images;
|
|
1295
|
+
blocks?: any[];
|
|
1358
1296
|
/**
|
|
1359
|
-
* -
|
|
1297
|
+
* - Name of the section
|
|
1360
1298
|
*/
|
|
1361
|
-
|
|
1299
|
+
name?: string;
|
|
1362
1300
|
/**
|
|
1363
|
-
* -
|
|
1301
|
+
* - Label for the section
|
|
1364
1302
|
*/
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1303
|
+
label?: string;
|
|
1304
|
+
};
|
|
1305
|
+
/** @returns {Preset} */
|
|
1306
|
+
declare function Preset(): Preset;
|
|
1307
|
+
type Preset = {
|
|
1308
|
+
pages?: Page[];
|
|
1309
|
+
};
|
|
1310
|
+
/** @returns {Page} */
|
|
1311
|
+
declare function Page(): Page;
|
|
1312
|
+
type Page = {
|
|
1313
|
+
item_total?: number;
|
|
1314
|
+
next_id?: string;
|
|
1315
|
+
has_previous?: boolean;
|
|
1316
|
+
has_next?: boolean;
|
|
1317
|
+
current?: number;
|
|
1318
|
+
type: string;
|
|
1319
|
+
size?: number;
|
|
1320
|
+
};
|
|
1321
|
+
/** @returns {Section} */
|
|
1322
|
+
declare function Section(): Section;
|
|
1323
|
+
type Section = {
|
|
1324
|
+
blocks?: Block[];
|
|
1325
|
+
predicate?: Predicate;
|
|
1368
1326
|
/**
|
|
1369
|
-
* - The
|
|
1327
|
+
* - The name of the section.
|
|
1370
1328
|
*/
|
|
1371
|
-
|
|
1329
|
+
name?: string;
|
|
1330
|
+
props?: SectionProps;
|
|
1331
|
+
preset?: SectionPreset;
|
|
1372
1332
|
};
|
|
1373
|
-
/** @returns {
|
|
1374
|
-
declare function
|
|
1375
|
-
type
|
|
1333
|
+
/** @returns {Block} */
|
|
1334
|
+
declare function Block(): Block;
|
|
1335
|
+
type Block = {
|
|
1376
1336
|
/**
|
|
1377
|
-
* - The
|
|
1337
|
+
* - The type of the block.
|
|
1378
1338
|
*/
|
|
1379
|
-
|
|
1339
|
+
type?: string;
|
|
1380
1340
|
/**
|
|
1381
|
-
* -
|
|
1341
|
+
* - The name of the block.
|
|
1382
1342
|
*/
|
|
1383
|
-
|
|
1343
|
+
name?: string;
|
|
1344
|
+
props?: BlockProps;
|
|
1384
1345
|
};
|
|
1385
|
-
/** @returns {
|
|
1386
|
-
declare function
|
|
1387
|
-
type
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
*/
|
|
1392
|
-
marketplace_theme_id?: string;
|
|
1346
|
+
/** @returns {Predicate} */
|
|
1347
|
+
declare function Predicate(): Predicate;
|
|
1348
|
+
type Predicate = {
|
|
1349
|
+
screen?: Screen;
|
|
1350
|
+
user?: ThemeUserSchema;
|
|
1351
|
+
route?: Route;
|
|
1393
1352
|
};
|
|
1394
|
-
/** @returns {
|
|
1395
|
-
declare function
|
|
1396
|
-
type
|
|
1397
|
-
/**
|
|
1398
|
-
* - The unique identifier of the theme
|
|
1399
|
-
*/
|
|
1400
|
-
_id?: string;
|
|
1353
|
+
/** @returns {Screen} */
|
|
1354
|
+
declare function Screen(): Screen;
|
|
1355
|
+
type Screen = {
|
|
1401
1356
|
/**
|
|
1402
|
-
* -
|
|
1357
|
+
* - True if the screen is a mobile device.
|
|
1403
1358
|
*/
|
|
1404
|
-
|
|
1359
|
+
mobile?: boolean;
|
|
1405
1360
|
/**
|
|
1406
|
-
* -
|
|
1361
|
+
* - True if the screen is a desktop device.
|
|
1407
1362
|
*/
|
|
1408
|
-
|
|
1409
|
-
assets?: Assets;
|
|
1363
|
+
desktop?: boolean;
|
|
1410
1364
|
/**
|
|
1411
|
-
* -
|
|
1365
|
+
* - True if the screen is a tablet device.
|
|
1412
1366
|
*/
|
|
1413
|
-
|
|
1367
|
+
tablet?: boolean;
|
|
1368
|
+
};
|
|
1369
|
+
/** @returns {ThemeUserSchema} */
|
|
1370
|
+
declare function ThemeUserSchema(): ThemeUserSchema;
|
|
1371
|
+
type ThemeUserSchema = {
|
|
1414
1372
|
/**
|
|
1415
|
-
* -
|
|
1373
|
+
* - True if the user is authenticated.
|
|
1416
1374
|
*/
|
|
1417
|
-
|
|
1418
|
-
config?: Config;
|
|
1375
|
+
authenticated?: boolean;
|
|
1419
1376
|
/**
|
|
1420
|
-
* -
|
|
1377
|
+
* - True if the user is anonymous.
|
|
1421
1378
|
*/
|
|
1422
|
-
|
|
1423
|
-
|
|
1379
|
+
anonymous?: boolean;
|
|
1380
|
+
};
|
|
1381
|
+
/** @returns {Route} */
|
|
1382
|
+
declare function Route(): Route;
|
|
1383
|
+
type Route = {
|
|
1424
1384
|
/**
|
|
1425
|
-
* -
|
|
1385
|
+
* - The selected route.
|
|
1426
1386
|
*/
|
|
1427
|
-
|
|
1387
|
+
selected?: string;
|
|
1428
1388
|
/**
|
|
1429
|
-
* - The
|
|
1389
|
+
* - The exact URL of the route.
|
|
1430
1390
|
*/
|
|
1431
|
-
|
|
1432
|
-
|
|
1391
|
+
exact_url?: string;
|
|
1392
|
+
};
|
|
1393
|
+
/** @returns {SectionProps} */
|
|
1394
|
+
declare function SectionProps(): SectionProps;
|
|
1395
|
+
type SectionProps = {
|
|
1396
|
+
title?: TextProp;
|
|
1397
|
+
item_margin?: TextProp;
|
|
1398
|
+
autoplay?: CheckboxProp;
|
|
1399
|
+
slide_interval?: RangeProp;
|
|
1400
|
+
};
|
|
1401
|
+
/** @returns {SectionPreset} */
|
|
1402
|
+
declare function SectionPreset(): SectionPreset;
|
|
1403
|
+
type SectionPreset = {
|
|
1404
|
+
blocks?: Block[];
|
|
1405
|
+
};
|
|
1406
|
+
/** @returns {BlockProps} */
|
|
1407
|
+
declare function BlockProps(): BlockProps;
|
|
1408
|
+
type BlockProps = {
|
|
1409
|
+
image?: ImagePickerProp;
|
|
1410
|
+
slide_link?: UrlProp;
|
|
1411
|
+
};
|
|
1412
|
+
/** @returns {TextProp} */
|
|
1413
|
+
declare function TextProp(): TextProp;
|
|
1414
|
+
type TextProp = {
|
|
1433
1415
|
/**
|
|
1434
|
-
* - The
|
|
1416
|
+
* - The value of the text property.
|
|
1435
1417
|
*/
|
|
1436
|
-
|
|
1437
|
-
src?: string;
|
|
1418
|
+
value?: string;
|
|
1438
1419
|
/**
|
|
1439
|
-
* - The
|
|
1420
|
+
* - The type of the property.
|
|
1440
1421
|
*/
|
|
1441
|
-
|
|
1422
|
+
type?: string;
|
|
1423
|
+
};
|
|
1424
|
+
/** @returns {CheckboxProp} */
|
|
1425
|
+
declare function CheckboxProp(): CheckboxProp;
|
|
1426
|
+
type CheckboxProp = {
|
|
1442
1427
|
/**
|
|
1443
|
-
* -
|
|
1428
|
+
* - The value of the checkbox property.
|
|
1444
1429
|
*/
|
|
1445
|
-
|
|
1430
|
+
value?: boolean;
|
|
1446
1431
|
/**
|
|
1447
|
-
* - The
|
|
1432
|
+
* - The type of the property.
|
|
1448
1433
|
*/
|
|
1449
|
-
|
|
1450
|
-
|
|
1434
|
+
type?: string;
|
|
1435
|
+
};
|
|
1436
|
+
/** @returns {RangeProp} */
|
|
1437
|
+
declare function RangeProp(): RangeProp;
|
|
1438
|
+
type RangeProp = {
|
|
1451
1439
|
/**
|
|
1452
|
-
* - The
|
|
1440
|
+
* - The value of the range property.
|
|
1453
1441
|
*/
|
|
1454
|
-
|
|
1442
|
+
value?: number;
|
|
1455
1443
|
/**
|
|
1456
|
-
* - The
|
|
1444
|
+
* - The type of the property.
|
|
1457
1445
|
*/
|
|
1458
|
-
|
|
1446
|
+
type?: string;
|
|
1459
1447
|
};
|
|
1460
|
-
/** @returns {
|
|
1461
|
-
declare function
|
|
1462
|
-
type
|
|
1448
|
+
/** @returns {ImagePickerProp} */
|
|
1449
|
+
declare function ImagePickerProp(): ImagePickerProp;
|
|
1450
|
+
type ImagePickerProp = {
|
|
1463
1451
|
/**
|
|
1464
|
-
* -
|
|
1452
|
+
* - The type of the property.
|
|
1465
1453
|
*/
|
|
1466
|
-
|
|
1454
|
+
type?: string;
|
|
1467
1455
|
/**
|
|
1468
|
-
* -
|
|
1456
|
+
* - The value of the image picker property.
|
|
1469
1457
|
*/
|
|
1470
|
-
|
|
1471
|
-
versions?: ThemeVersions;
|
|
1458
|
+
value?: string;
|
|
1472
1459
|
};
|
|
1473
|
-
/** @returns {
|
|
1474
|
-
declare function
|
|
1475
|
-
type
|
|
1460
|
+
/** @returns {UrlProp} */
|
|
1461
|
+
declare function UrlProp(): UrlProp;
|
|
1462
|
+
type UrlProp = {
|
|
1476
1463
|
/**
|
|
1477
|
-
* -
|
|
1464
|
+
* - The type of the property.
|
|
1478
1465
|
*/
|
|
1479
|
-
|
|
1466
|
+
type?: string;
|
|
1480
1467
|
/**
|
|
1481
|
-
* -
|
|
1468
|
+
* - The value of the URL property.
|
|
1482
1469
|
*/
|
|
1483
|
-
|
|
1470
|
+
value?: string;
|
|
1484
1471
|
};
|
|
1485
1472
|
/** @returns {ThemeVersions} */
|
|
1486
1473
|
declare function ThemeVersions(): ThemeVersions;
|
|
1487
1474
|
type ThemeVersions = {
|
|
1475
|
+
/**
|
|
1476
|
+
* - The version of the parent theme
|
|
1477
|
+
*/
|
|
1478
|
+
parent_theme?: string;
|
|
1488
1479
|
/**
|
|
1489
1480
|
* - The version of the applied theme
|
|
1490
1481
|
*/
|
|
1491
1482
|
applied_theme?: string;
|
|
1483
|
+
};
|
|
1484
|
+
/** @returns {DummyResponse} */
|
|
1485
|
+
declare function DummyResponse(): DummyResponse;
|
|
1486
|
+
type DummyResponse = {
|
|
1487
|
+
message?: string;
|
|
1488
|
+
};
|
|
1489
|
+
/** @returns {AppliedThemes} */
|
|
1490
|
+
declare function AppliedThemes(): AppliedThemes;
|
|
1491
|
+
type AppliedThemes = {
|
|
1492
1492
|
/**
|
|
1493
|
-
* -
|
|
1493
|
+
* - ID of the application theme
|
|
1494
1494
|
*/
|
|
1495
|
-
|
|
1496
|
-
};
|
|
1497
|
-
/** @returns {UMDJs} */
|
|
1498
|
-
declare function UMDJs(): UMDJs;
|
|
1499
|
-
type UMDJs = {
|
|
1500
|
-
link?: string;
|
|
1495
|
+
_id?: string;
|
|
1501
1496
|
/**
|
|
1502
|
-
* -
|
|
1497
|
+
* - ID of the application
|
|
1503
1498
|
*/
|
|
1504
|
-
|
|
1499
|
+
application_id?: string;
|
|
1505
1500
|
};
|
|
1506
|
-
/** @returns {
|
|
1507
|
-
declare function
|
|
1508
|
-
type
|
|
1501
|
+
/** @returns {CompanyPrivateTheme} */
|
|
1502
|
+
declare function CompanyPrivateTheme(): CompanyPrivateTheme;
|
|
1503
|
+
type CompanyPrivateTheme = {
|
|
1509
1504
|
/**
|
|
1510
|
-
* -
|
|
1505
|
+
* - Type of the theme
|
|
1506
|
+
*/
|
|
1507
|
+
theme_type?: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* - Unique identifier for the theme
|
|
1510
|
+
*/
|
|
1511
|
+
_id?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* - Name of the theme
|
|
1511
1514
|
*/
|
|
1512
1515
|
name?: string;
|
|
1513
|
-
};
|
|
1514
|
-
/** @returns {UpdateThemeRequestBody} */
|
|
1515
|
-
declare function UpdateThemeRequestBody(): UpdateThemeRequestBody;
|
|
1516
|
-
type UpdateThemeRequestBody = {
|
|
1517
|
-
config?: Config;
|
|
1518
|
-
font?: Font;
|
|
1519
|
-
};
|
|
1520
|
-
/** @returns {UrlProp} */
|
|
1521
|
-
declare function UrlProp(): UrlProp;
|
|
1522
|
-
type UrlProp = {
|
|
1523
1516
|
/**
|
|
1524
|
-
* -
|
|
1517
|
+
* - Version of the theme
|
|
1525
1518
|
*/
|
|
1526
|
-
|
|
1519
|
+
version?: string;
|
|
1527
1520
|
/**
|
|
1528
|
-
* -
|
|
1521
|
+
* - Identifier for the application
|
|
1529
1522
|
*/
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
|
|
1523
|
+
application_id?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* - Date and time when the theme was created
|
|
1526
|
+
*/
|
|
1527
|
+
created_at?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* - Date and time when the theme was last updated
|
|
1530
|
+
*/
|
|
1531
|
+
updated_at?: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* - Whether the theme is applied or not
|
|
1534
|
+
*/
|
|
1535
|
+
applied?: boolean;
|
|
1536
|
+
/**
|
|
1537
|
+
* - Whether the theme is private or not
|
|
1538
|
+
*/
|
|
1539
|
+
is_private?: boolean;
|
|
1540
|
+
meta?: CompanyThemeMeta;
|
|
1541
1541
|
};
|
|
1542
1542
|
/**
|
|
1543
1543
|
* Enum: PageType Used By: Theme
|