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