@snagsolutions/sdk 0.1.0-alpha.14 → 0.1.0-alpha.141

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 (449) hide show
  1. package/CHANGELOG.md +1178 -0
  2. package/README.md +23 -27
  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 +28 -18
  9. package/core.js.map +1 -1
  10. package/core.mjs +29 -19
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +20 -11
  13. package/index.d.ts +20 -11
  14. package/index.d.ts.map +1 -1
  15. package/index.js +21 -11
  16. package/index.js.map +1 -1
  17. package/index.mjs +22 -12
  18. package/index.mjs.map +1 -1
  19. package/package.json +11 -33
  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/auctions.js +19 -0
  69. package/resources/auctions.js.map +1 -0
  70. package/resources/auctions.mjs +3 -0
  71. package/resources/auctions.mjs.map +1 -0
  72. package/resources/auth.d.ts +44 -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 +7 -5
  79. package/resources/index.d.ts.map +1 -1
  80. package/resources/index.js +11 -7
  81. package/resources/index.js.map +1 -1
  82. package/resources/index.mjs +7 -5
  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/loyalty/accounts.d.ts +200 -0
  91. package/resources/loyalty/accounts.d.ts.map +1 -1
  92. package/resources/loyalty/accounts.js +28 -0
  93. package/resources/loyalty/accounts.js.map +1 -1
  94. package/resources/loyalty/accounts.mjs +28 -0
  95. package/resources/loyalty/accounts.mjs.map +1 -1
  96. package/resources/loyalty/badges.d.ts +475 -21
  97. package/resources/loyalty/badges.d.ts.map +1 -1
  98. package/resources/loyalty/badges.js +19 -1
  99. package/resources/loyalty/badges.js.map +1 -1
  100. package/resources/loyalty/badges.mjs +19 -1
  101. package/resources/loyalty/badges.mjs.map +1 -1
  102. package/resources/loyalty/currencies.d.ts +25 -0
  103. package/resources/loyalty/currencies.d.ts.map +1 -1
  104. package/resources/loyalty/currencies.js +19 -0
  105. package/resources/loyalty/currencies.js.map +1 -1
  106. package/resources/loyalty/currencies.mjs +19 -0
  107. package/resources/loyalty/currencies.mjs.map +1 -1
  108. package/resources/loyalty/index.d.ts +9 -5
  109. package/resources/loyalty/index.d.ts.map +1 -1
  110. package/resources/loyalty/index.js +11 -3
  111. package/resources/loyalty/index.js.map +1 -1
  112. package/resources/loyalty/index.mjs +6 -2
  113. package/resources/loyalty/index.mjs.map +1 -1
  114. package/resources/loyalty/loyalty.d.ts +33 -17
  115. package/resources/loyalty/loyalty.d.ts.map +1 -1
  116. package/resources/loyalty/loyalty.js +28 -12
  117. package/resources/loyalty/loyalty.js.map +1 -1
  118. package/resources/loyalty/loyalty.mjs +29 -13
  119. package/resources/loyalty/loyalty.mjs.map +1 -1
  120. package/resources/loyalty/multipliers.d.ts +76 -8
  121. package/resources/loyalty/multipliers.d.ts.map +1 -1
  122. package/resources/loyalty/multipliers.js +30 -1
  123. package/resources/loyalty/multipliers.js.map +1 -1
  124. package/resources/loyalty/multipliers.mjs +30 -1
  125. package/resources/loyalty/multipliers.mjs.map +1 -1
  126. package/resources/loyalty/{transaction-entries/questions-responses.d.ts → questions-responses.d.ts} +41 -2
  127. package/resources/loyalty/questions-responses.d.ts.map +1 -0
  128. package/resources/loyalty/{transaction-entries/questions-responses.js → questions-responses.js} +11 -2
  129. package/resources/loyalty/questions-responses.js.map +1 -0
  130. package/resources/loyalty/{transaction-entries/questions-responses.mjs → questions-responses.mjs} +11 -2
  131. package/resources/loyalty/questions-responses.mjs.map +1 -0
  132. package/resources/loyalty/{transaction-entries/questions.d.ts → 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 +2584 -10
  139. package/resources/loyalty/rule-edits.d.ts.map +1 -1
  140. package/resources/loyalty/rule-edits.js +15 -1
  141. package/resources/loyalty/rule-edits.js.map +1 -1
  142. package/resources/loyalty/rule-edits.mjs +15 -1
  143. package/resources/loyalty/rule-edits.mjs.map +1 -1
  144. package/resources/loyalty/rule-groups.d.ts +762 -0
  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/loyalty/rules.d.ts +1760 -230
  151. package/resources/loyalty/rules.d.ts.map +1 -1
  152. package/resources/loyalty/rules.js +40 -9
  153. package/resources/loyalty/rules.js.map +1 -1
  154. package/resources/loyalty/rules.mjs +40 -9
  155. package/resources/loyalty/rules.mjs.map +1 -1
  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/{transaction-entries/transaction-entries.js → transactions/transactions.js} +35 -25
  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 +2 -0
  181. package/resources/loyalty.d.ts.map +1 -0
  182. package/resources/loyalty.js +19 -0
  183. package/resources/loyalty.js.map +1 -0
  184. package/resources/loyalty.mjs +3 -0
  185. package/resources/loyalty.mjs.map +1 -0
  186. package/resources/{assets/minting.d.ts → minting.d.ts} +14 -14
  187. package/resources/minting.d.ts.map +1 -0
  188. package/resources/{assets/minting.js → minting.js} +2 -2
  189. package/resources/minting.js.map +1 -0
  190. package/resources/{assets/minting.mjs → minting.mjs} +2 -2
  191. package/resources/minting.mjs.map +1 -0
  192. package/resources/referral/index.d.ts +3 -0
  193. package/resources/referral/index.d.ts.map +1 -0
  194. package/resources/referral/index.js.map +1 -0
  195. package/resources/{assets/referral → referral}/index.mjs +1 -1
  196. package/resources/referral/index.mjs.map +1 -0
  197. package/resources/referral/referral.d.ts +39 -0
  198. package/resources/referral/referral.d.ts.map +1 -0
  199. package/resources/{assets/referral → referral}/referral.js +12 -6
  200. package/resources/referral/referral.js.map +1 -0
  201. package/resources/referral/referral.mjs +25 -0
  202. package/resources/referral/referral.mjs.map +1 -0
  203. package/resources/referral/users.d.ts +84 -0
  204. package/resources/referral/users.d.ts.map +1 -0
  205. package/resources/{assets/referral → referral}/users.js +17 -3
  206. package/resources/referral/users.js.map +1 -0
  207. package/resources/referral/users.mjs +31 -0
  208. package/resources/referral/users.mjs.map +1 -0
  209. package/resources/referral.d.ts +2 -0
  210. package/resources/referral.d.ts.map +1 -0
  211. package/resources/referral.js +19 -0
  212. package/resources/referral.js.map +1 -0
  213. package/resources/referral.mjs +3 -0
  214. package/resources/referral.mjs.map +1 -0
  215. package/resources/users/index.d.ts +2 -3
  216. package/resources/users/index.d.ts.map +1 -1
  217. package/resources/users/index.js +1 -3
  218. package/resources/users/index.js.map +1 -1
  219. package/resources/users/index.mjs +1 -2
  220. package/resources/users/index.mjs.map +1 -1
  221. package/resources/users/metadatas.d.ts +43 -7
  222. package/resources/users/metadatas.d.ts.map +1 -1
  223. package/resources/users/metadatas.js +2 -2
  224. package/resources/users/metadatas.js.map +1 -1
  225. package/resources/users/metadatas.mjs +2 -2
  226. package/resources/users/metadatas.mjs.map +1 -1
  227. package/resources/users/users.d.ts +414 -6
  228. package/resources/users/users.d.ts.map +1 -1
  229. package/resources/users/users.js +77 -4
  230. package/resources/users/users.js.map +1 -1
  231. package/resources/users/users.mjs +77 -4
  232. package/resources/users/users.mjs.map +1 -1
  233. package/resources/users.d.ts +2 -0
  234. package/resources/users.d.ts.map +1 -0
  235. package/resources/users.js +19 -0
  236. package/resources/users.js.map +1 -0
  237. package/resources/users.mjs +3 -0
  238. package/resources/users.mjs.map +1 -0
  239. package/resources/websites/index.d.ts +4 -0
  240. package/resources/websites/index.d.ts.map +1 -0
  241. package/resources/websites/index.js +11 -0
  242. package/resources/websites/index.js.map +1 -0
  243. package/resources/{assets → websites}/index.mjs +1 -4
  244. package/resources/websites/index.mjs.map +1 -0
  245. package/resources/websites/website-collections.d.ts +94 -0
  246. package/resources/websites/website-collections.d.ts.map +1 -0
  247. package/resources/{assets → websites}/website-collections.js +23 -2
  248. package/resources/websites/website-collections.js.map +1 -0
  249. package/resources/websites/website-collections.mjs +42 -0
  250. package/resources/websites/website-collections.mjs.map +1 -0
  251. package/resources/websites/website-user-roles.d.ts +96 -0
  252. package/resources/websites/website-user-roles.d.ts.map +1 -0
  253. package/resources/{assets → websites}/website-user-roles.js +30 -7
  254. package/resources/websites/website-user-roles.js.map +1 -0
  255. package/resources/websites/website-user-roles.mjs +41 -0
  256. package/resources/websites/website-user-roles.mjs.map +1 -0
  257. package/resources/websites/websites.d.ts +223 -0
  258. package/resources/websites/websites.d.ts.map +1 -0
  259. package/resources/{assets/assets.js → websites/websites.js} +21 -27
  260. package/resources/websites/websites.js.map +1 -0
  261. package/resources/websites/websites.mjs +36 -0
  262. package/resources/websites/websites.mjs.map +1 -0
  263. package/resources/websites.d.ts +1 -202
  264. package/resources/websites.d.ts.map +1 -1
  265. package/resources/websites.js +15 -18
  266. package/resources/websites.js.map +1 -1
  267. package/resources/websites.mjs +1 -16
  268. package/resources/websites.mjs.map +1 -1
  269. package/resources.d.ts +2 -0
  270. package/resources.d.ts.map +1 -0
  271. package/resources.js +18 -0
  272. package/resources.js.map +1 -0
  273. package/resources.mjs +2 -0
  274. package/resources.mjs.map +1 -0
  275. package/src/_shims/index.d.ts +2 -0
  276. package/src/_shims/index.js +5 -1
  277. package/src/_shims/index.mjs +5 -1
  278. package/src/core.ts +47 -19
  279. package/src/index.ts +94 -23
  280. package/src/resource.ts +1 -1
  281. package/src/resources/assets.ts +93 -0
  282. package/src/resources/auctions/auctions.ts +436 -0
  283. package/src/resources/auctions/index.ts +18 -0
  284. package/src/resources/auctions/website-user-attributes/index.ts +18 -0
  285. package/src/resources/auctions/website-user-attributes/values.ts +165 -0
  286. package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +207 -0
  287. package/src/resources/auctions/website-user-attributes.ts +3 -0
  288. package/src/resources/auctions.ts +3 -0
  289. package/src/resources/auth.ts +74 -0
  290. package/src/resources/index.ts +30 -9
  291. package/src/resources/loyalty/account-streaks.ts +110 -0
  292. package/src/resources/loyalty/accounts.ts +258 -1
  293. package/src/resources/loyalty/badges.ts +571 -23
  294. package/src/resources/loyalty/currencies.ts +25 -0
  295. package/src/resources/loyalty/index.ts +53 -14
  296. package/src/resources/loyalty/loyalty.ts +163 -69
  297. package/src/resources/loyalty/multipliers.ts +87 -12
  298. package/src/resources/loyalty/{transaction-entries/questions-responses.ts → questions-responses.ts} +48 -3
  299. package/src/resources/loyalty/{transaction-entries/questions.ts → questions.ts} +40 -4
  300. package/src/resources/loyalty/rule-edits.ts +3628 -61
  301. package/src/resources/loyalty/rule-groups.ts +1184 -0
  302. package/src/resources/loyalty/rules.ts +2963 -522
  303. package/src/resources/loyalty/transactions/index.ts +18 -0
  304. package/src/resources/loyalty/transactions/rule-statuses.ts +178 -0
  305. package/src/resources/loyalty/transactions/transactions.ts +677 -0
  306. package/src/resources/loyalty/transactions.ts +3 -0
  307. package/src/resources/loyalty.ts +3 -0
  308. package/src/resources/{assets/minting.ts → minting.ts} +49 -31
  309. package/src/resources/referral/index.ts +10 -0
  310. package/src/resources/referral/referral.ts +72 -0
  311. package/src/resources/referral/users.ts +124 -0
  312. package/src/resources/referral.ts +3 -0
  313. package/src/resources/users/index.ts +17 -4
  314. package/src/resources/users/metadatas.ts +77 -15
  315. package/src/resources/users/users.ts +579 -9
  316. package/src/resources/users.ts +3 -0
  317. package/src/resources/websites/index.ts +22 -0
  318. package/src/resources/{assets → websites}/website-collections.ts +66 -30
  319. package/src/resources/{assets → websites}/website-user-roles.ts +63 -40
  320. package/src/resources/websites/websites.ts +311 -0
  321. package/src/resources/websites.ts +1 -257
  322. package/src/resources.ts +1 -0
  323. package/src/version.ts +1 -1
  324. package/version.d.ts +1 -1
  325. package/version.d.ts.map +1 -1
  326. package/version.js +1 -1
  327. package/version.js.map +1 -1
  328. package/version.mjs +1 -1
  329. package/version.mjs.map +1 -1
  330. package/resources/assets/assets.d.ts +0 -153
  331. package/resources/assets/assets.d.ts.map +0 -1
  332. package/resources/assets/assets.js.map +0 -1
  333. package/resources/assets/assets.mjs +0 -42
  334. package/resources/assets/assets.mjs.map +0 -1
  335. package/resources/assets/index.d.ts +0 -7
  336. package/resources/assets/index.d.ts.map +0 -1
  337. package/resources/assets/index.js +0 -17
  338. package/resources/assets/index.js.map +0 -1
  339. package/resources/assets/index.mjs.map +0 -1
  340. package/resources/assets/minting.d.ts.map +0 -1
  341. package/resources/assets/minting.js.map +0 -1
  342. package/resources/assets/minting.mjs.map +0 -1
  343. package/resources/assets/referral/index.d.ts +0 -3
  344. package/resources/assets/referral/index.d.ts.map +0 -1
  345. package/resources/assets/referral/index.js.map +0 -1
  346. package/resources/assets/referral/index.mjs.map +0 -1
  347. package/resources/assets/referral/referral.d.ts +0 -30
  348. package/resources/assets/referral/referral.d.ts.map +0 -1
  349. package/resources/assets/referral/referral.js.map +0 -1
  350. package/resources/assets/referral/referral.mjs +0 -19
  351. package/resources/assets/referral/referral.mjs.map +0 -1
  352. package/resources/assets/referral/users.d.ts +0 -57
  353. package/resources/assets/referral/users.d.ts.map +0 -1
  354. package/resources/assets/referral/users.js.map +0 -1
  355. package/resources/assets/referral/users.mjs +0 -17
  356. package/resources/assets/referral/users.mjs.map +0 -1
  357. package/resources/assets/users.d.ts +0 -285
  358. package/resources/assets/users.d.ts.map +0 -1
  359. package/resources/assets/users.js +0 -34
  360. package/resources/assets/users.js.map +0 -1
  361. package/resources/assets/users.mjs +0 -30
  362. package/resources/assets/users.mjs.map +0 -1
  363. package/resources/assets/website-collections.d.ts +0 -73
  364. package/resources/assets/website-collections.d.ts.map +0 -1
  365. package/resources/assets/website-collections.js.map +0 -1
  366. package/resources/assets/website-collections.mjs +0 -21
  367. package/resources/assets/website-collections.mjs.map +0 -1
  368. package/resources/assets/website-user-roles.d.ts +0 -73
  369. package/resources/assets/website-user-roles.d.ts.map +0 -1
  370. package/resources/assets/website-user-roles.js.map +0 -1
  371. package/resources/assets/website-user-roles.mjs +0 -18
  372. package/resources/assets/website-user-roles.mjs.map +0 -1
  373. package/resources/auction-bids.d.ts +0 -51
  374. package/resources/auction-bids.d.ts.map +0 -1
  375. package/resources/auction-bids.js +0 -20
  376. package/resources/auction-bids.js.map +0 -1
  377. package/resources/auction-bids.mjs +0 -16
  378. package/resources/auction-bids.mjs.map +0 -1
  379. package/resources/drip/drip.d.ts +0 -14
  380. package/resources/drip/drip.d.ts.map +0 -1
  381. package/resources/drip/drip.js +0 -43
  382. package/resources/drip/drip.js.map +0 -1
  383. package/resources/drip/drip.mjs +0 -16
  384. package/resources/drip/drip.mjs.map +0 -1
  385. package/resources/drip/index.d.ts +0 -4
  386. package/resources/drip/index.d.ts.map +0 -1
  387. package/resources/drip/index.js +0 -11
  388. package/resources/drip/index.js.map +0 -1
  389. package/resources/drip/index.mjs +0 -5
  390. package/resources/drip/index.mjs.map +0 -1
  391. package/resources/drip/quests.d.ts +0 -4
  392. package/resources/drip/quests.d.ts.map +0 -1
  393. package/resources/drip/quests.js +0 -9
  394. package/resources/drip/quests.js.map +0 -1
  395. package/resources/drip/quests.mjs +0 -5
  396. package/resources/drip/quests.mjs.map +0 -1
  397. package/resources/drip/status.d.ts +0 -4
  398. package/resources/drip/status.d.ts.map +0 -1
  399. package/resources/drip/status.js +0 -9
  400. package/resources/drip/status.js.map +0 -1
  401. package/resources/drip/status.mjs +0 -5
  402. package/resources/drip/status.mjs.map +0 -1
  403. package/resources/loyalty/transaction-entries/accounts.d.ts +0 -191
  404. package/resources/loyalty/transaction-entries/accounts.d.ts.map +0 -1
  405. package/resources/loyalty/transaction-entries/accounts.js +0 -24
  406. package/resources/loyalty/transaction-entries/accounts.js.map +0 -1
  407. package/resources/loyalty/transaction-entries/accounts.mjs +0 -20
  408. package/resources/loyalty/transaction-entries/accounts.mjs.map +0 -1
  409. package/resources/loyalty/transaction-entries/index.d.ts +0 -5
  410. package/resources/loyalty/transaction-entries/index.d.ts.map +0 -1
  411. package/resources/loyalty/transaction-entries/index.js +0 -13
  412. package/resources/loyalty/transaction-entries/index.js.map +0 -1
  413. package/resources/loyalty/transaction-entries/index.mjs +0 -6
  414. package/resources/loyalty/transaction-entries/index.mjs.map +0 -1
  415. package/resources/loyalty/transaction-entries/questions-responses.d.ts.map +0 -1
  416. package/resources/loyalty/transaction-entries/questions-responses.js.map +0 -1
  417. package/resources/loyalty/transaction-entries/questions-responses.mjs.map +0 -1
  418. package/resources/loyalty/transaction-entries/questions.d.ts.map +0 -1
  419. package/resources/loyalty/transaction-entries/questions.js +0 -27
  420. package/resources/loyalty/transaction-entries/questions.js.map +0 -1
  421. package/resources/loyalty/transaction-entries/questions.mjs +0 -23
  422. package/resources/loyalty/transaction-entries/questions.mjs.map +0 -1
  423. package/resources/loyalty/transaction-entries/transaction-entries.d.ts +0 -300
  424. package/resources/loyalty/transaction-entries/transaction-entries.d.ts.map +0 -1
  425. package/resources/loyalty/transaction-entries/transaction-entries.js.map +0 -1
  426. package/resources/loyalty/transaction-entries/transaction-entries.mjs +0 -39
  427. package/resources/loyalty/transaction-entries/transaction-entries.mjs.map +0 -1
  428. package/resources/users/wallets.d.ts +0 -4
  429. package/resources/users/wallets.d.ts.map +0 -1
  430. package/resources/users/wallets.js +0 -9
  431. package/resources/users/wallets.js.map +0 -1
  432. package/resources/users/wallets.mjs +0 -5
  433. package/resources/users/wallets.mjs.map +0 -1
  434. package/src/resources/assets/assets.ts +0 -294
  435. package/src/resources/assets/index.ts +0 -38
  436. package/src/resources/assets/referral/index.ts +0 -14
  437. package/src/resources/assets/referral/referral.ts +0 -74
  438. package/src/resources/assets/referral/users.ts +0 -99
  439. package/src/resources/assets/users.ts +0 -415
  440. package/src/resources/auction-bids.ts +0 -77
  441. package/src/resources/drip/drip.ts +0 -21
  442. package/src/resources/drip/index.ts +0 -5
  443. package/src/resources/drip/quests.ts +0 -5
  444. package/src/resources/drip/status.ts +0 -5
  445. package/src/resources/loyalty/transaction-entries/accounts.ts +0 -251
  446. package/src/resources/loyalty/transaction-entries/index.ts +0 -34
  447. package/src/resources/loyalty/transaction-entries/transaction-entries.ts +0 -525
  448. package/src/resources/users/wallets.ts +0 -5
  449. /package/resources/{assets/referral → referral}/index.js +0 -0
@@ -3,34 +3,91 @@ 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
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
- status(query: RuleStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleStatusResponse>;
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' | null;
178
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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
  */
@@ -260,6 +390,10 @@ export declare namespace RuleCreateResponse {
260
390
  * Flag indicating whether to include only non-listed items.
261
391
  */
262
392
  onlyNonListed?: boolean;
393
+ /**
394
+ * Indicates if only existing users are rewarded.
395
+ */
396
+ onlyRewardExistingUser?: boolean;
263
397
  /**
264
398
  * give points for only one token ownership per contract
265
399
  */
@@ -268,6 +402,18 @@ export declare namespace RuleCreateResponse {
268
402
  * Promotional code associated with the rule.
269
403
  */
270
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';
271
417
  /**
272
418
  * Array defining ranges and corresponding rewards.
273
419
  */
@@ -280,10 +426,43 @@ export declare namespace RuleCreateResponse {
280
426
  * Lump sum reward given to a referrer.
281
427
  */
282
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;
283
449
  /**
284
450
  * Flag indicating if rewards are given per impression.
285
451
  */
286
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;
287
466
  /**
288
467
  * Currency associated with sales.
289
468
  */
@@ -307,7 +486,7 @@ export declare namespace RuleCreateResponse {
307
486
  /**
308
487
  * Social media platform associated with the rule.
309
488
  */
310
- 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;
311
490
  /**
312
491
  * URL of the social platform's logo.
313
492
  */
@@ -316,10 +495,18 @@ export declare namespace RuleCreateResponse {
316
495
  * Name of the social platform.
317
496
  */
318
497
  socialPlatformName?: string | null;
498
+ /**
499
+ * ID of the Steam app.
500
+ */
501
+ steamAppId?: string | null;
319
502
  /**
320
503
  * Array of streak milestones and corresponding rewards.
321
504
  */
322
505
  streakArray?: Array<Metadata.StreakArray> | null;
506
+ /**
507
+ * Metadata for swap loyalty rules
508
+ */
509
+ swap?: Metadata.Swap;
323
510
  /**
324
511
  * ID of the Telegram channel.
325
512
  */
@@ -332,6 +519,11 @@ export declare namespace RuleCreateResponse {
332
519
  * Flag indicating if all contracts are tracked.
333
520
  */
334
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;
335
527
  /**
336
528
  * URL of the associated Twitter account.
337
529
  */
@@ -367,7 +559,15 @@ export declare namespace RuleCreateResponse {
367
559
  /**
368
560
  * Type of wallet associated with the rule.
369
561
  */
370
- 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;
371
571
  }
372
572
  namespace Metadata {
373
573
  interface Collection {
@@ -382,7 +582,7 @@ export declare namespace RuleCreateResponse {
382
582
  /**
383
583
  * Blockchain network of the collection.
384
584
  */
385
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
386
586
  }
387
587
  /**
388
588
  * Object containing details for the call-to-action.
@@ -447,6 +647,49 @@ export declare namespace RuleCreateResponse {
447
647
  */
448
648
  id: string;
449
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
+ }
450
693
  interface Range {
451
694
  /**
452
695
  * Reward amount for this range.
@@ -460,6 +703,14 @@ export declare namespace RuleCreateResponse {
460
703
  * Start value of the range.
461
704
  */
462
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;
463
714
  }
464
715
  /**
465
716
  * Object defining referral requirements.
@@ -503,18 +754,14 @@ export declare namespace RuleCreateResponse {
503
754
  * Object containing details of the associated smart contract.
504
755
  */
505
756
  interface SmartContract {
506
- /**
507
- * ABI of the smart contract.
508
- */
509
- abi?: string | null;
510
757
  /**
511
758
  * Mapping of addresses for the smart contract.
512
759
  */
513
760
  addressMapping?: string | null;
514
761
  /**
515
- * Array of bonus details applied to the rule.
762
+ * Object containing details of the amount multiplier from the event.
516
763
  */
517
- bonus?: Array<SmartContract.Bonus> | null;
764
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
518
765
  /**
519
766
  * ID of the smart contract.
520
767
  */
@@ -523,58 +770,28 @@ export declare namespace RuleCreateResponse {
523
770
  * Criteria to evaluate the smart contract event.
524
771
  */
525
772
  criteria?: 'everyEvent' | 'byParameter' | null;
526
- /**
527
- * Time range applied to the rule.
528
- */
529
- customRange?: SmartContract.CustomRange | null;
530
773
  /**
531
774
  * Event emitted by the smart contract.
532
775
  */
533
776
  event?: string | null;
534
- /**
535
- * Maximum value allowed for the parameter.
536
- */
537
- max?: number | null;
538
777
  /**
539
778
  * Array of parameters for the smart contract.
540
779
  */
541
780
  params?: Array<SmartContract.Param> | null;
542
781
  /**
543
- * Flag indicating if a bonus is applied.
544
- */
545
- withBonus?: boolean | null;
546
- /**
547
- * Flag indicating if a custom range is applied.
782
+ * Type of the smart contract interaction.
548
783
  */
549
- withCustomRange?: boolean | null;
550
- /**
551
- * Flag indicating if a maximum limit is applied.
552
- */
553
- withMax?: boolean | null;
784
+ type?: 'function' | 'event' | null;
554
785
  }
555
786
  namespace SmartContract {
556
- interface Bonus {
557
- /**
558
- * Amount of the bonus.
559
- */
560
- amount?: number | null;
561
- /**
562
- * Number of times the bonus is applied.
563
- */
564
- count?: number | null;
565
- }
566
787
  /**
567
- * Time range applied to the rule.
788
+ * Object containing details of the amount multiplier from the event.
568
789
  */
569
- interface CustomRange {
790
+ interface AmountMultiplier {
570
791
  /**
571
- * End time of the custom range.
792
+ * Mapping of the value for the smart contract.
572
793
  */
573
- endsAt?: string | null;
574
- /**
575
- * Start time of the custom range.
576
- */
577
- startsAt?: string | null;
794
+ valueMapping?: string | null;
578
795
  }
579
796
  interface Param {
580
797
  /**
@@ -611,6 +828,24 @@ export declare namespace RuleCreateResponse {
611
828
  */
612
829
  streakMilestone: number;
613
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
+ }
614
849
  }
615
850
  interface Collection {
616
851
  /**
@@ -620,7 +855,11 @@ export declare namespace RuleCreateResponse {
620
855
  /**
621
856
  * Blockchain network for the collection
622
857
  */
623
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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;
624
863
  }
625
864
  }
626
865
  export interface RuleUpdateResponse {
@@ -665,6 +904,10 @@ export interface RuleUpdateResponse {
665
904
  * Effective start time of the rule
666
905
  */
667
906
  effectiveStartTime?: string | null;
907
+ /**
908
+ * ID of the external integration
909
+ */
910
+ externalIntegrationId?: string | null;
668
911
  /**
669
912
  * Frequency of the rule execution
670
913
  */
@@ -676,7 +919,7 @@ export interface RuleUpdateResponse {
676
919
  /**
677
920
  * Time interval for recurring rule execution
678
921
  */
679
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
922
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
680
923
  /**
681
924
  * Whether this rule is required for participation
682
925
  */
@@ -685,6 +928,20 @@ export interface RuleUpdateResponse {
685
928
  * ID of the rule group section to associate with the rule
686
929
  */
687
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;
688
945
  /**
689
946
  * Additional metadata for the loyalty rule
690
947
  */
@@ -692,7 +949,7 @@ export interface RuleUpdateResponse {
692
949
  /**
693
950
  * Blockchain network where the rule will apply
694
951
  */
695
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
696
953
  /**
697
954
  * ID for associated OAuth credentials
698
955
  */
@@ -700,15 +957,23 @@ export interface RuleUpdateResponse {
700
957
  /**
701
958
  * Type of reward issued by this rule
702
959
  */
703
- 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;
704
969
  /**
705
970
  * Start time for the loyalty rule
706
971
  */
707
972
  startTime?: string | null;
708
973
  /**
709
- * Optional subscription identifier for the rule
974
+ * Optional subscription id for the rule
710
975
  */
711
- subscriptionIdentifier?: string | null;
976
+ subscriptionId?: string | null;
712
977
  }
713
978
  export declare namespace RuleUpdateResponse {
714
979
  interface Collection {
@@ -719,12 +984,20 @@ export declare namespace RuleUpdateResponse {
719
984
  /**
720
985
  * Blockchain network for the collection
721
986
  */
722
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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;
723
992
  }
724
993
  /**
725
994
  * Additional metadata for the loyalty rule
726
995
  */
727
996
  interface Metadata {
997
+ /**
998
+ * Number of tokens per batch.
999
+ */
1000
+ batchSize?: number | null;
728
1001
  /**
729
1002
  * Text displayed on the action button.
730
1003
  */
@@ -749,6 +1022,16 @@ export declare namespace RuleUpdateResponse {
749
1022
  * Array of collections associated with the rule.
750
1023
  */
751
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;
752
1035
  /**
753
1036
  * Object containing details for the call-to-action.
754
1037
  */
@@ -757,6 +1040,10 @@ export declare namespace RuleUpdateResponse {
757
1040
  * API key for custom rewards integration.
758
1041
  */
759
1042
  customRewardsApiKey?: string;
1043
+ /**
1044
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
1045
+ */
1046
+ directRpc?: boolean;
760
1047
  /**
761
1048
  * Array of Discord servers, channels, and roles to join.
762
1049
  */
@@ -777,10 +1064,18 @@ export declare namespace RuleUpdateResponse {
777
1064
  * Flag indicating whether the verified multiplier is enabled.
778
1065
  */
779
1066
  enableVerifiedMultiplier?: boolean;
1067
+ /**
1068
+ * Fill source of the order for the token sale
1069
+ */
1070
+ fillSource?: string;
780
1071
  /**
781
1072
  * Percentage reward given to a user for their first referral.
782
1073
  */
783
1074
  firstReferralReward?: number | null;
1075
+ /**
1076
+ * Flag indicating whether the fill source is included.
1077
+ */
1078
+ hasFillSource?: boolean;
784
1079
  /**
785
1080
  * Indicates if the item has never been sold.
786
1081
  */
@@ -801,10 +1096,18 @@ export declare namespace RuleUpdateResponse {
801
1096
  * URL of the image associated with the rule.
802
1097
  */
803
1098
  imageUrl?: string | null;
1099
+ /**
1100
+ * If enabled, the first transaction done on the platform will complete this rule
1101
+ */
1102
+ isCheckInOnEveryTxn?: boolean;
804
1103
  /**
805
1104
  * Indicates if the multiplier has been applied to rewards.
806
1105
  */
807
1106
  isMultiplierApplied?: boolean;
1107
+ /**
1108
+ * Flag indicating if the rule is restricted to new users.
1109
+ */
1110
+ isRestrictedToNewUsers?: boolean;
808
1111
  /**
809
1112
  * Flag indicating if rewards are applied retroactively.
810
1113
  */
@@ -817,6 +1120,10 @@ export declare namespace RuleUpdateResponse {
817
1120
  * Optional link associated with the metadata.
818
1121
  */
819
1122
  link?: string | null;
1123
+ /**
1124
+ * Liquidity pool details.
1125
+ */
1126
+ liquidity?: Metadata.Liquidity;
820
1127
  /**
821
1128
  * Maximum quantity constraint for token holding.
822
1129
  */
@@ -841,6 +1148,10 @@ export declare namespace RuleUpdateResponse {
841
1148
  * Flag indicating whether to include only non-listed items.
842
1149
  */
843
1150
  onlyNonListed?: boolean;
1151
+ /**
1152
+ * Indicates if only existing users are rewarded.
1153
+ */
1154
+ onlyRewardExistingUser?: boolean;
844
1155
  /**
845
1156
  * give points for only one token ownership per contract
846
1157
  */
@@ -849,6 +1160,18 @@ export declare namespace RuleUpdateResponse {
849
1160
  * Promotional code associated with the rule.
850
1161
  */
851
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';
852
1175
  /**
853
1176
  * Array defining ranges and corresponding rewards.
854
1177
  */
@@ -861,10 +1184,43 @@ export declare namespace RuleUpdateResponse {
861
1184
  * Lump sum reward given to a referrer.
862
1185
  */
863
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;
864
1207
  /**
865
1208
  * Flag indicating if rewards are given per impression.
866
1209
  */
867
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;
868
1224
  /**
869
1225
  * Currency associated with sales.
870
1226
  */
@@ -888,7 +1244,7 @@ export declare namespace RuleUpdateResponse {
888
1244
  /**
889
1245
  * Social media platform associated with the rule.
890
1246
  */
891
- 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;
892
1248
  /**
893
1249
  * URL of the social platform's logo.
894
1250
  */
@@ -897,10 +1253,18 @@ export declare namespace RuleUpdateResponse {
897
1253
  * Name of the social platform.
898
1254
  */
899
1255
  socialPlatformName?: string | null;
1256
+ /**
1257
+ * ID of the Steam app.
1258
+ */
1259
+ steamAppId?: string | null;
900
1260
  /**
901
1261
  * Array of streak milestones and corresponding rewards.
902
1262
  */
903
1263
  streakArray?: Array<Metadata.StreakArray> | null;
1264
+ /**
1265
+ * Metadata for swap loyalty rules
1266
+ */
1267
+ swap?: Metadata.Swap;
904
1268
  /**
905
1269
  * ID of the Telegram channel.
906
1270
  */
@@ -913,6 +1277,11 @@ export declare namespace RuleUpdateResponse {
913
1277
  * Flag indicating if all contracts are tracked.
914
1278
  */
915
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;
916
1285
  /**
917
1286
  * URL of the associated Twitter account.
918
1287
  */
@@ -948,7 +1317,15 @@ export declare namespace RuleUpdateResponse {
948
1317
  /**
949
1318
  * Type of wallet associated with the rule.
950
1319
  */
951
- 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;
952
1329
  }
953
1330
  namespace Metadata {
954
1331
  interface Collection {
@@ -963,7 +1340,7 @@ export declare namespace RuleUpdateResponse {
963
1340
  /**
964
1341
  * Blockchain network of the collection.
965
1342
  */
966
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
967
1344
  }
968
1345
  /**
969
1346
  * Object containing details for the call-to-action.
@@ -1028,6 +1405,49 @@ export declare namespace RuleUpdateResponse {
1028
1405
  */
1029
1406
  id: string;
1030
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
+ }
1031
1451
  interface Range {
1032
1452
  /**
1033
1453
  * Reward amount for this range.
@@ -1041,6 +1461,14 @@ export declare namespace RuleUpdateResponse {
1041
1461
  * Start value of the range.
1042
1462
  */
1043
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;
1044
1472
  }
1045
1473
  /**
1046
1474
  * Object defining referral requirements.
@@ -1084,18 +1512,14 @@ export declare namespace RuleUpdateResponse {
1084
1512
  * Object containing details of the associated smart contract.
1085
1513
  */
1086
1514
  interface SmartContract {
1087
- /**
1088
- * ABI of the smart contract.
1089
- */
1090
- abi?: string | null;
1091
1515
  /**
1092
1516
  * Mapping of addresses for the smart contract.
1093
1517
  */
1094
1518
  addressMapping?: string | null;
1095
1519
  /**
1096
- * Array of bonus details applied to the rule.
1520
+ * Object containing details of the amount multiplier from the event.
1097
1521
  */
1098
- bonus?: Array<SmartContract.Bonus> | null;
1522
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
1099
1523
  /**
1100
1524
  * ID of the smart contract.
1101
1525
  */
@@ -1104,58 +1528,28 @@ export declare namespace RuleUpdateResponse {
1104
1528
  * Criteria to evaluate the smart contract event.
1105
1529
  */
1106
1530
  criteria?: 'everyEvent' | 'byParameter' | null;
1107
- /**
1108
- * Time range applied to the rule.
1109
- */
1110
- customRange?: SmartContract.CustomRange | null;
1111
1531
  /**
1112
1532
  * Event emitted by the smart contract.
1113
1533
  */
1114
1534
  event?: string | null;
1115
- /**
1116
- * Maximum value allowed for the parameter.
1117
- */
1118
- max?: number | null;
1119
1535
  /**
1120
1536
  * Array of parameters for the smart contract.
1121
1537
  */
1122
1538
  params?: Array<SmartContract.Param> | null;
1123
1539
  /**
1124
- * Flag indicating if a bonus is applied.
1125
- */
1126
- withBonus?: boolean | null;
1127
- /**
1128
- * Flag indicating if a custom range is applied.
1129
- */
1130
- withCustomRange?: boolean | null;
1131
- /**
1132
- * Flag indicating if a maximum limit is applied.
1540
+ * Type of the smart contract interaction.
1133
1541
  */
1134
- withMax?: boolean | null;
1542
+ type?: 'function' | 'event' | null;
1135
1543
  }
1136
1544
  namespace SmartContract {
1137
- interface Bonus {
1138
- /**
1139
- * Amount of the bonus.
1140
- */
1141
- amount?: number | null;
1142
- /**
1143
- * Number of times the bonus is applied.
1144
- */
1145
- count?: number | null;
1146
- }
1147
1545
  /**
1148
- * Time range applied to the rule.
1546
+ * Object containing details of the amount multiplier from the event.
1149
1547
  */
1150
- interface CustomRange {
1151
- /**
1152
- * End time of the custom range.
1153
- */
1154
- endsAt?: string | null;
1548
+ interface AmountMultiplier {
1155
1549
  /**
1156
- * Start time of the custom range.
1550
+ * Mapping of the value for the smart contract.
1157
1551
  */
1158
- startsAt?: string | null;
1552
+ valueMapping?: string | null;
1159
1553
  }
1160
1554
  interface Param {
1161
1555
  /**
@@ -1192,6 +1586,24 @@ export declare namespace RuleUpdateResponse {
1192
1586
  */
1193
1587
  streakMilestone: number;
1194
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
+ }
1195
1607
  }
1196
1608
  }
1197
1609
  export interface RuleListResponse {
@@ -1199,9 +1611,6 @@ export interface RuleListResponse {
1199
1611
  hasNextPage: boolean;
1200
1612
  }
1201
1613
  export declare namespace RuleListResponse {
1202
- /**
1203
- * Schema for a loyalty rule
1204
- */
1205
1614
  interface Data {
1206
1615
  /**
1207
1616
  * Unique identifier for the loyalty rule
@@ -1219,14 +1628,38 @@ export declare namespace RuleListResponse {
1219
1628
  * Timestamp when the loyalty rule was deleted (if applicable)
1220
1629
  */
1221
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;
1222
1639
  /**
1223
1640
  * Frequency of the loyalty rule
1224
1641
  */
1225
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;
1226
1651
  /**
1227
1652
  * Unique identifier for the organization
1228
1653
  */
1229
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;
1230
1663
  /**
1231
1664
  * Type of the loyalty rule
1232
1665
  */
@@ -1243,23 +1676,724 @@ export declare namespace RuleListResponse {
1243
1676
  * Optional address of the collection
1244
1677
  */
1245
1678
  collectionAddress?: string;
1679
+ /**
1680
+ * URL of the media associated with the loyalty rule
1681
+ */
1682
+ mediaUrl?: string | null;
1246
1683
  /**
1247
1684
  * Optional metadata for the loyalty rule
1248
1685
  */
1249
- metadata?: Record<string, unknown>;
1686
+ metadata?: {
1687
+ [key: string]: Data.Metadata;
1688
+ };
1250
1689
  }
1251
- }
1252
- export interface RuleDeleteResponse {
1253
- id: string;
1254
- deletedAt: string;
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
+ }
2384
+ }
2385
+ }
2386
+ export interface RuleDeleteResponse {
2387
+ id: string;
2388
+ deletedAt: string;
1255
2389
  }
1256
2390
  export interface RuleCompleteResponse {
1257
- message: string;
2391
+ message: 'Completion request added to queue' | 'Link click being verified, come back later to check the status';
1258
2392
  }
1259
- export interface RuleStatusResponse {
1260
- data: Array<RuleStatusResponse.Data>;
2393
+ export interface RuleGetStatusResponse {
2394
+ data: Array<RuleGetStatusResponse.Data>;
1261
2395
  }
1262
- export declare namespace RuleStatusResponse {
2396
+ export declare namespace RuleGetStatusResponse {
1263
2397
  interface Data {
1264
2398
  loyaltyRuleId: string;
1265
2399
  status: 'pending' | 'processing' | 'completed' | 'failed';
@@ -1311,7 +2445,7 @@ export interface RuleCreateParams {
1311
2445
  /**
1312
2446
  * Type of loyalty rule being created
1313
2447
  */
1314
- 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';
1315
2449
  /**
1316
2450
  * Unique identifier for the associated website
1317
2451
  */
@@ -1340,6 +2474,11 @@ export interface RuleCreateParams {
1340
2474
  * Optional detailed description of the rule
1341
2475
  */
1342
2476
  description?: string;
2477
+ duplicatedFromId?: string | null;
2478
+ /**
2479
+ * ID of the external integration
2480
+ */
2481
+ externalIntegrationId?: string | null;
1343
2482
  /**
1344
2483
  * Whether to hide this rule in the user interface
1345
2484
  */
@@ -1347,19 +2486,41 @@ export interface RuleCreateParams {
1347
2486
  /**
1348
2487
  * Interval between rule executions
1349
2488
  */
1350
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
2489
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
1351
2490
  /**
1352
2491
  * Whether this rule is mandatory
1353
2492
  */
1354
2493
  isRequired?: boolean;
2494
+ /**
2495
+ * Unique identifier for the loyalty badge
2496
+ */
2497
+ loyaltyBadgeId?: string | null;
1355
2498
  /**
1356
2499
  * Unique identifier for the loyalty rule group
1357
2500
  */
1358
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;
1359
2520
  /**
1360
2521
  * Blockchain network where the rule will apply
1361
2522
  */
1362
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
1363
2524
  /**
1364
2525
  * OAuth credentials associated with the rule
1365
2526
  */
@@ -1367,17 +2528,29 @@ export interface RuleCreateParams {
1367
2528
  /**
1368
2529
  * Type of reward issued by the rule
1369
2530
  */
1370
- rewardType?: 'points' | 'multiplier';
2531
+ rewardType?: 'points' | 'multiplier' | 'badge';
2532
+ /**
2533
+ * URL of the Shopify store
2534
+ */
2535
+ shopifyStoreUrl?: string | null;
1371
2536
  /**
1372
- * Identifier for associated subscriptions
2537
+ * Whether to show this rule before the start time
1373
2538
  */
1374
- subscriptionIdentifier?: string | null;
2539
+ showBeforeStart?: boolean;
2540
+ /**
2541
+ * Optional subscription id for the rule
2542
+ */
2543
+ subscriptionId?: string | null;
1375
2544
  }
1376
2545
  export declare namespace RuleCreateParams {
1377
2546
  /**
1378
2547
  * Additional metadata for the loyalty rule
1379
2548
  */
1380
2549
  interface Metadata {
2550
+ /**
2551
+ * Number of tokens per batch.
2552
+ */
2553
+ batchSize?: number | null;
1381
2554
  /**
1382
2555
  * Text displayed on the action button.
1383
2556
  */
@@ -1402,6 +2575,16 @@ export declare namespace RuleCreateParams {
1402
2575
  * Array of collections associated with the rule.
1403
2576
  */
1404
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;
1405
2588
  /**
1406
2589
  * Object containing details for the call-to-action.
1407
2590
  */
@@ -1410,6 +2593,10 @@ export declare namespace RuleCreateParams {
1410
2593
  * API key for custom rewards integration.
1411
2594
  */
1412
2595
  customRewardsApiKey?: string;
2596
+ /**
2597
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
2598
+ */
2599
+ directRpc?: boolean;
1413
2600
  /**
1414
2601
  * Array of Discord servers, channels, and roles to join.
1415
2602
  */
@@ -1430,10 +2617,18 @@ export declare namespace RuleCreateParams {
1430
2617
  * Flag indicating whether the verified multiplier is enabled.
1431
2618
  */
1432
2619
  enableVerifiedMultiplier?: boolean;
2620
+ /**
2621
+ * Fill source of the order for the token sale
2622
+ */
2623
+ fillSource?: string;
1433
2624
  /**
1434
2625
  * Percentage reward given to a user for their first referral.
1435
2626
  */
1436
2627
  firstReferralReward?: number | null;
2628
+ /**
2629
+ * Flag indicating whether the fill source is included.
2630
+ */
2631
+ hasFillSource?: boolean;
1437
2632
  /**
1438
2633
  * Indicates if the item has never been sold.
1439
2634
  */
@@ -1454,10 +2649,18 @@ export declare namespace RuleCreateParams {
1454
2649
  * URL of the image associated with the rule.
1455
2650
  */
1456
2651
  imageUrl?: string | null;
2652
+ /**
2653
+ * If enabled, the first transaction done on the platform will complete this rule
2654
+ */
2655
+ isCheckInOnEveryTxn?: boolean;
1457
2656
  /**
1458
2657
  * Indicates if the multiplier has been applied to rewards.
1459
2658
  */
1460
2659
  isMultiplierApplied?: boolean;
2660
+ /**
2661
+ * Flag indicating if the rule is restricted to new users.
2662
+ */
2663
+ isRestrictedToNewUsers?: boolean;
1461
2664
  /**
1462
2665
  * Flag indicating if rewards are applied retroactively.
1463
2666
  */
@@ -1470,6 +2673,10 @@ export declare namespace RuleCreateParams {
1470
2673
  * Optional link associated with the metadata.
1471
2674
  */
1472
2675
  link?: string | null;
2676
+ /**
2677
+ * Liquidity pool details.
2678
+ */
2679
+ liquidity?: Metadata.Liquidity;
1473
2680
  /**
1474
2681
  * Maximum quantity constraint for token holding.
1475
2682
  */
@@ -1494,6 +2701,10 @@ export declare namespace RuleCreateParams {
1494
2701
  * Flag indicating whether to include only non-listed items.
1495
2702
  */
1496
2703
  onlyNonListed?: boolean;
2704
+ /**
2705
+ * Indicates if only existing users are rewarded.
2706
+ */
2707
+ onlyRewardExistingUser?: boolean;
1497
2708
  /**
1498
2709
  * give points for only one token ownership per contract
1499
2710
  */
@@ -1502,6 +2713,18 @@ export declare namespace RuleCreateParams {
1502
2713
  * Promotional code associated with the rule.
1503
2714
  */
1504
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';
1505
2728
  /**
1506
2729
  * Array defining ranges and corresponding rewards.
1507
2730
  */
@@ -1514,10 +2737,43 @@ export declare namespace RuleCreateParams {
1514
2737
  * Lump sum reward given to a referrer.
1515
2738
  */
1516
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;
1517
2760
  /**
1518
2761
  * Flag indicating if rewards are given per impression.
1519
2762
  */
1520
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;
1521
2777
  /**
1522
2778
  * Currency associated with sales.
1523
2779
  */
@@ -1541,7 +2797,7 @@ export declare namespace RuleCreateParams {
1541
2797
  /**
1542
2798
  * Social media platform associated with the rule.
1543
2799
  */
1544
- 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;
1545
2801
  /**
1546
2802
  * URL of the social platform's logo.
1547
2803
  */
@@ -1550,10 +2806,18 @@ export declare namespace RuleCreateParams {
1550
2806
  * Name of the social platform.
1551
2807
  */
1552
2808
  socialPlatformName?: string | null;
2809
+ /**
2810
+ * ID of the Steam app.
2811
+ */
2812
+ steamAppId?: string | null;
1553
2813
  /**
1554
2814
  * Array of streak milestones and corresponding rewards.
1555
2815
  */
1556
2816
  streakArray?: Array<Metadata.StreakArray> | null;
2817
+ /**
2818
+ * Metadata for swap loyalty rules
2819
+ */
2820
+ swap?: Metadata.Swap;
1557
2821
  /**
1558
2822
  * ID of the Telegram channel.
1559
2823
  */
@@ -1566,6 +2830,11 @@ export declare namespace RuleCreateParams {
1566
2830
  * Flag indicating if all contracts are tracked.
1567
2831
  */
1568
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;
1569
2838
  /**
1570
2839
  * URL of the associated Twitter account.
1571
2840
  */
@@ -1601,7 +2870,15 @@ export declare namespace RuleCreateParams {
1601
2870
  /**
1602
2871
  * Type of wallet associated with the rule.
1603
2872
  */
1604
- 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;
1605
2882
  }
1606
2883
  namespace Metadata {
1607
2884
  interface Collection {
@@ -1616,7 +2893,7 @@ export declare namespace RuleCreateParams {
1616
2893
  /**
1617
2894
  * Blockchain network of the collection.
1618
2895
  */
1619
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
1620
2897
  }
1621
2898
  /**
1622
2899
  * Object containing details for the call-to-action.
@@ -1681,6 +2958,49 @@ export declare namespace RuleCreateParams {
1681
2958
  */
1682
2959
  id: string;
1683
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
+ }
1684
3004
  interface Range {
1685
3005
  /**
1686
3006
  * Reward amount for this range.
@@ -1694,6 +3014,14 @@ export declare namespace RuleCreateParams {
1694
3014
  * Start value of the range.
1695
3015
  */
1696
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;
1697
3025
  }
1698
3026
  /**
1699
3027
  * Object defining referral requirements.
@@ -1737,18 +3065,14 @@ export declare namespace RuleCreateParams {
1737
3065
  * Object containing details of the associated smart contract.
1738
3066
  */
1739
3067
  interface SmartContract {
1740
- /**
1741
- * ABI of the smart contract.
1742
- */
1743
- abi?: string | null;
1744
3068
  /**
1745
3069
  * Mapping of addresses for the smart contract.
1746
3070
  */
1747
3071
  addressMapping?: string | null;
1748
3072
  /**
1749
- * Array of bonus details applied to the rule.
3073
+ * Object containing details of the amount multiplier from the event.
1750
3074
  */
1751
- bonus?: Array<SmartContract.Bonus> | null;
3075
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
1752
3076
  /**
1753
3077
  * ID of the smart contract.
1754
3078
  */
@@ -1757,58 +3081,28 @@ export declare namespace RuleCreateParams {
1757
3081
  * Criteria to evaluate the smart contract event.
1758
3082
  */
1759
3083
  criteria?: 'everyEvent' | 'byParameter' | null;
1760
- /**
1761
- * Time range applied to the rule.
1762
- */
1763
- customRange?: SmartContract.CustomRange | null;
1764
3084
  /**
1765
3085
  * Event emitted by the smart contract.
1766
3086
  */
1767
3087
  event?: string | null;
1768
- /**
1769
- * Maximum value allowed for the parameter.
1770
- */
1771
- max?: number | null;
1772
3088
  /**
1773
3089
  * Array of parameters for the smart contract.
1774
3090
  */
1775
3091
  params?: Array<SmartContract.Param> | null;
1776
3092
  /**
1777
- * Flag indicating if a bonus is applied.
1778
- */
1779
- withBonus?: boolean | null;
1780
- /**
1781
- * Flag indicating if a custom range is applied.
3093
+ * Type of the smart contract interaction.
1782
3094
  */
1783
- withCustomRange?: boolean | null;
1784
- /**
1785
- * Flag indicating if a maximum limit is applied.
1786
- */
1787
- withMax?: boolean | null;
3095
+ type?: 'function' | 'event' | null;
1788
3096
  }
1789
3097
  namespace SmartContract {
1790
- interface Bonus {
1791
- /**
1792
- * Amount of the bonus.
1793
- */
1794
- amount?: number | null;
1795
- /**
1796
- * Number of times the bonus is applied.
1797
- */
1798
- count?: number | null;
1799
- }
1800
3098
  /**
1801
- * Time range applied to the rule.
3099
+ * Object containing details of the amount multiplier from the event.
1802
3100
  */
1803
- interface CustomRange {
3101
+ interface AmountMultiplier {
1804
3102
  /**
1805
- * End time of the custom range.
3103
+ * Mapping of the value for the smart contract.
1806
3104
  */
1807
- endsAt?: string | null;
1808
- /**
1809
- * Start time of the custom range.
1810
- */
1811
- startsAt?: string | null;
3105
+ valueMapping?: string | null;
1812
3106
  }
1813
3107
  interface Param {
1814
3108
  /**
@@ -1845,6 +3139,24 @@ export declare namespace RuleCreateParams {
1845
3139
  */
1846
3140
  streakMilestone: number;
1847
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
+ }
1848
3160
  }
1849
3161
  interface Collection {
1850
3162
  /**
@@ -1854,7 +3166,11 @@ export declare namespace RuleCreateParams {
1854
3166
  /**
1855
3167
  * Blockchain network for the collection
1856
3168
  */
1857
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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;
1858
3174
  }
1859
3175
  }
1860
3176
  export interface RuleUpdateParams {
@@ -1898,6 +3214,10 @@ export interface RuleUpdateParams {
1898
3214
  * Effective start time of the rule
1899
3215
  */
1900
3216
  effectiveStartTime?: string | null;
3217
+ /**
3218
+ * ID of the external integration
3219
+ */
3220
+ externalIntegrationId?: string | null;
1901
3221
  /**
1902
3222
  * Frequency of the rule execution
1903
3223
  */
@@ -1909,7 +3229,7 @@ export interface RuleUpdateParams {
1909
3229
  /**
1910
3230
  * Time interval for recurring rule execution
1911
3231
  */
1912
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
3232
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
1913
3233
  /**
1914
3234
  * Whether this rule is required for participation
1915
3235
  */
@@ -1918,6 +3238,20 @@ export interface RuleUpdateParams {
1918
3238
  * ID of the rule group section to associate with the rule
1919
3239
  */
1920
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;
1921
3255
  /**
1922
3256
  * Additional metadata for the loyalty rule
1923
3257
  */
@@ -1925,7 +3259,7 @@ export interface RuleUpdateParams {
1925
3259
  /**
1926
3260
  * Blockchain network where the rule will apply
1927
3261
  */
1928
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
1929
3263
  /**
1930
3264
  * ID for associated OAuth credentials
1931
3265
  */
@@ -1933,15 +3267,23 @@ export interface RuleUpdateParams {
1933
3267
  /**
1934
3268
  * Type of reward issued by this rule
1935
3269
  */
1936
- 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;
1937
3279
  /**
1938
3280
  * Start time for the loyalty rule
1939
3281
  */
1940
3282
  startTime?: string | null;
1941
3283
  /**
1942
- * Optional subscription identifier for the rule
3284
+ * Optional subscription id for the rule
1943
3285
  */
1944
- subscriptionIdentifier?: string | null;
3286
+ subscriptionId?: string | null;
1945
3287
  }
1946
3288
  export declare namespace RuleUpdateParams {
1947
3289
  interface Collection {
@@ -1952,12 +3294,20 @@ export declare namespace RuleUpdateParams {
1952
3294
  /**
1953
3295
  * Blockchain network for the collection
1954
3296
  */
1955
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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;
1956
3302
  }
1957
3303
  /**
1958
3304
  * Additional metadata for the loyalty rule
1959
3305
  */
1960
3306
  interface Metadata {
3307
+ /**
3308
+ * Number of tokens per batch.
3309
+ */
3310
+ batchSize?: number | null;
1961
3311
  /**
1962
3312
  * Text displayed on the action button.
1963
3313
  */
@@ -1982,6 +3332,16 @@ export declare namespace RuleUpdateParams {
1982
3332
  * Array of collections associated with the rule.
1983
3333
  */
1984
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;
1985
3345
  /**
1986
3346
  * Object containing details for the call-to-action.
1987
3347
  */
@@ -1990,6 +3350,10 @@ export declare namespace RuleUpdateParams {
1990
3350
  * API key for custom rewards integration.
1991
3351
  */
1992
3352
  customRewardsApiKey?: string;
3353
+ /**
3354
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
3355
+ */
3356
+ directRpc?: boolean;
1993
3357
  /**
1994
3358
  * Array of Discord servers, channels, and roles to join.
1995
3359
  */
@@ -2010,10 +3374,18 @@ export declare namespace RuleUpdateParams {
2010
3374
  * Flag indicating whether the verified multiplier is enabled.
2011
3375
  */
2012
3376
  enableVerifiedMultiplier?: boolean;
3377
+ /**
3378
+ * Fill source of the order for the token sale
3379
+ */
3380
+ fillSource?: string;
2013
3381
  /**
2014
3382
  * Percentage reward given to a user for their first referral.
2015
3383
  */
2016
3384
  firstReferralReward?: number | null;
3385
+ /**
3386
+ * Flag indicating whether the fill source is included.
3387
+ */
3388
+ hasFillSource?: boolean;
2017
3389
  /**
2018
3390
  * Indicates if the item has never been sold.
2019
3391
  */
@@ -2034,10 +3406,18 @@ export declare namespace RuleUpdateParams {
2034
3406
  * URL of the image associated with the rule.
2035
3407
  */
2036
3408
  imageUrl?: string | null;
3409
+ /**
3410
+ * If enabled, the first transaction done on the platform will complete this rule
3411
+ */
3412
+ isCheckInOnEveryTxn?: boolean;
2037
3413
  /**
2038
3414
  * Indicates if the multiplier has been applied to rewards.
2039
3415
  */
2040
3416
  isMultiplierApplied?: boolean;
3417
+ /**
3418
+ * Flag indicating if the rule is restricted to new users.
3419
+ */
3420
+ isRestrictedToNewUsers?: boolean;
2041
3421
  /**
2042
3422
  * Flag indicating if rewards are applied retroactively.
2043
3423
  */
@@ -2050,6 +3430,10 @@ export declare namespace RuleUpdateParams {
2050
3430
  * Optional link associated with the metadata.
2051
3431
  */
2052
3432
  link?: string | null;
3433
+ /**
3434
+ * Liquidity pool details.
3435
+ */
3436
+ liquidity?: Metadata.Liquidity;
2053
3437
  /**
2054
3438
  * Maximum quantity constraint for token holding.
2055
3439
  */
@@ -2074,6 +3458,10 @@ export declare namespace RuleUpdateParams {
2074
3458
  * Flag indicating whether to include only non-listed items.
2075
3459
  */
2076
3460
  onlyNonListed?: boolean;
3461
+ /**
3462
+ * Indicates if only existing users are rewarded.
3463
+ */
3464
+ onlyRewardExistingUser?: boolean;
2077
3465
  /**
2078
3466
  * give points for only one token ownership per contract
2079
3467
  */
@@ -2082,6 +3470,18 @@ export declare namespace RuleUpdateParams {
2082
3470
  * Promotional code associated with the rule.
2083
3471
  */
2084
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';
2085
3485
  /**
2086
3486
  * Array defining ranges and corresponding rewards.
2087
3487
  */
@@ -2094,10 +3494,43 @@ export declare namespace RuleUpdateParams {
2094
3494
  * Lump sum reward given to a referrer.
2095
3495
  */
2096
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;
2097
3517
  /**
2098
3518
  * Flag indicating if rewards are given per impression.
2099
3519
  */
2100
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;
2101
3534
  /**
2102
3535
  * Currency associated with sales.
2103
3536
  */
@@ -2121,7 +3554,7 @@ export declare namespace RuleUpdateParams {
2121
3554
  /**
2122
3555
  * Social media platform associated with the rule.
2123
3556
  */
2124
- 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;
2125
3558
  /**
2126
3559
  * URL of the social platform's logo.
2127
3560
  */
@@ -2130,10 +3563,18 @@ export declare namespace RuleUpdateParams {
2130
3563
  * Name of the social platform.
2131
3564
  */
2132
3565
  socialPlatformName?: string | null;
3566
+ /**
3567
+ * ID of the Steam app.
3568
+ */
3569
+ steamAppId?: string | null;
2133
3570
  /**
2134
3571
  * Array of streak milestones and corresponding rewards.
2135
3572
  */
2136
3573
  streakArray?: Array<Metadata.StreakArray> | null;
3574
+ /**
3575
+ * Metadata for swap loyalty rules
3576
+ */
3577
+ swap?: Metadata.Swap;
2137
3578
  /**
2138
3579
  * ID of the Telegram channel.
2139
3580
  */
@@ -2146,6 +3587,11 @@ export declare namespace RuleUpdateParams {
2146
3587
  * Flag indicating if all contracts are tracked.
2147
3588
  */
2148
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;
2149
3595
  /**
2150
3596
  * URL of the associated Twitter account.
2151
3597
  */
@@ -2181,7 +3627,15 @@ export declare namespace RuleUpdateParams {
2181
3627
  /**
2182
3628
  * Type of wallet associated with the rule.
2183
3629
  */
2184
- 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;
2185
3639
  }
2186
3640
  namespace Metadata {
2187
3641
  interface Collection {
@@ -2196,7 +3650,7 @@ export declare namespace RuleUpdateParams {
2196
3650
  /**
2197
3651
  * Blockchain network of the collection.
2198
3652
  */
2199
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
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';
2200
3654
  }
2201
3655
  /**
2202
3656
  * Object containing details for the call-to-action.
@@ -2261,6 +3715,49 @@ export declare namespace RuleUpdateParams {
2261
3715
  */
2262
3716
  id: string;
2263
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
+ }
2264
3761
  interface Range {
2265
3762
  /**
2266
3763
  * Reward amount for this range.
@@ -2274,6 +3771,14 @@ export declare namespace RuleUpdateParams {
2274
3771
  * Start value of the range.
2275
3772
  */
2276
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;
2277
3782
  }
2278
3783
  /**
2279
3784
  * Object defining referral requirements.
@@ -2317,18 +3822,14 @@ export declare namespace RuleUpdateParams {
2317
3822
  * Object containing details of the associated smart contract.
2318
3823
  */
2319
3824
  interface SmartContract {
2320
- /**
2321
- * ABI of the smart contract.
2322
- */
2323
- abi?: string | null;
2324
3825
  /**
2325
3826
  * Mapping of addresses for the smart contract.
2326
3827
  */
2327
3828
  addressMapping?: string | null;
2328
3829
  /**
2329
- * Array of bonus details applied to the rule.
3830
+ * Object containing details of the amount multiplier from the event.
2330
3831
  */
2331
- bonus?: Array<SmartContract.Bonus> | null;
3832
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
2332
3833
  /**
2333
3834
  * ID of the smart contract.
2334
3835
  */
@@ -2337,58 +3838,28 @@ export declare namespace RuleUpdateParams {
2337
3838
  * Criteria to evaluate the smart contract event.
2338
3839
  */
2339
3840
  criteria?: 'everyEvent' | 'byParameter' | null;
2340
- /**
2341
- * Time range applied to the rule.
2342
- */
2343
- customRange?: SmartContract.CustomRange | null;
2344
3841
  /**
2345
3842
  * Event emitted by the smart contract.
2346
3843
  */
2347
3844
  event?: string | null;
2348
- /**
2349
- * Maximum value allowed for the parameter.
2350
- */
2351
- max?: number | null;
2352
3845
  /**
2353
3846
  * Array of parameters for the smart contract.
2354
3847
  */
2355
3848
  params?: Array<SmartContract.Param> | null;
2356
3849
  /**
2357
- * Flag indicating if a bonus is applied.
2358
- */
2359
- withBonus?: boolean | null;
2360
- /**
2361
- * Flag indicating if a custom range is applied.
2362
- */
2363
- withCustomRange?: boolean | null;
2364
- /**
2365
- * Flag indicating if a maximum limit is applied.
3850
+ * Type of the smart contract interaction.
2366
3851
  */
2367
- withMax?: boolean | null;
3852
+ type?: 'function' | 'event' | null;
2368
3853
  }
2369
3854
  namespace SmartContract {
2370
- interface Bonus {
2371
- /**
2372
- * Amount of the bonus.
2373
- */
2374
- amount?: number | null;
2375
- /**
2376
- * Number of times the bonus is applied.
2377
- */
2378
- count?: number | null;
2379
- }
2380
3855
  /**
2381
- * Time range applied to the rule.
3856
+ * Object containing details of the amount multiplier from the event.
2382
3857
  */
2383
- interface CustomRange {
2384
- /**
2385
- * End time of the custom range.
2386
- */
2387
- endsAt?: string | null;
3858
+ interface AmountMultiplier {
2388
3859
  /**
2389
- * Start time of the custom range.
3860
+ * Mapping of the value for the smart contract.
2390
3861
  */
2391
- startsAt?: string | null;
3862
+ valueMapping?: string | null;
2392
3863
  }
2393
3864
  interface Param {
2394
3865
  /**
@@ -2425,21 +3896,60 @@ export declare namespace RuleUpdateParams {
2425
3896
  */
2426
3897
  streakMilestone: number;
2427
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
+ }
2428
3917
  }
2429
3918
  }
2430
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;
2431
3928
  /**
2432
3929
  * Address of the collection to filter by
2433
3930
  */
2434
3931
  collectionAddress?: string;
2435
3932
  /**
2436
- * 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
+ * Maximum number of records to return (max 100)
2437
3943
  */
2438
3944
  limit?: number;
2439
3945
  /**
2440
3946
  * ID of the loyalty rule group to filter results
2441
3947
  */
2442
3948
  loyaltyRuleGroupId?: string;
3949
+ /**
3950
+ * The IDs of the loyalty rule
3951
+ */
3952
+ loyaltyRuleId?: string | Array<string>;
2443
3953
  /**
2444
3954
  * Unique identifier for the organization to filter by
2445
3955
  */
@@ -2453,15 +3963,34 @@ export interface RuleListParams {
2453
3963
  */
2454
3964
  websiteId?: string;
2455
3965
  }
3966
+ export interface RuleDeleteParams {
3967
+ /**
3968
+ * Whether to debit loyalty points
3969
+ */
3970
+ debitLoyaltyPoints?: string;
3971
+ }
2456
3972
  export interface RuleCompleteParams {
2457
3973
  /**
2458
- * Link to the comment made by user
3974
+ * Override amount for the reward (rounded to nearest whole number). This will
3975
+ * override the rule amount and reward the integer passed.
3976
+ */
3977
+ amount?: number | null;
3978
+ /**
3979
+ * Link to the post/comment made by user
3980
+ */
3981
+ contentUrl?: string;
3982
+ /**
3983
+ * Unique key to ensure idempotent requests.
2459
3984
  */
2460
- commentLink?: string;
3985
+ idempotencyKey?: string;
2461
3986
  /**
2462
3987
  * ID of the choice selected by the user
2463
3988
  */
2464
3989
  loyaltyQuestionChoiceId?: string;
3990
+ /**
3991
+ * Value to compare with the range
3992
+ */
3993
+ rangeValue?: number | null;
2465
3994
  /**
2466
3995
  * Unique identifier for the user
2467
3996
  */
@@ -2472,7 +4001,7 @@ export interface RuleCompleteParams {
2472
4001
  verificationCode?: string;
2473
4002
  /**
2474
4003
  * Flag indicating if only verification is required, this will not create a
2475
- * transaction and reward the user
4004
+ * transaction and reward the user.
2476
4005
  */
2477
4006
  verifyOnly?: string;
2478
4007
  /**
@@ -2480,12 +4009,13 @@ export interface RuleCompleteParams {
2480
4009
  */
2481
4010
  walletAddress?: string;
2482
4011
  }
2483
- export interface RuleStatusParams {
2484
- organizationId: string;
2485
- websiteId: string;
4012
+ export interface RuleGetStatusParams {
4013
+ organizationId?: string;
2486
4014
  userId?: string;
4015
+ walletAddress?: string;
4016
+ websiteId?: string;
2487
4017
  }
2488
4018
  export declare namespace Rules {
2489
- export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleStatusResponse as RuleStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleCompleteParams as RuleCompleteParams, type RuleStatusParams as RuleStatusParams, };
4019
+ 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, };
2490
4020
  }
2491
4021
  //# sourceMappingURL=rules.d.ts.map