@snagsolutions/sdk 0.1.0-alpha.15 → 0.1.0-alpha.150

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 (426) hide show
  1. package/CHANGELOG.md +1243 -45
  2. package/README.md +17 -29
  3. package/_shims/index.d.ts +2 -0
  4. package/_shims/index.js +5 -1
  5. package/_shims/index.mjs +5 -1
  6. package/core.d.ts +19 -5
  7. package/core.d.ts.map +1 -1
  8. package/core.js +26 -17
  9. package/core.js.map +1 -1
  10. package/core.mjs +27 -18
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +30 -6
  13. package/index.d.ts +30 -6
  14. package/index.d.ts.map +1 -1
  15. package/index.js +36 -11
  16. package/index.js.map +1 -1
  17. package/index.mjs +36 -11
  18. package/index.mjs.map +1 -1
  19. package/package.json +4 -5
  20. package/resource.d.ts +1 -1
  21. package/resource.d.ts.map +1 -1
  22. package/resource.js.map +1 -1
  23. package/resource.mjs.map +1 -1
  24. package/resources/assets.d.ts +64 -0
  25. package/resources/assets.d.ts.map +1 -0
  26. package/resources/assets.js +25 -0
  27. package/resources/assets.js.map +1 -0
  28. package/resources/assets.mjs +21 -0
  29. package/resources/assets.mjs.map +1 -0
  30. package/resources/auctions/auctions.d.ts +285 -0
  31. package/resources/auctions/auctions.d.ts.map +1 -0
  32. package/resources/auctions/auctions.js +76 -0
  33. package/resources/auctions/auctions.js.map +1 -0
  34. package/resources/auctions/auctions.mjs +49 -0
  35. package/resources/auctions/auctions.mjs.map +1 -0
  36. package/resources/auctions/index.d.ts +3 -0
  37. package/resources/auctions/index.d.ts.map +1 -0
  38. package/resources/auctions/index.js +9 -0
  39. package/resources/auctions/index.js.map +1 -0
  40. package/resources/auctions/index.mjs +4 -0
  41. package/resources/auctions/index.mjs.map +1 -0
  42. package/resources/auctions/website-user-attributes/index.d.ts +3 -0
  43. package/resources/auctions/website-user-attributes/index.d.ts.map +1 -0
  44. package/resources/auctions/website-user-attributes/index.js +9 -0
  45. package/resources/auctions/website-user-attributes/index.js.map +1 -0
  46. package/resources/auctions/website-user-attributes/index.mjs +4 -0
  47. package/resources/auctions/website-user-attributes/index.mjs.map +1 -0
  48. package/resources/auctions/website-user-attributes/values.d.ts +122 -0
  49. package/resources/auctions/website-user-attributes/values.d.ts.map +1 -0
  50. package/resources/auctions/website-user-attributes/values.js +49 -0
  51. package/resources/auctions/website-user-attributes/values.js.map +1 -0
  52. package/resources/auctions/website-user-attributes/values.mjs +45 -0
  53. package/resources/auctions/website-user-attributes/values.mjs.map +1 -0
  54. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts +132 -0
  55. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts.map +1 -0
  56. package/resources/auctions/website-user-attributes/website-user-attributes.js +76 -0
  57. package/resources/auctions/website-user-attributes/website-user-attributes.js.map +1 -0
  58. package/resources/auctions/website-user-attributes/website-user-attributes.mjs +49 -0
  59. package/resources/auctions/website-user-attributes/website-user-attributes.mjs.map +1 -0
  60. package/resources/auctions/website-user-attributes.d.ts +2 -0
  61. package/resources/auctions/website-user-attributes.d.ts.map +1 -0
  62. package/resources/auctions/website-user-attributes.js +19 -0
  63. package/resources/auctions/website-user-attributes.js.map +1 -0
  64. package/resources/auctions/website-user-attributes.mjs +3 -0
  65. package/resources/auctions/website-user-attributes.mjs.map +1 -0
  66. package/resources/auctions.d.ts +2 -0
  67. package/resources/auctions.d.ts.map +1 -0
  68. package/resources/{api.js → auctions.js} +2 -2
  69. package/resources/auctions.js.map +1 -0
  70. package/resources/{api.mjs → auctions.mjs} +2 -2
  71. package/resources/auctions.mjs.map +1 -0
  72. package/resources/auth.d.ts +48 -0
  73. package/resources/auth.d.ts.map +1 -0
  74. package/resources/auth.js +16 -0
  75. package/resources/auth.js.map +1 -0
  76. package/resources/auth.mjs +12 -0
  77. package/resources/auth.mjs.map +1 -0
  78. package/resources/index.d.ts +8 -1
  79. package/resources/index.d.ts.map +1 -1
  80. package/resources/index.js +17 -3
  81. package/resources/index.js.map +1 -1
  82. package/resources/index.mjs +8 -1
  83. package/resources/index.mjs.map +1 -1
  84. package/resources/loyalty/account-streaks.d.ts +81 -0
  85. package/resources/loyalty/account-streaks.d.ts.map +1 -0
  86. package/resources/loyalty/account-streaks.js +24 -0
  87. package/resources/loyalty/account-streaks.js.map +1 -0
  88. package/resources/loyalty/account-streaks.mjs +20 -0
  89. package/resources/loyalty/account-streaks.mjs.map +1 -0
  90. package/resources/{api/loyalty → loyalty}/accounts.d.ts +36 -27
  91. package/resources/loyalty/accounts.d.ts.map +1 -0
  92. package/resources/{api/loyalty → loyalty}/accounts.js +17 -4
  93. package/resources/loyalty/accounts.js.map +1 -0
  94. package/resources/loyalty/accounts.mjs +33 -0
  95. package/resources/loyalty/accounts.mjs.map +1 -0
  96. package/resources/{api/loyalty → loyalty}/badges.d.ts +474 -24
  97. package/resources/loyalty/badges.d.ts.map +1 -0
  98. package/resources/{api/loyalty → loyalty}/badges.js +21 -3
  99. package/resources/loyalty/badges.js.map +1 -0
  100. package/resources/{api/loyalty → loyalty}/badges.mjs +21 -3
  101. package/resources/loyalty/badges.mjs.map +1 -0
  102. package/resources/{api/loyalty → loyalty}/currencies.d.ts +27 -2
  103. package/resources/loyalty/currencies.d.ts.map +1 -0
  104. package/resources/loyalty/currencies.js +40 -0
  105. package/resources/loyalty/currencies.js.map +1 -0
  106. package/resources/loyalty/currencies.mjs +36 -0
  107. package/resources/loyalty/currencies.mjs.map +1 -0
  108. package/resources/{api/loyalty → loyalty}/index.d.ts +6 -3
  109. package/resources/loyalty/index.d.ts.map +1 -0
  110. package/resources/{api/loyalty → loyalty}/index.js +7 -1
  111. package/resources/loyalty/index.js.map +1 -0
  112. package/resources/{api/loyalty → loyalty}/index.mjs +4 -1
  113. package/resources/loyalty/index.mjs.map +1 -0
  114. package/resources/loyalty/loyalty.d.ts +50 -0
  115. package/resources/loyalty/loyalty.d.ts.map +1 -0
  116. package/resources/{api/loyalty → loyalty}/loyalty.js +13 -20
  117. package/resources/loyalty/loyalty.js.map +1 -0
  118. package/resources/{api/loyalty → loyalty}/loyalty.mjs +13 -20
  119. package/resources/loyalty/loyalty.mjs.map +1 -0
  120. package/resources/{api/loyalty → loyalty}/multipliers.d.ts +65 -4
  121. package/resources/loyalty/multipliers.d.ts.map +1 -0
  122. package/resources/{api/loyalty → loyalty}/multipliers.js +25 -2
  123. package/resources/loyalty/multipliers.js.map +1 -0
  124. package/resources/{api/loyalty → loyalty}/multipliers.mjs +25 -2
  125. package/resources/loyalty/multipliers.mjs.map +1 -0
  126. package/resources/{api/loyalty → loyalty}/questions-responses.d.ts +41 -2
  127. package/resources/loyalty/questions-responses.d.ts.map +1 -0
  128. package/resources/{api/loyalty → loyalty}/questions-responses.js +11 -2
  129. package/resources/loyalty/questions-responses.js.map +1 -0
  130. package/resources/{api/loyalty → loyalty}/questions-responses.mjs +11 -2
  131. package/resources/loyalty/questions-responses.mjs.map +1 -0
  132. package/resources/{api/loyalty → loyalty}/questions.d.ts +39 -4
  133. package/resources/loyalty/questions.d.ts.map +1 -0
  134. package/resources/loyalty/questions.js +58 -0
  135. package/resources/loyalty/questions.js.map +1 -0
  136. package/resources/loyalty/questions.mjs +54 -0
  137. package/resources/loyalty/questions.mjs.map +1 -0
  138. package/resources/loyalty/rule-edits.d.ts +2904 -0
  139. package/resources/loyalty/rule-edits.d.ts.map +1 -0
  140. package/resources/{api/loyalty → loyalty}/rule-edits.js +15 -1
  141. package/resources/loyalty/rule-edits.js.map +1 -0
  142. package/resources/{api/loyalty → loyalty}/rule-edits.mjs +15 -1
  143. package/resources/loyalty/rule-edits.mjs.map +1 -0
  144. package/resources/{api/loyalty/loyalty.d.ts → loyalty/rule-groups.d.ts} +275 -320
  145. package/resources/loyalty/rule-groups.d.ts.map +1 -0
  146. package/resources/loyalty/rule-groups.js +52 -0
  147. package/resources/loyalty/rule-groups.js.map +1 -0
  148. package/resources/loyalty/rule-groups.mjs +48 -0
  149. package/resources/loyalty/rule-groups.mjs.map +1 -0
  150. package/resources/{api/loyalty → loyalty}/rules.d.ts +1743 -224
  151. package/resources/loyalty/rules.d.ts.map +1 -0
  152. package/resources/loyalty/rules.js +77 -0
  153. package/resources/loyalty/rules.js.map +1 -0
  154. package/resources/loyalty/rules.mjs +73 -0
  155. package/resources/loyalty/rules.mjs.map +1 -0
  156. package/resources/loyalty/transactions/index.d.ts +3 -0
  157. package/resources/loyalty/transactions/index.d.ts.map +1 -0
  158. package/resources/loyalty/transactions/index.js +9 -0
  159. package/resources/loyalty/transactions/index.js.map +1 -0
  160. package/resources/loyalty/transactions/index.mjs +4 -0
  161. package/resources/loyalty/transactions/index.mjs.map +1 -0
  162. package/resources/loyalty/transactions/rule-statuses.d.ts +120 -0
  163. package/resources/loyalty/transactions/rule-statuses.d.ts.map +1 -0
  164. package/resources/loyalty/transactions/rule-statuses.js +30 -0
  165. package/resources/loyalty/transactions/rule-statuses.js.map +1 -0
  166. package/resources/loyalty/transactions/rule-statuses.mjs +26 -0
  167. package/resources/loyalty/transactions/rule-statuses.mjs.map +1 -0
  168. package/resources/loyalty/transactions/transactions.d.ts +410 -0
  169. package/resources/loyalty/transactions/transactions.d.ts.map +1 -0
  170. package/resources/loyalty/transactions/transactions.js +76 -0
  171. package/resources/loyalty/transactions/transactions.js.map +1 -0
  172. package/resources/loyalty/transactions/transactions.mjs +49 -0
  173. package/resources/loyalty/transactions/transactions.mjs.map +1 -0
  174. package/resources/loyalty/transactions.d.ts +2 -0
  175. package/resources/loyalty/transactions.d.ts.map +1 -0
  176. package/resources/loyalty/transactions.js +19 -0
  177. package/resources/loyalty/transactions.js.map +1 -0
  178. package/resources/loyalty/transactions.mjs +3 -0
  179. package/resources/loyalty/transactions.mjs.map +1 -0
  180. package/resources/loyalty.d.ts.map +1 -0
  181. package/resources/loyalty.js.map +1 -0
  182. package/resources/loyalty.mjs.map +1 -0
  183. package/resources/{api/minting.d.ts → minting.d.ts} +7 -7
  184. package/resources/minting.d.ts.map +1 -0
  185. package/resources/{api/minting.js → minting.js} +1 -1
  186. package/resources/minting.js.map +1 -0
  187. package/resources/{api/minting.mjs → minting.mjs} +1 -1
  188. package/resources/minting.mjs.map +1 -0
  189. package/resources/referral/index.d.ts.map +1 -0
  190. package/resources/referral/index.js.map +1 -0
  191. package/resources/referral/index.mjs.map +1 -0
  192. package/resources/{api/referral → referral}/referral.d.ts +13 -5
  193. package/resources/referral/referral.d.ts.map +1 -0
  194. package/resources/{api/referral → referral}/referral.js +12 -6
  195. package/resources/referral/referral.js.map +1 -0
  196. package/resources/{api/referral → referral}/referral.mjs +12 -6
  197. package/resources/referral/referral.mjs.map +1 -0
  198. package/resources/{api/referral → referral}/users.d.ts +30 -3
  199. package/resources/referral/users.d.ts.map +1 -0
  200. package/resources/{api/referral → referral}/users.js +15 -1
  201. package/resources/referral/users.js.map +1 -0
  202. package/resources/{api/referral → referral}/users.mjs +15 -1
  203. package/resources/referral/users.mjs.map +1 -0
  204. package/resources/referral.d.ts.map +1 -0
  205. package/resources/referral.js.map +1 -0
  206. package/resources/referral.mjs.map +1 -0
  207. package/resources/users/index.d.ts +3 -0
  208. package/resources/users/index.d.ts.map +1 -0
  209. package/resources/users/index.js.map +1 -0
  210. package/resources/users/index.mjs.map +1 -0
  211. package/resources/{api/users → users}/metadatas.d.ts +34 -2
  212. package/resources/users/metadatas.d.ts.map +1 -0
  213. package/resources/{api/users → users}/metadatas.js +2 -2
  214. package/resources/users/metadatas.js.map +1 -0
  215. package/resources/{api/users → users}/metadatas.mjs +2 -2
  216. package/resources/users/metadatas.mjs.map +1 -0
  217. package/resources/users/users.d.ts +422 -0
  218. package/resources/users/users.d.ts.map +1 -0
  219. package/resources/{api/users → users}/users.js +61 -2
  220. package/resources/users/users.js.map +1 -0
  221. package/resources/users/users.mjs +89 -0
  222. package/resources/users/users.mjs.map +1 -0
  223. package/resources/users.d.ts.map +1 -0
  224. package/resources/users.js.map +1 -0
  225. package/resources/users.mjs.map +1 -0
  226. package/resources/websites/index.d.ts +4 -0
  227. package/resources/websites/index.d.ts.map +1 -0
  228. package/resources/websites/index.js +11 -0
  229. package/resources/websites/index.js.map +1 -0
  230. package/resources/{api → websites}/index.mjs +0 -5
  231. package/resources/websites/index.mjs.map +1 -0
  232. package/resources/{api → websites}/website-collections.d.ts +22 -1
  233. package/resources/websites/website-collections.d.ts.map +1 -0
  234. package/resources/{api → websites}/website-collections.js +21 -0
  235. package/resources/websites/website-collections.js.map +1 -0
  236. package/resources/websites/website-collections.mjs +42 -0
  237. package/resources/websites/website-collections.mjs.map +1 -0
  238. package/resources/{api → websites}/website-user-roles.d.ts +23 -0
  239. package/resources/websites/website-user-roles.d.ts.map +1 -0
  240. package/resources/{api → websites}/website-user-roles.js +23 -0
  241. package/resources/websites/website-user-roles.js.map +1 -0
  242. package/resources/websites/website-user-roles.mjs +41 -0
  243. package/resources/websites/website-user-roles.mjs.map +1 -0
  244. package/resources/{api → websites}/websites.d.ts +20 -0
  245. package/resources/websites/websites.d.ts.map +1 -0
  246. package/resources/websites/websites.js +63 -0
  247. package/resources/websites/websites.js.map +1 -0
  248. package/resources/websites/websites.mjs +36 -0
  249. package/resources/websites/websites.mjs.map +1 -0
  250. package/resources/websites.d.ts +2 -0
  251. package/resources/websites.d.ts.map +1 -0
  252. package/resources/websites.js +19 -0
  253. package/resources/websites.js.map +1 -0
  254. package/resources/websites.mjs +3 -0
  255. package/resources/websites.mjs.map +1 -0
  256. package/src/_shims/index.d.ts +2 -0
  257. package/src/_shims/index.js +5 -1
  258. package/src/_shims/index.mjs +5 -1
  259. package/src/core.ts +45 -17
  260. package/src/index.ts +126 -24
  261. package/src/resource.ts +1 -1
  262. package/src/resources/assets.ts +93 -0
  263. package/src/resources/auctions/auctions.ts +436 -0
  264. package/src/resources/auctions/index.ts +18 -0
  265. package/src/resources/auctions/website-user-attributes/index.ts +18 -0
  266. package/src/resources/auctions/website-user-attributes/values.ts +165 -0
  267. package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +207 -0
  268. package/src/resources/auctions/website-user-attributes.ts +3 -0
  269. package/src/resources/{api.ts → auctions.ts} +1 -1
  270. package/src/resources/auth.ts +79 -0
  271. package/src/resources/index.ts +37 -8
  272. package/src/resources/loyalty/account-streaks.ts +110 -0
  273. package/src/resources/{api/loyalty → loyalty}/accounts.ts +41 -35
  274. package/src/resources/{api/loyalty → loyalty}/badges.ts +570 -27
  275. package/src/resources/{api/loyalty → loyalty}/currencies.ts +27 -2
  276. package/src/resources/{api/loyalty → loyalty}/index.ts +28 -11
  277. package/src/resources/loyalty/loyalty.ts +259 -0
  278. package/src/resources/{api/loyalty → loyalty}/multipliers.ts +70 -7
  279. package/src/resources/{api/loyalty → loyalty}/questions-responses.ts +48 -3
  280. package/src/resources/{api/loyalty → loyalty}/questions.ts +40 -4
  281. package/src/resources/loyalty/rule-edits.ts +3988 -0
  282. package/src/resources/{api/loyalty/loyalty.ts → loyalty/rule-groups.ts} +437 -550
  283. package/src/resources/{api/loyalty → loyalty}/rules.ts +2906 -530
  284. package/src/resources/loyalty/transactions/index.ts +18 -0
  285. package/src/resources/loyalty/transactions/rule-statuses.ts +178 -0
  286. package/src/resources/loyalty/transactions/transactions.ts +677 -0
  287. package/src/resources/loyalty/transactions.ts +3 -0
  288. package/src/resources/{api/minting.ts → minting.ts} +37 -23
  289. package/src/resources/{api/referral → referral}/referral.ts +15 -13
  290. package/src/resources/{api/referral → referral}/users.ts +35 -4
  291. package/src/resources/{api/users → users}/index.ts +6 -0
  292. package/src/resources/{api/users → users}/metadatas.ts +62 -3
  293. package/src/resources/users/users.ts +603 -0
  294. package/src/resources/websites/index.ts +22 -0
  295. package/src/resources/{api → websites}/website-collections.ts +52 -17
  296. package/src/resources/{api → websites}/website-user-roles.ts +23 -0
  297. package/src/resources/{api → websites}/websites.ts +52 -0
  298. package/src/resources/websites.ts +3 -0
  299. package/src/version.ts +1 -1
  300. package/version.d.ts +1 -1
  301. package/version.d.ts.map +1 -1
  302. package/version.js +1 -1
  303. package/version.js.map +1 -1
  304. package/version.mjs +1 -1
  305. package/version.mjs.map +1 -1
  306. package/resources/api/api.d.ts +0 -365
  307. package/resources/api/api.d.ts.map +0 -1
  308. package/resources/api/api.js +0 -94
  309. package/resources/api/api.js.map +0 -1
  310. package/resources/api/api.mjs +0 -67
  311. package/resources/api/api.mjs.map +0 -1
  312. package/resources/api/index.d.ts +0 -9
  313. package/resources/api/index.d.ts.map +0 -1
  314. package/resources/api/index.js +0 -21
  315. package/resources/api/index.js.map +0 -1
  316. package/resources/api/index.mjs.map +0 -1
  317. package/resources/api/loyalty/accounts.d.ts.map +0 -1
  318. package/resources/api/loyalty/accounts.js.map +0 -1
  319. package/resources/api/loyalty/accounts.mjs +0 -20
  320. package/resources/api/loyalty/accounts.mjs.map +0 -1
  321. package/resources/api/loyalty/badges.d.ts.map +0 -1
  322. package/resources/api/loyalty/badges.js.map +0 -1
  323. package/resources/api/loyalty/badges.mjs.map +0 -1
  324. package/resources/api/loyalty/currencies.d.ts.map +0 -1
  325. package/resources/api/loyalty/currencies.js +0 -21
  326. package/resources/api/loyalty/currencies.js.map +0 -1
  327. package/resources/api/loyalty/currencies.mjs +0 -17
  328. package/resources/api/loyalty/currencies.mjs.map +0 -1
  329. package/resources/api/loyalty/index.d.ts.map +0 -1
  330. package/resources/api/loyalty/index.js.map +0 -1
  331. package/resources/api/loyalty/index.mjs.map +0 -1
  332. package/resources/api/loyalty/loyalty.d.ts.map +0 -1
  333. package/resources/api/loyalty/loyalty.js.map +0 -1
  334. package/resources/api/loyalty/loyalty.mjs.map +0 -1
  335. package/resources/api/loyalty/multipliers.d.ts.map +0 -1
  336. package/resources/api/loyalty/multipliers.js.map +0 -1
  337. package/resources/api/loyalty/multipliers.mjs.map +0 -1
  338. package/resources/api/loyalty/questions-responses.d.ts.map +0 -1
  339. package/resources/api/loyalty/questions-responses.js.map +0 -1
  340. package/resources/api/loyalty/questions-responses.mjs.map +0 -1
  341. package/resources/api/loyalty/questions.d.ts.map +0 -1
  342. package/resources/api/loyalty/questions.js +0 -27
  343. package/resources/api/loyalty/questions.js.map +0 -1
  344. package/resources/api/loyalty/questions.mjs +0 -23
  345. package/resources/api/loyalty/questions.mjs.map +0 -1
  346. package/resources/api/loyalty/rule-edits.d.ts +0 -330
  347. package/resources/api/loyalty/rule-edits.d.ts.map +0 -1
  348. package/resources/api/loyalty/rule-edits.js.map +0 -1
  349. package/resources/api/loyalty/rule-edits.mjs.map +0 -1
  350. package/resources/api/loyalty/rules.d.ts.map +0 -1
  351. package/resources/api/loyalty/rules.js +0 -46
  352. package/resources/api/loyalty/rules.js.map +0 -1
  353. package/resources/api/loyalty/rules.mjs +0 -42
  354. package/resources/api/loyalty/rules.mjs.map +0 -1
  355. package/resources/api/loyalty.d.ts.map +0 -1
  356. package/resources/api/loyalty.js.map +0 -1
  357. package/resources/api/loyalty.mjs.map +0 -1
  358. package/resources/api/minting.d.ts.map +0 -1
  359. package/resources/api/minting.js.map +0 -1
  360. package/resources/api/minting.mjs.map +0 -1
  361. package/resources/api/referral/index.d.ts.map +0 -1
  362. package/resources/api/referral/index.js.map +0 -1
  363. package/resources/api/referral/index.mjs.map +0 -1
  364. package/resources/api/referral/referral.d.ts.map +0 -1
  365. package/resources/api/referral/referral.js.map +0 -1
  366. package/resources/api/referral/referral.mjs.map +0 -1
  367. package/resources/api/referral/users.d.ts.map +0 -1
  368. package/resources/api/referral/users.js.map +0 -1
  369. package/resources/api/referral/users.mjs.map +0 -1
  370. package/resources/api/referral.d.ts.map +0 -1
  371. package/resources/api/referral.js.map +0 -1
  372. package/resources/api/referral.mjs.map +0 -1
  373. package/resources/api/users/index.d.ts +0 -3
  374. package/resources/api/users/index.d.ts.map +0 -1
  375. package/resources/api/users/index.js.map +0 -1
  376. package/resources/api/users/index.mjs.map +0 -1
  377. package/resources/api/users/metadatas.d.ts.map +0 -1
  378. package/resources/api/users/metadatas.js.map +0 -1
  379. package/resources/api/users/metadatas.mjs.map +0 -1
  380. package/resources/api/users/users.d.ts +0 -133
  381. package/resources/api/users/users.d.ts.map +0 -1
  382. package/resources/api/users/users.js.map +0 -1
  383. package/resources/api/users/users.mjs +0 -30
  384. package/resources/api/users/users.mjs.map +0 -1
  385. package/resources/api/users.d.ts.map +0 -1
  386. package/resources/api/users.js.map +0 -1
  387. package/resources/api/users.mjs.map +0 -1
  388. package/resources/api/website-collections.d.ts.map +0 -1
  389. package/resources/api/website-collections.js.map +0 -1
  390. package/resources/api/website-collections.mjs +0 -21
  391. package/resources/api/website-collections.mjs.map +0 -1
  392. package/resources/api/website-user-roles.d.ts.map +0 -1
  393. package/resources/api/website-user-roles.js.map +0 -1
  394. package/resources/api/website-user-roles.mjs +0 -18
  395. package/resources/api/website-user-roles.mjs.map +0 -1
  396. package/resources/api/websites.d.ts.map +0 -1
  397. package/resources/api/websites.js +0 -22
  398. package/resources/api/websites.js.map +0 -1
  399. package/resources/api/websites.mjs +0 -18
  400. package/resources/api/websites.mjs.map +0 -1
  401. package/resources/api.d.ts +0 -2
  402. package/resources/api.d.ts.map +0 -1
  403. package/resources/api.js.map +0 -1
  404. package/resources/api.mjs.map +0 -1
  405. package/src/resources/api/api.ts +0 -629
  406. package/src/resources/api/index.ts +0 -51
  407. package/src/resources/api/loyalty/rule-edits.ts +0 -418
  408. package/src/resources/api/users/users.ts +0 -203
  409. /package/resources/{api/loyalty.d.ts → loyalty.d.ts} +0 -0
  410. /package/resources/{api/loyalty.js → loyalty.js} +0 -0
  411. /package/resources/{api/loyalty.mjs → loyalty.mjs} +0 -0
  412. /package/resources/{api/referral → referral}/index.d.ts +0 -0
  413. /package/resources/{api/referral → referral}/index.js +0 -0
  414. /package/resources/{api/referral → referral}/index.mjs +0 -0
  415. /package/resources/{api/referral.d.ts → referral.d.ts} +0 -0
  416. /package/resources/{api/referral.js → referral.js} +0 -0
  417. /package/resources/{api/referral.mjs → referral.mjs} +0 -0
  418. /package/resources/{api/users → users}/index.js +0 -0
  419. /package/resources/{api/users → users}/index.mjs +0 -0
  420. /package/resources/{api/users.d.ts → users.d.ts} +0 -0
  421. /package/resources/{api/users.js → users.js} +0 -0
  422. /package/resources/{api/users.mjs → users.mjs} +0 -0
  423. /package/src/resources/{api/loyalty.ts → loyalty.ts} +0 -0
  424. /package/src/resources/{api/referral → referral}/index.ts +0 -0
  425. /package/src/resources/{api/referral.ts → referral.ts} +0 -0
  426. /package/src/resources/{api/users.ts → users.ts} +0 -0
@@ -1,36 +1,93 @@
1
- import { APIResource } from "../../../resource.js";
2
- import * as Core from "../../../core.js";
1
+ import { APIResource } from "../../resource.js";
2
+ import * as Core from "../../core.js";
3
3
  export declare class Rules extends APIResource {
4
4
  /**
5
5
  * Create a new Loyalty Rule
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const rule = await client.loyalty.rules.create({
10
+ * amount: '10.5',
11
+ * effectiveEndTime: '2024-12-31T23:59:00Z',
12
+ * effectiveStartTime: '2024-01-01T00:00:00Z',
13
+ * endTime: '2024-12-31T23:59:00Z',
14
+ * frequency: 'daily',
15
+ * loyaltyCurrencyId: '456e1234-e89b-12d3-a456-426614174003',
16
+ * metadata: {},
17
+ * name: 'Referral Bonus Rule',
18
+ * organizationId: '123e4567-e89b-12d3-a456-426614174001',
19
+ * startTime: '2024-01-01T00:00:00Z',
20
+ * type: 'Bonus',
21
+ * websiteId: '123e4567-e89b-12d3-a456-426614174002',
22
+ * });
23
+ * ```
6
24
  */
7
25
  create(body: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
8
26
  /**
9
27
  * Update an existing Loyalty Rule
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const rule = await client.loyalty.rules.update(
32
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
33
+ * {
34
+ * amount: '10.5',
35
+ * endTime: '2024-12-31T23:59:00Z',
36
+ * name: 'Daily Rewards Program',
37
+ * },
38
+ * );
39
+ * ```
10
40
  */
11
41
  update(id: string, body: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
12
42
  /**
13
43
  * Retrieve configured loyalty rules with optional pagination and filters
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * const rules = await client.loyalty.rules.list();
48
+ * ```
14
49
  */
15
50
  list(query?: RuleListParams, options?: Core.RequestOptions): Core.APIPromise<RuleListResponse>;
16
51
  list(options?: Core.RequestOptions): Core.APIPromise<RuleListResponse>;
17
52
  /**
18
53
  * Delete an existing Loyalty Rule
19
- */
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const rule = await client.loyalty.rules.delete(
58
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
59
+ * );
60
+ * ```
61
+ */
62
+ delete(id: string, params?: RuleDeleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
20
63
  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
21
64
  /**
22
65
  * Verify a loyalty rule based on user action and reward them if applicable. This
23
66
  * endpoint currently only supports following rule types code_entry, text_input,
24
67
  * link_click, discord_member, connect_wallet, check_in, external_rule,
25
68
  * drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name,
26
- * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages
69
+ * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages,
70
+ * youtube_subscribers, youtube_comment, steam_wishlist
71
+ *
72
+ * @example
73
+ * ```ts
74
+ * const response = await client.loyalty.rules.complete(
75
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
76
+ * );
77
+ * ```
27
78
  */
28
79
  complete(id: string, body?: RuleCompleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleCompleteResponse>;
29
80
  complete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleCompleteResponse>;
30
81
  /**
31
82
  * This will return the processing status of quests for a specific user
32
- */
33
- getStatus(query: RuleGetStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
83
+ *
84
+ * @example
85
+ * ```ts
86
+ * const response = await client.loyalty.rules.getStatus();
87
+ * ```
88
+ */
89
+ getStatus(query?: RuleGetStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
90
+ getStatus(options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
34
91
  }
35
92
  export interface RuleCreateResponse {
36
93
  id: string;
@@ -77,7 +134,7 @@ export interface RuleCreateResponse {
77
134
  /**
78
135
  * Type of loyalty rule being created
79
136
  */
80
- type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll';
137
+ type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll' | 'steam_wishlist' | 'liquidity_uniswap_v2' | 'liquidity_uniswap_v3' | 'points_airdrop' | 'youtube_subscribers' | 'youtube_comment' | 'shopify_spend' | 'swap' | 'tiktok_post' | 'post_impressions' | 'discord_join' | 'connected_youtube';
81
138
  /**
82
139
  * Unique identifier for the associated website
83
140
  */
@@ -106,6 +163,11 @@ export interface RuleCreateResponse {
106
163
  * Optional detailed description of the rule
107
164
  */
108
165
  description?: string;
166
+ duplicatedFromId?: string | null;
167
+ /**
168
+ * ID of the external integration
169
+ */
170
+ externalIntegrationId?: string | null;
109
171
  /**
110
172
  * Whether to hide this rule in the user interface
111
173
  */
@@ -113,19 +175,41 @@ export interface RuleCreateResponse {
113
175
  /**
114
176
  * Interval between rule executions
115
177
  */
116
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
178
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | null;
117
179
  /**
118
180
  * Whether this rule is mandatory
119
181
  */
120
182
  isRequired?: boolean;
183
+ /**
184
+ * Unique identifier for the loyalty badge
185
+ */
186
+ loyaltyBadgeId?: string | null;
121
187
  /**
122
188
  * Unique identifier for the loyalty rule group
123
189
  */
124
190
  loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
191
+ /**
192
+ * URL for uploading loyalty user allotment via CSV
193
+ */
194
+ loyaltyUserAllotmentCsvUrl?: string;
195
+ /**
196
+ * The interval for the max amount. Available for the smart contract and external
197
+ * rules.
198
+ */
199
+ maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
200
+ /**
201
+ * The maximum amount of points a user can earn per interval. Available for the
202
+ * smart contract and external rules.
203
+ */
204
+ maxAmountPerInterval?: number | null;
205
+ /**
206
+ * URL of the media to be displayed
207
+ */
208
+ mediaUrl?: string | null;
125
209
  /**
126
210
  * Blockchain network where the rule will apply
127
211
  */
128
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
212
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
129
213
  /**
130
214
  * OAuth credentials associated with the rule
131
215
  */
@@ -133,17 +217,29 @@ export interface RuleCreateResponse {
133
217
  /**
134
218
  * Type of reward issued by the rule
135
219
  */
136
- rewardType?: 'points' | 'multiplier';
220
+ rewardType?: 'points' | 'multiplier' | 'badge';
221
+ /**
222
+ * URL of the Shopify store
223
+ */
224
+ shopifyStoreUrl?: string | null;
137
225
  /**
138
- * Identifier for associated subscriptions
226
+ * Whether to show this rule before the start time
139
227
  */
140
- subscriptionIdentifier?: string | null;
228
+ showBeforeStart?: boolean;
229
+ /**
230
+ * Optional subscription id for the rule
231
+ */
232
+ subscriptionId?: string | null;
141
233
  }
142
234
  export declare namespace RuleCreateResponse {
143
235
  /**
144
236
  * Additional metadata for the loyalty rule
145
237
  */
146
238
  interface Metadata {
239
+ /**
240
+ * Number of tokens per batch.
241
+ */
242
+ batchSize?: number | null;
147
243
  /**
148
244
  * Text displayed on the action button.
149
245
  */
@@ -168,6 +264,16 @@ export declare namespace RuleCreateResponse {
168
264
  * Array of collections associated with the rule.
169
265
  */
170
266
  collection?: Array<Metadata.Collection>;
267
+ /**
268
+ * Conditions for completing the profile.
269
+ */
270
+ completeProfileConditions?: {
271
+ [key: string]: boolean;
272
+ } | null;
273
+ /**
274
+ * Description of the external rule condition (only for external rules)
275
+ */
276
+ conditionDescription?: string;
171
277
  /**
172
278
  * Object containing details for the call-to-action.
173
279
  */
@@ -176,6 +282,10 @@ export declare namespace RuleCreateResponse {
176
282
  * API key for custom rewards integration.
177
283
  */
178
284
  customRewardsApiKey?: string;
285
+ /**
286
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
287
+ */
288
+ directRpc?: boolean;
179
289
  /**
180
290
  * Array of Discord servers, channels, and roles to join.
181
291
  */
@@ -196,10 +306,18 @@ export declare namespace RuleCreateResponse {
196
306
  * Flag indicating whether the verified multiplier is enabled.
197
307
  */
198
308
  enableVerifiedMultiplier?: boolean;
309
+ /**
310
+ * Fill source of the order for the token sale
311
+ */
312
+ fillSource?: string;
199
313
  /**
200
314
  * Percentage reward given to a user for their first referral.
201
315
  */
202
316
  firstReferralReward?: number | null;
317
+ /**
318
+ * Flag indicating whether the fill source is included.
319
+ */
320
+ hasFillSource?: boolean;
203
321
  /**
204
322
  * Indicates if the item has never been sold.
205
323
  */
@@ -220,10 +338,18 @@ export declare namespace RuleCreateResponse {
220
338
  * URL of the image associated with the rule.
221
339
  */
222
340
  imageUrl?: string | null;
341
+ /**
342
+ * If enabled, the first transaction done on the platform will complete this rule
343
+ */
344
+ isCheckInOnEveryTxn?: boolean;
223
345
  /**
224
346
  * Indicates if the multiplier has been applied to rewards.
225
347
  */
226
348
  isMultiplierApplied?: boolean;
349
+ /**
350
+ * Flag indicating if the rule is restricted to new users.
351
+ */
352
+ isRestrictedToNewUsers?: boolean;
227
353
  /**
228
354
  * Flag indicating if rewards are applied retroactively.
229
355
  */
@@ -236,6 +362,10 @@ export declare namespace RuleCreateResponse {
236
362
  * Optional link associated with the metadata.
237
363
  */
238
364
  link?: string | null;
365
+ /**
366
+ * Liquidity pool details.
367
+ */
368
+ liquidity?: Metadata.Liquidity;
239
369
  /**
240
370
  * Maximum quantity constraint for token holding.
241
371
  */
@@ -272,6 +402,18 @@ export declare namespace RuleCreateResponse {
272
402
  * Promotional code associated with the rule.
273
403
  */
274
404
  promoCode?: string;
405
+ /**
406
+ * URL of the CSV file containing promo codes.
407
+ */
408
+ promoCodeCsvUrl?: string;
409
+ /**
410
+ * Numbers of the promotional code to be generated.
411
+ */
412
+ promoCodeLength?: number | null;
413
+ /**
414
+ * Type of the promotional code.
415
+ */
416
+ promoCodeType?: 'code' | 'csv' | 'generate';
275
417
  /**
276
418
  * Array defining ranges and corresponding rewards.
277
419
  */
@@ -284,10 +426,43 @@ export declare namespace RuleCreateResponse {
284
426
  * Lump sum reward given to a referrer.
285
427
  */
286
428
  referrerReward?: number | null;
429
+ /**
430
+ * Loyalty currency ID of the referrer reward.
431
+ */
432
+ referrerRewardLoyaltyCurrencyId?: string | null;
433
+ /**
434
+ * Flag indicating if the post link is required.
435
+ */
436
+ requirePostLink?: boolean | null;
437
+ /**
438
+ * Flag indicating if the rule can also reward badges per range.
439
+ */
440
+ rewardBadgePerRange?: boolean;
441
+ /**
442
+ * Flag indicating if the reward is rewarded by batch.
443
+ */
444
+ rewardByBatch?: boolean | null;
445
+ /**
446
+ * Flag indicating if the reward is rewarded per action.
447
+ */
448
+ rewardPerAction?: boolean | null;
287
449
  /**
288
450
  * Flag indicating if rewards are given per impression.
289
451
  */
290
452
  rewardPerImpression?: boolean | null;
453
+ /**
454
+ * Flag indicating if the rule should reward based on value of traded tokens
455
+ * instead of count.
456
+ */
457
+ rewardPerValue?: boolean;
458
+ /**
459
+ * Wallet address of the user can only be used if userId is not provided
460
+ */
461
+ royaltyAddress?: string;
462
+ /**
463
+ * Royalty percentage of the item.
464
+ */
465
+ royaltyPercentage?: number;
291
466
  /**
292
467
  * Currency associated with sales.
293
468
  */
@@ -311,7 +486,7 @@ export declare namespace RuleCreateResponse {
311
486
  /**
312
487
  * Social media platform associated with the rule.
313
488
  */
314
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
489
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
315
490
  /**
316
491
  * URL of the social platform's logo.
317
492
  */
@@ -320,10 +495,18 @@ export declare namespace RuleCreateResponse {
320
495
  * Name of the social platform.
321
496
  */
322
497
  socialPlatformName?: string | null;
498
+ /**
499
+ * ID of the Steam app.
500
+ */
501
+ steamAppId?: string | null;
323
502
  /**
324
503
  * Array of streak milestones and corresponding rewards.
325
504
  */
326
505
  streakArray?: Array<Metadata.StreakArray> | null;
506
+ /**
507
+ * Metadata for swap loyalty rules
508
+ */
509
+ swap?: Metadata.Swap;
327
510
  /**
328
511
  * ID of the Telegram channel.
329
512
  */
@@ -336,6 +519,11 @@ export declare namespace RuleCreateResponse {
336
519
  * Flag indicating if all contracts are tracked.
337
520
  */
338
521
  trackAllContracts?: boolean | null;
522
+ /**
523
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
524
+ * completed once the progress is 100%.
525
+ */
526
+ trackProgress?: boolean | null;
339
527
  /**
340
528
  * URL of the associated Twitter account.
341
529
  */
@@ -371,7 +559,15 @@ export declare namespace RuleCreateResponse {
371
559
  /**
372
560
  * Type of wallet associated with the rule.
373
561
  */
374
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
562
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
563
+ /**
564
+ * ID of the Youtube channel.
565
+ */
566
+ youtubeChannelId?: string | null;
567
+ /**
568
+ * ID of the Youtube video.
569
+ */
570
+ youtubeVideoId?: string | null;
375
571
  }
376
572
  namespace Metadata {
377
573
  interface Collection {
@@ -386,7 +582,7 @@ export declare namespace RuleCreateResponse {
386
582
  /**
387
583
  * Blockchain network of the collection.
388
584
  */
389
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
585
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
390
586
  }
391
587
  /**
392
588
  * Object containing details for the call-to-action.
@@ -451,6 +647,49 @@ export declare namespace RuleCreateResponse {
451
647
  */
452
648
  id: string;
453
649
  }
650
+ /**
651
+ * Liquidity pool details.
652
+ */
653
+ interface Liquidity {
654
+ /**
655
+ * Calculation type of the liquidity pool.
656
+ */
657
+ calculationType?: 'fixed' | 'custom';
658
+ /**
659
+ * Custom function to calculate the the reward amount based on the liquidity
660
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
661
+ * USD.
662
+ */
663
+ customFunction?: string;
664
+ /**
665
+ * Liquidity provided per day in USD
666
+ */
667
+ liquidityPerDay?: number;
668
+ /**
669
+ * Blockchain network of the liquidity pool.
670
+ */
671
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
672
+ /**
673
+ * Indicates if only in-range liquidity is rewarded.
674
+ */
675
+ onlyRewardInRangeLiquidity?: boolean;
676
+ /**
677
+ * Array of liquidity pools associated with the rule.
678
+ */
679
+ pools?: Array<Liquidity.Pool>;
680
+ /**
681
+ * Protocol of the liquidity pool.
682
+ */
683
+ protocol?: string;
684
+ }
685
+ namespace Liquidity {
686
+ interface Pool {
687
+ /**
688
+ * Unique identifier of the liquidity pool.
689
+ */
690
+ id: string;
691
+ }
692
+ }
454
693
  interface Range {
455
694
  /**
456
695
  * Reward amount for this range.
@@ -464,6 +703,14 @@ export declare namespace RuleCreateResponse {
464
703
  * Start value of the range.
465
704
  */
466
705
  startRange: number;
706
+ /**
707
+ * ID of the loyalty badge for this range.
708
+ */
709
+ loyaltyBadgeId?: string;
710
+ /**
711
+ * Amount of the loyalty multiplier for this range.
712
+ */
713
+ loyaltyMultiplierAmount?: number;
467
714
  }
468
715
  /**
469
716
  * Object defining referral requirements.
@@ -507,18 +754,14 @@ export declare namespace RuleCreateResponse {
507
754
  * Object containing details of the associated smart contract.
508
755
  */
509
756
  interface SmartContract {
510
- /**
511
- * ABI of the smart contract.
512
- */
513
- abi?: string | null;
514
757
  /**
515
758
  * Mapping of addresses for the smart contract.
516
759
  */
517
760
  addressMapping?: string | null;
518
761
  /**
519
- * Array of bonus details applied to the rule.
762
+ * Object containing details of the amount multiplier from the event.
520
763
  */
521
- bonus?: Array<SmartContract.Bonus> | null;
764
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
522
765
  /**
523
766
  * ID of the smart contract.
524
767
  */
@@ -527,58 +770,28 @@ export declare namespace RuleCreateResponse {
527
770
  * Criteria to evaluate the smart contract event.
528
771
  */
529
772
  criteria?: 'everyEvent' | 'byParameter' | null;
530
- /**
531
- * Time range applied to the rule.
532
- */
533
- customRange?: SmartContract.CustomRange | null;
534
773
  /**
535
774
  * Event emitted by the smart contract.
536
775
  */
537
776
  event?: string | null;
538
- /**
539
- * Maximum value allowed for the parameter.
540
- */
541
- max?: number | null;
542
777
  /**
543
778
  * Array of parameters for the smart contract.
544
779
  */
545
780
  params?: Array<SmartContract.Param> | null;
546
781
  /**
547
- * Flag indicating if a bonus is applied.
548
- */
549
- withBonus?: boolean | null;
550
- /**
551
- * Flag indicating if a custom range is applied.
552
- */
553
- withCustomRange?: boolean | null;
554
- /**
555
- * Flag indicating if a maximum limit is applied.
782
+ * Type of the smart contract interaction.
556
783
  */
557
- withMax?: boolean | null;
784
+ type?: 'function' | 'event' | null;
558
785
  }
559
786
  namespace SmartContract {
560
- interface Bonus {
561
- /**
562
- * Amount of the bonus.
563
- */
564
- amount?: number | null;
565
- /**
566
- * Number of times the bonus is applied.
567
- */
568
- count?: number | null;
569
- }
570
787
  /**
571
- * Time range applied to the rule.
788
+ * Object containing details of the amount multiplier from the event.
572
789
  */
573
- interface CustomRange {
574
- /**
575
- * End time of the custom range.
576
- */
577
- endsAt?: string | null;
790
+ interface AmountMultiplier {
578
791
  /**
579
- * Start time of the custom range.
792
+ * Mapping of the value for the smart contract.
580
793
  */
581
- startsAt?: string | null;
794
+ valueMapping?: string | null;
582
795
  }
583
796
  interface Param {
584
797
  /**
@@ -615,6 +828,24 @@ export declare namespace RuleCreateResponse {
615
828
  */
616
829
  streakMilestone: number;
617
830
  }
831
+ /**
832
+ * Metadata for swap loyalty rules
833
+ */
834
+ interface Swap {
835
+ provider?: 'any' | 'relay' | 'lifi';
836
+ relayReferrerId?: string;
837
+ requireCrossChainSwap?: boolean;
838
+ swappedToChain?: 'any' | number | string;
839
+ swappedToTokens?: Array<Swap.SwappedToToken>;
840
+ tokenMode?: 'any' | 'specific';
841
+ trackTokenAmount?: boolean;
842
+ }
843
+ namespace Swap {
844
+ interface SwappedToToken {
845
+ address: string;
846
+ chainId: string;
847
+ }
848
+ }
618
849
  }
619
850
  interface Collection {
620
851
  /**
@@ -624,7 +855,11 @@ export declare namespace RuleCreateResponse {
624
855
  /**
625
856
  * Blockchain network for the collection
626
857
  */
627
- network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
858
+ network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
859
+ /**
860
+ * Symbol of the collection.
861
+ */
862
+ symbol?: string;
628
863
  }
629
864
  }
630
865
  export interface RuleUpdateResponse {
@@ -669,6 +904,10 @@ export interface RuleUpdateResponse {
669
904
  * Effective start time of the rule
670
905
  */
671
906
  effectiveStartTime?: string | null;
907
+ /**
908
+ * ID of the external integration
909
+ */
910
+ externalIntegrationId?: string | null;
672
911
  /**
673
912
  * Frequency of the rule execution
674
913
  */
@@ -680,7 +919,7 @@ export interface RuleUpdateResponse {
680
919
  /**
681
920
  * Time interval for recurring rule execution
682
921
  */
683
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
922
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | null;
684
923
  /**
685
924
  * Whether this rule is required for participation
686
925
  */
@@ -689,6 +928,20 @@ export interface RuleUpdateResponse {
689
928
  * ID of the rule group section to associate with the rule
690
929
  */
691
930
  loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
931
+ /**
932
+ * The interval for the max amount. Available for the smart contract and external
933
+ * rules.
934
+ */
935
+ maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
936
+ /**
937
+ * The maximum amount of points a user can earn per interval. Available for the
938
+ * smart contract and external rules.
939
+ */
940
+ maxAmountPerInterval?: number | null;
941
+ /**
942
+ * URL of the media to be displayed
943
+ */
944
+ mediaUrl?: string | null;
692
945
  /**
693
946
  * Additional metadata for the loyalty rule
694
947
  */
@@ -696,7 +949,7 @@ export interface RuleUpdateResponse {
696
949
  /**
697
950
  * Blockchain network where the rule will apply
698
951
  */
699
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
952
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
700
953
  /**
701
954
  * ID for associated OAuth credentials
702
955
  */
@@ -704,15 +957,23 @@ export interface RuleUpdateResponse {
704
957
  /**
705
958
  * Type of reward issued by this rule
706
959
  */
707
- rewardType?: 'points' | 'multiplier';
960
+ rewardType?: 'points' | 'multiplier' | 'badge';
961
+ /**
962
+ * URL of the Shopify store
963
+ */
964
+ shopifyStoreUrl?: string | null;
965
+ /**
966
+ * Whether to show this rule before the start time
967
+ */
968
+ showBeforeStart?: boolean;
708
969
  /**
709
970
  * Start time for the loyalty rule
710
971
  */
711
972
  startTime?: string | null;
712
973
  /**
713
- * Optional subscription identifier for the rule
974
+ * Optional subscription id for the rule
714
975
  */
715
- subscriptionIdentifier?: string | null;
976
+ subscriptionId?: string | null;
716
977
  }
717
978
  export declare namespace RuleUpdateResponse {
718
979
  interface Collection {
@@ -723,12 +984,20 @@ export declare namespace RuleUpdateResponse {
723
984
  /**
724
985
  * Blockchain network for the collection
725
986
  */
726
- network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
987
+ network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
988
+ /**
989
+ * Symbol of the collection.
990
+ */
991
+ symbol?: string;
727
992
  }
728
993
  /**
729
994
  * Additional metadata for the loyalty rule
730
995
  */
731
996
  interface Metadata {
997
+ /**
998
+ * Number of tokens per batch.
999
+ */
1000
+ batchSize?: number | null;
732
1001
  /**
733
1002
  * Text displayed on the action button.
734
1003
  */
@@ -753,6 +1022,16 @@ export declare namespace RuleUpdateResponse {
753
1022
  * Array of collections associated with the rule.
754
1023
  */
755
1024
  collection?: Array<Metadata.Collection>;
1025
+ /**
1026
+ * Conditions for completing the profile.
1027
+ */
1028
+ completeProfileConditions?: {
1029
+ [key: string]: boolean;
1030
+ } | null;
1031
+ /**
1032
+ * Description of the external rule condition (only for external rules)
1033
+ */
1034
+ conditionDescription?: string;
756
1035
  /**
757
1036
  * Object containing details for the call-to-action.
758
1037
  */
@@ -761,6 +1040,10 @@ export declare namespace RuleUpdateResponse {
761
1040
  * API key for custom rewards integration.
762
1041
  */
763
1042
  customRewardsApiKey?: string;
1043
+ /**
1044
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
1045
+ */
1046
+ directRpc?: boolean;
764
1047
  /**
765
1048
  * Array of Discord servers, channels, and roles to join.
766
1049
  */
@@ -781,10 +1064,18 @@ export declare namespace RuleUpdateResponse {
781
1064
  * Flag indicating whether the verified multiplier is enabled.
782
1065
  */
783
1066
  enableVerifiedMultiplier?: boolean;
1067
+ /**
1068
+ * Fill source of the order for the token sale
1069
+ */
1070
+ fillSource?: string;
784
1071
  /**
785
1072
  * Percentage reward given to a user for their first referral.
786
1073
  */
787
1074
  firstReferralReward?: number | null;
1075
+ /**
1076
+ * Flag indicating whether the fill source is included.
1077
+ */
1078
+ hasFillSource?: boolean;
788
1079
  /**
789
1080
  * Indicates if the item has never been sold.
790
1081
  */
@@ -805,10 +1096,18 @@ export declare namespace RuleUpdateResponse {
805
1096
  * URL of the image associated with the rule.
806
1097
  */
807
1098
  imageUrl?: string | null;
1099
+ /**
1100
+ * If enabled, the first transaction done on the platform will complete this rule
1101
+ */
1102
+ isCheckInOnEveryTxn?: boolean;
808
1103
  /**
809
1104
  * Indicates if the multiplier has been applied to rewards.
810
1105
  */
811
1106
  isMultiplierApplied?: boolean;
1107
+ /**
1108
+ * Flag indicating if the rule is restricted to new users.
1109
+ */
1110
+ isRestrictedToNewUsers?: boolean;
812
1111
  /**
813
1112
  * Flag indicating if rewards are applied retroactively.
814
1113
  */
@@ -821,6 +1120,10 @@ export declare namespace RuleUpdateResponse {
821
1120
  * Optional link associated with the metadata.
822
1121
  */
823
1122
  link?: string | null;
1123
+ /**
1124
+ * Liquidity pool details.
1125
+ */
1126
+ liquidity?: Metadata.Liquidity;
824
1127
  /**
825
1128
  * Maximum quantity constraint for token holding.
826
1129
  */
@@ -857,6 +1160,18 @@ export declare namespace RuleUpdateResponse {
857
1160
  * Promotional code associated with the rule.
858
1161
  */
859
1162
  promoCode?: string;
1163
+ /**
1164
+ * URL of the CSV file containing promo codes.
1165
+ */
1166
+ promoCodeCsvUrl?: string;
1167
+ /**
1168
+ * Numbers of the promotional code to be generated.
1169
+ */
1170
+ promoCodeLength?: number | null;
1171
+ /**
1172
+ * Type of the promotional code.
1173
+ */
1174
+ promoCodeType?: 'code' | 'csv' | 'generate';
860
1175
  /**
861
1176
  * Array defining ranges and corresponding rewards.
862
1177
  */
@@ -869,10 +1184,43 @@ export declare namespace RuleUpdateResponse {
869
1184
  * Lump sum reward given to a referrer.
870
1185
  */
871
1186
  referrerReward?: number | null;
1187
+ /**
1188
+ * Loyalty currency ID of the referrer reward.
1189
+ */
1190
+ referrerRewardLoyaltyCurrencyId?: string | null;
1191
+ /**
1192
+ * Flag indicating if the post link is required.
1193
+ */
1194
+ requirePostLink?: boolean | null;
1195
+ /**
1196
+ * Flag indicating if the rule can also reward badges per range.
1197
+ */
1198
+ rewardBadgePerRange?: boolean;
1199
+ /**
1200
+ * Flag indicating if the reward is rewarded by batch.
1201
+ */
1202
+ rewardByBatch?: boolean | null;
1203
+ /**
1204
+ * Flag indicating if the reward is rewarded per action.
1205
+ */
1206
+ rewardPerAction?: boolean | null;
872
1207
  /**
873
1208
  * Flag indicating if rewards are given per impression.
874
1209
  */
875
1210
  rewardPerImpression?: boolean | null;
1211
+ /**
1212
+ * Flag indicating if the rule should reward based on value of traded tokens
1213
+ * instead of count.
1214
+ */
1215
+ rewardPerValue?: boolean;
1216
+ /**
1217
+ * Wallet address of the user can only be used if userId is not provided
1218
+ */
1219
+ royaltyAddress?: string;
1220
+ /**
1221
+ * Royalty percentage of the item.
1222
+ */
1223
+ royaltyPercentage?: number;
876
1224
  /**
877
1225
  * Currency associated with sales.
878
1226
  */
@@ -896,7 +1244,7 @@ export declare namespace RuleUpdateResponse {
896
1244
  /**
897
1245
  * Social media platform associated with the rule.
898
1246
  */
899
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
1247
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
900
1248
  /**
901
1249
  * URL of the social platform's logo.
902
1250
  */
@@ -905,10 +1253,18 @@ export declare namespace RuleUpdateResponse {
905
1253
  * Name of the social platform.
906
1254
  */
907
1255
  socialPlatformName?: string | null;
1256
+ /**
1257
+ * ID of the Steam app.
1258
+ */
1259
+ steamAppId?: string | null;
908
1260
  /**
909
1261
  * Array of streak milestones and corresponding rewards.
910
1262
  */
911
1263
  streakArray?: Array<Metadata.StreakArray> | null;
1264
+ /**
1265
+ * Metadata for swap loyalty rules
1266
+ */
1267
+ swap?: Metadata.Swap;
912
1268
  /**
913
1269
  * ID of the Telegram channel.
914
1270
  */
@@ -921,6 +1277,11 @@ export declare namespace RuleUpdateResponse {
921
1277
  * Flag indicating if all contracts are tracked.
922
1278
  */
923
1279
  trackAllContracts?: boolean | null;
1280
+ /**
1281
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
1282
+ * completed once the progress is 100%.
1283
+ */
1284
+ trackProgress?: boolean | null;
924
1285
  /**
925
1286
  * URL of the associated Twitter account.
926
1287
  */
@@ -956,7 +1317,15 @@ export declare namespace RuleUpdateResponse {
956
1317
  /**
957
1318
  * Type of wallet associated with the rule.
958
1319
  */
959
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
1320
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
1321
+ /**
1322
+ * ID of the Youtube channel.
1323
+ */
1324
+ youtubeChannelId?: string | null;
1325
+ /**
1326
+ * ID of the Youtube video.
1327
+ */
1328
+ youtubeVideoId?: string | null;
960
1329
  }
961
1330
  namespace Metadata {
962
1331
  interface Collection {
@@ -971,7 +1340,7 @@ export declare namespace RuleUpdateResponse {
971
1340
  /**
972
1341
  * Blockchain network of the collection.
973
1342
  */
974
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
1343
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
975
1344
  }
976
1345
  /**
977
1346
  * Object containing details for the call-to-action.
@@ -1036,6 +1405,49 @@ export declare namespace RuleUpdateResponse {
1036
1405
  */
1037
1406
  id: string;
1038
1407
  }
1408
+ /**
1409
+ * Liquidity pool details.
1410
+ */
1411
+ interface Liquidity {
1412
+ /**
1413
+ * Calculation type of the liquidity pool.
1414
+ */
1415
+ calculationType?: 'fixed' | 'custom';
1416
+ /**
1417
+ * Custom function to calculate the the reward amount based on the liquidity
1418
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
1419
+ * USD.
1420
+ */
1421
+ customFunction?: string;
1422
+ /**
1423
+ * Liquidity provided per day in USD
1424
+ */
1425
+ liquidityPerDay?: number;
1426
+ /**
1427
+ * Blockchain network of the liquidity pool.
1428
+ */
1429
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
1430
+ /**
1431
+ * Indicates if only in-range liquidity is rewarded.
1432
+ */
1433
+ onlyRewardInRangeLiquidity?: boolean;
1434
+ /**
1435
+ * Array of liquidity pools associated with the rule.
1436
+ */
1437
+ pools?: Array<Liquidity.Pool>;
1438
+ /**
1439
+ * Protocol of the liquidity pool.
1440
+ */
1441
+ protocol?: string;
1442
+ }
1443
+ namespace Liquidity {
1444
+ interface Pool {
1445
+ /**
1446
+ * Unique identifier of the liquidity pool.
1447
+ */
1448
+ id: string;
1449
+ }
1450
+ }
1039
1451
  interface Range {
1040
1452
  /**
1041
1453
  * Reward amount for this range.
@@ -1049,6 +1461,14 @@ export declare namespace RuleUpdateResponse {
1049
1461
  * Start value of the range.
1050
1462
  */
1051
1463
  startRange: number;
1464
+ /**
1465
+ * ID of the loyalty badge for this range.
1466
+ */
1467
+ loyaltyBadgeId?: string;
1468
+ /**
1469
+ * Amount of the loyalty multiplier for this range.
1470
+ */
1471
+ loyaltyMultiplierAmount?: number;
1052
1472
  }
1053
1473
  /**
1054
1474
  * Object defining referral requirements.
@@ -1092,18 +1512,14 @@ export declare namespace RuleUpdateResponse {
1092
1512
  * Object containing details of the associated smart contract.
1093
1513
  */
1094
1514
  interface SmartContract {
1095
- /**
1096
- * ABI of the smart contract.
1097
- */
1098
- abi?: string | null;
1099
1515
  /**
1100
1516
  * Mapping of addresses for the smart contract.
1101
1517
  */
1102
1518
  addressMapping?: string | null;
1103
1519
  /**
1104
- * Array of bonus details applied to the rule.
1520
+ * Object containing details of the amount multiplier from the event.
1105
1521
  */
1106
- bonus?: Array<SmartContract.Bonus> | null;
1522
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
1107
1523
  /**
1108
1524
  * ID of the smart contract.
1109
1525
  */
@@ -1112,58 +1528,28 @@ export declare namespace RuleUpdateResponse {
1112
1528
  * Criteria to evaluate the smart contract event.
1113
1529
  */
1114
1530
  criteria?: 'everyEvent' | 'byParameter' | null;
1115
- /**
1116
- * Time range applied to the rule.
1117
- */
1118
- customRange?: SmartContract.CustomRange | null;
1119
1531
  /**
1120
1532
  * Event emitted by the smart contract.
1121
1533
  */
1122
1534
  event?: string | null;
1123
- /**
1124
- * Maximum value allowed for the parameter.
1125
- */
1126
- max?: number | null;
1127
1535
  /**
1128
1536
  * Array of parameters for the smart contract.
1129
1537
  */
1130
1538
  params?: Array<SmartContract.Param> | null;
1131
1539
  /**
1132
- * Flag indicating if a bonus is applied.
1133
- */
1134
- withBonus?: boolean | null;
1135
- /**
1136
- * Flag indicating if a custom range is applied.
1137
- */
1138
- withCustomRange?: boolean | null;
1139
- /**
1140
- * Flag indicating if a maximum limit is applied.
1540
+ * Type of the smart contract interaction.
1141
1541
  */
1142
- withMax?: boolean | null;
1542
+ type?: 'function' | 'event' | null;
1143
1543
  }
1144
1544
  namespace SmartContract {
1145
- interface Bonus {
1146
- /**
1147
- * Amount of the bonus.
1148
- */
1149
- amount?: number | null;
1150
- /**
1151
- * Number of times the bonus is applied.
1152
- */
1153
- count?: number | null;
1154
- }
1155
1545
  /**
1156
- * Time range applied to the rule.
1546
+ * Object containing details of the amount multiplier from the event.
1157
1547
  */
1158
- interface CustomRange {
1159
- /**
1160
- * End time of the custom range.
1161
- */
1162
- endsAt?: string | null;
1548
+ interface AmountMultiplier {
1163
1549
  /**
1164
- * Start time of the custom range.
1550
+ * Mapping of the value for the smart contract.
1165
1551
  */
1166
- startsAt?: string | null;
1552
+ valueMapping?: string | null;
1167
1553
  }
1168
1554
  interface Param {
1169
1555
  /**
@@ -1200,6 +1586,24 @@ export declare namespace RuleUpdateResponse {
1200
1586
  */
1201
1587
  streakMilestone: number;
1202
1588
  }
1589
+ /**
1590
+ * Metadata for swap loyalty rules
1591
+ */
1592
+ interface Swap {
1593
+ provider?: 'any' | 'relay' | 'lifi';
1594
+ relayReferrerId?: string;
1595
+ requireCrossChainSwap?: boolean;
1596
+ swappedToChain?: 'any' | number | string;
1597
+ swappedToTokens?: Array<Swap.SwappedToToken>;
1598
+ tokenMode?: 'any' | 'specific';
1599
+ trackTokenAmount?: boolean;
1600
+ }
1601
+ namespace Swap {
1602
+ interface SwappedToToken {
1603
+ address: string;
1604
+ chainId: string;
1605
+ }
1606
+ }
1203
1607
  }
1204
1608
  }
1205
1609
  export interface RuleListResponse {
@@ -1207,9 +1611,6 @@ export interface RuleListResponse {
1207
1611
  hasNextPage: boolean;
1208
1612
  }
1209
1613
  export declare namespace RuleListResponse {
1210
- /**
1211
- * Schema for a loyalty rule
1212
- */
1213
1614
  interface Data {
1214
1615
  /**
1215
1616
  * Unique identifier for the loyalty rule
@@ -1227,14 +1628,38 @@ export declare namespace RuleListResponse {
1227
1628
  * Timestamp when the loyalty rule was deleted (if applicable)
1228
1629
  */
1229
1630
  deletedAt: string | null;
1631
+ /**
1632
+ * Description of the loyalty rule
1633
+ */
1634
+ description: string;
1635
+ /**
1636
+ * End time of the loyalty rule
1637
+ */
1638
+ endTime: string;
1230
1639
  /**
1231
1640
  * Frequency of the loyalty rule
1232
1641
  */
1233
1642
  frequency: string;
1643
+ /**
1644
+ * Chains attached to the loyalty rule
1645
+ */
1646
+ loyaltyRuleChain: Array<Data.LoyaltyRuleChain>;
1647
+ /**
1648
+ * Name of the loyalty rule
1649
+ */
1650
+ name: string;
1234
1651
  /**
1235
1652
  * Unique identifier for the organization
1236
1653
  */
1237
1654
  organizationId: string;
1655
+ /**
1656
+ * Type of the reward
1657
+ */
1658
+ rewardType: 'points' | 'multiplier' | 'badge';
1659
+ /**
1660
+ * Start time of the loyalty rule
1661
+ */
1662
+ startTime: string;
1238
1663
  /**
1239
1664
  * Type of the loyalty rule
1240
1665
  */
@@ -1251,10 +1676,711 @@ export declare namespace RuleListResponse {
1251
1676
  * Optional address of the collection
1252
1677
  */
1253
1678
  collectionAddress?: string;
1679
+ /**
1680
+ * URL of the media associated with the loyalty rule
1681
+ */
1682
+ mediaUrl?: string | null;
1254
1683
  /**
1255
1684
  * Optional metadata for the loyalty rule
1256
1685
  */
1257
- metadata?: Record<string, unknown>;
1686
+ metadata?: {
1687
+ [key: string]: Data.Metadata;
1688
+ };
1689
+ }
1690
+ namespace Data {
1691
+ interface LoyaltyRuleChain {
1692
+ /**
1693
+ * Unique identifier for the rule chain
1694
+ */
1695
+ id: string;
1696
+ loyaltyConditions: Array<LoyaltyRuleChain.LoyaltyCondition>;
1697
+ /**
1698
+ * Unique identifier for the loyalty rule
1699
+ */
1700
+ loyaltyRuleId: string;
1701
+ /**
1702
+ * Name of the rule chain
1703
+ */
1704
+ name: string;
1705
+ }
1706
+ namespace LoyaltyRuleChain {
1707
+ interface LoyaltyCondition {
1708
+ /**
1709
+ * Unique identifier for the condition
1710
+ */
1711
+ id: string;
1712
+ /**
1713
+ * Amount of the condition
1714
+ */
1715
+ amount: number | null;
1716
+ association: Array<LoyaltyCondition.Association>;
1717
+ /**
1718
+ * URL of the CSV file
1719
+ */
1720
+ csvUrl: string | null;
1721
+ /**
1722
+ * Description of the condition
1723
+ */
1724
+ description: string | null;
1725
+ /**
1726
+ * Number of times the condition must be met
1727
+ */
1728
+ repeatCount: number | null;
1729
+ /**
1730
+ * Number of times the condition must be met
1731
+ */
1732
+ requiredCount: number | null;
1733
+ /**
1734
+ * Type of the condition
1735
+ */
1736
+ type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
1737
+ }
1738
+ namespace LoyaltyCondition {
1739
+ interface Association {
1740
+ /**
1741
+ * Unique identifier for the association
1742
+ */
1743
+ id: string;
1744
+ /**
1745
+ * Unique identifier for the loyalty badge
1746
+ */
1747
+ loyaltyBadgeId: string | null;
1748
+ /**
1749
+ * Unique identifier for the loyalty currency
1750
+ */
1751
+ loyaltyCurrencyId: string | null;
1752
+ loyaltyRule: Association.LoyaltyRule | null;
1753
+ /**
1754
+ * Unique identifier for the loyalty rule group
1755
+ */
1756
+ loyaltyRuleGroupId: string | null;
1757
+ /**
1758
+ * Unique identifier for the loyalty rule
1759
+ */
1760
+ loyaltyRuleId: string | null;
1761
+ }
1762
+ namespace Association {
1763
+ interface LoyaltyRule {
1764
+ /**
1765
+ * Name of the loyalty rule
1766
+ */
1767
+ name: string;
1768
+ }
1769
+ }
1770
+ }
1771
+ }
1772
+ interface Metadata {
1773
+ /**
1774
+ * Number of tokens per batch.
1775
+ */
1776
+ batchSize?: number | null;
1777
+ /**
1778
+ * Text displayed on the action button.
1779
+ */
1780
+ buttonText?: string | null;
1781
+ /**
1782
+ * Flag indicating if commenting is required.
1783
+ */
1784
+ checkComment?: boolean | null;
1785
+ /**
1786
+ * Flag indicating if liking the post is required.
1787
+ */
1788
+ checkLike?: boolean | null;
1789
+ /**
1790
+ * Flag indicating if reposting is required.
1791
+ */
1792
+ checkRepost?: boolean | null;
1793
+ /**
1794
+ * Text to check in the Twitter post, username, or bio.
1795
+ */
1796
+ checkText?: string | null;
1797
+ /**
1798
+ * Array of collections associated with the rule.
1799
+ */
1800
+ collection?: Array<Metadata.Collection>;
1801
+ /**
1802
+ * Conditions for completing the profile.
1803
+ */
1804
+ completeProfileConditions?: {
1805
+ [key: string]: boolean;
1806
+ } | null;
1807
+ /**
1808
+ * Description of the external rule condition (only for external rules)
1809
+ */
1810
+ conditionDescription?: string;
1811
+ /**
1812
+ * Object containing details for the call-to-action.
1813
+ */
1814
+ cta?: Metadata.Cta | null;
1815
+ /**
1816
+ * API key for custom rewards integration.
1817
+ */
1818
+ customRewardsApiKey?: string;
1819
+ /**
1820
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
1821
+ */
1822
+ directRpc?: boolean;
1823
+ /**
1824
+ * Array of Discord servers, channels, and roles to join.
1825
+ */
1826
+ discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
1827
+ /**
1828
+ * Array of drip quests required to complete the rule.
1829
+ */
1830
+ dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
1831
+ /**
1832
+ * Flag indicating whether joining Discord servers is required.
1833
+ */
1834
+ enableJoinDiscordServers?: boolean | null;
1835
+ /**
1836
+ * Flag indicating whether streaks are enabled.
1837
+ */
1838
+ enableStreaks?: boolean | null;
1839
+ /**
1840
+ * Flag indicating whether the verified multiplier is enabled.
1841
+ */
1842
+ enableVerifiedMultiplier?: boolean;
1843
+ /**
1844
+ * Fill source of the order for the token sale
1845
+ */
1846
+ fillSource?: string;
1847
+ /**
1848
+ * Percentage reward given to a user for their first referral.
1849
+ */
1850
+ firstReferralReward?: number | null;
1851
+ /**
1852
+ * Flag indicating whether the fill source is included.
1853
+ */
1854
+ hasFillSource?: boolean;
1855
+ /**
1856
+ * Indicates if the item has never been sold.
1857
+ */
1858
+ hasNeverSold?: boolean;
1859
+ /**
1860
+ * Indicates if the full royalty has been paid for items.
1861
+ */
1862
+ hasPaidFullRoyalty?: boolean;
1863
+ /**
1864
+ * Flag indicating if the sale currency is included.
1865
+ */
1866
+ hasSaleCurrency?: boolean;
1867
+ /**
1868
+ * Indicates if the user has a verified Twitter account.
1869
+ */
1870
+ hasVerifiedTwitter?: boolean;
1871
+ /**
1872
+ * URL of the image associated with the rule.
1873
+ */
1874
+ imageUrl?: string | null;
1875
+ /**
1876
+ * If enabled, the first transaction done on the platform will complete this rule
1877
+ */
1878
+ isCheckInOnEveryTxn?: boolean;
1879
+ /**
1880
+ * Indicates if the multiplier has been applied to rewards.
1881
+ */
1882
+ isMultiplierApplied?: boolean;
1883
+ /**
1884
+ * Flag indicating if the rule is restricted to new users.
1885
+ */
1886
+ isRestrictedToNewUsers?: boolean;
1887
+ /**
1888
+ * Flag indicating if rewards are applied retroactively.
1889
+ */
1890
+ isRetroactive?: boolean | null;
1891
+ /**
1892
+ * Flag indicating if the token hold multiplier is applied.
1893
+ */
1894
+ isTokenHoldMultiplier?: boolean;
1895
+ /**
1896
+ * Optional link associated with the metadata.
1897
+ */
1898
+ link?: string | null;
1899
+ /**
1900
+ * Liquidity pool details.
1901
+ */
1902
+ liquidity?: Metadata.Liquidity;
1903
+ /**
1904
+ * Maximum quantity constraint for token holding.
1905
+ */
1906
+ maxQty?: number | null;
1907
+ /**
1908
+ * Minimum quantity constraint for token holding.
1909
+ */
1910
+ minQty?: number | null;
1911
+ /**
1912
+ * Array of loyalty currency IDs used for multipliers.
1913
+ */
1914
+ multiplierLoyaltyCurrencyIds?: Array<string> | null;
1915
+ /**
1916
+ * Flag indicating whether to include only known users.
1917
+ */
1918
+ onlyKnownUsers?: boolean;
1919
+ /**
1920
+ * Flag indicating whether to include only native tokens.
1921
+ */
1922
+ onlyNative?: boolean;
1923
+ /**
1924
+ * Flag indicating whether to include only non-listed items.
1925
+ */
1926
+ onlyNonListed?: boolean;
1927
+ /**
1928
+ * Indicates if only existing users are rewarded.
1929
+ */
1930
+ onlyRewardExistingUser?: boolean;
1931
+ /**
1932
+ * give points for only one token ownership per contract
1933
+ */
1934
+ onlyRewardSingleTokenOwnership?: boolean | null;
1935
+ /**
1936
+ * Promotional code associated with the rule.
1937
+ */
1938
+ promoCode?: string;
1939
+ /**
1940
+ * URL of the CSV file containing promo codes.
1941
+ */
1942
+ promoCodeCsvUrl?: string;
1943
+ /**
1944
+ * Numbers of the promotional code to be generated.
1945
+ */
1946
+ promoCodeLength?: number | null;
1947
+ /**
1948
+ * Type of the promotional code.
1949
+ */
1950
+ promoCodeType?: 'code' | 'csv' | 'generate';
1951
+ /**
1952
+ * Array defining ranges and corresponding rewards.
1953
+ */
1954
+ range?: Array<Metadata.Range>;
1955
+ /**
1956
+ * Object defining referral requirements.
1957
+ */
1958
+ referralRequirements?: Metadata.ReferralRequirements | null;
1959
+ /**
1960
+ * Lump sum reward given to a referrer.
1961
+ */
1962
+ referrerReward?: number | null;
1963
+ /**
1964
+ * Loyalty currency ID of the referrer reward.
1965
+ */
1966
+ referrerRewardLoyaltyCurrencyId?: string | null;
1967
+ /**
1968
+ * Flag indicating if the post link is required.
1969
+ */
1970
+ requirePostLink?: boolean | null;
1971
+ /**
1972
+ * Flag indicating if the rule can also reward badges per range.
1973
+ */
1974
+ rewardBadgePerRange?: boolean;
1975
+ /**
1976
+ * Flag indicating if the reward is rewarded by batch.
1977
+ */
1978
+ rewardByBatch?: boolean | null;
1979
+ /**
1980
+ * Flag indicating if the reward is rewarded per action.
1981
+ */
1982
+ rewardPerAction?: boolean | null;
1983
+ /**
1984
+ * Flag indicating if rewards are given per impression.
1985
+ */
1986
+ rewardPerImpression?: boolean | null;
1987
+ /**
1988
+ * Flag indicating if the rule should reward based on value of traded tokens
1989
+ * instead of count.
1990
+ */
1991
+ rewardPerValue?: boolean;
1992
+ /**
1993
+ * Wallet address of the user can only be used if userId is not provided
1994
+ */
1995
+ royaltyAddress?: string;
1996
+ /**
1997
+ * Royalty percentage of the item.
1998
+ */
1999
+ royaltyPercentage?: number;
2000
+ /**
2001
+ * Currency associated with sales.
2002
+ */
2003
+ saleCurrency?: string;
2004
+ /**
2005
+ * Percentage reward given for a second-level referral.
2006
+ */
2007
+ secondReferralReward?: number | null;
2008
+ /**
2009
+ * Flag indicating if the multiplier is skipped.
2010
+ */
2011
+ skipMultiplier?: boolean | null;
2012
+ /**
2013
+ * Object containing details of the associated smart contract.
2014
+ */
2015
+ smartContract?: Metadata.SmartContract;
2016
+ /**
2017
+ * Array of snapshot proposals for the rule.
2018
+ */
2019
+ snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
2020
+ /**
2021
+ * Social media platform associated with the rule.
2022
+ */
2023
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
2024
+ /**
2025
+ * URL of the social platform's logo.
2026
+ */
2027
+ socialPlatformLogo?: string | null;
2028
+ /**
2029
+ * Name of the social platform.
2030
+ */
2031
+ socialPlatformName?: string | null;
2032
+ /**
2033
+ * ID of the Steam app.
2034
+ */
2035
+ steamAppId?: string | null;
2036
+ /**
2037
+ * Array of streak milestones and corresponding rewards.
2038
+ */
2039
+ streakArray?: Array<Metadata.StreakArray> | null;
2040
+ /**
2041
+ * Metadata for swap loyalty rules
2042
+ */
2043
+ swap?: Metadata.Swap;
2044
+ /**
2045
+ * ID of the Telegram channel.
2046
+ */
2047
+ telegramChannelId?: string | null;
2048
+ /**
2049
+ * Time delay in seconds to verify actions.
2050
+ */
2051
+ timeDelayToVerifySeconds?: string | number | null;
2052
+ /**
2053
+ * Flag indicating if all contracts are tracked.
2054
+ */
2055
+ trackAllContracts?: boolean | null;
2056
+ /**
2057
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
2058
+ * completed once the progress is 100%.
2059
+ */
2060
+ trackProgress?: boolean | null;
2061
+ /**
2062
+ * URL of the associated Twitter account.
2063
+ */
2064
+ twitterAccountUrl?: string;
2065
+ /**
2066
+ * Hashtag associated with the Twitter post.
2067
+ */
2068
+ twitterHashtag?: string;
2069
+ /**
2070
+ * URL of the associated Twitter post.
2071
+ */
2072
+ twitterPostUrl?: string;
2073
+ /**
2074
+ * Unique identifier of the Twitter user.
2075
+ */
2076
+ twitterUserId?: string;
2077
+ /**
2078
+ * Twitter username of the user.
2079
+ */
2080
+ twitterUsername?: string;
2081
+ /**
2082
+ * Minimum length of the verification text.
2083
+ */
2084
+ verificationTextMinimumLength?: number | null;
2085
+ /**
2086
+ * Multiplier applied to rewards for verified users.
2087
+ */
2088
+ verifiedMultiplier?: number | null;
2089
+ /**
2090
+ * Placeholder text for verification input fields.
2091
+ */
2092
+ verifyPlaceHolderText?: string | null;
2093
+ /**
2094
+ * Type of wallet associated with the rule.
2095
+ */
2096
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
2097
+ /**
2098
+ * ID of the Youtube channel.
2099
+ */
2100
+ youtubeChannelId?: string | null;
2101
+ /**
2102
+ * ID of the Youtube video.
2103
+ */
2104
+ youtubeVideoId?: string | null;
2105
+ }
2106
+ namespace Metadata {
2107
+ interface Collection {
2108
+ /**
2109
+ * Blockchain address of the collection.
2110
+ */
2111
+ address?: string;
2112
+ /**
2113
+ * Multiplier applied to the rewards for this collection.
2114
+ */
2115
+ multiplier?: number;
2116
+ /**
2117
+ * Blockchain network of the collection.
2118
+ */
2119
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
2120
+ }
2121
+ /**
2122
+ * Object containing details for the call-to-action.
2123
+ */
2124
+ interface Cta {
2125
+ /**
2126
+ * Link for the call-to-action.
2127
+ */
2128
+ href?: string | null;
2129
+ /**
2130
+ * Label for the call-to-action.
2131
+ */
2132
+ label?: string | null;
2133
+ }
2134
+ interface DiscordServersToJoin {
2135
+ /**
2136
+ * ID of the Discord server to join.
2137
+ */
2138
+ id?: string;
2139
+ /**
2140
+ * Array of Discord channels to join.
2141
+ */
2142
+ channels?: Array<DiscordServersToJoin.Channel>;
2143
+ /**
2144
+ * Array of roles to assign in the Discord server.
2145
+ */
2146
+ roles?: Array<DiscordServersToJoin.Role>;
2147
+ }
2148
+ namespace DiscordServersToJoin {
2149
+ interface Channel {
2150
+ /**
2151
+ * ID of the Discord channel.
2152
+ */
2153
+ id?: string;
2154
+ /**
2155
+ * Array of emojis used in the channel.
2156
+ */
2157
+ emojis?: Array<Channel.Emoji>;
2158
+ /**
2159
+ * Phrase of text to be present in the discord message
2160
+ */
2161
+ text?: string;
2162
+ }
2163
+ namespace Channel {
2164
+ interface Emoji {
2165
+ /**
2166
+ * ID of the emoji used in the channel.
2167
+ */
2168
+ id?: string;
2169
+ }
2170
+ }
2171
+ interface Role {
2172
+ /**
2173
+ * ID of the role in the Discord server.
2174
+ */
2175
+ id: string;
2176
+ }
2177
+ }
2178
+ interface DripQuestsToComplete {
2179
+ /**
2180
+ * ID of the drip quest to complete.
2181
+ */
2182
+ id: string;
2183
+ }
2184
+ /**
2185
+ * Liquidity pool details.
2186
+ */
2187
+ interface Liquidity {
2188
+ /**
2189
+ * Calculation type of the liquidity pool.
2190
+ */
2191
+ calculationType?: 'fixed' | 'custom';
2192
+ /**
2193
+ * Custom function to calculate the the reward amount based on the liquidity
2194
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
2195
+ * USD.
2196
+ */
2197
+ customFunction?: string;
2198
+ /**
2199
+ * Liquidity provided per day in USD
2200
+ */
2201
+ liquidityPerDay?: number;
2202
+ /**
2203
+ * Blockchain network of the liquidity pool.
2204
+ */
2205
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
2206
+ /**
2207
+ * Indicates if only in-range liquidity is rewarded.
2208
+ */
2209
+ onlyRewardInRangeLiquidity?: boolean;
2210
+ /**
2211
+ * Array of liquidity pools associated with the rule.
2212
+ */
2213
+ pools?: Array<Liquidity.Pool>;
2214
+ /**
2215
+ * Protocol of the liquidity pool.
2216
+ */
2217
+ protocol?: string;
2218
+ }
2219
+ namespace Liquidity {
2220
+ interface Pool {
2221
+ /**
2222
+ * Unique identifier of the liquidity pool.
2223
+ */
2224
+ id: string;
2225
+ }
2226
+ }
2227
+ interface Range {
2228
+ /**
2229
+ * Reward amount for this range.
2230
+ */
2231
+ amount: number;
2232
+ /**
2233
+ * End value of the range.
2234
+ */
2235
+ endRange: number;
2236
+ /**
2237
+ * Start value of the range.
2238
+ */
2239
+ startRange: number;
2240
+ /**
2241
+ * ID of the loyalty badge for this range.
2242
+ */
2243
+ loyaltyBadgeId?: string;
2244
+ /**
2245
+ * Amount of the loyalty multiplier for this range.
2246
+ */
2247
+ loyaltyMultiplierAmount?: number;
2248
+ }
2249
+ /**
2250
+ * Object defining referral requirements.
2251
+ */
2252
+ interface ReferralRequirements {
2253
+ /**
2254
+ * Flag indicating if achieving points is required.
2255
+ */
2256
+ achievePoints?: boolean | null;
2257
+ /**
2258
+ * Flag indicating if completing the profile is required.
2259
+ */
2260
+ completeProfile?: boolean | null;
2261
+ /**
2262
+ * Flag indicating if connecting Discord is required.
2263
+ */
2264
+ connectDiscord?: boolean | null;
2265
+ /**
2266
+ * Flag indicating if connecting email is required.
2267
+ */
2268
+ connectEmail?: boolean | null;
2269
+ /**
2270
+ * Flag indicating if connecting Twitter is required.
2271
+ */
2272
+ connectTwitter?: boolean | null;
2273
+ points?: ReferralRequirements.Points | null;
2274
+ }
2275
+ namespace ReferralRequirements {
2276
+ interface Points {
2277
+ /**
2278
+ * Points required for referral.
2279
+ */
2280
+ amount?: number | null;
2281
+ /**
2282
+ * ID of the loyalty currency for referral.
2283
+ */
2284
+ loyaltyCurrecyId?: string | null;
2285
+ }
2286
+ }
2287
+ /**
2288
+ * Object containing details of the associated smart contract.
2289
+ */
2290
+ interface SmartContract {
2291
+ /**
2292
+ * Mapping of addresses for the smart contract.
2293
+ */
2294
+ addressMapping?: string | null;
2295
+ /**
2296
+ * Object containing details of the amount multiplier from the event.
2297
+ */
2298
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
2299
+ /**
2300
+ * ID of the smart contract.
2301
+ */
2302
+ contractId?: string | null;
2303
+ /**
2304
+ * Criteria to evaluate the smart contract event.
2305
+ */
2306
+ criteria?: 'everyEvent' | 'byParameter' | null;
2307
+ /**
2308
+ * Event emitted by the smart contract.
2309
+ */
2310
+ event?: string | null;
2311
+ /**
2312
+ * Array of parameters for the smart contract.
2313
+ */
2314
+ params?: Array<SmartContract.Param> | null;
2315
+ /**
2316
+ * Type of the smart contract interaction.
2317
+ */
2318
+ type?: 'function' | 'event' | null;
2319
+ }
2320
+ namespace SmartContract {
2321
+ /**
2322
+ * Object containing details of the amount multiplier from the event.
2323
+ */
2324
+ interface AmountMultiplier {
2325
+ /**
2326
+ * Mapping of the value for the smart contract.
2327
+ */
2328
+ valueMapping?: string | null;
2329
+ }
2330
+ interface Param {
2331
+ /**
2332
+ * Condition to check for the parameter.
2333
+ */
2334
+ condition?: string | null;
2335
+ /**
2336
+ * Name of the smart contract parameter.
2337
+ */
2338
+ name?: string | null;
2339
+ /**
2340
+ * Value of the parameter.
2341
+ */
2342
+ value?: string | null;
2343
+ }
2344
+ }
2345
+ interface SnapshotProposal {
2346
+ /**
2347
+ * ID of the snapshot proposal.
2348
+ */
2349
+ id: string;
2350
+ /**
2351
+ * Space associated with the snapshot proposal.
2352
+ */
2353
+ space: string;
2354
+ }
2355
+ interface StreakArray {
2356
+ /**
2357
+ * Reward amount for achieving the streak milestone.
2358
+ */
2359
+ streakAmount: number;
2360
+ /**
2361
+ * Milestone required to achieve the streak.
2362
+ */
2363
+ streakMilestone: number;
2364
+ }
2365
+ /**
2366
+ * Metadata for swap loyalty rules
2367
+ */
2368
+ interface Swap {
2369
+ provider?: 'any' | 'relay' | 'lifi';
2370
+ relayReferrerId?: string;
2371
+ requireCrossChainSwap?: boolean;
2372
+ swappedToChain?: 'any' | number | string;
2373
+ swappedToTokens?: Array<Swap.SwappedToToken>;
2374
+ tokenMode?: 'any' | 'specific';
2375
+ trackTokenAmount?: boolean;
2376
+ }
2377
+ namespace Swap {
2378
+ interface SwappedToToken {
2379
+ address: string;
2380
+ chainId: string;
2381
+ }
2382
+ }
2383
+ }
1258
2384
  }
1259
2385
  }
1260
2386
  export interface RuleDeleteResponse {
@@ -1262,7 +2388,7 @@ export interface RuleDeleteResponse {
1262
2388
  deletedAt: string;
1263
2389
  }
1264
2390
  export interface RuleCompleteResponse {
1265
- message: string;
2391
+ message: 'Completion request added to queue' | 'Link click being verified, come back later to check the status';
1266
2392
  }
1267
2393
  export interface RuleGetStatusResponse {
1268
2394
  data: Array<RuleGetStatusResponse.Data>;
@@ -1319,7 +2445,7 @@ export interface RuleCreateParams {
1319
2445
  /**
1320
2446
  * Type of loyalty rule being created
1321
2447
  */
1322
- type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll';
2448
+ type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll' | 'steam_wishlist' | 'liquidity_uniswap_v2' | 'liquidity_uniswap_v3' | 'points_airdrop' | 'youtube_subscribers' | 'youtube_comment' | 'shopify_spend' | 'swap' | 'tiktok_post' | 'post_impressions' | 'discord_join' | 'connected_youtube';
1323
2449
  /**
1324
2450
  * Unique identifier for the associated website
1325
2451
  */
@@ -1348,6 +2474,11 @@ export interface RuleCreateParams {
1348
2474
  * Optional detailed description of the rule
1349
2475
  */
1350
2476
  description?: string;
2477
+ duplicatedFromId?: string | null;
2478
+ /**
2479
+ * ID of the external integration
2480
+ */
2481
+ externalIntegrationId?: string | null;
1351
2482
  /**
1352
2483
  * Whether to hide this rule in the user interface
1353
2484
  */
@@ -1355,19 +2486,41 @@ export interface RuleCreateParams {
1355
2486
  /**
1356
2487
  * Interval between rule executions
1357
2488
  */
1358
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
2489
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | null;
1359
2490
  /**
1360
2491
  * Whether this rule is mandatory
1361
2492
  */
1362
2493
  isRequired?: boolean;
2494
+ /**
2495
+ * Unique identifier for the loyalty badge
2496
+ */
2497
+ loyaltyBadgeId?: string | null;
1363
2498
  /**
1364
2499
  * Unique identifier for the loyalty rule group
1365
2500
  */
1366
2501
  loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
2502
+ /**
2503
+ * URL for uploading loyalty user allotment via CSV
2504
+ */
2505
+ loyaltyUserAllotmentCsvUrl?: string;
2506
+ /**
2507
+ * The interval for the max amount. Available for the smart contract and external
2508
+ * rules.
2509
+ */
2510
+ maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
2511
+ /**
2512
+ * The maximum amount of points a user can earn per interval. Available for the
2513
+ * smart contract and external rules.
2514
+ */
2515
+ maxAmountPerInterval?: number | null;
2516
+ /**
2517
+ * URL of the media to be displayed
2518
+ */
2519
+ mediaUrl?: string | null;
1367
2520
  /**
1368
2521
  * Blockchain network where the rule will apply
1369
2522
  */
1370
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
2523
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
1371
2524
  /**
1372
2525
  * OAuth credentials associated with the rule
1373
2526
  */
@@ -1375,17 +2528,29 @@ export interface RuleCreateParams {
1375
2528
  /**
1376
2529
  * Type of reward issued by the rule
1377
2530
  */
1378
- rewardType?: 'points' | 'multiplier';
2531
+ rewardType?: 'points' | 'multiplier' | 'badge';
2532
+ /**
2533
+ * URL of the Shopify store
2534
+ */
2535
+ shopifyStoreUrl?: string | null;
2536
+ /**
2537
+ * Whether to show this rule before the start time
2538
+ */
2539
+ showBeforeStart?: boolean;
1379
2540
  /**
1380
- * Identifier for associated subscriptions
2541
+ * Optional subscription id for the rule
1381
2542
  */
1382
- subscriptionIdentifier?: string | null;
2543
+ subscriptionId?: string | null;
1383
2544
  }
1384
2545
  export declare namespace RuleCreateParams {
1385
2546
  /**
1386
2547
  * Additional metadata for the loyalty rule
1387
2548
  */
1388
2549
  interface Metadata {
2550
+ /**
2551
+ * Number of tokens per batch.
2552
+ */
2553
+ batchSize?: number | null;
1389
2554
  /**
1390
2555
  * Text displayed on the action button.
1391
2556
  */
@@ -1410,6 +2575,16 @@ export declare namespace RuleCreateParams {
1410
2575
  * Array of collections associated with the rule.
1411
2576
  */
1412
2577
  collection?: Array<Metadata.Collection>;
2578
+ /**
2579
+ * Conditions for completing the profile.
2580
+ */
2581
+ completeProfileConditions?: {
2582
+ [key: string]: boolean;
2583
+ } | null;
2584
+ /**
2585
+ * Description of the external rule condition (only for external rules)
2586
+ */
2587
+ conditionDescription?: string;
1413
2588
  /**
1414
2589
  * Object containing details for the call-to-action.
1415
2590
  */
@@ -1418,6 +2593,10 @@ export declare namespace RuleCreateParams {
1418
2593
  * API key for custom rewards integration.
1419
2594
  */
1420
2595
  customRewardsApiKey?: string;
2596
+ /**
2597
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
2598
+ */
2599
+ directRpc?: boolean;
1421
2600
  /**
1422
2601
  * Array of Discord servers, channels, and roles to join.
1423
2602
  */
@@ -1438,10 +2617,18 @@ export declare namespace RuleCreateParams {
1438
2617
  * Flag indicating whether the verified multiplier is enabled.
1439
2618
  */
1440
2619
  enableVerifiedMultiplier?: boolean;
2620
+ /**
2621
+ * Fill source of the order for the token sale
2622
+ */
2623
+ fillSource?: string;
1441
2624
  /**
1442
2625
  * Percentage reward given to a user for their first referral.
1443
2626
  */
1444
2627
  firstReferralReward?: number | null;
2628
+ /**
2629
+ * Flag indicating whether the fill source is included.
2630
+ */
2631
+ hasFillSource?: boolean;
1445
2632
  /**
1446
2633
  * Indicates if the item has never been sold.
1447
2634
  */
@@ -1462,10 +2649,18 @@ export declare namespace RuleCreateParams {
1462
2649
  * URL of the image associated with the rule.
1463
2650
  */
1464
2651
  imageUrl?: string | null;
2652
+ /**
2653
+ * If enabled, the first transaction done on the platform will complete this rule
2654
+ */
2655
+ isCheckInOnEveryTxn?: boolean;
1465
2656
  /**
1466
2657
  * Indicates if the multiplier has been applied to rewards.
1467
2658
  */
1468
2659
  isMultiplierApplied?: boolean;
2660
+ /**
2661
+ * Flag indicating if the rule is restricted to new users.
2662
+ */
2663
+ isRestrictedToNewUsers?: boolean;
1469
2664
  /**
1470
2665
  * Flag indicating if rewards are applied retroactively.
1471
2666
  */
@@ -1478,6 +2673,10 @@ export declare namespace RuleCreateParams {
1478
2673
  * Optional link associated with the metadata.
1479
2674
  */
1480
2675
  link?: string | null;
2676
+ /**
2677
+ * Liquidity pool details.
2678
+ */
2679
+ liquidity?: Metadata.Liquidity;
1481
2680
  /**
1482
2681
  * Maximum quantity constraint for token holding.
1483
2682
  */
@@ -1514,6 +2713,18 @@ export declare namespace RuleCreateParams {
1514
2713
  * Promotional code associated with the rule.
1515
2714
  */
1516
2715
  promoCode?: string;
2716
+ /**
2717
+ * URL of the CSV file containing promo codes.
2718
+ */
2719
+ promoCodeCsvUrl?: string;
2720
+ /**
2721
+ * Numbers of the promotional code to be generated.
2722
+ */
2723
+ promoCodeLength?: number | null;
2724
+ /**
2725
+ * Type of the promotional code.
2726
+ */
2727
+ promoCodeType?: 'code' | 'csv' | 'generate';
1517
2728
  /**
1518
2729
  * Array defining ranges and corresponding rewards.
1519
2730
  */
@@ -1526,10 +2737,43 @@ export declare namespace RuleCreateParams {
1526
2737
  * Lump sum reward given to a referrer.
1527
2738
  */
1528
2739
  referrerReward?: number | null;
2740
+ /**
2741
+ * Loyalty currency ID of the referrer reward.
2742
+ */
2743
+ referrerRewardLoyaltyCurrencyId?: string | null;
2744
+ /**
2745
+ * Flag indicating if the post link is required.
2746
+ */
2747
+ requirePostLink?: boolean | null;
2748
+ /**
2749
+ * Flag indicating if the rule can also reward badges per range.
2750
+ */
2751
+ rewardBadgePerRange?: boolean;
2752
+ /**
2753
+ * Flag indicating if the reward is rewarded by batch.
2754
+ */
2755
+ rewardByBatch?: boolean | null;
2756
+ /**
2757
+ * Flag indicating if the reward is rewarded per action.
2758
+ */
2759
+ rewardPerAction?: boolean | null;
1529
2760
  /**
1530
2761
  * Flag indicating if rewards are given per impression.
1531
2762
  */
1532
2763
  rewardPerImpression?: boolean | null;
2764
+ /**
2765
+ * Flag indicating if the rule should reward based on value of traded tokens
2766
+ * instead of count.
2767
+ */
2768
+ rewardPerValue?: boolean;
2769
+ /**
2770
+ * Wallet address of the user can only be used if userId is not provided
2771
+ */
2772
+ royaltyAddress?: string;
2773
+ /**
2774
+ * Royalty percentage of the item.
2775
+ */
2776
+ royaltyPercentage?: number;
1533
2777
  /**
1534
2778
  * Currency associated with sales.
1535
2779
  */
@@ -1553,7 +2797,7 @@ export declare namespace RuleCreateParams {
1553
2797
  /**
1554
2798
  * Social media platform associated with the rule.
1555
2799
  */
1556
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
2800
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
1557
2801
  /**
1558
2802
  * URL of the social platform's logo.
1559
2803
  */
@@ -1562,10 +2806,18 @@ export declare namespace RuleCreateParams {
1562
2806
  * Name of the social platform.
1563
2807
  */
1564
2808
  socialPlatformName?: string | null;
2809
+ /**
2810
+ * ID of the Steam app.
2811
+ */
2812
+ steamAppId?: string | null;
1565
2813
  /**
1566
2814
  * Array of streak milestones and corresponding rewards.
1567
2815
  */
1568
2816
  streakArray?: Array<Metadata.StreakArray> | null;
2817
+ /**
2818
+ * Metadata for swap loyalty rules
2819
+ */
2820
+ swap?: Metadata.Swap;
1569
2821
  /**
1570
2822
  * ID of the Telegram channel.
1571
2823
  */
@@ -1578,6 +2830,11 @@ export declare namespace RuleCreateParams {
1578
2830
  * Flag indicating if all contracts are tracked.
1579
2831
  */
1580
2832
  trackAllContracts?: boolean | null;
2833
+ /**
2834
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
2835
+ * completed once the progress is 100%.
2836
+ */
2837
+ trackProgress?: boolean | null;
1581
2838
  /**
1582
2839
  * URL of the associated Twitter account.
1583
2840
  */
@@ -1613,7 +2870,15 @@ export declare namespace RuleCreateParams {
1613
2870
  /**
1614
2871
  * Type of wallet associated with the rule.
1615
2872
  */
1616
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
2873
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
2874
+ /**
2875
+ * ID of the Youtube channel.
2876
+ */
2877
+ youtubeChannelId?: string | null;
2878
+ /**
2879
+ * ID of the Youtube video.
2880
+ */
2881
+ youtubeVideoId?: string | null;
1617
2882
  }
1618
2883
  namespace Metadata {
1619
2884
  interface Collection {
@@ -1628,7 +2893,7 @@ export declare namespace RuleCreateParams {
1628
2893
  /**
1629
2894
  * Blockchain network of the collection.
1630
2895
  */
1631
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
2896
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
1632
2897
  }
1633
2898
  /**
1634
2899
  * Object containing details for the call-to-action.
@@ -1693,6 +2958,49 @@ export declare namespace RuleCreateParams {
1693
2958
  */
1694
2959
  id: string;
1695
2960
  }
2961
+ /**
2962
+ * Liquidity pool details.
2963
+ */
2964
+ interface Liquidity {
2965
+ /**
2966
+ * Calculation type of the liquidity pool.
2967
+ */
2968
+ calculationType?: 'fixed' | 'custom';
2969
+ /**
2970
+ * Custom function to calculate the the reward amount based on the liquidity
2971
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
2972
+ * USD.
2973
+ */
2974
+ customFunction?: string;
2975
+ /**
2976
+ * Liquidity provided per day in USD
2977
+ */
2978
+ liquidityPerDay?: number;
2979
+ /**
2980
+ * Blockchain network of the liquidity pool.
2981
+ */
2982
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
2983
+ /**
2984
+ * Indicates if only in-range liquidity is rewarded.
2985
+ */
2986
+ onlyRewardInRangeLiquidity?: boolean;
2987
+ /**
2988
+ * Array of liquidity pools associated with the rule.
2989
+ */
2990
+ pools?: Array<Liquidity.Pool>;
2991
+ /**
2992
+ * Protocol of the liquidity pool.
2993
+ */
2994
+ protocol?: string;
2995
+ }
2996
+ namespace Liquidity {
2997
+ interface Pool {
2998
+ /**
2999
+ * Unique identifier of the liquidity pool.
3000
+ */
3001
+ id: string;
3002
+ }
3003
+ }
1696
3004
  interface Range {
1697
3005
  /**
1698
3006
  * Reward amount for this range.
@@ -1706,6 +3014,14 @@ export declare namespace RuleCreateParams {
1706
3014
  * Start value of the range.
1707
3015
  */
1708
3016
  startRange: number;
3017
+ /**
3018
+ * ID of the loyalty badge for this range.
3019
+ */
3020
+ loyaltyBadgeId?: string;
3021
+ /**
3022
+ * Amount of the loyalty multiplier for this range.
3023
+ */
3024
+ loyaltyMultiplierAmount?: number;
1709
3025
  }
1710
3026
  /**
1711
3027
  * Object defining referral requirements.
@@ -1749,18 +3065,14 @@ export declare namespace RuleCreateParams {
1749
3065
  * Object containing details of the associated smart contract.
1750
3066
  */
1751
3067
  interface SmartContract {
1752
- /**
1753
- * ABI of the smart contract.
1754
- */
1755
- abi?: string | null;
1756
3068
  /**
1757
3069
  * Mapping of addresses for the smart contract.
1758
3070
  */
1759
3071
  addressMapping?: string | null;
1760
3072
  /**
1761
- * Array of bonus details applied to the rule.
3073
+ * Object containing details of the amount multiplier from the event.
1762
3074
  */
1763
- bonus?: Array<SmartContract.Bonus> | null;
3075
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
1764
3076
  /**
1765
3077
  * ID of the smart contract.
1766
3078
  */
@@ -1769,58 +3081,28 @@ export declare namespace RuleCreateParams {
1769
3081
  * Criteria to evaluate the smart contract event.
1770
3082
  */
1771
3083
  criteria?: 'everyEvent' | 'byParameter' | null;
1772
- /**
1773
- * Time range applied to the rule.
1774
- */
1775
- customRange?: SmartContract.CustomRange | null;
1776
3084
  /**
1777
3085
  * Event emitted by the smart contract.
1778
3086
  */
1779
3087
  event?: string | null;
1780
- /**
1781
- * Maximum value allowed for the parameter.
1782
- */
1783
- max?: number | null;
1784
3088
  /**
1785
3089
  * Array of parameters for the smart contract.
1786
3090
  */
1787
3091
  params?: Array<SmartContract.Param> | null;
1788
3092
  /**
1789
- * Flag indicating if a bonus is applied.
1790
- */
1791
- withBonus?: boolean | null;
1792
- /**
1793
- * Flag indicating if a custom range is applied.
3093
+ * Type of the smart contract interaction.
1794
3094
  */
1795
- withCustomRange?: boolean | null;
1796
- /**
1797
- * Flag indicating if a maximum limit is applied.
1798
- */
1799
- withMax?: boolean | null;
3095
+ type?: 'function' | 'event' | null;
1800
3096
  }
1801
3097
  namespace SmartContract {
1802
- interface Bonus {
1803
- /**
1804
- * Amount of the bonus.
1805
- */
1806
- amount?: number | null;
1807
- /**
1808
- * Number of times the bonus is applied.
1809
- */
1810
- count?: number | null;
1811
- }
1812
3098
  /**
1813
- * Time range applied to the rule.
3099
+ * Object containing details of the amount multiplier from the event.
1814
3100
  */
1815
- interface CustomRange {
3101
+ interface AmountMultiplier {
1816
3102
  /**
1817
- * End time of the custom range.
3103
+ * Mapping of the value for the smart contract.
1818
3104
  */
1819
- endsAt?: string | null;
1820
- /**
1821
- * Start time of the custom range.
1822
- */
1823
- startsAt?: string | null;
3105
+ valueMapping?: string | null;
1824
3106
  }
1825
3107
  interface Param {
1826
3108
  /**
@@ -1857,6 +3139,24 @@ export declare namespace RuleCreateParams {
1857
3139
  */
1858
3140
  streakMilestone: number;
1859
3141
  }
3142
+ /**
3143
+ * Metadata for swap loyalty rules
3144
+ */
3145
+ interface Swap {
3146
+ provider?: 'any' | 'relay' | 'lifi';
3147
+ relayReferrerId?: string;
3148
+ requireCrossChainSwap?: boolean;
3149
+ swappedToChain?: 'any' | number | string;
3150
+ swappedToTokens?: Array<Swap.SwappedToToken>;
3151
+ tokenMode?: 'any' | 'specific';
3152
+ trackTokenAmount?: boolean;
3153
+ }
3154
+ namespace Swap {
3155
+ interface SwappedToToken {
3156
+ address: string;
3157
+ chainId: string;
3158
+ }
3159
+ }
1860
3160
  }
1861
3161
  interface Collection {
1862
3162
  /**
@@ -1866,7 +3166,11 @@ export declare namespace RuleCreateParams {
1866
3166
  /**
1867
3167
  * Blockchain network for the collection
1868
3168
  */
1869
- network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
3169
+ network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
3170
+ /**
3171
+ * Symbol of the collection.
3172
+ */
3173
+ symbol?: string;
1870
3174
  }
1871
3175
  }
1872
3176
  export interface RuleUpdateParams {
@@ -1910,6 +3214,10 @@ export interface RuleUpdateParams {
1910
3214
  * Effective start time of the rule
1911
3215
  */
1912
3216
  effectiveStartTime?: string | null;
3217
+ /**
3218
+ * ID of the external integration
3219
+ */
3220
+ externalIntegrationId?: string | null;
1913
3221
  /**
1914
3222
  * Frequency of the rule execution
1915
3223
  */
@@ -1921,7 +3229,7 @@ export interface RuleUpdateParams {
1921
3229
  /**
1922
3230
  * Time interval for recurring rule execution
1923
3231
  */
1924
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
3232
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | null;
1925
3233
  /**
1926
3234
  * Whether this rule is required for participation
1927
3235
  */
@@ -1930,6 +3238,20 @@ export interface RuleUpdateParams {
1930
3238
  * ID of the rule group section to associate with the rule
1931
3239
  */
1932
3240
  loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
3241
+ /**
3242
+ * The interval for the max amount. Available for the smart contract and external
3243
+ * rules.
3244
+ */
3245
+ maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
3246
+ /**
3247
+ * The maximum amount of points a user can earn per interval. Available for the
3248
+ * smart contract and external rules.
3249
+ */
3250
+ maxAmountPerInterval?: number | null;
3251
+ /**
3252
+ * URL of the media to be displayed
3253
+ */
3254
+ mediaUrl?: string | null;
1933
3255
  /**
1934
3256
  * Additional metadata for the loyalty rule
1935
3257
  */
@@ -1937,7 +3259,7 @@ export interface RuleUpdateParams {
1937
3259
  /**
1938
3260
  * Blockchain network where the rule will apply
1939
3261
  */
1940
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
3262
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
1941
3263
  /**
1942
3264
  * ID for associated OAuth credentials
1943
3265
  */
@@ -1945,15 +3267,23 @@ export interface RuleUpdateParams {
1945
3267
  /**
1946
3268
  * Type of reward issued by this rule
1947
3269
  */
1948
- rewardType?: 'points' | 'multiplier';
3270
+ rewardType?: 'points' | 'multiplier' | 'badge';
3271
+ /**
3272
+ * URL of the Shopify store
3273
+ */
3274
+ shopifyStoreUrl?: string | null;
3275
+ /**
3276
+ * Whether to show this rule before the start time
3277
+ */
3278
+ showBeforeStart?: boolean;
1949
3279
  /**
1950
3280
  * Start time for the loyalty rule
1951
3281
  */
1952
3282
  startTime?: string | null;
1953
3283
  /**
1954
- * Optional subscription identifier for the rule
3284
+ * Optional subscription id for the rule
1955
3285
  */
1956
- subscriptionIdentifier?: string | null;
3286
+ subscriptionId?: string | null;
1957
3287
  }
1958
3288
  export declare namespace RuleUpdateParams {
1959
3289
  interface Collection {
@@ -1964,12 +3294,20 @@ export declare namespace RuleUpdateParams {
1964
3294
  /**
1965
3295
  * Blockchain network for the collection
1966
3296
  */
1967
- network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
3297
+ network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
3298
+ /**
3299
+ * Symbol of the collection.
3300
+ */
3301
+ symbol?: string;
1968
3302
  }
1969
3303
  /**
1970
3304
  * Additional metadata for the loyalty rule
1971
3305
  */
1972
3306
  interface Metadata {
3307
+ /**
3308
+ * Number of tokens per batch.
3309
+ */
3310
+ batchSize?: number | null;
1973
3311
  /**
1974
3312
  * Text displayed on the action button.
1975
3313
  */
@@ -1994,6 +3332,16 @@ export declare namespace RuleUpdateParams {
1994
3332
  * Array of collections associated with the rule.
1995
3333
  */
1996
3334
  collection?: Array<Metadata.Collection>;
3335
+ /**
3336
+ * Conditions for completing the profile.
3337
+ */
3338
+ completeProfileConditions?: {
3339
+ [key: string]: boolean;
3340
+ } | null;
3341
+ /**
3342
+ * Description of the external rule condition (only for external rules)
3343
+ */
3344
+ conditionDescription?: string;
1997
3345
  /**
1998
3346
  * Object containing details for the call-to-action.
1999
3347
  */
@@ -2002,6 +3350,10 @@ export declare namespace RuleUpdateParams {
2002
3350
  * API key for custom rewards integration.
2003
3351
  */
2004
3352
  customRewardsApiKey?: string;
3353
+ /**
3354
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
3355
+ */
3356
+ directRpc?: boolean;
2005
3357
  /**
2006
3358
  * Array of Discord servers, channels, and roles to join.
2007
3359
  */
@@ -2022,10 +3374,18 @@ export declare namespace RuleUpdateParams {
2022
3374
  * Flag indicating whether the verified multiplier is enabled.
2023
3375
  */
2024
3376
  enableVerifiedMultiplier?: boolean;
3377
+ /**
3378
+ * Fill source of the order for the token sale
3379
+ */
3380
+ fillSource?: string;
2025
3381
  /**
2026
3382
  * Percentage reward given to a user for their first referral.
2027
3383
  */
2028
3384
  firstReferralReward?: number | null;
3385
+ /**
3386
+ * Flag indicating whether the fill source is included.
3387
+ */
3388
+ hasFillSource?: boolean;
2029
3389
  /**
2030
3390
  * Indicates if the item has never been sold.
2031
3391
  */
@@ -2046,10 +3406,18 @@ export declare namespace RuleUpdateParams {
2046
3406
  * URL of the image associated with the rule.
2047
3407
  */
2048
3408
  imageUrl?: string | null;
3409
+ /**
3410
+ * If enabled, the first transaction done on the platform will complete this rule
3411
+ */
3412
+ isCheckInOnEveryTxn?: boolean;
2049
3413
  /**
2050
3414
  * Indicates if the multiplier has been applied to rewards.
2051
3415
  */
2052
3416
  isMultiplierApplied?: boolean;
3417
+ /**
3418
+ * Flag indicating if the rule is restricted to new users.
3419
+ */
3420
+ isRestrictedToNewUsers?: boolean;
2053
3421
  /**
2054
3422
  * Flag indicating if rewards are applied retroactively.
2055
3423
  */
@@ -2062,6 +3430,10 @@ export declare namespace RuleUpdateParams {
2062
3430
  * Optional link associated with the metadata.
2063
3431
  */
2064
3432
  link?: string | null;
3433
+ /**
3434
+ * Liquidity pool details.
3435
+ */
3436
+ liquidity?: Metadata.Liquidity;
2065
3437
  /**
2066
3438
  * Maximum quantity constraint for token holding.
2067
3439
  */
@@ -2098,6 +3470,18 @@ export declare namespace RuleUpdateParams {
2098
3470
  * Promotional code associated with the rule.
2099
3471
  */
2100
3472
  promoCode?: string;
3473
+ /**
3474
+ * URL of the CSV file containing promo codes.
3475
+ */
3476
+ promoCodeCsvUrl?: string;
3477
+ /**
3478
+ * Numbers of the promotional code to be generated.
3479
+ */
3480
+ promoCodeLength?: number | null;
3481
+ /**
3482
+ * Type of the promotional code.
3483
+ */
3484
+ promoCodeType?: 'code' | 'csv' | 'generate';
2101
3485
  /**
2102
3486
  * Array defining ranges and corresponding rewards.
2103
3487
  */
@@ -2110,10 +3494,43 @@ export declare namespace RuleUpdateParams {
2110
3494
  * Lump sum reward given to a referrer.
2111
3495
  */
2112
3496
  referrerReward?: number | null;
3497
+ /**
3498
+ * Loyalty currency ID of the referrer reward.
3499
+ */
3500
+ referrerRewardLoyaltyCurrencyId?: string | null;
3501
+ /**
3502
+ * Flag indicating if the post link is required.
3503
+ */
3504
+ requirePostLink?: boolean | null;
3505
+ /**
3506
+ * Flag indicating if the rule can also reward badges per range.
3507
+ */
3508
+ rewardBadgePerRange?: boolean;
3509
+ /**
3510
+ * Flag indicating if the reward is rewarded by batch.
3511
+ */
3512
+ rewardByBatch?: boolean | null;
3513
+ /**
3514
+ * Flag indicating if the reward is rewarded per action.
3515
+ */
3516
+ rewardPerAction?: boolean | null;
2113
3517
  /**
2114
3518
  * Flag indicating if rewards are given per impression.
2115
3519
  */
2116
3520
  rewardPerImpression?: boolean | null;
3521
+ /**
3522
+ * Flag indicating if the rule should reward based on value of traded tokens
3523
+ * instead of count.
3524
+ */
3525
+ rewardPerValue?: boolean;
3526
+ /**
3527
+ * Wallet address of the user can only be used if userId is not provided
3528
+ */
3529
+ royaltyAddress?: string;
3530
+ /**
3531
+ * Royalty percentage of the item.
3532
+ */
3533
+ royaltyPercentage?: number;
2117
3534
  /**
2118
3535
  * Currency associated with sales.
2119
3536
  */
@@ -2137,7 +3554,7 @@ export declare namespace RuleUpdateParams {
2137
3554
  /**
2138
3555
  * Social media platform associated with the rule.
2139
3556
  */
2140
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
3557
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
2141
3558
  /**
2142
3559
  * URL of the social platform's logo.
2143
3560
  */
@@ -2146,10 +3563,18 @@ export declare namespace RuleUpdateParams {
2146
3563
  * Name of the social platform.
2147
3564
  */
2148
3565
  socialPlatformName?: string | null;
3566
+ /**
3567
+ * ID of the Steam app.
3568
+ */
3569
+ steamAppId?: string | null;
2149
3570
  /**
2150
3571
  * Array of streak milestones and corresponding rewards.
2151
3572
  */
2152
3573
  streakArray?: Array<Metadata.StreakArray> | null;
3574
+ /**
3575
+ * Metadata for swap loyalty rules
3576
+ */
3577
+ swap?: Metadata.Swap;
2153
3578
  /**
2154
3579
  * ID of the Telegram channel.
2155
3580
  */
@@ -2162,6 +3587,11 @@ export declare namespace RuleUpdateParams {
2162
3587
  * Flag indicating if all contracts are tracked.
2163
3588
  */
2164
3589
  trackAllContracts?: boolean | null;
3590
+ /**
3591
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
3592
+ * completed once the progress is 100%.
3593
+ */
3594
+ trackProgress?: boolean | null;
2165
3595
  /**
2166
3596
  * URL of the associated Twitter account.
2167
3597
  */
@@ -2197,7 +3627,15 @@ export declare namespace RuleUpdateParams {
2197
3627
  /**
2198
3628
  * Type of wallet associated with the rule.
2199
3629
  */
2200
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
3630
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
3631
+ /**
3632
+ * ID of the Youtube channel.
3633
+ */
3634
+ youtubeChannelId?: string | null;
3635
+ /**
3636
+ * ID of the Youtube video.
3637
+ */
3638
+ youtubeVideoId?: string | null;
2201
3639
  }
2202
3640
  namespace Metadata {
2203
3641
  interface Collection {
@@ -2212,7 +3650,7 @@ export declare namespace RuleUpdateParams {
2212
3650
  /**
2213
3651
  * Blockchain network of the collection.
2214
3652
  */
2215
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
3653
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
2216
3654
  }
2217
3655
  /**
2218
3656
  * Object containing details for the call-to-action.
@@ -2277,6 +3715,49 @@ export declare namespace RuleUpdateParams {
2277
3715
  */
2278
3716
  id: string;
2279
3717
  }
3718
+ /**
3719
+ * Liquidity pool details.
3720
+ */
3721
+ interface Liquidity {
3722
+ /**
3723
+ * Calculation type of the liquidity pool.
3724
+ */
3725
+ calculationType?: 'fixed' | 'custom';
3726
+ /**
3727
+ * Custom function to calculate the the reward amount based on the liquidity
3728
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
3729
+ * USD.
3730
+ */
3731
+ customFunction?: string;
3732
+ /**
3733
+ * Liquidity provided per day in USD
3734
+ */
3735
+ liquidityPerDay?: number;
3736
+ /**
3737
+ * Blockchain network of the liquidity pool.
3738
+ */
3739
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
3740
+ /**
3741
+ * Indicates if only in-range liquidity is rewarded.
3742
+ */
3743
+ onlyRewardInRangeLiquidity?: boolean;
3744
+ /**
3745
+ * Array of liquidity pools associated with the rule.
3746
+ */
3747
+ pools?: Array<Liquidity.Pool>;
3748
+ /**
3749
+ * Protocol of the liquidity pool.
3750
+ */
3751
+ protocol?: string;
3752
+ }
3753
+ namespace Liquidity {
3754
+ interface Pool {
3755
+ /**
3756
+ * Unique identifier of the liquidity pool.
3757
+ */
3758
+ id: string;
3759
+ }
3760
+ }
2280
3761
  interface Range {
2281
3762
  /**
2282
3763
  * Reward amount for this range.
@@ -2290,6 +3771,14 @@ export declare namespace RuleUpdateParams {
2290
3771
  * Start value of the range.
2291
3772
  */
2292
3773
  startRange: number;
3774
+ /**
3775
+ * ID of the loyalty badge for this range.
3776
+ */
3777
+ loyaltyBadgeId?: string;
3778
+ /**
3779
+ * Amount of the loyalty multiplier for this range.
3780
+ */
3781
+ loyaltyMultiplierAmount?: number;
2293
3782
  }
2294
3783
  /**
2295
3784
  * Object defining referral requirements.
@@ -2333,18 +3822,14 @@ export declare namespace RuleUpdateParams {
2333
3822
  * Object containing details of the associated smart contract.
2334
3823
  */
2335
3824
  interface SmartContract {
2336
- /**
2337
- * ABI of the smart contract.
2338
- */
2339
- abi?: string | null;
2340
3825
  /**
2341
3826
  * Mapping of addresses for the smart contract.
2342
3827
  */
2343
3828
  addressMapping?: string | null;
2344
3829
  /**
2345
- * Array of bonus details applied to the rule.
3830
+ * Object containing details of the amount multiplier from the event.
2346
3831
  */
2347
- bonus?: Array<SmartContract.Bonus> | null;
3832
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
2348
3833
  /**
2349
3834
  * ID of the smart contract.
2350
3835
  */
@@ -2353,58 +3838,28 @@ export declare namespace RuleUpdateParams {
2353
3838
  * Criteria to evaluate the smart contract event.
2354
3839
  */
2355
3840
  criteria?: 'everyEvent' | 'byParameter' | null;
2356
- /**
2357
- * Time range applied to the rule.
2358
- */
2359
- customRange?: SmartContract.CustomRange | null;
2360
3841
  /**
2361
3842
  * Event emitted by the smart contract.
2362
3843
  */
2363
3844
  event?: string | null;
2364
- /**
2365
- * Maximum value allowed for the parameter.
2366
- */
2367
- max?: number | null;
2368
3845
  /**
2369
3846
  * Array of parameters for the smart contract.
2370
3847
  */
2371
3848
  params?: Array<SmartContract.Param> | null;
2372
3849
  /**
2373
- * Flag indicating if a bonus is applied.
2374
- */
2375
- withBonus?: boolean | null;
2376
- /**
2377
- * Flag indicating if a custom range is applied.
2378
- */
2379
- withCustomRange?: boolean | null;
2380
- /**
2381
- * Flag indicating if a maximum limit is applied.
3850
+ * Type of the smart contract interaction.
2382
3851
  */
2383
- withMax?: boolean | null;
3852
+ type?: 'function' | 'event' | null;
2384
3853
  }
2385
3854
  namespace SmartContract {
2386
- interface Bonus {
2387
- /**
2388
- * Amount of the bonus.
2389
- */
2390
- amount?: number | null;
2391
- /**
2392
- * Number of times the bonus is applied.
2393
- */
2394
- count?: number | null;
2395
- }
2396
3855
  /**
2397
- * Time range applied to the rule.
3856
+ * Object containing details of the amount multiplier from the event.
2398
3857
  */
2399
- interface CustomRange {
2400
- /**
2401
- * End time of the custom range.
2402
- */
2403
- endsAt?: string | null;
3858
+ interface AmountMultiplier {
2404
3859
  /**
2405
- * Start time of the custom range.
3860
+ * Mapping of the value for the smart contract.
2406
3861
  */
2407
- startsAt?: string | null;
3862
+ valueMapping?: string | null;
2408
3863
  }
2409
3864
  interface Param {
2410
3865
  /**
@@ -2441,21 +3896,65 @@ export declare namespace RuleUpdateParams {
2441
3896
  */
2442
3897
  streakMilestone: number;
2443
3898
  }
3899
+ /**
3900
+ * Metadata for swap loyalty rules
3901
+ */
3902
+ interface Swap {
3903
+ provider?: 'any' | 'relay' | 'lifi';
3904
+ relayReferrerId?: string;
3905
+ requireCrossChainSwap?: boolean;
3906
+ swappedToChain?: 'any' | number | string;
3907
+ swappedToTokens?: Array<Swap.SwappedToToken>;
3908
+ tokenMode?: 'any' | 'specific';
3909
+ trackTokenAmount?: boolean;
3910
+ }
3911
+ namespace Swap {
3912
+ interface SwappedToToken {
3913
+ address: string;
3914
+ chainId: string;
3915
+ }
3916
+ }
2444
3917
  }
2445
3918
  }
2446
3919
  export interface RuleListParams {
3920
+ /**
3921
+ * IDs of the users to filter results by
3922
+ */
3923
+ allotedToUserId?: string | Array<string>;
3924
+ /**
3925
+ * ID of the user group to filter results by
3926
+ */
3927
+ allotedUserGroupId?: string;
2447
3928
  /**
2448
3929
  * Address of the collection to filter by
2449
3930
  */
2450
3931
  collectionAddress?: string;
2451
3932
  /**
2452
- * Maximum number of records to return (max 1000)
3933
+ * If true this will only return loyalty rule chains
3934
+ */
3935
+ includeLoyaltyRuleChains?: 'true' | 'false';
3936
+ /**
3937
+ * If true this will only return active rules, the rules for which the startTime is
3938
+ * in the past and the endTime is in the future
3939
+ */
3940
+ isActive?: 'true' | 'false';
3941
+ /**
3942
+ * If true this will only return special rules, special rules are the rules that
3943
+ * are used for anti sybil as honey pot
3944
+ */
3945
+ isSpecial?: 'true' | 'false';
3946
+ /**
3947
+ * Maximum number of records to return (max 100)
2453
3948
  */
2454
3949
  limit?: number;
2455
3950
  /**
2456
3951
  * ID of the loyalty rule group to filter results
2457
3952
  */
2458
3953
  loyaltyRuleGroupId?: string;
3954
+ /**
3955
+ * The IDs of the loyalty rule
3956
+ */
3957
+ loyaltyRuleId?: string | Array<string>;
2459
3958
  /**
2460
3959
  * Unique identifier for the organization to filter by
2461
3960
  */
@@ -2469,15 +3968,34 @@ export interface RuleListParams {
2469
3968
  */
2470
3969
  websiteId?: string;
2471
3970
  }
3971
+ export interface RuleDeleteParams {
3972
+ /**
3973
+ * Whether to debit loyalty points
3974
+ */
3975
+ debitLoyaltyPoints?: string;
3976
+ }
2472
3977
  export interface RuleCompleteParams {
2473
3978
  /**
2474
- * Link to the comment made by user
3979
+ * Override amount for the reward (rounded to nearest whole number). This will
3980
+ * override the rule amount and reward the integer passed.
3981
+ */
3982
+ amount?: number | null;
3983
+ /**
3984
+ * Link to the post/comment made by user
3985
+ */
3986
+ contentUrl?: string;
3987
+ /**
3988
+ * Unique key to ensure idempotent requests.
2475
3989
  */
2476
- commentLink?: string;
3990
+ idempotencyKey?: string;
2477
3991
  /**
2478
3992
  * ID of the choice selected by the user
2479
3993
  */
2480
3994
  loyaltyQuestionChoiceId?: string;
3995
+ /**
3996
+ * Value to compare with the range
3997
+ */
3998
+ rangeValue?: number | null;
2481
3999
  /**
2482
4000
  * Unique identifier for the user
2483
4001
  */
@@ -2488,7 +4006,7 @@ export interface RuleCompleteParams {
2488
4006
  verificationCode?: string;
2489
4007
  /**
2490
4008
  * Flag indicating if only verification is required, this will not create a
2491
- * transaction and reward the user
4009
+ * transaction and reward the user.
2492
4010
  */
2493
4011
  verifyOnly?: string;
2494
4012
  /**
@@ -2497,11 +4015,12 @@ export interface RuleCompleteParams {
2497
4015
  walletAddress?: string;
2498
4016
  }
2499
4017
  export interface RuleGetStatusParams {
2500
- organizationId: string;
2501
- websiteId: string;
4018
+ organizationId?: string;
2502
4019
  userId?: string;
4020
+ walletAddress?: string;
4021
+ websiteId?: string;
2503
4022
  }
2504
4023
  export declare namespace Rules {
2505
- export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleGetStatusResponse as RuleGetStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleCompleteParams as RuleCompleteParams, type RuleGetStatusParams as RuleGetStatusParams, };
4024
+ export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleGetStatusResponse as RuleGetStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleDeleteParams as RuleDeleteParams, type RuleCompleteParams as RuleCompleteParams, type RuleGetStatusParams as RuleGetStatusParams, };
2506
4025
  }
2507
4026
  //# sourceMappingURL=rules.d.ts.map