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