@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-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.
Files changed (326) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +0 -2
  8. package/sdk/application/ApplicationClient.js +0 -20
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -97
  10. package/sdk/application/Cart/CartApplicationClient.js +60 -1262
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -162
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1313
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -9
  14. package/sdk/application/Common/CommonApplicationClient.js +5 -90
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -80
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -725
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +63 -85
  20. package/sdk/application/Content/ContentApplicationClient.js +126 -942
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -15
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +26 -130
  23. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -17
  24. package/sdk/application/Lead/LeadApplicationClient.js +32 -201
  25. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -62
  26. package/sdk/application/Logistic/LogisticApplicationClient.js +51 -647
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -56
  28. package/sdk/application/Order/OrderApplicationClient.js +86 -555
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -209
  30. package/sdk/application/Payment/PaymentApplicationClient.js +57 -2099
  31. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -26
  32. package/sdk/application/Rewards/RewardsApplicationClient.js +17 -303
  33. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  34. package/sdk/application/Share/ShareApplicationClient.js +34 -294
  35. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  36. package/sdk/application/Theme/ThemeApplicationClient.js +30 -166
  37. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  38. package/sdk/application/User/UserApplicationClient.js +47 -1817
  39. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  40. package/sdk/application/Webhook/WebhookApplicationClient.js +6 -49
  41. package/sdk/application/index.d.ts +0 -19
  42. package/sdk/application/index.js +0 -35
  43. package/sdk/common/Utility.d.ts +1 -1
  44. package/sdk/common/Utility.js +10 -7
  45. package/sdk/common/Validator.d.ts +1 -0
  46. package/sdk/common/Validator.js +20 -0
  47. package/sdk/common/utils.d.ts +0 -1
  48. package/sdk/common/utils.js +0 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  56. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  58. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
  65. package/sdk/partner/OAuthClient.js +1 -0
  66. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  67. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  68. package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
  69. package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
  70. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  71. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  72. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  73. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  74. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  75. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  76. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  88. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  90. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +1328 -4975
  98. package/sdk/platform/Cart/CartPlatformModel.js +1229 -1922
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1744 -1501
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +1211 -1383
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  110. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  112. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  117. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  118. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  125. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  126. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +138 -283
  132. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +100 -219
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  134. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
  138. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
  139. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  140. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  141. package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
  142. package/sdk/platform/Content/ContentPlatformModel.js +390 -521
  143. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  144. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  145. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  146. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  147. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  148. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  149. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  150. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  151. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  152. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  153. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  154. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  155. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  156. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  157. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  158. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  159. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  160. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  161. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  162. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  163. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  164. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  165. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  166. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  167. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  168. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  169. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  170. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -25
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -175
  173. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -52
  174. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -34
  175. package/sdk/platform/Order/OrderPlatformClient.d.ts +103 -174
  176. package/sdk/platform/Order/OrderPlatformClient.js +275 -528
  177. package/sdk/platform/Order/OrderPlatformModel.d.ts +3078 -5449
  178. package/sdk/platform/Order/OrderPlatformModel.js +1659 -3501
  179. package/sdk/platform/Order/OrderPlatformValidator.d.ts +219 -234
  180. package/sdk/platform/Order/OrderPlatformValidator.js +118 -146
  181. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  182. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
  193. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
  194. package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
  195. package/sdk/platform/PlatformClient.d.ts +2 -0
  196. package/sdk/platform/PlatformClient.js +4 -0
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  199. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  200. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  201. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +396 -620
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +326 -501
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +11 -11
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +10 -10
  213. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  214. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  215. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
  216. package/sdk/platform/Share/SharePlatformModel.js +4 -27
  217. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  218. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  219. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  220. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  221. package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
  222. package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  227. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  228. package/sdk/platform/User/UserPlatformModel.js +23 -23
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  235. package/sdk/platform/index.d.ts +1 -0
  236. package/sdk/platform/index.js +2 -0
  237. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  238. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -8
  239. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  240. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  241. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  242. package/sdk/public/Content/ContentPublicClient.js +19 -793
  243. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  244. package/sdk/public/Content/ContentPublicModel.js +3 -649
  245. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  246. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  247. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  248. package/sdk/public/Partner/PartnerPublicClient.js +14 -2
  249. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  250. package/sdk/public/Webhook/WebhookPublicClient.js +13 -10
  251. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  252. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  253. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  254. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  255. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -4340
  256. package/sdk/application/Cart/CartApplicationModel.js +0 -2718
  257. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -788
  258. package/sdk/application/Cart/CartApplicationValidator.js +0 -546
  259. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3909
  260. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2667
  261. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  262. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  263. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  264. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  265. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  266. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  267. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  268. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  269. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  270. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  271. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2544
  272. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1875
  273. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  274. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  275. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2189
  276. package/sdk/application/Content/ContentApplicationModel.js +0 -1640
  277. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -290
  278. package/sdk/application/Content/ContentApplicationValidator.js +0 -269
  279. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -270
  280. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -188
  281. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  282. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -36
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
  285. package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
  286. package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
  287. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
  288. package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
  289. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  290. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  291. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  292. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  293. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -2034
  294. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1391
  295. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -299
  296. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -224
  297. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2612
  298. package/sdk/application/Order/OrderApplicationModel.js +0 -1669
  299. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -279
  300. package/sdk/application/Order/OrderApplicationValidator.js +0 -210
  301. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4062
  302. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2632
  303. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  304. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  305. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  306. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  307. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  308. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  309. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  310. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  311. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  312. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  313. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1744
  314. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1446
  315. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -79
  316. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -65
  317. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  318. package/sdk/application/User/UserApplicationModel.js +0 -1382
  319. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  320. package/sdk/application/User/UserApplicationValidator.js +0 -573
  321. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -54
  322. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -48
  323. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  324. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  325. package/sdk/common/Clickstream.d.ts +0 -1
  326. package/sdk/common/Clickstream.js +0 -464
@@ -1,1744 +0,0 @@
1
- export = ThemeApplicationModel;
2
- /**
3
- * @typedef AllAvailablePageSchema
4
- * @property {AvailablePageSchema[]} [pages] - List all the pages.
5
- */
6
- /**
7
- * @typedef AvailablePageSchema
8
- * @property {string} [value] - The name of the page. For example, 'about-us'.
9
- * @property {string} [text] - The textual content associated with the page. For
10
- * example, 'about us'.
11
- * @property {string} [path] - The url path for the page. For example, 'about-us'.
12
- * @property {string} [type] - The type of the page, which can be 'system',
13
- * 'custom', or 'sections'.
14
- * @property {AvailablePageSchemaSections[]} [sections] - An array of sections
15
- * that make up the page.
16
- * @property {AvailablePageSectionMetaAttributes[]} [sections_meta] - An array
17
- * of metadata attributes for the sections of the page, each represented by an object.
18
- * @property {string} [theme] - The unique identifier for the theme associated
19
- * with the section.
20
- * @property {AvailablePageSeo} [seo]
21
- * @property {Object[]} [props] - An array of properties associated with the
22
- * object, where each property is represented as an object.
23
- * @property {string} [_id] - The unique identifier for the object.
24
- */
25
- /**
26
- * @typedef AvailablePageSectionMetaAttributes
27
- * @property {Object} [attributes] - A key-value pair object containing metadata
28
- * attributes for the section.
29
- */
30
- /**
31
- * @typedef SEOMetaItem
32
- * @property {string} [title] - The title of the meta tag item.
33
- * @property {SEOMetaItems[]} [items] - An array of items within the meta tag,
34
- * each represented by an object.
35
- */
36
- /**
37
- * @typedef SEOMetaItems
38
- * @property {string} [key] - The key of the meta tag item.
39
- * @property {string} [value] - The value of the meta tag item.
40
- */
41
- /**
42
- * @typedef SEOSitemap
43
- * @property {number} [priority] - The priority of the page in the sitemap,
44
- * typically a value between 0.0 And 1.0.
45
- * @property {string} [frequency] - The frequency with which the content of the
46
- * page is likely to change, such as 'always', 'hourly', 'daily', 'weekly',
47
- * 'monthly', 'yearly', or 'never'.
48
- */
49
- /**
50
- * @typedef SEObreadcrumb
51
- * @property {string} [url] - The url associated with the breadcrumb.
52
- * @property {Action} [action]
53
- */
54
- /**
55
- * @typedef Action
56
- * @property {string} [type] - Type of action to be taken e.g, page.
57
- * @property {ActionPage} [page]
58
- * @property {ActionPage} [popup]
59
- */
60
- /**
61
- * @typedef AvailablePageSeo
62
- * @property {string} [title] - The seo title of the page.
63
- * @property {string} [description] - The seo description of the page.
64
- * @property {string} [canonical_url] - The canonical url of the page.
65
- * @property {SEOMetaItem[]} [meta_tags] - An array of meta tags for the page,
66
- * each represented by an object.
67
- * @property {SEOSitemap} [sitemap]
68
- * @property {SEObreadcrumb[]} [breadcrumb] - An array representing breadcrumb
69
- * navigation, where each item provides information about a step in the
70
- * navigation path.
71
- * @property {string} [_id] - The unique identifier for the object.
72
- */
73
- /**
74
- * @typedef AvailablePageSchemaSections
75
- * @property {string} [name] - The name of the section.
76
- * @property {string} [label] - A label for the section, which can be used for
77
- * display purposes.
78
- * @property {Object} [props] - An object containing various properties
79
- * associated with the section.
80
- * @property {Object[]} [blocks] - An array of blocks within the section, where
81
- * each block is represented as an object.
82
- * @property {Object} [preset] - An object containing preset configurations for
83
- * the section.
84
- * @property {AvailablePagePredicate} [predicate]
85
- * @property {SectionSource} [__source]
86
- * @property {SectionAssets} [assets]
87
- */
88
- /**
89
- * @typedef SectionAssets
90
- * @property {string} [js] - The CDN URL of JS bundle.
91
- * @property {string} [css] - The CDN URL of CSS file.
92
- */
93
- /**
94
- * @typedef SectionSource
95
- * @property {string} [id] - The source id specifying the source of the section.
96
- * @property {string} [bundle_name] - This is the extension binding name
97
- * containing this section.
98
- * @property {string} [type] - This is source type. It will either be
99
- * themeBundle or extension.
100
- */
101
- /**
102
- * @typedef AvailablePagePredicate
103
- * @property {AvailablePageScreenPredicate} [screen]
104
- * @property {AvailablePageUserPredicate} [user]
105
- * @property {AvailablePageRoutePredicate} [route]
106
- * @property {AvailablePageSchedulePredicate} [schedule]
107
- * @property {AvailablePagePlatformPredicate} [platform]
108
- * @property {string[]} [zones] - An array of zone ids associated with the section.
109
- */
110
- /**
111
- * @typedef AvailablePageScreenPredicate
112
- * @property {boolean} [mobile] - Indicates if the predicate applies to mobile screens.
113
- * @property {boolean} [desktop] - Indicates if the predicate applies to desktop screens.
114
- * @property {boolean} [tablet] - Indicates if the predicate applies to tablet screens.
115
- */
116
- /**
117
- * @typedef AvailablePageUserPredicate
118
- * @property {boolean} [authenticated] - Indicates if the predicate applies to
119
- * authenticated users.
120
- * @property {boolean} [anonymous] - Indicates if the predicate applies to
121
- * anonymous users.
122
- */
123
- /**
124
- * @typedef AvailablePageRoutePredicate
125
- * @property {string} [selected] - Specifies the type of route selection, which
126
- * can be 'none', 'exact', or 'query'.
127
- * @property {string} [exact_url] - The exact url for the route when 'selected'
128
- * is set to 'exact'.
129
- * @property {Object} [query] - An object representing query parameters for the
130
- * route when 'selected' is set to 'query'.
131
- */
132
- /**
133
- * @typedef AvailablePageSchedulePredicate
134
- * @property {string} [cron] - A cron expression specifying the schedule for the
135
- * predicate.
136
- * @property {string} [start] - The start date and time for the schedule, in iso
137
- * 8601 format.
138
- * @property {string} [end] - The end date and time for the schedule, in iso 8601 format.
139
- */
140
- /**
141
- * @typedef ThemesSchema
142
- * @property {Font} [font]
143
- * @property {Config} [config]
144
- * @property {boolean} [applied] - Whether the theme has been applied or not.
145
- * @property {boolean} [is_private] - Whether the theme is private or not.
146
- * @property {string[]} [tags] - An array of tags associated with the theme.
147
- * @property {string} [_id] - The unique identifier of the theme.
148
- * @property {string} [application_id] - The id of the application.
149
- * @property {string} [marketplace_theme_id] - The id of the theme in the marketplace.
150
- * @property {ThemeMeta} [meta]
151
- * @property {string} [name] - The name of the theme.
152
- * @property {string} [template_theme_id] - The id of the template theme.
153
- * @property {string} [version] - The version of the theme.
154
- * @property {Object} [styles] - The styles associated with the theme.
155
- * @property {string} [created_at] - The creation timestamp of the theme.
156
- * @property {string} [updated_at] - The last update timestamp of the theme.
157
- * @property {Assets} [assets]
158
- * @property {SectionItem[]} [available_sections] - Available sections information.
159
- * @property {string} [theme_type] - The theme or category type associated with the page.
160
- * @property {number} [company_id] - The company id in which sales channel exists.
161
- */
162
- /**
163
- * @typedef Font
164
- * @property {FontVariants} variants
165
- * @property {string} family - The font family.
166
- */
167
- /**
168
- * @typedef FontVariants
169
- * @property {FontVariant} [light]
170
- * @property {FontVariant} [regular]
171
- * @property {FontVariant} [medium]
172
- * @property {FontVariant} [semi_bold]
173
- * @property {FontVariant} [bold]
174
- */
175
- /**
176
- * @typedef FontVariant
177
- * @property {string} name - The name of the font variant.
178
- * @property {string} file - The url of the font file.
179
- */
180
- /**
181
- * @typedef Config
182
- * @property {string} current - The current configuration.
183
- * @property {ThemeConfiguration[]} list - A list of configurations.
184
- * @property {GlobalSchema} [global_schema]
185
- * @property {Preset} [preset]
186
- */
187
- /**
188
- * @typedef ThemeConfiguration
189
- * @property {string} [name] - The name of the configuration.
190
- * @property {Object} [global_config] - A global configuration object containing
191
- * various settings for the theme.
192
- * @property {string[]} [page] - An array of pages associated with the theme
193
- * configuration.
194
- */
195
- /**
196
- * @typedef CustomConfig
197
- * @property {CustomProps} [props]
198
- */
199
- /**
200
- * @typedef CustomProps
201
- * @property {string} [header_bg_color] - The header background color.
202
- * @property {string} [header_text_color] - The header text color.
203
- * @property {string} [header_border_color] - The header border color.
204
- * @property {string} [header_icon_color] - The header icon color.
205
- * @property {string} [header_cart_notification_bg_color] - The header cart
206
- * notification background color.
207
- * @property {string} [header_cart_notification_text_color] - The header cart
208
- * notification text color.
209
- * @property {string} [header_nav_hover_color] - The header navigation hover color.
210
- * @property {string} [button_primary_color] - The primary button color.
211
- * @property {string} [button_primary_label_color] - The primary button label color.
212
- * @property {string} [button_add_to_cart_color] - The add to cart button color.
213
- * @property {string} [button_add_to_cart_label_color] - The add to cart button
214
- * label color.
215
- * @property {string} [button_secondary_color] - The secondary button color.
216
- * @property {string} [button_secondary_label_color] - The secondary button label color.
217
- * @property {string} [button_tertiary_color] - The tertiary button color.
218
- * @property {string} [button_tertiary_label_color] - The tertiary button label color.
219
- * @property {string} [button_tertiary_hover_color] - The tertiary button hover color.
220
- * @property {string} [button_tertiary_hover_text_color] - The tertiary button
221
- * hover text color.
222
- * @property {string} [text_heading_link_color] - The text heading link color.
223
- * @property {string} [text_body_color] - The text body color.
224
- * @property {string} [text_price_color] - The text price color.
225
- * @property {string} [text_sale_price_color] - The text sale price color.
226
- * @property {string} [text_strikethrough_price_color] - The text strikethrough
227
- * price color.
228
- * @property {string} [text_discount_color] - The text discount color.
229
- * @property {string} [footer_bg_color] - The footer background color.
230
- * @property {string} [footer_text_color] - The footer text color.
231
- * @property {string} [footer_border_color] - The footer border color.
232
- * @property {string} [footer_nav_hover_color] - The footer navigation hover color.
233
- * @property {boolean} [disable_cart] - Whether to disable the cart or not.
234
- * @property {boolean} [is_menu_below_logo] - Whether the menu is below the logo or not.
235
- * @property {string} [menu_position] - The position of the menu.
236
- */
237
- /**
238
- * @typedef GeneralSetting
239
- * @property {ThemeSetting} [theme]
240
- * @property {TextSetting} [text]
241
- * @property {ButtonSetting} [button]
242
- * @property {SaleDiscountSetting} [sale_discount]
243
- * @property {HeaderSetting} [header]
244
- * @property {FooterSetting} [footer]
245
- */
246
- /**
247
- * @typedef AdvanceSetting
248
- * @property {OverlayPopupSetting} [overlay_popup]
249
- * @property {DividerStrokeHighlightSetting} [divider_stroke_highlight]
250
- * @property {UserAlertsSetting} [user_alerts]
251
- */
252
- /**
253
- * @typedef UserAlertsSetting
254
- * @property {string} [success_background] - The success background color.
255
- * @property {string} [success_text] - The success text color.
256
- * @property {string} [error_background] - The error background color.
257
- * @property {string} [error_text] - The error text color.
258
- * @property {string} [info_background] - The info background color.
259
- * @property {string} [info_text] - The info text color.
260
- */
261
- /**
262
- * @typedef ThemeSetting
263
- * @property {string} [page_background] - The page background color.
264
- * @property {string} [theme_accent] - The theme accent color.
265
- */
266
- /**
267
- * @typedef TextSetting
268
- * @property {string} [text_heading] - The text heading color.
269
- * @property {string} [text_body] - The text body color.
270
- * @property {string} [text_label] - The text label color.
271
- * @property {string} [text_secondary] - The secondary text color.
272
- */
273
- /**
274
- * @typedef ButtonSetting
275
- * @property {string} [button_primary] - The primary button color.
276
- * @property {string} [button_secondary] - The secondary button color.
277
- * @property {string} [button_link] - The button link color.
278
- */
279
- /**
280
- * @typedef SaleDiscountSetting
281
- * @property {string} [sale_badge_background] - The sale badge background color.
282
- * @property {string} [sale_badge_text] - The sale badge text color.
283
- * @property {string} [sale_discount_text] - The sale discount text color.
284
- * @property {string} [sale_timer] - The sale timer color.
285
- */
286
- /**
287
- * @typedef HeaderSetting
288
- * @property {string} [header_background] - The header background color.
289
- * @property {string} [header_nav] - The header navigation color.
290
- * @property {string} [header_icon] - The header icon color.
291
- */
292
- /**
293
- * @typedef FooterSetting
294
- * @property {string} [footer_background] - The footer background color.
295
- * @property {string} [footer_bottom_background] - The footer bottom background color.
296
- * @property {string} [footer_heading_text] - The footer heading text color.
297
- * @property {string} [footer_body_text] - The footer body text color.
298
- * @property {string} [footer_icon] - The footer icon color.
299
- */
300
- /**
301
- * @typedef OverlayPopupSetting
302
- * @property {string} [dialog_backgroung] - The dialog background color.
303
- * @property {string} [overlay] - The overlay color.
304
- */
305
- /**
306
- * @typedef DividerStrokeHighlightSetting
307
- * @property {string} [divider_strokes] - The divider strokes color.
308
- * @property {string} [highlight] - The highlight color.
309
- */
310
- /**
311
- * @typedef StaticConfig
312
- * @property {StaticProps} [props]
313
- */
314
- /**
315
- * @typedef StaticProps
316
- * @property {Colors} [colors]
317
- * @property {AuthConfig} [auth]
318
- * @property {PaletteConfig} [palette]
319
- */
320
- /**
321
- * @typedef Colors
322
- * @property {string} [primary_color] - The primary color.
323
- * @property {string} [secondary_color] - The secondary color.
324
- * @property {string} [accent_color] - The accent color.
325
- * @property {string} [link_color] - The link color.
326
- * @property {string} [button_secondary_color] - The secondary button color.
327
- * @property {string} [bg_color] - The background color.
328
- */
329
- /**
330
- * @typedef AuthConfig
331
- * @property {boolean} [show_header_auth] - Whether to show header authentication or not.
332
- * @property {boolean} [show_footer_auth] - Whether to show footer authentication or not.
333
- */
334
- /**
335
- * @typedef PaletteConfig
336
- * @property {GeneralSetting} [general_setting]
337
- * @property {AdvanceSetting} [advance_setting]
338
- */
339
- /**
340
- * @typedef ThemeMeta
341
- * @property {ThemePayment} [payment]
342
- * @property {string} [description] - The description of the theme.
343
- * @property {string[]} [industry] - An array of industries associated with the theme.
344
- * @property {Release} [release]
345
- * @property {Images} [images]
346
- * @property {string} [slug] - The slug of the theme.
347
- * @property {string} [name] - The name of the theme.
348
- */
349
- /**
350
- * @typedef ThemePayment
351
- * @property {boolean} [is_paid] - Whether the theme is paid or not.
352
- * @property {number} [amount] - The amount of the theme.
353
- */
354
- /**
355
- * @typedef Release
356
- * @property {string} [notes] - The release notes of the theme.
357
- * @property {string} [version] - The version of the theme.
358
- */
359
- /**
360
- * @typedef Images
361
- * @property {string} [desktop] - The url of the desktop image.
362
- * @property {string} [mobile] - The url of the mobile image.
363
- */
364
- /**
365
- * @typedef Assets
366
- * @property {UMDJs} [umd_js]
367
- * @property {CommonJS} [common_js]
368
- * @property {CSS} [css]
369
- */
370
- /**
371
- * @typedef UMDJs
372
- * @property {string[]} [links] - An array of strings representing urls or links.
373
- */
374
- /**
375
- * @typedef CommonJS
376
- * @property {string} [link] - A string representing the url or link to the
377
- * commonjs module.
378
- */
379
- /**
380
- * @typedef CSS
381
- * @property {string[]} [links] - An array of strings representing urls for css assets.
382
- */
383
- /**
384
- * @typedef SectionItem
385
- * @property {Object[]} [props] - An array of objects representing properties or
386
- * attributes of the section item.
387
- * @property {Object[]} [blocks] - An array having blocks of the section.
388
- * @property {string} [name] - Name of the section.
389
- * @property {string} [label] - Label for the section.
390
- */
391
- /**
392
- * @typedef GlobalSchema
393
- * @property {Prop[]} [props] - An array of properties associated with the
394
- * global schema, where each property is represented by an object.
395
- */
396
- /**
397
- * @typedef Prop
398
- * @property {string} [type] - The type of the property.
399
- * @property {string} [category] - The category of the property.
400
- * @property {string} [id] - The id of the property.
401
- * @property {string} [label] - The label of the property.
402
- * @property {string} [info] - Additional information about the property.
403
- */
404
- /**
405
- * @typedef Preset
406
- * @property {Page[]} [pages] - An array of pages included in the preset, each
407
- * represented by an object.
408
- */
409
- /**
410
- * @typedef Page
411
- * @property {Section[]} [sections] - An array of sections included in the page.
412
- * @property {string} [value] - The value of the page.
413
- */
414
- /**
415
- * @typedef SectionProps
416
- * @property {TextProp} [title]
417
- * @property {TextProp} [item_margin]
418
- * @property {CheckboxProp} [autoplay]
419
- * @property {RangeProp} [slide_interval]
420
- */
421
- /**
422
- * @typedef SectionPreset
423
- * @property {Block[]} [blocks] - An array of blocks included in the section preset.
424
- */
425
- /**
426
- * @typedef ImagePickerProp
427
- * @property {string} [type] - The type of the property.
428
- * @property {string} [value] - The value of the image picker property.
429
- */
430
- /**
431
- * @typedef UrlProp
432
- * @property {string} [type] - The type of the property.
433
- * @property {string} [value] - The value of the url property.
434
- */
435
- /**
436
- * @typedef BlockProps
437
- * @property {ImagePickerProp} [image]
438
- * @property {UrlProp} [slide_link]
439
- */
440
- /**
441
- * @typedef TextProp
442
- * @property {string} [value] - The value of the text property.
443
- * @property {string} [type] - The type of the property.
444
- */
445
- /**
446
- * @typedef CheckboxProp
447
- * @property {boolean} [value] - The value of the checkbox property.
448
- * @property {string} [type] - The type of the property.
449
- */
450
- /**
451
- * @typedef RangeProp
452
- * @property {number} [value] - The value of the range property.
453
- * @property {string} [type] - The type of the property.
454
- */
455
- /**
456
- * @typedef Section
457
- * @property {Block[]} [blocks] - An array of blocks included in the section,
458
- * each represented by an object conforming to the block schema.
459
- * @property {Predicate} [predicate]
460
- * @property {string} [name] - The name of the section.
461
- * @property {SectionProps} [props]
462
- * @property {SectionPreset} [preset]
463
- */
464
- /**
465
- * @typedef Block
466
- * @property {string} [type] - The type of the block.
467
- * @property {string} [name] - The name of the block.
468
- * @property {BlockProps} [props]
469
- */
470
- /**
471
- * @typedef Predicate
472
- * @property {Screen} [screen]
473
- * @property {ThemeUserSchema} [user]
474
- * @property {Route} [route]
475
- */
476
- /**
477
- * @typedef Screen
478
- * @property {boolean} [mobile] - True if the screen is a mobile device.
479
- * @property {boolean} [desktop] - True if the screen is a desktop device.
480
- * @property {boolean} [tablet] - True if the screen is a tablet device.
481
- */
482
- /**
483
- * @typedef ThemeUserSchema
484
- * @property {boolean} [authenticated] - True if the user is authenticated.
485
- * @property {boolean} [anonymous] - True if the user is anonymous.
486
- */
487
- /**
488
- * @typedef Route
489
- * @property {string} [selected] - The selected route.
490
- * @property {string} [exact_url] - The exact url of the route.
491
- */
492
- /**
493
- * @typedef AvailablePagePlatformPredicate
494
- * @property {boolean} [ios] - Section visibility on ios platform.
495
- * @property {boolean} [android] - Section visibility on android platform.
496
- * @property {boolean} [web] - Section visibility on web platform.
497
- */
498
- /**
499
- * @typedef BlitzkriegInternalServerErrorSchema
500
- * @property {string} [message] - A descriptive message detailing the internal
501
- * server error.
502
- */
503
- /**
504
- * @typedef BlitzkriegApiErrorSchema
505
- * @property {string} [message] - A descriptive message detailing the api error.
506
- */
507
- /**
508
- * @typedef ActionPage
509
- * @property {Object} [params] - Parameters that should be considered in path.
510
- * @property {Object} [query] - Query parameter if any to be added to the action.
511
- * @property {string} [url] - The URL for the action.
512
- * @property {PageType} type
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
- * | "custom"
527
- * | "contact-us"
528
- * | "external"
529
- * | "faq"
530
- * | "freshchat"
531
- * | "home"
532
- * | "notification-settings"
533
- * | "orders"
534
- * | "page"
535
- * | "policy"
536
- * | "product"
537
- * | "product-request"
538
- * | "products"
539
- * | "profile"
540
- * | "profile-order-shipment"
541
- * | "profile-basic"
542
- * | "profile-company"
543
- * | "profile-emails"
544
- * | "profile-phones"
545
- * | "rate-us"
546
- * | "refer-earn"
547
- * | "settings"
548
- * | "shared-cart"
549
- * | "tnc"
550
- * | "track-order"
551
- * | "wishlist"
552
- * | "sections"
553
- * | "form"
554
- * | "cart-delivery"
555
- * | "cart-payment"
556
- * | "cart-review"
557
- * | "login"
558
- * | "register"
559
- * | "shipping-policy"
560
- * | "return-policy"
561
- * | "order-status"
562
- * | "locate-us"} PageType
563
- */
564
- declare class ThemeApplicationModel {
565
- }
566
- declare namespace ThemeApplicationModel {
567
- export { AllAvailablePageSchema, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionAssets, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePageSchedulePredicate, ThemesSchema, Font, FontVariants, FontVariant, Config, ThemeConfiguration, CustomConfig, CustomProps, GeneralSetting, AdvanceSetting, UserAlertsSetting, ThemeSetting, TextSetting, ButtonSetting, SaleDiscountSetting, HeaderSetting, FooterSetting, OverlayPopupSetting, DividerStrokeHighlightSetting, StaticConfig, StaticProps, Colors, AuthConfig, PaletteConfig, ThemeMeta, ThemePayment, Release, Images, Assets, UMDJs, CommonJS, CSS, SectionItem, GlobalSchema, Prop, Preset, Page, SectionProps, SectionPreset, ImagePickerProp, UrlProp, BlockProps, TextProp, CheckboxProp, RangeProp, Section, Block, Predicate, Screen, ThemeUserSchema, Route, AvailablePagePlatformPredicate, BlitzkriegInternalServerErrorSchema, BlitzkriegApiErrorSchema, ActionPage, PageType };
568
- }
569
- /** @returns {AllAvailablePageSchema} */
570
- declare function AllAvailablePageSchema(): AllAvailablePageSchema;
571
- type AllAvailablePageSchema = {
572
- /**
573
- * - List all the pages.
574
- */
575
- pages?: AvailablePageSchema[];
576
- };
577
- /** @returns {AvailablePageSchema} */
578
- declare function AvailablePageSchema(): AvailablePageSchema;
579
- type AvailablePageSchema = {
580
- /**
581
- * - The name of the page. For example, 'about-us'.
582
- */
583
- value?: string;
584
- /**
585
- * - The textual content associated with the page. For
586
- * example, 'about us'.
587
- */
588
- text?: string;
589
- /**
590
- * - The url path for the page. For example, 'about-us'.
591
- */
592
- path?: string;
593
- /**
594
- * - The type of the page, which can be 'system',
595
- * 'custom', or 'sections'.
596
- */
597
- type?: string;
598
- /**
599
- * - An array of sections
600
- * that make up the page.
601
- */
602
- sections?: AvailablePageSchemaSections[];
603
- /**
604
- * - An array
605
- * of metadata attributes for the sections of the page, each represented by an object.
606
- */
607
- sections_meta?: AvailablePageSectionMetaAttributes[];
608
- /**
609
- * - The unique identifier for the theme associated
610
- * with the section.
611
- */
612
- theme?: string;
613
- seo?: AvailablePageSeo;
614
- /**
615
- * - An array of properties associated with the
616
- * object, where each property is represented as an object.
617
- */
618
- props?: any[];
619
- /**
620
- * - The unique identifier for the object.
621
- */
622
- _id?: string;
623
- };
624
- /** @returns {AvailablePageSectionMetaAttributes} */
625
- declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
626
- type AvailablePageSectionMetaAttributes = {
627
- /**
628
- * - A key-value pair object containing metadata
629
- * attributes for the section.
630
- */
631
- attributes?: any;
632
- };
633
- /** @returns {SEOMetaItem} */
634
- declare function SEOMetaItem(): SEOMetaItem;
635
- type SEOMetaItem = {
636
- /**
637
- * - The title of the meta tag item.
638
- */
639
- title?: string;
640
- /**
641
- * - An array of items within the meta tag,
642
- * each represented by an object.
643
- */
644
- items?: SEOMetaItems[];
645
- };
646
- /** @returns {SEOMetaItems} */
647
- declare function SEOMetaItems(): SEOMetaItems;
648
- type SEOMetaItems = {
649
- /**
650
- * - The key of the meta tag item.
651
- */
652
- key?: string;
653
- /**
654
- * - The value of the meta tag item.
655
- */
656
- value?: string;
657
- };
658
- /** @returns {SEOSitemap} */
659
- declare function SEOSitemap(): SEOSitemap;
660
- type SEOSitemap = {
661
- /**
662
- * - The priority of the page in the sitemap,
663
- * typically a value between 0.0 And 1.0.
664
- */
665
- priority?: number;
666
- /**
667
- * - The frequency with which the content of the
668
- * page is likely to change, such as 'always', 'hourly', 'daily', 'weekly',
669
- * 'monthly', 'yearly', or 'never'.
670
- */
671
- frequency?: string;
672
- };
673
- /** @returns {SEObreadcrumb} */
674
- declare function SEObreadcrumb(): SEObreadcrumb;
675
- type SEObreadcrumb = {
676
- /**
677
- * - The url associated with the breadcrumb.
678
- */
679
- url?: string;
680
- action?: Action;
681
- };
682
- /** @returns {Action} */
683
- declare function Action(): Action;
684
- type Action = {
685
- /**
686
- * - Type of action to be taken e.g, page.
687
- */
688
- type?: string;
689
- page?: ActionPage;
690
- popup?: ActionPage;
691
- };
692
- /** @returns {AvailablePageSeo} */
693
- declare function AvailablePageSeo(): AvailablePageSeo;
694
- type AvailablePageSeo = {
695
- /**
696
- * - The seo title of the page.
697
- */
698
- title?: string;
699
- /**
700
- * - The seo description of the page.
701
- */
702
- description?: string;
703
- /**
704
- * - The canonical url of the page.
705
- */
706
- canonical_url?: string;
707
- /**
708
- * - An array of meta tags for the page,
709
- * each represented by an object.
710
- */
711
- meta_tags?: SEOMetaItem[];
712
- sitemap?: SEOSitemap;
713
- /**
714
- * - An array representing breadcrumb
715
- * navigation, where each item provides information about a step in the
716
- * navigation path.
717
- */
718
- breadcrumb?: SEObreadcrumb[];
719
- /**
720
- * - The unique identifier for the object.
721
- */
722
- _id?: string;
723
- };
724
- /** @returns {AvailablePageSchemaSections} */
725
- declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
726
- type AvailablePageSchemaSections = {
727
- /**
728
- * - The name of the section.
729
- */
730
- name?: string;
731
- /**
732
- * - A label for the section, which can be used for
733
- * display purposes.
734
- */
735
- label?: string;
736
- /**
737
- * - An object containing various properties
738
- * associated with the section.
739
- */
740
- props?: any;
741
- /**
742
- * - An array of blocks within the section, where
743
- * each block is represented as an object.
744
- */
745
- blocks?: any[];
746
- /**
747
- * - An object containing preset configurations for
748
- * the section.
749
- */
750
- preset?: any;
751
- predicate?: AvailablePagePredicate;
752
- __source?: SectionSource;
753
- assets?: SectionAssets;
754
- };
755
- /** @returns {SectionAssets} */
756
- declare function SectionAssets(): SectionAssets;
757
- type SectionAssets = {
758
- /**
759
- * - The CDN URL of JS bundle.
760
- */
761
- js?: string;
762
- /**
763
- * - The CDN URL of CSS file.
764
- */
765
- css?: string;
766
- };
767
- /** @returns {SectionSource} */
768
- declare function SectionSource(): SectionSource;
769
- type SectionSource = {
770
- /**
771
- * - The source id specifying the source of the section.
772
- */
773
- id?: string;
774
- /**
775
- * - This is the extension binding name
776
- * containing this section.
777
- */
778
- bundle_name?: string;
779
- /**
780
- * - This is source type. It will either be
781
- * themeBundle or extension.
782
- */
783
- type?: string;
784
- };
785
- /** @returns {AvailablePagePredicate} */
786
- declare function AvailablePagePredicate(): AvailablePagePredicate;
787
- type AvailablePagePredicate = {
788
- screen?: AvailablePageScreenPredicate;
789
- user?: AvailablePageUserPredicate;
790
- route?: AvailablePageRoutePredicate;
791
- schedule?: AvailablePageSchedulePredicate;
792
- platform?: AvailablePagePlatformPredicate;
793
- /**
794
- * - An array of zone ids associated with the section.
795
- */
796
- zones?: string[];
797
- };
798
- /** @returns {AvailablePageScreenPredicate} */
799
- declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
800
- type AvailablePageScreenPredicate = {
801
- /**
802
- * - Indicates if the predicate applies to mobile screens.
803
- */
804
- mobile?: boolean;
805
- /**
806
- * - Indicates if the predicate applies to desktop screens.
807
- */
808
- desktop?: boolean;
809
- /**
810
- * - Indicates if the predicate applies to tablet screens.
811
- */
812
- tablet?: boolean;
813
- };
814
- /** @returns {AvailablePageUserPredicate} */
815
- declare function AvailablePageUserPredicate(): AvailablePageUserPredicate;
816
- type AvailablePageUserPredicate = {
817
- /**
818
- * - Indicates if the predicate applies to
819
- * authenticated users.
820
- */
821
- authenticated?: boolean;
822
- /**
823
- * - Indicates if the predicate applies to
824
- * anonymous users.
825
- */
826
- anonymous?: boolean;
827
- };
828
- /** @returns {AvailablePageRoutePredicate} */
829
- declare function AvailablePageRoutePredicate(): AvailablePageRoutePredicate;
830
- type AvailablePageRoutePredicate = {
831
- /**
832
- * - Specifies the type of route selection, which
833
- * can be 'none', 'exact', or 'query'.
834
- */
835
- selected?: string;
836
- /**
837
- * - The exact url for the route when 'selected'
838
- * is set to 'exact'.
839
- */
840
- exact_url?: string;
841
- /**
842
- * - An object representing query parameters for the
843
- * route when 'selected' is set to 'query'.
844
- */
845
- query?: any;
846
- };
847
- /** @returns {AvailablePageSchedulePredicate} */
848
- declare function AvailablePageSchedulePredicate(): AvailablePageSchedulePredicate;
849
- type AvailablePageSchedulePredicate = {
850
- /**
851
- * - A cron expression specifying the schedule for the
852
- * predicate.
853
- */
854
- cron?: string;
855
- /**
856
- * - The start date and time for the schedule, in iso
857
- * 8601 format.
858
- */
859
- start?: string;
860
- /**
861
- * - The end date and time for the schedule, in iso 8601 format.
862
- */
863
- end?: string;
864
- };
865
- /** @returns {ThemesSchema} */
866
- declare function ThemesSchema(): ThemesSchema;
867
- type ThemesSchema = {
868
- font?: Font;
869
- config?: Config;
870
- /**
871
- * - Whether the theme has been applied or not.
872
- */
873
- applied?: boolean;
874
- /**
875
- * - Whether the theme is private or not.
876
- */
877
- is_private?: boolean;
878
- /**
879
- * - An array of tags associated with the theme.
880
- */
881
- tags?: string[];
882
- /**
883
- * - The unique identifier of the theme.
884
- */
885
- _id?: string;
886
- /**
887
- * - The id of the application.
888
- */
889
- application_id?: string;
890
- /**
891
- * - The id of the theme in the marketplace.
892
- */
893
- marketplace_theme_id?: string;
894
- meta?: ThemeMeta;
895
- /**
896
- * - The name of the theme.
897
- */
898
- name?: string;
899
- /**
900
- * - The id of the template theme.
901
- */
902
- template_theme_id?: string;
903
- /**
904
- * - The version of the theme.
905
- */
906
- version?: string;
907
- /**
908
- * - The styles associated with the theme.
909
- */
910
- styles?: any;
911
- /**
912
- * - The creation timestamp of the theme.
913
- */
914
- created_at?: string;
915
- /**
916
- * - The last update timestamp of the theme.
917
- */
918
- updated_at?: string;
919
- assets?: Assets;
920
- /**
921
- * - Available sections information.
922
- */
923
- available_sections?: SectionItem[];
924
- /**
925
- * - The theme or category type associated with the page.
926
- */
927
- theme_type?: string;
928
- /**
929
- * - The company id in which sales channel exists.
930
- */
931
- company_id?: number;
932
- };
933
- /** @returns {Font} */
934
- declare function Font(): Font;
935
- type Font = {
936
- variants: FontVariants;
937
- /**
938
- * - The font family.
939
- */
940
- family: string;
941
- };
942
- /** @returns {FontVariants} */
943
- declare function FontVariants(): FontVariants;
944
- type FontVariants = {
945
- light?: FontVariant;
946
- regular?: FontVariant;
947
- medium?: FontVariant;
948
- semi_bold?: FontVariant;
949
- bold?: FontVariant;
950
- };
951
- /** @returns {FontVariant} */
952
- declare function FontVariant(): FontVariant;
953
- type FontVariant = {
954
- /**
955
- * - The name of the font variant.
956
- */
957
- name: string;
958
- /**
959
- * - The url of the font file.
960
- */
961
- file: string;
962
- };
963
- /** @returns {Config} */
964
- declare function Config(): Config;
965
- type Config = {
966
- /**
967
- * - The current configuration.
968
- */
969
- current: string;
970
- /**
971
- * - A list of configurations.
972
- */
973
- list: ThemeConfiguration[];
974
- global_schema?: GlobalSchema;
975
- preset?: Preset;
976
- };
977
- /** @returns {ThemeConfiguration} */
978
- declare function ThemeConfiguration(): ThemeConfiguration;
979
- type ThemeConfiguration = {
980
- /**
981
- * - The name of the configuration.
982
- */
983
- name?: string;
984
- /**
985
- * - A global configuration object containing
986
- * various settings for the theme.
987
- */
988
- global_config?: any;
989
- /**
990
- * - An array of pages associated with the theme
991
- * configuration.
992
- */
993
- page?: string[];
994
- };
995
- /** @returns {CustomConfig} */
996
- declare function CustomConfig(): CustomConfig;
997
- type CustomConfig = {
998
- props?: CustomProps;
999
- };
1000
- /** @returns {CustomProps} */
1001
- declare function CustomProps(): CustomProps;
1002
- type CustomProps = {
1003
- /**
1004
- * - The header background color.
1005
- */
1006
- header_bg_color?: string;
1007
- /**
1008
- * - The header text color.
1009
- */
1010
- header_text_color?: string;
1011
- /**
1012
- * - The header border color.
1013
- */
1014
- header_border_color?: string;
1015
- /**
1016
- * - The header icon color.
1017
- */
1018
- header_icon_color?: string;
1019
- /**
1020
- * - The header cart
1021
- * notification background color.
1022
- */
1023
- header_cart_notification_bg_color?: string;
1024
- /**
1025
- * - The header cart
1026
- * notification text color.
1027
- */
1028
- header_cart_notification_text_color?: string;
1029
- /**
1030
- * - The header navigation hover color.
1031
- */
1032
- header_nav_hover_color?: string;
1033
- /**
1034
- * - The primary button color.
1035
- */
1036
- button_primary_color?: string;
1037
- /**
1038
- * - The primary button label color.
1039
- */
1040
- button_primary_label_color?: string;
1041
- /**
1042
- * - The add to cart button color.
1043
- */
1044
- button_add_to_cart_color?: string;
1045
- /**
1046
- * - The add to cart button
1047
- * label color.
1048
- */
1049
- button_add_to_cart_label_color?: string;
1050
- /**
1051
- * - The secondary button color.
1052
- */
1053
- button_secondary_color?: string;
1054
- /**
1055
- * - The secondary button label color.
1056
- */
1057
- button_secondary_label_color?: string;
1058
- /**
1059
- * - The tertiary button color.
1060
- */
1061
- button_tertiary_color?: string;
1062
- /**
1063
- * - The tertiary button label color.
1064
- */
1065
- button_tertiary_label_color?: string;
1066
- /**
1067
- * - The tertiary button hover color.
1068
- */
1069
- button_tertiary_hover_color?: string;
1070
- /**
1071
- * - The tertiary button
1072
- * hover text color.
1073
- */
1074
- button_tertiary_hover_text_color?: string;
1075
- /**
1076
- * - The text heading link color.
1077
- */
1078
- text_heading_link_color?: string;
1079
- /**
1080
- * - The text body color.
1081
- */
1082
- text_body_color?: string;
1083
- /**
1084
- * - The text price color.
1085
- */
1086
- text_price_color?: string;
1087
- /**
1088
- * - The text sale price color.
1089
- */
1090
- text_sale_price_color?: string;
1091
- /**
1092
- * - The text strikethrough
1093
- * price color.
1094
- */
1095
- text_strikethrough_price_color?: string;
1096
- /**
1097
- * - The text discount color.
1098
- */
1099
- text_discount_color?: string;
1100
- /**
1101
- * - The footer background color.
1102
- */
1103
- footer_bg_color?: string;
1104
- /**
1105
- * - The footer text color.
1106
- */
1107
- footer_text_color?: string;
1108
- /**
1109
- * - The footer border color.
1110
- */
1111
- footer_border_color?: string;
1112
- /**
1113
- * - The footer navigation hover color.
1114
- */
1115
- footer_nav_hover_color?: string;
1116
- /**
1117
- * - Whether to disable the cart or not.
1118
- */
1119
- disable_cart?: boolean;
1120
- /**
1121
- * - Whether the menu is below the logo or not.
1122
- */
1123
- is_menu_below_logo?: boolean;
1124
- /**
1125
- * - The position of the menu.
1126
- */
1127
- menu_position?: string;
1128
- };
1129
- /** @returns {GeneralSetting} */
1130
- declare function GeneralSetting(): GeneralSetting;
1131
- type GeneralSetting = {
1132
- theme?: ThemeSetting;
1133
- text?: TextSetting;
1134
- button?: ButtonSetting;
1135
- sale_discount?: SaleDiscountSetting;
1136
- header?: HeaderSetting;
1137
- footer?: FooterSetting;
1138
- };
1139
- /** @returns {AdvanceSetting} */
1140
- declare function AdvanceSetting(): AdvanceSetting;
1141
- type AdvanceSetting = {
1142
- overlay_popup?: OverlayPopupSetting;
1143
- divider_stroke_highlight?: DividerStrokeHighlightSetting;
1144
- user_alerts?: UserAlertsSetting;
1145
- };
1146
- /** @returns {UserAlertsSetting} */
1147
- declare function UserAlertsSetting(): UserAlertsSetting;
1148
- type UserAlertsSetting = {
1149
- /**
1150
- * - The success background color.
1151
- */
1152
- success_background?: string;
1153
- /**
1154
- * - The success text color.
1155
- */
1156
- success_text?: string;
1157
- /**
1158
- * - The error background color.
1159
- */
1160
- error_background?: string;
1161
- /**
1162
- * - The error text color.
1163
- */
1164
- error_text?: string;
1165
- /**
1166
- * - The info background color.
1167
- */
1168
- info_background?: string;
1169
- /**
1170
- * - The info text color.
1171
- */
1172
- info_text?: string;
1173
- };
1174
- /** @returns {ThemeSetting} */
1175
- declare function ThemeSetting(): ThemeSetting;
1176
- type ThemeSetting = {
1177
- /**
1178
- * - The page background color.
1179
- */
1180
- page_background?: string;
1181
- /**
1182
- * - The theme accent color.
1183
- */
1184
- theme_accent?: string;
1185
- };
1186
- /** @returns {TextSetting} */
1187
- declare function TextSetting(): TextSetting;
1188
- type TextSetting = {
1189
- /**
1190
- * - The text heading color.
1191
- */
1192
- text_heading?: string;
1193
- /**
1194
- * - The text body color.
1195
- */
1196
- text_body?: string;
1197
- /**
1198
- * - The text label color.
1199
- */
1200
- text_label?: string;
1201
- /**
1202
- * - The secondary text color.
1203
- */
1204
- text_secondary?: string;
1205
- };
1206
- /** @returns {ButtonSetting} */
1207
- declare function ButtonSetting(): ButtonSetting;
1208
- type ButtonSetting = {
1209
- /**
1210
- * - The primary button color.
1211
- */
1212
- button_primary?: string;
1213
- /**
1214
- * - The secondary button color.
1215
- */
1216
- button_secondary?: string;
1217
- /**
1218
- * - The button link color.
1219
- */
1220
- button_link?: string;
1221
- };
1222
- /** @returns {SaleDiscountSetting} */
1223
- declare function SaleDiscountSetting(): SaleDiscountSetting;
1224
- type SaleDiscountSetting = {
1225
- /**
1226
- * - The sale badge background color.
1227
- */
1228
- sale_badge_background?: string;
1229
- /**
1230
- * - The sale badge text color.
1231
- */
1232
- sale_badge_text?: string;
1233
- /**
1234
- * - The sale discount text color.
1235
- */
1236
- sale_discount_text?: string;
1237
- /**
1238
- * - The sale timer color.
1239
- */
1240
- sale_timer?: string;
1241
- };
1242
- /** @returns {HeaderSetting} */
1243
- declare function HeaderSetting(): HeaderSetting;
1244
- type HeaderSetting = {
1245
- /**
1246
- * - The header background color.
1247
- */
1248
- header_background?: string;
1249
- /**
1250
- * - The header navigation color.
1251
- */
1252
- header_nav?: string;
1253
- /**
1254
- * - The header icon color.
1255
- */
1256
- header_icon?: string;
1257
- };
1258
- /** @returns {FooterSetting} */
1259
- declare function FooterSetting(): FooterSetting;
1260
- type FooterSetting = {
1261
- /**
1262
- * - The footer background color.
1263
- */
1264
- footer_background?: string;
1265
- /**
1266
- * - The footer bottom background color.
1267
- */
1268
- footer_bottom_background?: string;
1269
- /**
1270
- * - The footer heading text color.
1271
- */
1272
- footer_heading_text?: string;
1273
- /**
1274
- * - The footer body text color.
1275
- */
1276
- footer_body_text?: string;
1277
- /**
1278
- * - The footer icon color.
1279
- */
1280
- footer_icon?: string;
1281
- };
1282
- /** @returns {OverlayPopupSetting} */
1283
- declare function OverlayPopupSetting(): OverlayPopupSetting;
1284
- type OverlayPopupSetting = {
1285
- /**
1286
- * - The dialog background color.
1287
- */
1288
- dialog_backgroung?: string;
1289
- /**
1290
- * - The overlay color.
1291
- */
1292
- overlay?: string;
1293
- };
1294
- /** @returns {DividerStrokeHighlightSetting} */
1295
- declare function DividerStrokeHighlightSetting(): DividerStrokeHighlightSetting;
1296
- type DividerStrokeHighlightSetting = {
1297
- /**
1298
- * - The divider strokes color.
1299
- */
1300
- divider_strokes?: string;
1301
- /**
1302
- * - The highlight color.
1303
- */
1304
- highlight?: string;
1305
- };
1306
- /** @returns {StaticConfig} */
1307
- declare function StaticConfig(): StaticConfig;
1308
- type StaticConfig = {
1309
- props?: StaticProps;
1310
- };
1311
- /** @returns {StaticProps} */
1312
- declare function StaticProps(): StaticProps;
1313
- type StaticProps = {
1314
- colors?: Colors;
1315
- auth?: AuthConfig;
1316
- palette?: PaletteConfig;
1317
- };
1318
- /** @returns {Colors} */
1319
- declare function Colors(): Colors;
1320
- type Colors = {
1321
- /**
1322
- * - The primary color.
1323
- */
1324
- primary_color?: string;
1325
- /**
1326
- * - The secondary color.
1327
- */
1328
- secondary_color?: string;
1329
- /**
1330
- * - The accent color.
1331
- */
1332
- accent_color?: string;
1333
- /**
1334
- * - The link color.
1335
- */
1336
- link_color?: string;
1337
- /**
1338
- * - The secondary button color.
1339
- */
1340
- button_secondary_color?: string;
1341
- /**
1342
- * - The background color.
1343
- */
1344
- bg_color?: string;
1345
- };
1346
- /** @returns {AuthConfig} */
1347
- declare function AuthConfig(): AuthConfig;
1348
- type AuthConfig = {
1349
- /**
1350
- * - Whether to show header authentication or not.
1351
- */
1352
- show_header_auth?: boolean;
1353
- /**
1354
- * - Whether to show footer authentication or not.
1355
- */
1356
- show_footer_auth?: boolean;
1357
- };
1358
- /** @returns {PaletteConfig} */
1359
- declare function PaletteConfig(): PaletteConfig;
1360
- type PaletteConfig = {
1361
- general_setting?: GeneralSetting;
1362
- advance_setting?: AdvanceSetting;
1363
- };
1364
- /** @returns {ThemeMeta} */
1365
- declare function ThemeMeta(): ThemeMeta;
1366
- type ThemeMeta = {
1367
- payment?: ThemePayment;
1368
- /**
1369
- * - The description of the theme.
1370
- */
1371
- description?: string;
1372
- /**
1373
- * - An array of industries associated with the theme.
1374
- */
1375
- industry?: string[];
1376
- release?: Release;
1377
- images?: Images;
1378
- /**
1379
- * - The slug of the theme.
1380
- */
1381
- slug?: string;
1382
- /**
1383
- * - The name of the theme.
1384
- */
1385
- name?: string;
1386
- };
1387
- /** @returns {ThemePayment} */
1388
- declare function ThemePayment(): ThemePayment;
1389
- type ThemePayment = {
1390
- /**
1391
- * - Whether the theme is paid or not.
1392
- */
1393
- is_paid?: boolean;
1394
- /**
1395
- * - The amount of the theme.
1396
- */
1397
- amount?: number;
1398
- };
1399
- /** @returns {Release} */
1400
- declare function Release(): Release;
1401
- type Release = {
1402
- /**
1403
- * - The release notes of the theme.
1404
- */
1405
- notes?: string;
1406
- /**
1407
- * - The version of the theme.
1408
- */
1409
- version?: string;
1410
- };
1411
- /** @returns {Images} */
1412
- declare function Images(): Images;
1413
- type Images = {
1414
- /**
1415
- * - The url of the desktop image.
1416
- */
1417
- desktop?: string;
1418
- /**
1419
- * - The url of the mobile image.
1420
- */
1421
- mobile?: string;
1422
- };
1423
- /** @returns {Assets} */
1424
- declare function Assets(): Assets;
1425
- type Assets = {
1426
- umd_js?: UMDJs;
1427
- common_js?: CommonJS;
1428
- css?: CSS;
1429
- };
1430
- /** @returns {UMDJs} */
1431
- declare function UMDJs(): UMDJs;
1432
- type UMDJs = {
1433
- /**
1434
- * - An array of strings representing urls or links.
1435
- */
1436
- links?: string[];
1437
- };
1438
- /** @returns {CommonJS} */
1439
- declare function CommonJS(): CommonJS;
1440
- type CommonJS = {
1441
- /**
1442
- * - A string representing the url or link to the
1443
- * commonjs module.
1444
- */
1445
- link?: string;
1446
- };
1447
- /** @returns {CSS} */
1448
- declare function CSS(): CSS;
1449
- type CSS = {
1450
- /**
1451
- * - An array of strings representing urls for css assets.
1452
- */
1453
- links?: string[];
1454
- };
1455
- /** @returns {SectionItem} */
1456
- declare function SectionItem(): SectionItem;
1457
- type SectionItem = {
1458
- /**
1459
- * - An array of objects representing properties or
1460
- * attributes of the section item.
1461
- */
1462
- props?: any[];
1463
- /**
1464
- * - An array having blocks of the section.
1465
- */
1466
- blocks?: any[];
1467
- /**
1468
- * - Name of the section.
1469
- */
1470
- name?: string;
1471
- /**
1472
- * - Label for the section.
1473
- */
1474
- label?: string;
1475
- };
1476
- /** @returns {GlobalSchema} */
1477
- declare function GlobalSchema(): GlobalSchema;
1478
- type GlobalSchema = {
1479
- /**
1480
- * - An array of properties associated with the
1481
- * global schema, where each property is represented by an object.
1482
- */
1483
- props?: Prop[];
1484
- };
1485
- /** @returns {Prop} */
1486
- declare function Prop(): Prop;
1487
- type Prop = {
1488
- /**
1489
- * - The type of the property.
1490
- */
1491
- type?: string;
1492
- /**
1493
- * - The category of the property.
1494
- */
1495
- category?: string;
1496
- /**
1497
- * - The id of the property.
1498
- */
1499
- id?: string;
1500
- /**
1501
- * - The label of the property.
1502
- */
1503
- label?: string;
1504
- /**
1505
- * - Additional information about the property.
1506
- */
1507
- info?: string;
1508
- };
1509
- /** @returns {Preset} */
1510
- declare function Preset(): Preset;
1511
- type Preset = {
1512
- /**
1513
- * - An array of pages included in the preset, each
1514
- * represented by an object.
1515
- */
1516
- pages?: Page[];
1517
- };
1518
- /** @returns {Page} */
1519
- declare function Page(): Page;
1520
- type Page = {
1521
- /**
1522
- * - An array of sections included in the page.
1523
- */
1524
- sections?: Section[];
1525
- /**
1526
- * - The value of the page.
1527
- */
1528
- value?: string;
1529
- };
1530
- /** @returns {SectionProps} */
1531
- declare function SectionProps(): SectionProps;
1532
- type SectionProps = {
1533
- title?: TextProp;
1534
- item_margin?: TextProp;
1535
- autoplay?: CheckboxProp;
1536
- slide_interval?: RangeProp;
1537
- };
1538
- /** @returns {SectionPreset} */
1539
- declare function SectionPreset(): SectionPreset;
1540
- type SectionPreset = {
1541
- /**
1542
- * - An array of blocks included in the section preset.
1543
- */
1544
- blocks?: Block[];
1545
- };
1546
- /** @returns {ImagePickerProp} */
1547
- declare function ImagePickerProp(): ImagePickerProp;
1548
- type ImagePickerProp = {
1549
- /**
1550
- * - The type of the property.
1551
- */
1552
- type?: string;
1553
- /**
1554
- * - The value of the image picker property.
1555
- */
1556
- value?: string;
1557
- };
1558
- /** @returns {UrlProp} */
1559
- declare function UrlProp(): UrlProp;
1560
- type UrlProp = {
1561
- /**
1562
- * - The type of the property.
1563
- */
1564
- type?: string;
1565
- /**
1566
- * - The value of the url property.
1567
- */
1568
- value?: string;
1569
- };
1570
- /** @returns {BlockProps} */
1571
- declare function BlockProps(): BlockProps;
1572
- type BlockProps = {
1573
- image?: ImagePickerProp;
1574
- slide_link?: UrlProp;
1575
- };
1576
- /** @returns {TextProp} */
1577
- declare function TextProp(): TextProp;
1578
- type TextProp = {
1579
- /**
1580
- * - The value of the text property.
1581
- */
1582
- value?: string;
1583
- /**
1584
- * - The type of the property.
1585
- */
1586
- type?: string;
1587
- };
1588
- /** @returns {CheckboxProp} */
1589
- declare function CheckboxProp(): CheckboxProp;
1590
- type CheckboxProp = {
1591
- /**
1592
- * - The value of the checkbox property.
1593
- */
1594
- value?: boolean;
1595
- /**
1596
- * - The type of the property.
1597
- */
1598
- type?: string;
1599
- };
1600
- /** @returns {RangeProp} */
1601
- declare function RangeProp(): RangeProp;
1602
- type RangeProp = {
1603
- /**
1604
- * - The value of the range property.
1605
- */
1606
- value?: number;
1607
- /**
1608
- * - The type of the property.
1609
- */
1610
- type?: string;
1611
- };
1612
- /** @returns {Section} */
1613
- declare function Section(): Section;
1614
- type Section = {
1615
- /**
1616
- * - An array of blocks included in the section,
1617
- * each represented by an object conforming to the block schema.
1618
- */
1619
- blocks?: Block[];
1620
- predicate?: Predicate;
1621
- /**
1622
- * - The name of the section.
1623
- */
1624
- name?: string;
1625
- props?: SectionProps;
1626
- preset?: SectionPreset;
1627
- };
1628
- /** @returns {Block} */
1629
- declare function Block(): Block;
1630
- type Block = {
1631
- /**
1632
- * - The type of the block.
1633
- */
1634
- type?: string;
1635
- /**
1636
- * - The name of the block.
1637
- */
1638
- name?: string;
1639
- props?: BlockProps;
1640
- };
1641
- /** @returns {Predicate} */
1642
- declare function Predicate(): Predicate;
1643
- type Predicate = {
1644
- screen?: Screen;
1645
- user?: ThemeUserSchema;
1646
- route?: Route;
1647
- };
1648
- /** @returns {Screen} */
1649
- declare function Screen(): Screen;
1650
- type Screen = {
1651
- /**
1652
- * - True if the screen is a mobile device.
1653
- */
1654
- mobile?: boolean;
1655
- /**
1656
- * - True if the screen is a desktop device.
1657
- */
1658
- desktop?: boolean;
1659
- /**
1660
- * - True if the screen is a tablet device.
1661
- */
1662
- tablet?: boolean;
1663
- };
1664
- /** @returns {ThemeUserSchema} */
1665
- declare function ThemeUserSchema(): ThemeUserSchema;
1666
- type ThemeUserSchema = {
1667
- /**
1668
- * - True if the user is authenticated.
1669
- */
1670
- authenticated?: boolean;
1671
- /**
1672
- * - True if the user is anonymous.
1673
- */
1674
- anonymous?: boolean;
1675
- };
1676
- /** @returns {Route} */
1677
- declare function Route(): Route;
1678
- type Route = {
1679
- /**
1680
- * - The selected route.
1681
- */
1682
- selected?: string;
1683
- /**
1684
- * - The exact url of the route.
1685
- */
1686
- exact_url?: string;
1687
- };
1688
- /** @returns {AvailablePagePlatformPredicate} */
1689
- declare function AvailablePagePlatformPredicate(): AvailablePagePlatformPredicate;
1690
- type AvailablePagePlatformPredicate = {
1691
- /**
1692
- * - Section visibility on ios platform.
1693
- */
1694
- ios?: boolean;
1695
- /**
1696
- * - Section visibility on android platform.
1697
- */
1698
- android?: boolean;
1699
- /**
1700
- * - Section visibility on web platform.
1701
- */
1702
- web?: boolean;
1703
- };
1704
- /** @returns {BlitzkriegInternalServerErrorSchema} */
1705
- declare function BlitzkriegInternalServerErrorSchema(): BlitzkriegInternalServerErrorSchema;
1706
- type BlitzkriegInternalServerErrorSchema = {
1707
- /**
1708
- * - A descriptive message detailing the internal
1709
- * server error.
1710
- */
1711
- message?: string;
1712
- };
1713
- /** @returns {BlitzkriegApiErrorSchema} */
1714
- declare function BlitzkriegApiErrorSchema(): BlitzkriegApiErrorSchema;
1715
- type BlitzkriegApiErrorSchema = {
1716
- /**
1717
- * - A descriptive message detailing the api error.
1718
- */
1719
- message?: string;
1720
- };
1721
- /** @returns {ActionPage} */
1722
- declare function ActionPage(): ActionPage;
1723
- type ActionPage = {
1724
- /**
1725
- * - Parameters that should be considered in path.
1726
- */
1727
- params?: any;
1728
- /**
1729
- * - Query parameter if any to be added to the action.
1730
- */
1731
- query?: any;
1732
- /**
1733
- * - The URL for the action.
1734
- */
1735
- url?: string;
1736
- type: PageType;
1737
- };
1738
- /**
1739
- * Enum: PageType Used By: Theme
1740
- *
1741
- * @returns {PageType}
1742
- */
1743
- declare function PageType(): PageType;
1744
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "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" | "locate-us";