@snagsolutions/sdk 0.1.0-alpha.230 → 0.1.0-alpha.232

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 (786) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +42 -112
  3. package/_shims/MultipartBody.d.ts +9 -0
  4. package/_shims/MultipartBody.d.ts.map +1 -0
  5. package/_shims/MultipartBody.js +16 -0
  6. package/_shims/MultipartBody.js.map +1 -0
  7. package/_shims/MultipartBody.mjs +12 -0
  8. package/_shims/MultipartBody.mjs.map +1 -0
  9. package/_shims/README.md +46 -0
  10. package/_shims/auto/runtime-bun.d.ts +5 -0
  11. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  12. package/_shims/auto/runtime-bun.js +21 -0
  13. package/_shims/auto/runtime-bun.js.map +1 -0
  14. package/_shims/auto/runtime-bun.mjs +2 -0
  15. package/_shims/auto/runtime-bun.mjs.map +1 -0
  16. package/_shims/auto/runtime-node.d.ts +5 -0
  17. package/_shims/auto/runtime-node.d.ts.map +1 -0
  18. package/_shims/auto/runtime-node.js +21 -0
  19. package/_shims/auto/runtime-node.js.map +1 -0
  20. package/_shims/auto/runtime-node.mjs +2 -0
  21. package/_shims/auto/runtime-node.mjs.map +1 -0
  22. package/_shims/auto/runtime.d.ts +5 -0
  23. package/_shims/auto/runtime.d.ts.map +1 -0
  24. package/_shims/auto/runtime.js +21 -0
  25. package/_shims/auto/runtime.js.map +1 -0
  26. package/_shims/auto/runtime.mjs +2 -0
  27. package/_shims/auto/runtime.mjs.map +1 -0
  28. package/_shims/auto/types-node.d.ts +5 -0
  29. package/_shims/auto/types-node.d.ts.map +1 -0
  30. package/_shims/auto/types-node.js +21 -0
  31. package/_shims/auto/types-node.js.map +1 -0
  32. package/_shims/auto/types-node.mjs +2 -0
  33. package/_shims/auto/types-node.mjs.map +1 -0
  34. package/_shims/auto/types.d.ts +101 -0
  35. package/_shims/auto/types.js +3 -0
  36. package/_shims/auto/types.mjs +3 -0
  37. package/_shims/bun-runtime.d.ts +6 -0
  38. package/_shims/bun-runtime.d.ts.map +1 -0
  39. package/_shims/bun-runtime.js +14 -0
  40. package/_shims/bun-runtime.js.map +1 -0
  41. package/_shims/bun-runtime.mjs +10 -0
  42. package/_shims/bun-runtime.mjs.map +1 -0
  43. package/_shims/index.d.ts +83 -0
  44. package/_shims/index.js +17 -0
  45. package/_shims/index.mjs +11 -0
  46. package/_shims/manual-types.d.ts +12 -0
  47. package/_shims/manual-types.js +3 -0
  48. package/_shims/manual-types.mjs +3 -0
  49. package/_shims/node-runtime.d.ts +3 -0
  50. package/_shims/node-runtime.d.ts.map +1 -0
  51. package/_shims/node-runtime.js +89 -0
  52. package/_shims/node-runtime.js.map +1 -0
  53. package/_shims/node-runtime.mjs +56 -0
  54. package/_shims/node-runtime.mjs.map +1 -0
  55. package/_shims/node-types.d.ts +42 -0
  56. package/_shims/node-types.js +3 -0
  57. package/_shims/node-types.mjs +3 -0
  58. package/_shims/registry.d.ts +37 -0
  59. package/_shims/registry.d.ts.map +1 -0
  60. package/_shims/registry.js +41 -0
  61. package/_shims/registry.js.map +1 -0
  62. package/_shims/registry.mjs +37 -0
  63. package/_shims/registry.mjs.map +1 -0
  64. package/_shims/web-runtime.d.ts +5 -0
  65. package/_shims/web-runtime.d.ts.map +1 -0
  66. package/_shims/web-runtime.js +78 -0
  67. package/_shims/web-runtime.js.map +1 -0
  68. package/_shims/web-runtime.mjs +71 -0
  69. package/_shims/web-runtime.mjs.map +1 -0
  70. package/_shims/web-types.d.ts +83 -0
  71. package/_shims/web-types.js +3 -0
  72. package/_shims/web-types.mjs +3 -0
  73. package/core.d.ts +255 -0
  74. package/core.d.ts.map +1 -0
  75. package/core.js +929 -0
  76. package/core.js.map +1 -0
  77. package/core.mjs +897 -0
  78. package/core.mjs.map +1 -0
  79. package/error.d.ts +46 -1
  80. package/error.d.ts.map +1 -1
  81. package/error.js +110 -3
  82. package/error.js.map +1 -1
  83. package/error.mjs +96 -1
  84. package/error.mjs.map +1 -1
  85. package/index.d.mts +138 -6
  86. package/index.d.ts +137 -5
  87. package/index.d.ts.map +1 -1
  88. package/index.js +136 -12
  89. package/index.js.map +1 -1
  90. package/index.mjs +109 -5
  91. package/index.mjs.map +1 -1
  92. package/internal/qs/formats.d.ts +0 -1
  93. package/internal/qs/formats.d.ts.map +1 -1
  94. package/internal/qs/formats.js +2 -4
  95. package/internal/qs/formats.js.map +1 -1
  96. package/internal/qs/formats.mjs +1 -2
  97. package/internal/qs/formats.mjs.map +1 -1
  98. package/internal/qs/index.d.ts.map +1 -1
  99. package/internal/qs/stringify.d.ts.map +1 -1
  100. package/internal/qs/stringify.js +19 -16
  101. package/internal/qs/stringify.js.map +1 -1
  102. package/internal/qs/stringify.mjs +19 -17
  103. package/internal/qs/stringify.mjs.map +1 -1
  104. package/internal/qs/utils.d.ts +0 -1
  105. package/internal/qs/utils.d.ts.map +1 -1
  106. package/internal/qs/utils.js +21 -22
  107. package/internal/qs/utils.js.map +1 -1
  108. package/internal/qs/utils.mjs +12 -12
  109. package/internal/qs/utils.mjs.map +1 -1
  110. package/package.json +65 -101
  111. package/resource.d.ts +5 -1
  112. package/resource.d.ts.map +1 -1
  113. package/resource.js +8 -3
  114. package/resource.js.map +1 -1
  115. package/resource.mjs +6 -1
  116. package/resource.mjs.map +1 -1
  117. package/resources/assets.d.ts +3 -4
  118. package/resources/assets.d.ts.map +1 -1
  119. package/resources/assets.js +1 -1
  120. package/resources/assets.js.map +1 -1
  121. package/resources/assets.mjs +1 -1
  122. package/resources/assets.mjs.map +1 -1
  123. package/resources/auctions/auctions.d.ts +6 -6
  124. package/resources/auctions/auctions.d.ts.map +1 -1
  125. package/resources/auctions/auctions.js +29 -11
  126. package/resources/auctions/auctions.js.map +1 -1
  127. package/resources/auctions/auctions.mjs +5 -9
  128. package/resources/auctions/auctions.mjs.map +1 -1
  129. package/resources/auctions/index.d.ts.map +1 -1
  130. package/resources/auctions/website-user-attributes/index.d.ts.map +1 -1
  131. package/resources/auctions/website-user-attributes/values.d.ts +4 -5
  132. package/resources/auctions/website-user-attributes/values.d.ts.map +1 -1
  133. package/resources/auctions/website-user-attributes/values.js +1 -1
  134. package/resources/auctions/website-user-attributes/values.js.map +1 -1
  135. package/resources/auctions/website-user-attributes/values.mjs +1 -1
  136. package/resources/auctions/website-user-attributes/values.mjs.map +1 -1
  137. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts +6 -6
  138. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts.map +1 -1
  139. package/resources/auctions/website-user-attributes/website-user-attributes.js +31 -15
  140. package/resources/auctions/website-user-attributes/website-user-attributes.js.map +1 -1
  141. package/resources/auctions/website-user-attributes/website-user-attributes.mjs +7 -13
  142. package/resources/auctions/website-user-attributes/website-user-attributes.mjs.map +1 -1
  143. package/resources/auctions/website-user-attributes.d.ts.map +1 -1
  144. package/resources/auctions/website-user-attributes.js +15 -2
  145. package/resources/auctions/website-user-attributes.js.map +1 -1
  146. package/resources/auctions.d.ts.map +1 -1
  147. package/resources/auctions.js +15 -2
  148. package/resources/auctions.js.map +1 -1
  149. package/resources/auth.d.ts +52 -5
  150. package/resources/auth.d.ts.map +1 -1
  151. package/resources/auth.js +11 -5
  152. package/resources/auth.js.map +1 -1
  153. package/resources/auth.mjs +11 -5
  154. package/resources/auth.mjs.map +1 -1
  155. package/resources/index.d.ts +1 -1
  156. package/resources/index.d.ts.map +1 -1
  157. package/resources/index.js.map +1 -1
  158. package/resources/index.mjs +1 -1
  159. package/resources/index.mjs.map +1 -1
  160. package/resources/loyalty/account-streaks.d.ts +3 -4
  161. package/resources/loyalty/account-streaks.d.ts.map +1 -1
  162. package/resources/loyalty/account-streaks.js +1 -1
  163. package/resources/loyalty/account-streaks.js.map +1 -1
  164. package/resources/loyalty/account-streaks.mjs +1 -1
  165. package/resources/loyalty/account-streaks.mjs.map +1 -1
  166. package/resources/loyalty/accounts.d.ts +5 -5
  167. package/resources/loyalty/accounts.d.ts.map +1 -1
  168. package/resources/loyalty/accounts.js +6 -11
  169. package/resources/loyalty/accounts.js.map +1 -1
  170. package/resources/loyalty/accounts.mjs +6 -11
  171. package/resources/loyalty/accounts.mjs.map +1 -1
  172. package/resources/loyalty/badges.d.ts +12 -9
  173. package/resources/loyalty/badges.d.ts.map +1 -1
  174. package/resources/loyalty/badges.js +18 -44
  175. package/resources/loyalty/badges.js.map +1 -1
  176. package/resources/loyalty/badges.mjs +18 -44
  177. package/resources/loyalty/badges.mjs.map +1 -1
  178. package/resources/loyalty/currencies.d.ts +4 -5
  179. package/resources/loyalty/currencies.d.ts.map +1 -1
  180. package/resources/loyalty/currencies.js +1 -1
  181. package/resources/loyalty/currencies.js.map +1 -1
  182. package/resources/loyalty/currencies.mjs +1 -1
  183. package/resources/loyalty/currencies.mjs.map +1 -1
  184. package/resources/loyalty/index.d.ts.map +1 -1
  185. package/resources/loyalty/loyalty.d.ts +1 -1
  186. package/resources/loyalty/loyalty.d.ts.map +1 -1
  187. package/resources/loyalty/loyalty.js +35 -13
  188. package/resources/loyalty/loyalty.js.map +1 -1
  189. package/resources/loyalty/loyalty.mjs +1 -1
  190. package/resources/loyalty/multipliers.d.ts +10 -9
  191. package/resources/loyalty/multipliers.d.ts.map +1 -1
  192. package/resources/loyalty/multipliers.js +14 -26
  193. package/resources/loyalty/multipliers.js.map +1 -1
  194. package/resources/loyalty/multipliers.mjs +14 -26
  195. package/resources/loyalty/multipliers.mjs.map +1 -1
  196. package/resources/loyalty/questions-responses.d.ts +5 -5
  197. package/resources/loyalty/questions-responses.d.ts.map +1 -1
  198. package/resources/loyalty/questions-responses.js +5 -11
  199. package/resources/loyalty/questions-responses.js.map +1 -1
  200. package/resources/loyalty/questions-responses.mjs +5 -11
  201. package/resources/loyalty/questions-responses.mjs.map +1 -1
  202. package/resources/loyalty/questions.d.ts +5 -6
  203. package/resources/loyalty/questions.d.ts.map +1 -1
  204. package/resources/loyalty/questions.js +2 -3
  205. package/resources/loyalty/questions.js.map +1 -1
  206. package/resources/loyalty/questions.mjs +2 -3
  207. package/resources/loyalty/questions.mjs.map +1 -1
  208. package/resources/loyalty/rule-edits.d.ts +4 -5
  209. package/resources/loyalty/rule-edits.d.ts.map +1 -1
  210. package/resources/loyalty/rule-edits.js +2 -3
  211. package/resources/loyalty/rule-edits.js.map +1 -1
  212. package/resources/loyalty/rule-edits.mjs +2 -3
  213. package/resources/loyalty/rule-edits.mjs.map +1 -1
  214. package/resources/loyalty/rule-groups.d.ts +8 -7
  215. package/resources/loyalty/rule-groups.d.ts.map +1 -1
  216. package/resources/loyalty/rule-groups.js +10 -24
  217. package/resources/loyalty/rule-groups.js.map +1 -1
  218. package/resources/loyalty/rule-groups.mjs +10 -24
  219. package/resources/loyalty/rule-groups.mjs.map +1 -1
  220. package/resources/loyalty/rules.d.ts +12 -9
  221. package/resources/loyalty/rules.d.ts.map +1 -1
  222. package/resources/loyalty/rules.js +18 -48
  223. package/resources/loyalty/rules.js.map +1 -1
  224. package/resources/loyalty/rules.mjs +18 -48
  225. package/resources/loyalty/rules.mjs.map +1 -1
  226. package/resources/loyalty/transactions/index.d.ts.map +1 -1
  227. package/resources/loyalty/transactions/posts.d.ts +5 -5
  228. package/resources/loyalty/transactions/posts.d.ts.map +1 -1
  229. package/resources/loyalty/transactions/posts.js +6 -14
  230. package/resources/loyalty/transactions/posts.js.map +1 -1
  231. package/resources/loyalty/transactions/posts.mjs +6 -14
  232. package/resources/loyalty/transactions/posts.mjs.map +1 -1
  233. package/resources/loyalty/transactions/rule-statuses.d.ts +5 -5
  234. package/resources/loyalty/transactions/rule-statuses.d.ts.map +1 -1
  235. package/resources/loyalty/transactions/rule-statuses.js +5 -10
  236. package/resources/loyalty/transactions/rule-statuses.js.map +1 -1
  237. package/resources/loyalty/transactions/rule-statuses.mjs +5 -10
  238. package/resources/loyalty/transactions/rule-statuses.mjs.map +1 -1
  239. package/resources/loyalty/transactions/transactions.d.ts +8 -8
  240. package/resources/loyalty/transactions/transactions.d.ts.map +1 -1
  241. package/resources/loyalty/transactions/transactions.js +30 -14
  242. package/resources/loyalty/transactions/transactions.js.map +1 -1
  243. package/resources/loyalty/transactions/transactions.mjs +5 -11
  244. package/resources/loyalty/transactions/transactions.mjs.map +1 -1
  245. package/resources/loyalty/transactions.d.ts.map +1 -1
  246. package/resources/loyalty/transactions.js +15 -2
  247. package/resources/loyalty/transactions.js.map +1 -1
  248. package/resources/loyalty.d.ts.map +1 -1
  249. package/resources/loyalty.js +15 -2
  250. package/resources/loyalty.js.map +1 -1
  251. package/resources/minting/allowlist.d.ts +4 -5
  252. package/resources/minting/allowlist.d.ts.map +1 -1
  253. package/resources/minting/allowlist.js +1 -1
  254. package/resources/minting/allowlist.js.map +1 -1
  255. package/resources/minting/allowlist.mjs +1 -1
  256. package/resources/minting/allowlist.mjs.map +1 -1
  257. package/resources/minting/contracts.d.ts +5 -5
  258. package/resources/minting/contracts.d.ts.map +1 -1
  259. package/resources/minting/contracts.js +5 -9
  260. package/resources/minting/contracts.js.map +1 -1
  261. package/resources/minting/contracts.mjs +5 -9
  262. package/resources/minting/contracts.mjs.map +1 -1
  263. package/resources/minting/index.d.ts.map +1 -1
  264. package/resources/minting/minting.d.ts +4 -5
  265. package/resources/minting/minting.d.ts.map +1 -1
  266. package/resources/minting/minting.js +27 -5
  267. package/resources/minting/minting.js.map +1 -1
  268. package/resources/minting/minting.mjs +1 -1
  269. package/resources/minting/minting.mjs.map +1 -1
  270. package/resources/minting/status.d.ts +4 -5
  271. package/resources/minting/status.d.ts.map +1 -1
  272. package/resources/minting/status.js +3 -4
  273. package/resources/minting/status.js.map +1 -1
  274. package/resources/minting/status.mjs +3 -4
  275. package/resources/minting/status.mjs.map +1 -1
  276. package/resources/minting.d.ts.map +1 -1
  277. package/resources/minting.js +15 -2
  278. package/resources/minting.js.map +1 -1
  279. package/resources/referral/index.d.ts.map +1 -1
  280. package/resources/referral/referral.d.ts +3 -4
  281. package/resources/referral/referral.d.ts.map +1 -1
  282. package/resources/referral/referral.js +25 -3
  283. package/resources/referral/referral.js.map +1 -1
  284. package/resources/referral/referral.mjs +1 -1
  285. package/resources/referral/referral.mjs.map +1 -1
  286. package/resources/referral/users.d.ts +5 -5
  287. package/resources/referral/users.d.ts.map +1 -1
  288. package/resources/referral/users.js +5 -9
  289. package/resources/referral/users.js.map +1 -1
  290. package/resources/referral/users.mjs +5 -9
  291. package/resources/referral/users.mjs.map +1 -1
  292. package/resources/referral.d.ts.map +1 -1
  293. package/resources/referral.js +15 -2
  294. package/resources/referral.js.map +1 -1
  295. package/resources/token-claims.d.ts +10 -9
  296. package/resources/token-claims.d.ts.map +1 -1
  297. package/resources/token-claims.js +16 -16
  298. package/resources/token-claims.js.map +1 -1
  299. package/resources/token-claims.mjs +16 -16
  300. package/resources/token-claims.mjs.map +1 -1
  301. package/resources/users/index.d.ts.map +1 -1
  302. package/resources/users/metadatas.d.ts +6 -5
  303. package/resources/users/metadatas.d.ts.map +1 -1
  304. package/resources/users/metadatas.js +8 -17
  305. package/resources/users/metadatas.js.map +1 -1
  306. package/resources/users/metadatas.mjs +8 -17
  307. package/resources/users/metadatas.mjs.map +1 -1
  308. package/resources/users/users.d.ts +13 -9
  309. package/resources/users/users.d.ts.map +1 -1
  310. package/resources/users/users.js +29 -11
  311. package/resources/users/users.js.map +1 -1
  312. package/resources/users/users.mjs +5 -9
  313. package/resources/users/users.mjs.map +1 -1
  314. package/resources/users.d.ts.map +1 -1
  315. package/resources/users.js +15 -2
  316. package/resources/users.js.map +1 -1
  317. package/resources/websites/index.d.ts.map +1 -1
  318. package/resources/websites/website-collections.d.ts +4 -5
  319. package/resources/websites/website-collections.d.ts.map +1 -1
  320. package/resources/websites/website-collections.js +2 -3
  321. package/resources/websites/website-collections.js.map +1 -1
  322. package/resources/websites/website-collections.mjs +2 -3
  323. package/resources/websites/website-collections.mjs.map +1 -1
  324. package/resources/websites/website-user-roles.d.ts +4 -5
  325. package/resources/websites/website-user-roles.d.ts.map +1 -1
  326. package/resources/websites/website-user-roles.js +1 -1
  327. package/resources/websites/website-user-roles.js.map +1 -1
  328. package/resources/websites/website-user-roles.mjs +1 -1
  329. package/resources/websites/website-user-roles.mjs.map +1 -1
  330. package/resources/websites/websites.d.ts +5 -5
  331. package/resources/websites/websites.d.ts.map +1 -1
  332. package/resources/websites/websites.js +30 -13
  333. package/resources/websites/websites.js.map +1 -1
  334. package/resources/websites/websites.mjs +5 -10
  335. package/resources/websites/websites.mjs.map +1 -1
  336. package/resources/websites.d.ts.map +1 -1
  337. package/resources/websites.js +15 -2
  338. package/resources/websites.js.map +1 -1
  339. package/resources.d.ts.map +1 -1
  340. package/resources.js +15 -2
  341. package/resources.js.map +1 -1
  342. package/shims/node.d.ts +30 -0
  343. package/shims/node.d.ts.map +1 -0
  344. package/shims/node.js +31 -0
  345. package/shims/node.js.map +1 -0
  346. package/shims/node.mjs +5 -0
  347. package/shims/node.mjs.map +1 -0
  348. package/shims/web.d.ts +26 -0
  349. package/shims/web.d.ts.map +1 -0
  350. package/shims/web.js +31 -0
  351. package/shims/web.js.map +1 -0
  352. package/shims/web.mjs +5 -0
  353. package/shims/web.mjs.map +1 -0
  354. package/src/_shims/MultipartBody.ts +9 -0
  355. package/src/_shims/README.md +46 -0
  356. package/src/_shims/auto/runtime-bun.ts +4 -0
  357. package/src/_shims/auto/runtime-node.ts +4 -0
  358. package/src/_shims/auto/runtime.ts +4 -0
  359. package/src/_shims/auto/types-node.ts +4 -0
  360. package/src/_shims/auto/types.d.ts +101 -0
  361. package/src/_shims/auto/types.js +3 -0
  362. package/src/_shims/auto/types.mjs +3 -0
  363. package/src/_shims/bun-runtime.ts +14 -0
  364. package/src/_shims/index.d.ts +83 -0
  365. package/src/_shims/index.js +17 -0
  366. package/src/_shims/index.mjs +11 -0
  367. package/src/_shims/manual-types.d.ts +12 -0
  368. package/src/_shims/manual-types.js +3 -0
  369. package/src/_shims/manual-types.mjs +3 -0
  370. package/src/_shims/node-runtime.ts +81 -0
  371. package/src/_shims/node-types.d.ts +42 -0
  372. package/src/_shims/node-types.js +3 -0
  373. package/src/_shims/node-types.mjs +3 -0
  374. package/src/_shims/registry.ts +67 -0
  375. package/src/_shims/web-runtime.ts +103 -0
  376. package/src/_shims/web-types.d.ts +83 -0
  377. package/src/_shims/web-types.js +3 -0
  378. package/src/_shims/web-types.mjs +3 -0
  379. package/src/core.ts +1243 -0
  380. package/src/error.ts +130 -2
  381. package/src/index.ts +342 -5
  382. package/src/internal/qs/formats.ts +1 -2
  383. package/src/internal/qs/stringify.ts +20 -17
  384. package/src/internal/qs/utils.ts +14 -14
  385. package/src/resource.ts +11 -2
  386. package/src/resources/assets.ts +6 -4
  387. package/src/resources/auctions/auctions.ts +17 -9
  388. package/src/resources/auctions/website-user-attributes/values.ts +4 -5
  389. package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +20 -13
  390. package/src/resources/auth.ts +107 -8
  391. package/src/resources/index.ts +7 -1
  392. package/src/resources/loyalty/account-streaks.ts +4 -5
  393. package/src/resources/loyalty/accounts.ts +14 -10
  394. package/src/resources/loyalty/badges.ts +53 -22
  395. package/src/resources/loyalty/currencies.ts +4 -5
  396. package/src/resources/loyalty/loyalty.ts +1 -1
  397. package/src/resources/loyalty/multipliers.ts +35 -19
  398. package/src/resources/loyalty/questions-responses.ts +16 -8
  399. package/src/resources/loyalty/questions.ts +7 -9
  400. package/src/resources/loyalty/rule-edits.ts +6 -8
  401. package/src/resources/loyalty/rule-groups.ts +34 -15
  402. package/src/resources/loyalty/rules.ts +56 -22
  403. package/src/resources/loyalty/transactions/posts.ts +17 -9
  404. package/src/resources/loyalty/transactions/rule-statuses.ts +15 -7
  405. package/src/resources/loyalty/transactions/transactions.ts +24 -14
  406. package/src/resources/minting/allowlist.ts +7 -5
  407. package/src/resources/minting/contracts.ts +12 -7
  408. package/src/resources/minting/minting.ts +8 -6
  409. package/src/resources/minting/status.ts +10 -8
  410. package/src/resources/referral/referral.ts +4 -5
  411. package/src/resources/referral/users.ts +12 -7
  412. package/src/resources/token-claims.ts +39 -26
  413. package/src/resources/users/metadatas.ts +19 -9
  414. package/src/resources/users/users.ts +30 -11
  415. package/src/resources/websites/website-collections.ts +6 -8
  416. package/src/resources/websites/website-user-roles.ts +8 -6
  417. package/src/resources/websites/websites.ts +12 -7
  418. package/src/shims/node.ts +50 -0
  419. package/src/shims/web.ts +50 -0
  420. package/src/tsconfig.json +2 -2
  421. package/src/uploads.ts +255 -2
  422. package/src/version.ts +1 -1
  423. package/uploads.d.ts +74 -1
  424. package/uploads.d.ts.map +1 -1
  425. package/uploads.js +168 -3
  426. package/uploads.js.map +1 -1
  427. package/uploads.mjs +157 -1
  428. package/uploads.mjs.map +1 -1
  429. package/version.d.ts +1 -1
  430. package/version.js +1 -1
  431. package/version.mjs +1 -1
  432. package/api-promise.d.mts +0 -2
  433. package/api-promise.d.mts.map +0 -1
  434. package/api-promise.d.ts +0 -2
  435. package/api-promise.d.ts.map +0 -1
  436. package/api-promise.js +0 -6
  437. package/api-promise.js.map +0 -1
  438. package/api-promise.mjs +0 -2
  439. package/api-promise.mjs.map +0 -1
  440. package/client.d.mts +0 -202
  441. package/client.d.mts.map +0 -1
  442. package/client.d.ts +0 -202
  443. package/client.d.ts.map +0 -1
  444. package/client.js +0 -478
  445. package/client.js.map +0 -1
  446. package/client.mjs +0 -474
  447. package/client.mjs.map +0 -1
  448. package/core/api-promise.d.mts +0 -46
  449. package/core/api-promise.d.mts.map +0 -1
  450. package/core/api-promise.d.ts +0 -46
  451. package/core/api-promise.d.ts.map +0 -1
  452. package/core/api-promise.js +0 -74
  453. package/core/api-promise.js.map +0 -1
  454. package/core/api-promise.mjs +0 -70
  455. package/core/api-promise.mjs.map +0 -1
  456. package/core/error.d.mts +0 -46
  457. package/core/error.d.mts.map +0 -1
  458. package/core/error.d.ts +0 -46
  459. package/core/error.d.ts.map +0 -1
  460. package/core/error.js +0 -113
  461. package/core/error.js.map +0 -1
  462. package/core/error.mjs +0 -97
  463. package/core/error.mjs.map +0 -1
  464. package/core/resource.d.mts +0 -6
  465. package/core/resource.d.mts.map +0 -1
  466. package/core/resource.d.ts +0 -6
  467. package/core/resource.d.ts.map +0 -1
  468. package/core/resource.js +0 -11
  469. package/core/resource.js.map +0 -1
  470. package/core/resource.mjs +0 -7
  471. package/core/resource.mjs.map +0 -1
  472. package/core/uploads.d.mts +0 -3
  473. package/core/uploads.d.mts.map +0 -1
  474. package/core/uploads.d.ts +0 -3
  475. package/core/uploads.d.ts.map +0 -1
  476. package/core/uploads.js +0 -6
  477. package/core/uploads.js.map +0 -1
  478. package/core/uploads.mjs +0 -2
  479. package/core/uploads.mjs.map +0 -1
  480. package/error.d.mts +0 -2
  481. package/error.d.mts.map +0 -1
  482. package/index.d.mts.map +0 -1
  483. package/internal/builtin-types.d.mts +0 -73
  484. package/internal/builtin-types.d.mts.map +0 -1
  485. package/internal/builtin-types.d.ts +0 -73
  486. package/internal/builtin-types.d.ts.map +0 -1
  487. package/internal/builtin-types.js +0 -4
  488. package/internal/builtin-types.js.map +0 -1
  489. package/internal/builtin-types.mjs +0 -3
  490. package/internal/builtin-types.mjs.map +0 -1
  491. package/internal/detect-platform.d.mts +0 -15
  492. package/internal/detect-platform.d.mts.map +0 -1
  493. package/internal/detect-platform.d.ts +0 -15
  494. package/internal/detect-platform.d.ts.map +0 -1
  495. package/internal/detect-platform.js +0 -162
  496. package/internal/detect-platform.js.map +0 -1
  497. package/internal/detect-platform.mjs +0 -157
  498. package/internal/detect-platform.mjs.map +0 -1
  499. package/internal/errors.d.mts +0 -3
  500. package/internal/errors.d.mts.map +0 -1
  501. package/internal/errors.d.ts +0 -3
  502. package/internal/errors.d.ts.map +0 -1
  503. package/internal/errors.js +0 -41
  504. package/internal/errors.js.map +0 -1
  505. package/internal/errors.mjs +0 -36
  506. package/internal/errors.mjs.map +0 -1
  507. package/internal/headers.d.mts +0 -20
  508. package/internal/headers.d.mts.map +0 -1
  509. package/internal/headers.d.ts +0 -20
  510. package/internal/headers.d.ts.map +0 -1
  511. package/internal/headers.js +0 -79
  512. package/internal/headers.js.map +0 -1
  513. package/internal/headers.mjs +0 -74
  514. package/internal/headers.mjs.map +0 -1
  515. package/internal/parse.d.mts +0 -12
  516. package/internal/parse.d.mts.map +0 -1
  517. package/internal/parse.d.ts +0 -12
  518. package/internal/parse.d.ts.map +0 -1
  519. package/internal/parse.js +0 -40
  520. package/internal/parse.js.map +0 -1
  521. package/internal/parse.mjs +0 -37
  522. package/internal/parse.mjs.map +0 -1
  523. package/internal/qs/formats.d.mts +0 -7
  524. package/internal/qs/formats.d.mts.map +0 -1
  525. package/internal/qs/index.d.mts +0 -10
  526. package/internal/qs/index.d.mts.map +0 -1
  527. package/internal/qs/stringify.d.mts +0 -3
  528. package/internal/qs/stringify.d.mts.map +0 -1
  529. package/internal/qs/types.d.mts +0 -57
  530. package/internal/qs/types.d.mts.map +0 -1
  531. package/internal/qs/utils.d.mts +0 -15
  532. package/internal/qs/utils.d.mts.map +0 -1
  533. package/internal/request-options.d.mts +0 -75
  534. package/internal/request-options.d.mts.map +0 -1
  535. package/internal/request-options.d.ts +0 -75
  536. package/internal/request-options.d.ts.map +0 -1
  537. package/internal/request-options.js +0 -14
  538. package/internal/request-options.js.map +0 -1
  539. package/internal/request-options.mjs +0 -10
  540. package/internal/request-options.mjs.map +0 -1
  541. package/internal/shim-types.d.mts +0 -17
  542. package/internal/shim-types.d.mts.map +0 -1
  543. package/internal/shim-types.d.ts +0 -17
  544. package/internal/shim-types.d.ts.map +0 -1
  545. package/internal/shim-types.js +0 -4
  546. package/internal/shim-types.js.map +0 -1
  547. package/internal/shim-types.mjs +0 -3
  548. package/internal/shim-types.mjs.map +0 -1
  549. package/internal/shims.d.mts +0 -20
  550. package/internal/shims.d.mts.map +0 -1
  551. package/internal/shims.d.ts +0 -20
  552. package/internal/shims.d.ts.map +0 -1
  553. package/internal/shims.js +0 -92
  554. package/internal/shims.js.map +0 -1
  555. package/internal/shims.mjs +0 -85
  556. package/internal/shims.mjs.map +0 -1
  557. package/internal/to-file.d.mts +0 -45
  558. package/internal/to-file.d.mts.map +0 -1
  559. package/internal/to-file.d.ts +0 -45
  560. package/internal/to-file.d.ts.map +0 -1
  561. package/internal/to-file.js +0 -91
  562. package/internal/to-file.js.map +0 -1
  563. package/internal/to-file.mjs +0 -88
  564. package/internal/to-file.mjs.map +0 -1
  565. package/internal/tslib.js +0 -81
  566. package/internal/tslib.mjs +0 -17
  567. package/internal/types.d.mts +0 -69
  568. package/internal/types.d.mts.map +0 -1
  569. package/internal/types.d.ts +0 -69
  570. package/internal/types.d.ts.map +0 -1
  571. package/internal/types.js +0 -4
  572. package/internal/types.js.map +0 -1
  573. package/internal/types.mjs +0 -3
  574. package/internal/types.mjs.map +0 -1
  575. package/internal/uploads.d.mts +0 -42
  576. package/internal/uploads.d.mts.map +0 -1
  577. package/internal/uploads.d.ts +0 -42
  578. package/internal/uploads.d.ts.map +0 -1
  579. package/internal/uploads.js +0 -141
  580. package/internal/uploads.js.map +0 -1
  581. package/internal/uploads.mjs +0 -131
  582. package/internal/uploads.mjs.map +0 -1
  583. package/internal/utils/base64.d.mts +0 -3
  584. package/internal/utils/base64.d.mts.map +0 -1
  585. package/internal/utils/base64.d.ts +0 -3
  586. package/internal/utils/base64.d.ts.map +0 -1
  587. package/internal/utils/base64.js +0 -38
  588. package/internal/utils/base64.js.map +0 -1
  589. package/internal/utils/base64.mjs +0 -33
  590. package/internal/utils/base64.mjs.map +0 -1
  591. package/internal/utils/bytes.d.mts +0 -4
  592. package/internal/utils/bytes.d.mts.map +0 -1
  593. package/internal/utils/bytes.d.ts +0 -4
  594. package/internal/utils/bytes.d.ts.map +0 -1
  595. package/internal/utils/bytes.js +0 -31
  596. package/internal/utils/bytes.js.map +0 -1
  597. package/internal/utils/bytes.mjs +0 -26
  598. package/internal/utils/bytes.mjs.map +0 -1
  599. package/internal/utils/env.d.mts +0 -9
  600. package/internal/utils/env.d.mts.map +0 -1
  601. package/internal/utils/env.d.ts +0 -9
  602. package/internal/utils/env.d.ts.map +0 -1
  603. package/internal/utils/env.js +0 -22
  604. package/internal/utils/env.js.map +0 -1
  605. package/internal/utils/env.mjs +0 -18
  606. package/internal/utils/env.mjs.map +0 -1
  607. package/internal/utils/log.d.mts +0 -37
  608. package/internal/utils/log.d.mts.map +0 -1
  609. package/internal/utils/log.d.ts +0 -37
  610. package/internal/utils/log.d.ts.map +0 -1
  611. package/internal/utils/log.js +0 -86
  612. package/internal/utils/log.js.map +0 -1
  613. package/internal/utils/log.mjs +0 -80
  614. package/internal/utils/log.mjs.map +0 -1
  615. package/internal/utils/path.d.mts +0 -15
  616. package/internal/utils/path.d.mts.map +0 -1
  617. package/internal/utils/path.d.ts +0 -15
  618. package/internal/utils/path.d.ts.map +0 -1
  619. package/internal/utils/path.js +0 -79
  620. package/internal/utils/path.js.map +0 -1
  621. package/internal/utils/path.mjs +0 -74
  622. package/internal/utils/path.mjs.map +0 -1
  623. package/internal/utils/sleep.d.mts +0 -2
  624. package/internal/utils/sleep.d.mts.map +0 -1
  625. package/internal/utils/sleep.d.ts +0 -2
  626. package/internal/utils/sleep.d.ts.map +0 -1
  627. package/internal/utils/sleep.js +0 -7
  628. package/internal/utils/sleep.js.map +0 -1
  629. package/internal/utils/sleep.mjs +0 -3
  630. package/internal/utils/sleep.mjs.map +0 -1
  631. package/internal/utils/uuid.d.mts +0 -5
  632. package/internal/utils/uuid.d.mts.map +0 -1
  633. package/internal/utils/uuid.d.ts +0 -5
  634. package/internal/utils/uuid.d.ts.map +0 -1
  635. package/internal/utils/uuid.js +0 -19
  636. package/internal/utils/uuid.js.map +0 -1
  637. package/internal/utils/uuid.mjs +0 -15
  638. package/internal/utils/uuid.mjs.map +0 -1
  639. package/internal/utils/values.d.mts +0 -18
  640. package/internal/utils/values.d.mts.map +0 -1
  641. package/internal/utils/values.d.ts +0 -18
  642. package/internal/utils/values.d.ts.map +0 -1
  643. package/internal/utils/values.js +0 -112
  644. package/internal/utils/values.js.map +0 -1
  645. package/internal/utils/values.mjs +0 -94
  646. package/internal/utils/values.mjs.map +0 -1
  647. package/internal/utils.d.mts +0 -7
  648. package/internal/utils.d.mts.map +0 -1
  649. package/internal/utils.d.ts +0 -7
  650. package/internal/utils.d.ts.map +0 -1
  651. package/internal/utils.js +0 -11
  652. package/internal/utils.js.map +0 -1
  653. package/internal/utils.mjs +0 -8
  654. package/internal/utils.mjs.map +0 -1
  655. package/resource.d.mts +0 -2
  656. package/resource.d.mts.map +0 -1
  657. package/resources/assets.d.mts +0 -65
  658. package/resources/assets.d.mts.map +0 -1
  659. package/resources/auctions/auctions.d.mts +0 -368
  660. package/resources/auctions/auctions.d.mts.map +0 -1
  661. package/resources/auctions/index.d.mts +0 -3
  662. package/resources/auctions/index.d.mts.map +0 -1
  663. package/resources/auctions/website-user-attributes/index.d.mts +0 -3
  664. package/resources/auctions/website-user-attributes/index.d.mts.map +0 -1
  665. package/resources/auctions/website-user-attributes/values.d.mts +0 -127
  666. package/resources/auctions/website-user-attributes/values.d.mts.map +0 -1
  667. package/resources/auctions/website-user-attributes/website-user-attributes.d.mts +0 -136
  668. package/resources/auctions/website-user-attributes/website-user-attributes.d.mts.map +0 -1
  669. package/resources/auctions/website-user-attributes.d.mts +0 -2
  670. package/resources/auctions/website-user-attributes.d.mts.map +0 -1
  671. package/resources/auctions.d.mts +0 -2
  672. package/resources/auctions.d.mts.map +0 -1
  673. package/resources/auth.d.mts +0 -53
  674. package/resources/auth.d.mts.map +0 -1
  675. package/resources/index.d.mts +0 -10
  676. package/resources/index.d.mts.map +0 -1
  677. package/resources/loyalty/account-streaks.d.mts +0 -97
  678. package/resources/loyalty/account-streaks.d.mts.map +0 -1
  679. package/resources/loyalty/accounts.d.mts +0 -238
  680. package/resources/loyalty/accounts.d.mts.map +0 -1
  681. package/resources/loyalty/badges.d.mts +0 -1398
  682. package/resources/loyalty/badges.d.mts.map +0 -1
  683. package/resources/loyalty/currencies.d.mts +0 -272
  684. package/resources/loyalty/currencies.d.mts.map +0 -1
  685. package/resources/loyalty/index.d.mts +0 -13
  686. package/resources/loyalty/index.d.mts.map +0 -1
  687. package/resources/loyalty/loyalty.d.mts +0 -50
  688. package/resources/loyalty/loyalty.d.mts.map +0 -1
  689. package/resources/loyalty/multipliers.d.mts +0 -221
  690. package/resources/loyalty/multipliers.d.mts.map +0 -1
  691. package/resources/loyalty/questions-responses.d.mts +0 -148
  692. package/resources/loyalty/questions-responses.d.mts.map +0 -1
  693. package/resources/loyalty/questions.d.mts +0 -205
  694. package/resources/loyalty/questions.d.mts.map +0 -1
  695. package/resources/loyalty/rule-edits.d.mts +0 -3165
  696. package/resources/loyalty/rule-edits.d.mts.map +0 -1
  697. package/resources/loyalty/rule-groups.d.mts +0 -826
  698. package/resources/loyalty/rule-groups.d.mts.map +0 -1
  699. package/resources/loyalty/rules.d.mts +0 -4543
  700. package/resources/loyalty/rules.d.mts.map +0 -1
  701. package/resources/loyalty/transactions/index.d.mts +0 -4
  702. package/resources/loyalty/transactions/index.d.mts.map +0 -1
  703. package/resources/loyalty/transactions/posts.d.mts +0 -145
  704. package/resources/loyalty/transactions/posts.d.mts.map +0 -1
  705. package/resources/loyalty/transactions/rule-statuses.d.mts +0 -121
  706. package/resources/loyalty/transactions/rule-statuses.d.mts.map +0 -1
  707. package/resources/loyalty/transactions/transactions.d.mts +0 -564
  708. package/resources/loyalty/transactions/transactions.d.mts.map +0 -1
  709. package/resources/loyalty/transactions.d.mts +0 -2
  710. package/resources/loyalty/transactions.d.mts.map +0 -1
  711. package/resources/loyalty.d.mts +0 -2
  712. package/resources/loyalty.d.mts.map +0 -1
  713. package/resources/minting/allowlist.d.mts +0 -85
  714. package/resources/minting/allowlist.d.mts.map +0 -1
  715. package/resources/minting/contracts.d.mts +0 -165
  716. package/resources/minting/contracts.d.mts.map +0 -1
  717. package/resources/minting/index.d.mts +0 -5
  718. package/resources/minting/index.d.mts.map +0 -1
  719. package/resources/minting/minting.d.mts +0 -143
  720. package/resources/minting/minting.d.mts.map +0 -1
  721. package/resources/minting/status.d.mts +0 -45
  722. package/resources/minting/status.d.mts.map +0 -1
  723. package/resources/minting.d.mts +0 -2
  724. package/resources/minting.d.mts.map +0 -1
  725. package/resources/referral/index.d.mts +0 -3
  726. package/resources/referral/index.d.mts.map +0 -1
  727. package/resources/referral/referral.d.mts +0 -41
  728. package/resources/referral/referral.d.mts.map +0 -1
  729. package/resources/referral/users.d.mts +0 -84
  730. package/resources/referral/users.d.mts.map +0 -1
  731. package/resources/referral.d.mts +0 -2
  732. package/resources/referral.d.mts.map +0 -1
  733. package/resources/token-claims.d.mts +0 -159
  734. package/resources/token-claims.d.mts.map +0 -1
  735. package/resources/users/index.d.mts +0 -3
  736. package/resources/users/index.d.mts.map +0 -1
  737. package/resources/users/metadatas.d.mts +0 -174
  738. package/resources/users/metadatas.d.mts.map +0 -1
  739. package/resources/users/users.d.mts +0 -465
  740. package/resources/users/users.d.mts.map +0 -1
  741. package/resources/users.d.mts +0 -2
  742. package/resources/users.d.mts.map +0 -1
  743. package/resources/websites/index.d.mts +0 -4
  744. package/resources/websites/index.d.mts.map +0 -1
  745. package/resources/websites/website-collections.d.mts +0 -95
  746. package/resources/websites/website-collections.d.mts.map +0 -1
  747. package/resources/websites/website-user-roles.d.mts +0 -97
  748. package/resources/websites/website-user-roles.d.mts.map +0 -1
  749. package/resources/websites/websites.d.mts +0 -329
  750. package/resources/websites/websites.d.mts.map +0 -1
  751. package/resources/websites.d.mts +0 -2
  752. package/resources/websites.d.mts.map +0 -1
  753. package/resources.d.mts +0 -2
  754. package/resources.d.mts.map +0 -1
  755. package/src/api-promise.ts +0 -2
  756. package/src/client.ts +0 -868
  757. package/src/core/README.md +0 -3
  758. package/src/core/api-promise.ts +0 -92
  759. package/src/core/error.ts +0 -130
  760. package/src/core/resource.ts +0 -11
  761. package/src/core/uploads.ts +0 -2
  762. package/src/internal/README.md +0 -3
  763. package/src/internal/builtin-types.ts +0 -93
  764. package/src/internal/detect-platform.ts +0 -196
  765. package/src/internal/errors.ts +0 -33
  766. package/src/internal/headers.ts +0 -97
  767. package/src/internal/parse.ts +0 -56
  768. package/src/internal/request-options.ts +0 -91
  769. package/src/internal/shim-types.ts +0 -26
  770. package/src/internal/shims.ts +0 -107
  771. package/src/internal/to-file.ts +0 -154
  772. package/src/internal/types.ts +0 -95
  773. package/src/internal/uploads.ts +0 -187
  774. package/src/internal/utils/base64.ts +0 -40
  775. package/src/internal/utils/bytes.ts +0 -32
  776. package/src/internal/utils/env.ts +0 -18
  777. package/src/internal/utils/log.ts +0 -127
  778. package/src/internal/utils/path.ts +0 -88
  779. package/src/internal/utils/sleep.ts +0 -3
  780. package/src/internal/utils/uuid.ts +0 -17
  781. package/src/internal/utils/values.ts +0 -105
  782. package/src/internal/utils.ts +0 -8
  783. package/uploads.d.mts +0 -2
  784. package/uploads.d.mts.map +0 -1
  785. package/version.d.mts +0 -2
  786. package/version.d.mts.map +0 -1
@@ -1,3165 +0,0 @@
1
- import { APIResource } from "../../core/resource.mjs";
2
- import { APIPromise } from "../../core/api-promise.mjs";
3
- import { RequestOptions } from "../../internal/request-options.mjs";
4
- export declare class RuleEdits extends APIResource {
5
- /**
6
- * Retrieve configured loyalty rule edits with optional pagination and filters
7
- *
8
- * @example
9
- * ```ts
10
- * const ruleEdits = await client.loyalty.ruleEdits.list({
11
- * loyaltyRuleId: true,
12
- * });
13
- * ```
14
- */
15
- list(query: RuleEditListParams, options?: RequestOptions): APIPromise<RuleEditListResponse>;
16
- /**
17
- * Restore a loyalty rule from a rule edit
18
- *
19
- * @example
20
- * ```ts
21
- * const response = await client.loyalty.ruleEdits.restore(
22
- * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
23
- * );
24
- * ```
25
- */
26
- restore(id: string, body?: RuleEditRestoreParams | null | undefined, options?: RequestOptions): APIPromise<RuleEditRestoreResponse>;
27
- }
28
- export interface RuleEditListResponse {
29
- data: Array<RuleEditListResponse.Data>;
30
- hasNextPage: boolean;
31
- }
32
- export declare namespace RuleEditListResponse {
33
- interface Data {
34
- /**
35
- * Unique identifier for the rule edit
36
- */
37
- id: string;
38
- /**
39
- * Type of action that was made on the rule
40
- */
41
- action: 'create' | 'update' | 'delete' | 'restore';
42
- /**
43
- * Data that was changed on the rule
44
- */
45
- data: Data.Data;
46
- /**
47
- * Timestamp of when the rule edit was made
48
- */
49
- editedAt: string;
50
- /**
51
- * User ID of the user who made the edit
52
- */
53
- editedByUserId: string;
54
- /**
55
- * ID of the loyalty rule
56
- */
57
- loyaltyRuleId: string;
58
- /**
59
- * Unique identifier for the organization
60
- */
61
- organizationId: string;
62
- /**
63
- * Unique identifier for the website
64
- */
65
- websiteId: string;
66
- /**
67
- * Comment that was made on the edit
68
- */
69
- comment?: string;
70
- /**
71
- * Previous data of the rule before the edit
72
- */
73
- previousData?: Data.PreviousData;
74
- }
75
- namespace Data {
76
- /**
77
- * Data that was changed on the rule
78
- */
79
- interface Data {
80
- /**
81
- * Unique identifier for the loyalty rule
82
- */
83
- id: string;
84
- /**
85
- * Amount associated with the loyalty rule
86
- */
87
- amount: number | null;
88
- /**
89
- * Timestamp when the loyalty rule was created
90
- */
91
- createdAt: string;
92
- /**
93
- * Timestamp when the loyalty rule was deleted (if applicable)
94
- */
95
- deletedAt: string | null;
96
- /**
97
- * Description of the loyalty rule
98
- */
99
- description: string;
100
- /**
101
- * End time of the loyalty rule
102
- */
103
- endTime: string | null;
104
- /**
105
- * Frequency of the loyalty rule
106
- */
107
- frequency: string;
108
- /**
109
- * Name of the loyalty rule
110
- */
111
- name: string;
112
- /**
113
- * Unique identifier for the organization
114
- */
115
- organizationId: string;
116
- /**
117
- * Type of the reward
118
- */
119
- rewardType: 'points' | 'multiplier' | 'badge';
120
- /**
121
- * Start time of the loyalty rule
122
- */
123
- startTime: string | null;
124
- /**
125
- * Type of the loyalty rule
126
- */
127
- type: string;
128
- /**
129
- * Timestamp when the loyalty rule was last updated
130
- */
131
- updatedAt: string;
132
- /**
133
- * Unique identifier for the website
134
- */
135
- websiteId: string;
136
- /**
137
- * Optional address of the collection
138
- */
139
- collectionAddress?: string;
140
- /**
141
- * URL of the media associated with the loyalty rule
142
- */
143
- mediaUrl?: string | null;
144
- /**
145
- * Optional metadata for the loyalty rule
146
- */
147
- metadata?: {
148
- [key: string]: Data.Metadata;
149
- };
150
- }
151
- namespace Data {
152
- interface Metadata {
153
- /**
154
- * Flag indicating if the rule allows multiple redemptions. Applies to Enter a Code
155
- * only.
156
- */
157
- allowMultipleRedemptions?: boolean;
158
- /**
159
- * Array of loyalty rule IDs that count as check-in when completed. If ["any"] then
160
- * any rule completions count as check-in.
161
- */
162
- autoCheckInRuleIds?: Array<(string & {}) | 'any'> | null;
163
- /**
164
- * Number of tokens per batch.
165
- */
166
- batchSize?: number | null;
167
- /**
168
- * Text displayed on the action button.
169
- */
170
- buttonText?: string | null;
171
- /**
172
- * Flag indicating if commenting is required.
173
- */
174
- checkComment?: boolean | null;
175
- /**
176
- * Flag indicating if liking the post is required.
177
- */
178
- checkLike?: boolean | null;
179
- /**
180
- * Flag indicating if reposting is required.
181
- */
182
- checkRepost?: boolean | null;
183
- /**
184
- * Text to check in the Twitter post, username, or bio.
185
- */
186
- checkText?: string | Array<string> | null;
187
- /**
188
- * Array of collections associated with the rule.
189
- */
190
- collection?: Array<Metadata.Collection>;
191
- /**
192
- * Conditions for completing the profile.
193
- */
194
- completeProfileConditions?: {
195
- [key: string]: boolean;
196
- } | null;
197
- /**
198
- * Description of the external rule condition (only for external rules)
199
- */
200
- conditionDescription?: string;
201
- /**
202
- * Object containing details for the call-to-action.
203
- */
204
- cta?: Metadata.Cta | null;
205
- /**
206
- * API key for custom rewards integration.
207
- */
208
- customRewardsApiKey?: string;
209
- /**
210
- * Flag indicating if the rule should use direct RPC to get the balance of tokens.
211
- */
212
- directRpc?: boolean;
213
- /**
214
- * Array of Discord servers, channels, and roles to join.
215
- */
216
- discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
217
- /**
218
- * Array of drip quests required to complete the rule.
219
- */
220
- dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
221
- /**
222
- * Flag indicating whether joining Discord servers is required.
223
- */
224
- enableJoinDiscordServers?: boolean | null;
225
- /**
226
- * Flag indicating whether streaks are enabled.
227
- */
228
- enableStreaks?: boolean | null;
229
- /**
230
- * Flag indicating whether the verified multiplier is enabled.
231
- */
232
- enableVerifiedMultiplier?: boolean;
233
- /**
234
- * Type of ERC20 token for the loyalty rule.
235
- */
236
- erc20Type?: 'erc20' | 'native';
237
- /**
238
- * Fill source of the order for the token sale
239
- */
240
- fillSource?: string;
241
- /**
242
- * Percentage reward given to a user for their first referral.
243
- */
244
- firstReferralReward?: number | null;
245
- /**
246
- * Name of the GitHub branch to check for PR merge.
247
- */
248
- githubBranchName?: string | null;
249
- /**
250
- * URL of the GitHub repository to check for star.
251
- */
252
- githubRepoUrl?: string | null;
253
- /**
254
- * Flag indicating whether the fill source is included.
255
- */
256
- hasFillSource?: boolean;
257
- /**
258
- * Indicates if the item has never been sold.
259
- */
260
- hasNeverSold?: boolean;
261
- /**
262
- * Indicates if the full royalty has been paid for items.
263
- */
264
- hasPaidFullRoyalty?: boolean;
265
- /**
266
- * Flag indicating if the sale currency is included.
267
- */
268
- hasSaleCurrency?: boolean;
269
- /**
270
- * Indicates if the user has a verified Twitter account.
271
- */
272
- hasVerifiedTwitter?: boolean;
273
- /**
274
- * URL of the image associated with the rule.
275
- */
276
- imageUrl?: string | null;
277
- /**
278
- * If enabled, the first transaction done on the platform will complete this rule
279
- */
280
- isCheckInOnEveryTxn?: boolean;
281
- /**
282
- * Indicates if the multiplier has been applied to rewards.
283
- */
284
- isMultiplierApplied?: boolean;
285
- /**
286
- * Flag indicating if the rule is restricted to new users.
287
- */
288
- isRestrictedToNewUsers?: boolean;
289
- /**
290
- * Flag indicating if rewards are applied retroactively.
291
- */
292
- isRetroactive?: boolean | null;
293
- /**
294
- * Flag indicating if the token hold multiplier is applied.
295
- */
296
- isTokenHoldMultiplier?: boolean;
297
- /**
298
- * Optional link associated with the metadata.
299
- */
300
- link?: string | null;
301
- /**
302
- * Liquidity pool details.
303
- */
304
- liquidity?: Metadata.Liquidity;
305
- /**
306
- * Maximum quantity constraint for token holding.
307
- */
308
- maxQty?: number | null;
309
- /**
310
- * Minimum follower count for the rule. Accepts both number and string values.
311
- */
312
- minimumFollowerCount?: number | null;
313
- /**
314
- * Minimum quantity constraint for token holding.
315
- */
316
- minQty?: number | null;
317
- /**
318
- * Array of loyalty currency IDs used for multipliers.
319
- */
320
- multiplierLoyaltyCurrencyIds?: Array<string> | null;
321
- /**
322
- * Flag indicating whether to include only known users.
323
- */
324
- onlyKnownUsers?: boolean;
325
- /**
326
- * Flag indicating whether to include only native tokens.
327
- */
328
- onlyNative?: boolean;
329
- /**
330
- * Flag indicating whether to include only non-listed items.
331
- */
332
- onlyNonListed?: boolean;
333
- /**
334
- * Indicates if only existing users are rewarded.
335
- */
336
- onlyRewardExistingUser?: boolean;
337
- /**
338
- * give points for only one token ownership per contract
339
- */
340
- onlyRewardSingleTokenOwnership?: boolean | null;
341
- /**
342
- * Pre-generated text template that will be used to prefill the post content.
343
- */
344
- preGeneratedPostText?: string | null;
345
- /**
346
- * Promotional code associated with the rule.
347
- */
348
- promoCode?: string;
349
- /**
350
- * URL of the CSV file containing promo codes.
351
- */
352
- promoCodeCsvUrl?: string;
353
- /**
354
- * Numbers of the promotional code to be generated.
355
- */
356
- promoCodeLength?: number | null;
357
- /**
358
- * Type of the promotional code.
359
- */
360
- promoCodeType?: 'code' | 'csv' | 'generate';
361
- /**
362
- * Array defining ranges and corresponding rewards.
363
- */
364
- range?: Array<Metadata.Range>;
365
- /**
366
- * ID of the Reddit post.
367
- */
368
- redditPostId?: string | null;
369
- /**
370
- * Object defining referral requirements.
371
- */
372
- referralRequirements?: Metadata.ReferralRequirements | null;
373
- /**
374
- * Lump sum reward given to a referrer.
375
- */
376
- referrerReward?: number | null;
377
- /**
378
- * Loyalty currency ID of the referrer reward.
379
- */
380
- referrerRewardLoyaltyCurrencyId?: string | null;
381
- /**
382
- * Flag indicating if the post link is required.
383
- */
384
- requirePostLink?: boolean | null;
385
- /**
386
- * Flag indicating if media metadata is required.
387
- */
388
- requirePostMediaLink?: boolean | null;
389
- /**
390
- * Flag indicating if the rule can also reward badges per range.
391
- */
392
- rewardBadgePerRange?: boolean;
393
- /**
394
- * Flag indicating if the reward is rewarded by batch.
395
- */
396
- rewardByBatch?: boolean | null;
397
- /**
398
- * Criteria to evaluate the reward.
399
- */
400
- rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
401
- /**
402
- * Flag indicating if the reward is rewarded per action.
403
- */
404
- rewardPerAction?: boolean | null;
405
- /**
406
- * Flag indicating if rewards are given per impression.
407
- */
408
- rewardPerImpression?: boolean | null;
409
- /**
410
- * Flag indicating if the rule should reward based on value of traded tokens
411
- * instead of count.
412
- */
413
- rewardPerValue?: boolean;
414
- /**
415
- * Flag indicating if the rule should reward quality posts.
416
- */
417
- rewardQualityPosts?: boolean;
418
- robinhoodSymbols?: Array<string> | null;
419
- /**
420
- * Wallet address of the user can only be used if userId is not provided
421
- */
422
- royaltyAddress?: string;
423
- /**
424
- * Royalty percentage of the item.
425
- */
426
- royaltyPercentage?: number;
427
- /**
428
- * Currency associated with sales.
429
- */
430
- saleCurrency?: string;
431
- /**
432
- * Percentage reward given for a second-level referral.
433
- */
434
- secondReferralReward?: number | null;
435
- /**
436
- * Flag indicating if the multiplier is skipped.
437
- */
438
- skipMultiplier?: boolean | null;
439
- /**
440
- * Object containing details of the associated smart contract.
441
- */
442
- smartContract?: Metadata.SmartContract;
443
- /**
444
- * Array of snapshot proposals for the rule.
445
- */
446
- snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
447
- /**
448
- * Social media platform associated with the rule.
449
- */
450
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | 'GitHub' | 'Reddit' | null;
451
- /**
452
- * URL of the social platform's logo.
453
- */
454
- socialPlatformLogo?: string | null;
455
- /**
456
- * Name of the social platform.
457
- */
458
- socialPlatformName?: string | null;
459
- /**
460
- * ID of the Steam app.
461
- */
462
- steamAppId?: string | null;
463
- /**
464
- * Array of streak milestones and corresponding rewards.
465
- */
466
- streakArray?: Array<Metadata.StreakArray> | null;
467
- /**
468
- * Metadata for swap loyalty rules
469
- */
470
- swap?: Metadata.Swap;
471
- /**
472
- * ID of the Telegram channel.
473
- */
474
- telegramChannelId?: string | null;
475
- /**
476
- * Time delay in seconds to verify actions.
477
- */
478
- timeDelayToVerifySeconds?: string | number | null;
479
- /**
480
- * Flag indicating if all contracts are tracked.
481
- */
482
- trackAllContracts?: boolean | null;
483
- /**
484
- * Flag indicating if the progress is tracked. If enabled, the rule can only be
485
- * completed once the progress is 100%.
486
- */
487
- trackProgress?: boolean | null;
488
- /**
489
- * URL of the associated Twitter account.
490
- */
491
- twitterAccountUrl?: string;
492
- /**
493
- * Hashtag associated with the Twitter post.
494
- */
495
- twitterHashtag?: string;
496
- /**
497
- * URL of the associated Twitter post.
498
- */
499
- twitterPostUrl?: string;
500
- /**
501
- * Unique identifier of the Twitter user.
502
- */
503
- twitterUserId?: string;
504
- /**
505
- * Twitter username of the user.
506
- */
507
- twitterUsername?: string;
508
- /**
509
- * Minimum length of the verification text.
510
- */
511
- verificationTextMinimumLength?: number | null;
512
- /**
513
- * Multiplier applied to rewards for verified users.
514
- */
515
- verifiedMultiplier?: number | null;
516
- /**
517
- * Placeholder text for verification input fields.
518
- */
519
- verifyPlaceHolderText?: string | null;
520
- /**
521
- * Type of wallet associated with the rule.
522
- */
523
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | 'flow_cadence' | 'substrate' | null;
524
- /**
525
- * ID of the Youtube channel.
526
- */
527
- youtubeChannelId?: string | null;
528
- /**
529
- * ID of the Youtube video.
530
- */
531
- youtubeVideoId?: string | null;
532
- }
533
- namespace Metadata {
534
- interface Collection {
535
- /**
536
- * Blockchain address of the collection.
537
- */
538
- address?: string;
539
- /**
540
- * Multiplier applied to the rewards for this collection.
541
- */
542
- multiplier?: number;
543
- /**
544
- * Blockchain network of the collection.
545
- */
546
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
547
- }
548
- /**
549
- * Object containing details for the call-to-action.
550
- */
551
- interface Cta {
552
- /**
553
- * Link for the call-to-action.
554
- */
555
- href?: string | null;
556
- /**
557
- * Label for the call-to-action.
558
- */
559
- label?: string | null;
560
- }
561
- interface DiscordServersToJoin {
562
- /**
563
- * ID of the Discord server to join.
564
- */
565
- id?: string;
566
- /**
567
- * Array of Discord channels to join.
568
- */
569
- channels?: Array<DiscordServersToJoin.Channel>;
570
- /**
571
- * Array of roles to assign in the Discord server.
572
- */
573
- roles?: Array<DiscordServersToJoin.Role>;
574
- }
575
- namespace DiscordServersToJoin {
576
- interface Channel {
577
- /**
578
- * ID of the Discord channel.
579
- */
580
- id?: string;
581
- /**
582
- * Array of emojis used in the channel.
583
- */
584
- emojis?: Array<Channel.Emoji>;
585
- /**
586
- * Phrase of text to be present in the discord message
587
- */
588
- text?: string;
589
- }
590
- namespace Channel {
591
- interface Emoji {
592
- /**
593
- * ID of the emoji used in the channel.
594
- */
595
- id?: string;
596
- }
597
- }
598
- interface Role {
599
- /**
600
- * ID of the role in the Discord server.
601
- */
602
- id: string;
603
- }
604
- }
605
- interface DripQuestsToComplete {
606
- /**
607
- * ID of the drip quest to complete.
608
- */
609
- id: string;
610
- }
611
- /**
612
- * Liquidity pool details.
613
- */
614
- interface Liquidity {
615
- /**
616
- * Calculation type of the liquidity pool.
617
- */
618
- calculationType?: 'fixed' | 'custom';
619
- /**
620
- * Custom function to calculate the the reward amount based on the liquidity
621
- * provided per day. X is the reward amount, Y is the liquidity provided per day in
622
- * USD.
623
- */
624
- customFunction?: string;
625
- /**
626
- * Liquidity provided per day in USD
627
- */
628
- liquidityPerDay?: number;
629
- /**
630
- * Blockchain network of the liquidity pool.
631
- */
632
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
633
- /**
634
- * Indicates if only in-range liquidity is rewarded.
635
- */
636
- onlyRewardInRangeLiquidity?: boolean;
637
- /**
638
- * Array of liquidity pools associated with the rule.
639
- */
640
- pools?: Array<Liquidity.Pool>;
641
- /**
642
- * Protocol of the liquidity pool.
643
- */
644
- protocol?: string;
645
- }
646
- namespace Liquidity {
647
- interface Pool {
648
- /**
649
- * Unique identifier of the liquidity pool.
650
- */
651
- id: string;
652
- }
653
- }
654
- interface Range {
655
- /**
656
- * Reward amount for this range.
657
- */
658
- amount: number;
659
- /**
660
- * End value of the range.
661
- */
662
- endRange: number;
663
- /**
664
- * Start value of the range.
665
- */
666
- startRange: number;
667
- /**
668
- * ID of the loyalty badge for this range.
669
- */
670
- loyaltyBadgeId?: string;
671
- /**
672
- * Amount of the loyalty multiplier for this range.
673
- */
674
- loyaltyMultiplierAmount?: number;
675
- }
676
- /**
677
- * Object defining referral requirements.
678
- */
679
- interface ReferralRequirements {
680
- /**
681
- * Flag indicating if achieving points is required.
682
- */
683
- achievePoints?: boolean | null;
684
- /**
685
- * Flag indicating if completing the profile is required.
686
- */
687
- completeProfile?: boolean | null;
688
- /**
689
- * Flag indicating if connecting Discord is required.
690
- */
691
- connectDiscord?: boolean | null;
692
- /**
693
- * Flag indicating if connecting email is required.
694
- */
695
- connectEmail?: boolean | null;
696
- /**
697
- * Flag indicating if connecting Twitter is required.
698
- */
699
- connectTwitter?: boolean | null;
700
- points?: ReferralRequirements.Points | null;
701
- }
702
- namespace ReferralRequirements {
703
- interface Points {
704
- /**
705
- * Points required for referral.
706
- */
707
- amount?: number | null;
708
- /**
709
- * ID of the loyalty currency for referral.
710
- */
711
- loyaltyCurrecyId?: string | null;
712
- }
713
- }
714
- /**
715
- * Object containing details of the associated smart contract.
716
- */
717
- interface SmartContract {
718
- /**
719
- * Mapping of addresses for the smart contract.
720
- */
721
- addressMapping?: string | null;
722
- /**
723
- * Object containing details of the amount multiplier from the event.
724
- */
725
- amountMultiplier?: SmartContract.AmountMultiplier | null;
726
- /**
727
- * ID of the smart contract.
728
- */
729
- contractId?: string | null;
730
- /**
731
- * Criteria to evaluate the smart contract event.
732
- */
733
- criteria?: 'everyEvent' | 'byParameter' | null;
734
- /**
735
- * Event emitted by the smart contract.
736
- */
737
- event?: string | null;
738
- /**
739
- * Array of parameters for the smart contract.
740
- */
741
- params?: Array<SmartContract.Param> | null;
742
- /**
743
- * Type of the smart contract interaction.
744
- */
745
- type?: 'function' | 'event' | null;
746
- }
747
- namespace SmartContract {
748
- /**
749
- * Object containing details of the amount multiplier from the event.
750
- */
751
- interface AmountMultiplier {
752
- /**
753
- * Mapping of the value for the smart contract.
754
- */
755
- valueMapping?: string | null;
756
- }
757
- interface Param {
758
- /**
759
- * Condition to check for the parameter.
760
- */
761
- condition?: string | null;
762
- /**
763
- * Name of the smart contract parameter.
764
- */
765
- name?: string | null;
766
- /**
767
- * Value of the parameter.
768
- */
769
- value?: string | null;
770
- }
771
- }
772
- interface SnapshotProposal {
773
- /**
774
- * ID of the snapshot proposal.
775
- */
776
- id: string;
777
- /**
778
- * Space associated with the snapshot proposal.
779
- */
780
- space: string;
781
- }
782
- interface StreakArray {
783
- /**
784
- * Reward amount for achieving the streak milestone.
785
- */
786
- streakAmount: number;
787
- /**
788
- * Milestone required to achieve the streak.
789
- */
790
- streakMilestone: number;
791
- }
792
- /**
793
- * Metadata for swap loyalty rules
794
- */
795
- interface Swap {
796
- from?: Swap.From;
797
- provider?: 'any' | 'relay' | 'lifi';
798
- relayReferrerId?: string;
799
- requireCrossChainSwap?: boolean;
800
- to?: Swap.To;
801
- }
802
- namespace Swap {
803
- interface From {
804
- chain?: 'any' | number | string;
805
- mode?: 'any' | 'specific';
806
- tokens?: Array<From.Token>;
807
- trackAmount?: boolean;
808
- }
809
- namespace From {
810
- interface Token {
811
- address: string;
812
- chainId: string;
813
- }
814
- }
815
- interface To {
816
- chain?: 'any' | number | string;
817
- mode?: 'any' | 'specific';
818
- tokens?: Array<To.Token>;
819
- trackAmount?: boolean;
820
- }
821
- namespace To {
822
- interface Token {
823
- address: string;
824
- chainId: string;
825
- }
826
- }
827
- }
828
- }
829
- }
830
- /**
831
- * Previous data of the rule before the edit
832
- */
833
- interface PreviousData {
834
- /**
835
- * Unique identifier for the loyalty rule
836
- */
837
- id: string;
838
- /**
839
- * Amount associated with the loyalty rule
840
- */
841
- amount: number | null;
842
- /**
843
- * Timestamp when the loyalty rule was created
844
- */
845
- createdAt: string;
846
- /**
847
- * Timestamp when the loyalty rule was deleted (if applicable)
848
- */
849
- deletedAt: string | null;
850
- /**
851
- * Description of the loyalty rule
852
- */
853
- description: string;
854
- /**
855
- * End time of the loyalty rule
856
- */
857
- endTime: string | null;
858
- /**
859
- * Frequency of the loyalty rule
860
- */
861
- frequency: string;
862
- /**
863
- * Name of the loyalty rule
864
- */
865
- name: string;
866
- /**
867
- * Unique identifier for the organization
868
- */
869
- organizationId: string;
870
- /**
871
- * Type of the reward
872
- */
873
- rewardType: 'points' | 'multiplier' | 'badge';
874
- /**
875
- * Start time of the loyalty rule
876
- */
877
- startTime: string | null;
878
- /**
879
- * Type of the loyalty rule
880
- */
881
- type: string;
882
- /**
883
- * Timestamp when the loyalty rule was last updated
884
- */
885
- updatedAt: string;
886
- /**
887
- * Unique identifier for the website
888
- */
889
- websiteId: string;
890
- /**
891
- * Optional address of the collection
892
- */
893
- collectionAddress?: string;
894
- /**
895
- * URL of the media associated with the loyalty rule
896
- */
897
- mediaUrl?: string | null;
898
- /**
899
- * Optional metadata for the loyalty rule
900
- */
901
- metadata?: {
902
- [key: string]: PreviousData.Metadata;
903
- };
904
- }
905
- namespace PreviousData {
906
- interface Metadata {
907
- /**
908
- * Flag indicating if the rule allows multiple redemptions. Applies to Enter a Code
909
- * only.
910
- */
911
- allowMultipleRedemptions?: boolean;
912
- /**
913
- * Array of loyalty rule IDs that count as check-in when completed. If ["any"] then
914
- * any rule completions count as check-in.
915
- */
916
- autoCheckInRuleIds?: Array<(string & {}) | 'any'> | null;
917
- /**
918
- * Number of tokens per batch.
919
- */
920
- batchSize?: number | null;
921
- /**
922
- * Text displayed on the action button.
923
- */
924
- buttonText?: string | null;
925
- /**
926
- * Flag indicating if commenting is required.
927
- */
928
- checkComment?: boolean | null;
929
- /**
930
- * Flag indicating if liking the post is required.
931
- */
932
- checkLike?: boolean | null;
933
- /**
934
- * Flag indicating if reposting is required.
935
- */
936
- checkRepost?: boolean | null;
937
- /**
938
- * Text to check in the Twitter post, username, or bio.
939
- */
940
- checkText?: string | Array<string> | null;
941
- /**
942
- * Array of collections associated with the rule.
943
- */
944
- collection?: Array<Metadata.Collection>;
945
- /**
946
- * Conditions for completing the profile.
947
- */
948
- completeProfileConditions?: {
949
- [key: string]: boolean;
950
- } | null;
951
- /**
952
- * Description of the external rule condition (only for external rules)
953
- */
954
- conditionDescription?: string;
955
- /**
956
- * Object containing details for the call-to-action.
957
- */
958
- cta?: Metadata.Cta | null;
959
- /**
960
- * API key for custom rewards integration.
961
- */
962
- customRewardsApiKey?: string;
963
- /**
964
- * Flag indicating if the rule should use direct RPC to get the balance of tokens.
965
- */
966
- directRpc?: boolean;
967
- /**
968
- * Array of Discord servers, channels, and roles to join.
969
- */
970
- discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
971
- /**
972
- * Array of drip quests required to complete the rule.
973
- */
974
- dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
975
- /**
976
- * Flag indicating whether joining Discord servers is required.
977
- */
978
- enableJoinDiscordServers?: boolean | null;
979
- /**
980
- * Flag indicating whether streaks are enabled.
981
- */
982
- enableStreaks?: boolean | null;
983
- /**
984
- * Flag indicating whether the verified multiplier is enabled.
985
- */
986
- enableVerifiedMultiplier?: boolean;
987
- /**
988
- * Type of ERC20 token for the loyalty rule.
989
- */
990
- erc20Type?: 'erc20' | 'native';
991
- /**
992
- * Fill source of the order for the token sale
993
- */
994
- fillSource?: string;
995
- /**
996
- * Percentage reward given to a user for their first referral.
997
- */
998
- firstReferralReward?: number | null;
999
- /**
1000
- * Name of the GitHub branch to check for PR merge.
1001
- */
1002
- githubBranchName?: string | null;
1003
- /**
1004
- * URL of the GitHub repository to check for star.
1005
- */
1006
- githubRepoUrl?: string | null;
1007
- /**
1008
- * Flag indicating whether the fill source is included.
1009
- */
1010
- hasFillSource?: boolean;
1011
- /**
1012
- * Indicates if the item has never been sold.
1013
- */
1014
- hasNeverSold?: boolean;
1015
- /**
1016
- * Indicates if the full royalty has been paid for items.
1017
- */
1018
- hasPaidFullRoyalty?: boolean;
1019
- /**
1020
- * Flag indicating if the sale currency is included.
1021
- */
1022
- hasSaleCurrency?: boolean;
1023
- /**
1024
- * Indicates if the user has a verified Twitter account.
1025
- */
1026
- hasVerifiedTwitter?: boolean;
1027
- /**
1028
- * URL of the image associated with the rule.
1029
- */
1030
- imageUrl?: string | null;
1031
- /**
1032
- * If enabled, the first transaction done on the platform will complete this rule
1033
- */
1034
- isCheckInOnEveryTxn?: boolean;
1035
- /**
1036
- * Indicates if the multiplier has been applied to rewards.
1037
- */
1038
- isMultiplierApplied?: boolean;
1039
- /**
1040
- * Flag indicating if the rule is restricted to new users.
1041
- */
1042
- isRestrictedToNewUsers?: boolean;
1043
- /**
1044
- * Flag indicating if rewards are applied retroactively.
1045
- */
1046
- isRetroactive?: boolean | null;
1047
- /**
1048
- * Flag indicating if the token hold multiplier is applied.
1049
- */
1050
- isTokenHoldMultiplier?: boolean;
1051
- /**
1052
- * Optional link associated with the metadata.
1053
- */
1054
- link?: string | null;
1055
- /**
1056
- * Liquidity pool details.
1057
- */
1058
- liquidity?: Metadata.Liquidity;
1059
- /**
1060
- * Maximum quantity constraint for token holding.
1061
- */
1062
- maxQty?: number | null;
1063
- /**
1064
- * Minimum follower count for the rule. Accepts both number and string values.
1065
- */
1066
- minimumFollowerCount?: number | null;
1067
- /**
1068
- * Minimum quantity constraint for token holding.
1069
- */
1070
- minQty?: number | null;
1071
- /**
1072
- * Array of loyalty currency IDs used for multipliers.
1073
- */
1074
- multiplierLoyaltyCurrencyIds?: Array<string> | null;
1075
- /**
1076
- * Flag indicating whether to include only known users.
1077
- */
1078
- onlyKnownUsers?: boolean;
1079
- /**
1080
- * Flag indicating whether to include only native tokens.
1081
- */
1082
- onlyNative?: boolean;
1083
- /**
1084
- * Flag indicating whether to include only non-listed items.
1085
- */
1086
- onlyNonListed?: boolean;
1087
- /**
1088
- * Indicates if only existing users are rewarded.
1089
- */
1090
- onlyRewardExistingUser?: boolean;
1091
- /**
1092
- * give points for only one token ownership per contract
1093
- */
1094
- onlyRewardSingleTokenOwnership?: boolean | null;
1095
- /**
1096
- * Pre-generated text template that will be used to prefill the post content.
1097
- */
1098
- preGeneratedPostText?: string | null;
1099
- /**
1100
- * Promotional code associated with the rule.
1101
- */
1102
- promoCode?: string;
1103
- /**
1104
- * URL of the CSV file containing promo codes.
1105
- */
1106
- promoCodeCsvUrl?: string;
1107
- /**
1108
- * Numbers of the promotional code to be generated.
1109
- */
1110
- promoCodeLength?: number | null;
1111
- /**
1112
- * Type of the promotional code.
1113
- */
1114
- promoCodeType?: 'code' | 'csv' | 'generate';
1115
- /**
1116
- * Array defining ranges and corresponding rewards.
1117
- */
1118
- range?: Array<Metadata.Range>;
1119
- /**
1120
- * ID of the Reddit post.
1121
- */
1122
- redditPostId?: string | null;
1123
- /**
1124
- * Object defining referral requirements.
1125
- */
1126
- referralRequirements?: Metadata.ReferralRequirements | null;
1127
- /**
1128
- * Lump sum reward given to a referrer.
1129
- */
1130
- referrerReward?: number | null;
1131
- /**
1132
- * Loyalty currency ID of the referrer reward.
1133
- */
1134
- referrerRewardLoyaltyCurrencyId?: string | null;
1135
- /**
1136
- * Flag indicating if the post link is required.
1137
- */
1138
- requirePostLink?: boolean | null;
1139
- /**
1140
- * Flag indicating if media metadata is required.
1141
- */
1142
- requirePostMediaLink?: boolean | null;
1143
- /**
1144
- * Flag indicating if the rule can also reward badges per range.
1145
- */
1146
- rewardBadgePerRange?: boolean;
1147
- /**
1148
- * Flag indicating if the reward is rewarded by batch.
1149
- */
1150
- rewardByBatch?: boolean | null;
1151
- /**
1152
- * Criteria to evaluate the reward.
1153
- */
1154
- rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
1155
- /**
1156
- * Flag indicating if the reward is rewarded per action.
1157
- */
1158
- rewardPerAction?: boolean | null;
1159
- /**
1160
- * Flag indicating if rewards are given per impression.
1161
- */
1162
- rewardPerImpression?: boolean | null;
1163
- /**
1164
- * Flag indicating if the rule should reward based on value of traded tokens
1165
- * instead of count.
1166
- */
1167
- rewardPerValue?: boolean;
1168
- /**
1169
- * Flag indicating if the rule should reward quality posts.
1170
- */
1171
- rewardQualityPosts?: boolean;
1172
- robinhoodSymbols?: Array<string> | null;
1173
- /**
1174
- * Wallet address of the user can only be used if userId is not provided
1175
- */
1176
- royaltyAddress?: string;
1177
- /**
1178
- * Royalty percentage of the item.
1179
- */
1180
- royaltyPercentage?: number;
1181
- /**
1182
- * Currency associated with sales.
1183
- */
1184
- saleCurrency?: string;
1185
- /**
1186
- * Percentage reward given for a second-level referral.
1187
- */
1188
- secondReferralReward?: number | null;
1189
- /**
1190
- * Flag indicating if the multiplier is skipped.
1191
- */
1192
- skipMultiplier?: boolean | null;
1193
- /**
1194
- * Object containing details of the associated smart contract.
1195
- */
1196
- smartContract?: Metadata.SmartContract;
1197
- /**
1198
- * Array of snapshot proposals for the rule.
1199
- */
1200
- snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
1201
- /**
1202
- * Social media platform associated with the rule.
1203
- */
1204
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | 'GitHub' | 'Reddit' | null;
1205
- /**
1206
- * URL of the social platform's logo.
1207
- */
1208
- socialPlatformLogo?: string | null;
1209
- /**
1210
- * Name of the social platform.
1211
- */
1212
- socialPlatformName?: string | null;
1213
- /**
1214
- * ID of the Steam app.
1215
- */
1216
- steamAppId?: string | null;
1217
- /**
1218
- * Array of streak milestones and corresponding rewards.
1219
- */
1220
- streakArray?: Array<Metadata.StreakArray> | null;
1221
- /**
1222
- * Metadata for swap loyalty rules
1223
- */
1224
- swap?: Metadata.Swap;
1225
- /**
1226
- * ID of the Telegram channel.
1227
- */
1228
- telegramChannelId?: string | null;
1229
- /**
1230
- * Time delay in seconds to verify actions.
1231
- */
1232
- timeDelayToVerifySeconds?: string | number | null;
1233
- /**
1234
- * Flag indicating if all contracts are tracked.
1235
- */
1236
- trackAllContracts?: boolean | null;
1237
- /**
1238
- * Flag indicating if the progress is tracked. If enabled, the rule can only be
1239
- * completed once the progress is 100%.
1240
- */
1241
- trackProgress?: boolean | null;
1242
- /**
1243
- * URL of the associated Twitter account.
1244
- */
1245
- twitterAccountUrl?: string;
1246
- /**
1247
- * Hashtag associated with the Twitter post.
1248
- */
1249
- twitterHashtag?: string;
1250
- /**
1251
- * URL of the associated Twitter post.
1252
- */
1253
- twitterPostUrl?: string;
1254
- /**
1255
- * Unique identifier of the Twitter user.
1256
- */
1257
- twitterUserId?: string;
1258
- /**
1259
- * Twitter username of the user.
1260
- */
1261
- twitterUsername?: string;
1262
- /**
1263
- * Minimum length of the verification text.
1264
- */
1265
- verificationTextMinimumLength?: number | null;
1266
- /**
1267
- * Multiplier applied to rewards for verified users.
1268
- */
1269
- verifiedMultiplier?: number | null;
1270
- /**
1271
- * Placeholder text for verification input fields.
1272
- */
1273
- verifyPlaceHolderText?: string | null;
1274
- /**
1275
- * Type of wallet associated with the rule.
1276
- */
1277
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | 'flow_cadence' | 'substrate' | null;
1278
- /**
1279
- * ID of the Youtube channel.
1280
- */
1281
- youtubeChannelId?: string | null;
1282
- /**
1283
- * ID of the Youtube video.
1284
- */
1285
- youtubeVideoId?: string | null;
1286
- }
1287
- namespace Metadata {
1288
- interface Collection {
1289
- /**
1290
- * Blockchain address of the collection.
1291
- */
1292
- address?: string;
1293
- /**
1294
- * Multiplier applied to the rewards for this collection.
1295
- */
1296
- multiplier?: number;
1297
- /**
1298
- * Blockchain network of the collection.
1299
- */
1300
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
1301
- }
1302
- /**
1303
- * Object containing details for the call-to-action.
1304
- */
1305
- interface Cta {
1306
- /**
1307
- * Link for the call-to-action.
1308
- */
1309
- href?: string | null;
1310
- /**
1311
- * Label for the call-to-action.
1312
- */
1313
- label?: string | null;
1314
- }
1315
- interface DiscordServersToJoin {
1316
- /**
1317
- * ID of the Discord server to join.
1318
- */
1319
- id?: string;
1320
- /**
1321
- * Array of Discord channels to join.
1322
- */
1323
- channels?: Array<DiscordServersToJoin.Channel>;
1324
- /**
1325
- * Array of roles to assign in the Discord server.
1326
- */
1327
- roles?: Array<DiscordServersToJoin.Role>;
1328
- }
1329
- namespace DiscordServersToJoin {
1330
- interface Channel {
1331
- /**
1332
- * ID of the Discord channel.
1333
- */
1334
- id?: string;
1335
- /**
1336
- * Array of emojis used in the channel.
1337
- */
1338
- emojis?: Array<Channel.Emoji>;
1339
- /**
1340
- * Phrase of text to be present in the discord message
1341
- */
1342
- text?: string;
1343
- }
1344
- namespace Channel {
1345
- interface Emoji {
1346
- /**
1347
- * ID of the emoji used in the channel.
1348
- */
1349
- id?: string;
1350
- }
1351
- }
1352
- interface Role {
1353
- /**
1354
- * ID of the role in the Discord server.
1355
- */
1356
- id: string;
1357
- }
1358
- }
1359
- interface DripQuestsToComplete {
1360
- /**
1361
- * ID of the drip quest to complete.
1362
- */
1363
- id: string;
1364
- }
1365
- /**
1366
- * Liquidity pool details.
1367
- */
1368
- interface Liquidity {
1369
- /**
1370
- * Calculation type of the liquidity pool.
1371
- */
1372
- calculationType?: 'fixed' | 'custom';
1373
- /**
1374
- * Custom function to calculate the the reward amount based on the liquidity
1375
- * provided per day. X is the reward amount, Y is the liquidity provided per day in
1376
- * USD.
1377
- */
1378
- customFunction?: string;
1379
- /**
1380
- * Liquidity provided per day in USD
1381
- */
1382
- liquidityPerDay?: number;
1383
- /**
1384
- * Blockchain network of the liquidity pool.
1385
- */
1386
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
1387
- /**
1388
- * Indicates if only in-range liquidity is rewarded.
1389
- */
1390
- onlyRewardInRangeLiquidity?: boolean;
1391
- /**
1392
- * Array of liquidity pools associated with the rule.
1393
- */
1394
- pools?: Array<Liquidity.Pool>;
1395
- /**
1396
- * Protocol of the liquidity pool.
1397
- */
1398
- protocol?: string;
1399
- }
1400
- namespace Liquidity {
1401
- interface Pool {
1402
- /**
1403
- * Unique identifier of the liquidity pool.
1404
- */
1405
- id: string;
1406
- }
1407
- }
1408
- interface Range {
1409
- /**
1410
- * Reward amount for this range.
1411
- */
1412
- amount: number;
1413
- /**
1414
- * End value of the range.
1415
- */
1416
- endRange: number;
1417
- /**
1418
- * Start value of the range.
1419
- */
1420
- startRange: number;
1421
- /**
1422
- * ID of the loyalty badge for this range.
1423
- */
1424
- loyaltyBadgeId?: string;
1425
- /**
1426
- * Amount of the loyalty multiplier for this range.
1427
- */
1428
- loyaltyMultiplierAmount?: number;
1429
- }
1430
- /**
1431
- * Object defining referral requirements.
1432
- */
1433
- interface ReferralRequirements {
1434
- /**
1435
- * Flag indicating if achieving points is required.
1436
- */
1437
- achievePoints?: boolean | null;
1438
- /**
1439
- * Flag indicating if completing the profile is required.
1440
- */
1441
- completeProfile?: boolean | null;
1442
- /**
1443
- * Flag indicating if connecting Discord is required.
1444
- */
1445
- connectDiscord?: boolean | null;
1446
- /**
1447
- * Flag indicating if connecting email is required.
1448
- */
1449
- connectEmail?: boolean | null;
1450
- /**
1451
- * Flag indicating if connecting Twitter is required.
1452
- */
1453
- connectTwitter?: boolean | null;
1454
- points?: ReferralRequirements.Points | null;
1455
- }
1456
- namespace ReferralRequirements {
1457
- interface Points {
1458
- /**
1459
- * Points required for referral.
1460
- */
1461
- amount?: number | null;
1462
- /**
1463
- * ID of the loyalty currency for referral.
1464
- */
1465
- loyaltyCurrecyId?: string | null;
1466
- }
1467
- }
1468
- /**
1469
- * Object containing details of the associated smart contract.
1470
- */
1471
- interface SmartContract {
1472
- /**
1473
- * Mapping of addresses for the smart contract.
1474
- */
1475
- addressMapping?: string | null;
1476
- /**
1477
- * Object containing details of the amount multiplier from the event.
1478
- */
1479
- amountMultiplier?: SmartContract.AmountMultiplier | null;
1480
- /**
1481
- * ID of the smart contract.
1482
- */
1483
- contractId?: string | null;
1484
- /**
1485
- * Criteria to evaluate the smart contract event.
1486
- */
1487
- criteria?: 'everyEvent' | 'byParameter' | null;
1488
- /**
1489
- * Event emitted by the smart contract.
1490
- */
1491
- event?: string | null;
1492
- /**
1493
- * Array of parameters for the smart contract.
1494
- */
1495
- params?: Array<SmartContract.Param> | null;
1496
- /**
1497
- * Type of the smart contract interaction.
1498
- */
1499
- type?: 'function' | 'event' | null;
1500
- }
1501
- namespace SmartContract {
1502
- /**
1503
- * Object containing details of the amount multiplier from the event.
1504
- */
1505
- interface AmountMultiplier {
1506
- /**
1507
- * Mapping of the value for the smart contract.
1508
- */
1509
- valueMapping?: string | null;
1510
- }
1511
- interface Param {
1512
- /**
1513
- * Condition to check for the parameter.
1514
- */
1515
- condition?: string | null;
1516
- /**
1517
- * Name of the smart contract parameter.
1518
- */
1519
- name?: string | null;
1520
- /**
1521
- * Value of the parameter.
1522
- */
1523
- value?: string | null;
1524
- }
1525
- }
1526
- interface SnapshotProposal {
1527
- /**
1528
- * ID of the snapshot proposal.
1529
- */
1530
- id: string;
1531
- /**
1532
- * Space associated with the snapshot proposal.
1533
- */
1534
- space: string;
1535
- }
1536
- interface StreakArray {
1537
- /**
1538
- * Reward amount for achieving the streak milestone.
1539
- */
1540
- streakAmount: number;
1541
- /**
1542
- * Milestone required to achieve the streak.
1543
- */
1544
- streakMilestone: number;
1545
- }
1546
- /**
1547
- * Metadata for swap loyalty rules
1548
- */
1549
- interface Swap {
1550
- from?: Swap.From;
1551
- provider?: 'any' | 'relay' | 'lifi';
1552
- relayReferrerId?: string;
1553
- requireCrossChainSwap?: boolean;
1554
- to?: Swap.To;
1555
- }
1556
- namespace Swap {
1557
- interface From {
1558
- chain?: 'any' | number | string;
1559
- mode?: 'any' | 'specific';
1560
- tokens?: Array<From.Token>;
1561
- trackAmount?: boolean;
1562
- }
1563
- namespace From {
1564
- interface Token {
1565
- address: string;
1566
- chainId: string;
1567
- }
1568
- }
1569
- interface To {
1570
- chain?: 'any' | number | string;
1571
- mode?: 'any' | 'specific';
1572
- tokens?: Array<To.Token>;
1573
- trackAmount?: boolean;
1574
- }
1575
- namespace To {
1576
- interface Token {
1577
- address: string;
1578
- chainId: string;
1579
- }
1580
- }
1581
- }
1582
- }
1583
- }
1584
- }
1585
- }
1586
- export interface RuleEditRestoreResponse {
1587
- /**
1588
- * Unique identifier for the rule edit
1589
- */
1590
- id: string;
1591
- /**
1592
- * Type of action that was made on the rule
1593
- */
1594
- action: 'create' | 'update' | 'delete' | 'restore';
1595
- /**
1596
- * Data that was changed on the rule
1597
- */
1598
- data: RuleEditRestoreResponse.Data;
1599
- /**
1600
- * Timestamp of when the rule edit was made
1601
- */
1602
- editedAt: string;
1603
- /**
1604
- * User ID of the user who made the edit
1605
- */
1606
- editedByUserId: string;
1607
- /**
1608
- * ID of the loyalty rule
1609
- */
1610
- loyaltyRuleId: string;
1611
- /**
1612
- * Unique identifier for the organization
1613
- */
1614
- organizationId: string;
1615
- /**
1616
- * Unique identifier for the website
1617
- */
1618
- websiteId: string;
1619
- /**
1620
- * Comment that was made on the edit
1621
- */
1622
- comment?: string;
1623
- /**
1624
- * Previous data of the rule before the edit
1625
- */
1626
- previousData?: RuleEditRestoreResponse.PreviousData;
1627
- }
1628
- export declare namespace RuleEditRestoreResponse {
1629
- /**
1630
- * Data that was changed on the rule
1631
- */
1632
- interface Data {
1633
- /**
1634
- * Unique identifier for the loyalty rule
1635
- */
1636
- id: string;
1637
- /**
1638
- * Amount associated with the loyalty rule
1639
- */
1640
- amount: number | null;
1641
- /**
1642
- * Timestamp when the loyalty rule was created
1643
- */
1644
- createdAt: string;
1645
- /**
1646
- * Timestamp when the loyalty rule was deleted (if applicable)
1647
- */
1648
- deletedAt: string | null;
1649
- /**
1650
- * Description of the loyalty rule
1651
- */
1652
- description: string;
1653
- /**
1654
- * End time of the loyalty rule
1655
- */
1656
- endTime: string | null;
1657
- /**
1658
- * Frequency of the loyalty rule
1659
- */
1660
- frequency: string;
1661
- /**
1662
- * Name of the loyalty rule
1663
- */
1664
- name: string;
1665
- /**
1666
- * Unique identifier for the organization
1667
- */
1668
- organizationId: string;
1669
- /**
1670
- * Type of the reward
1671
- */
1672
- rewardType: 'points' | 'multiplier' | 'badge';
1673
- /**
1674
- * Start time of the loyalty rule
1675
- */
1676
- startTime: string | null;
1677
- /**
1678
- * Type of the loyalty rule
1679
- */
1680
- type: string;
1681
- /**
1682
- * Timestamp when the loyalty rule was last updated
1683
- */
1684
- updatedAt: string;
1685
- /**
1686
- * Unique identifier for the website
1687
- */
1688
- websiteId: string;
1689
- /**
1690
- * Optional address of the collection
1691
- */
1692
- collectionAddress?: string;
1693
- /**
1694
- * URL of the media associated with the loyalty rule
1695
- */
1696
- mediaUrl?: string | null;
1697
- /**
1698
- * Optional metadata for the loyalty rule
1699
- */
1700
- metadata?: {
1701
- [key: string]: Data.Metadata;
1702
- };
1703
- }
1704
- namespace Data {
1705
- interface Metadata {
1706
- /**
1707
- * Flag indicating if the rule allows multiple redemptions. Applies to Enter a Code
1708
- * only.
1709
- */
1710
- allowMultipleRedemptions?: boolean;
1711
- /**
1712
- * Array of loyalty rule IDs that count as check-in when completed. If ["any"] then
1713
- * any rule completions count as check-in.
1714
- */
1715
- autoCheckInRuleIds?: Array<(string & {}) | 'any'> | null;
1716
- /**
1717
- * Number of tokens per batch.
1718
- */
1719
- batchSize?: number | null;
1720
- /**
1721
- * Text displayed on the action button.
1722
- */
1723
- buttonText?: string | null;
1724
- /**
1725
- * Flag indicating if commenting is required.
1726
- */
1727
- checkComment?: boolean | null;
1728
- /**
1729
- * Flag indicating if liking the post is required.
1730
- */
1731
- checkLike?: boolean | null;
1732
- /**
1733
- * Flag indicating if reposting is required.
1734
- */
1735
- checkRepost?: boolean | null;
1736
- /**
1737
- * Text to check in the Twitter post, username, or bio.
1738
- */
1739
- checkText?: string | Array<string> | null;
1740
- /**
1741
- * Array of collections associated with the rule.
1742
- */
1743
- collection?: Array<Metadata.Collection>;
1744
- /**
1745
- * Conditions for completing the profile.
1746
- */
1747
- completeProfileConditions?: {
1748
- [key: string]: boolean;
1749
- } | null;
1750
- /**
1751
- * Description of the external rule condition (only for external rules)
1752
- */
1753
- conditionDescription?: string;
1754
- /**
1755
- * Object containing details for the call-to-action.
1756
- */
1757
- cta?: Metadata.Cta | null;
1758
- /**
1759
- * API key for custom rewards integration.
1760
- */
1761
- customRewardsApiKey?: string;
1762
- /**
1763
- * Flag indicating if the rule should use direct RPC to get the balance of tokens.
1764
- */
1765
- directRpc?: boolean;
1766
- /**
1767
- * Array of Discord servers, channels, and roles to join.
1768
- */
1769
- discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
1770
- /**
1771
- * Array of drip quests required to complete the rule.
1772
- */
1773
- dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
1774
- /**
1775
- * Flag indicating whether joining Discord servers is required.
1776
- */
1777
- enableJoinDiscordServers?: boolean | null;
1778
- /**
1779
- * Flag indicating whether streaks are enabled.
1780
- */
1781
- enableStreaks?: boolean | null;
1782
- /**
1783
- * Flag indicating whether the verified multiplier is enabled.
1784
- */
1785
- enableVerifiedMultiplier?: boolean;
1786
- /**
1787
- * Type of ERC20 token for the loyalty rule.
1788
- */
1789
- erc20Type?: 'erc20' | 'native';
1790
- /**
1791
- * Fill source of the order for the token sale
1792
- */
1793
- fillSource?: string;
1794
- /**
1795
- * Percentage reward given to a user for their first referral.
1796
- */
1797
- firstReferralReward?: number | null;
1798
- /**
1799
- * Name of the GitHub branch to check for PR merge.
1800
- */
1801
- githubBranchName?: string | null;
1802
- /**
1803
- * URL of the GitHub repository to check for star.
1804
- */
1805
- githubRepoUrl?: string | null;
1806
- /**
1807
- * Flag indicating whether the fill source is included.
1808
- */
1809
- hasFillSource?: boolean;
1810
- /**
1811
- * Indicates if the item has never been sold.
1812
- */
1813
- hasNeverSold?: boolean;
1814
- /**
1815
- * Indicates if the full royalty has been paid for items.
1816
- */
1817
- hasPaidFullRoyalty?: boolean;
1818
- /**
1819
- * Flag indicating if the sale currency is included.
1820
- */
1821
- hasSaleCurrency?: boolean;
1822
- /**
1823
- * Indicates if the user has a verified Twitter account.
1824
- */
1825
- hasVerifiedTwitter?: boolean;
1826
- /**
1827
- * URL of the image associated with the rule.
1828
- */
1829
- imageUrl?: string | null;
1830
- /**
1831
- * If enabled, the first transaction done on the platform will complete this rule
1832
- */
1833
- isCheckInOnEveryTxn?: boolean;
1834
- /**
1835
- * Indicates if the multiplier has been applied to rewards.
1836
- */
1837
- isMultiplierApplied?: boolean;
1838
- /**
1839
- * Flag indicating if the rule is restricted to new users.
1840
- */
1841
- isRestrictedToNewUsers?: boolean;
1842
- /**
1843
- * Flag indicating if rewards are applied retroactively.
1844
- */
1845
- isRetroactive?: boolean | null;
1846
- /**
1847
- * Flag indicating if the token hold multiplier is applied.
1848
- */
1849
- isTokenHoldMultiplier?: boolean;
1850
- /**
1851
- * Optional link associated with the metadata.
1852
- */
1853
- link?: string | null;
1854
- /**
1855
- * Liquidity pool details.
1856
- */
1857
- liquidity?: Metadata.Liquidity;
1858
- /**
1859
- * Maximum quantity constraint for token holding.
1860
- */
1861
- maxQty?: number | null;
1862
- /**
1863
- * Minimum follower count for the rule. Accepts both number and string values.
1864
- */
1865
- minimumFollowerCount?: number | null;
1866
- /**
1867
- * Minimum quantity constraint for token holding.
1868
- */
1869
- minQty?: number | null;
1870
- /**
1871
- * Array of loyalty currency IDs used for multipliers.
1872
- */
1873
- multiplierLoyaltyCurrencyIds?: Array<string> | null;
1874
- /**
1875
- * Flag indicating whether to include only known users.
1876
- */
1877
- onlyKnownUsers?: boolean;
1878
- /**
1879
- * Flag indicating whether to include only native tokens.
1880
- */
1881
- onlyNative?: boolean;
1882
- /**
1883
- * Flag indicating whether to include only non-listed items.
1884
- */
1885
- onlyNonListed?: boolean;
1886
- /**
1887
- * Indicates if only existing users are rewarded.
1888
- */
1889
- onlyRewardExistingUser?: boolean;
1890
- /**
1891
- * give points for only one token ownership per contract
1892
- */
1893
- onlyRewardSingleTokenOwnership?: boolean | null;
1894
- /**
1895
- * Pre-generated text template that will be used to prefill the post content.
1896
- */
1897
- preGeneratedPostText?: string | null;
1898
- /**
1899
- * Promotional code associated with the rule.
1900
- */
1901
- promoCode?: string;
1902
- /**
1903
- * URL of the CSV file containing promo codes.
1904
- */
1905
- promoCodeCsvUrl?: string;
1906
- /**
1907
- * Numbers of the promotional code to be generated.
1908
- */
1909
- promoCodeLength?: number | null;
1910
- /**
1911
- * Type of the promotional code.
1912
- */
1913
- promoCodeType?: 'code' | 'csv' | 'generate';
1914
- /**
1915
- * Array defining ranges and corresponding rewards.
1916
- */
1917
- range?: Array<Metadata.Range>;
1918
- /**
1919
- * ID of the Reddit post.
1920
- */
1921
- redditPostId?: string | null;
1922
- /**
1923
- * Object defining referral requirements.
1924
- */
1925
- referralRequirements?: Metadata.ReferralRequirements | null;
1926
- /**
1927
- * Lump sum reward given to a referrer.
1928
- */
1929
- referrerReward?: number | null;
1930
- /**
1931
- * Loyalty currency ID of the referrer reward.
1932
- */
1933
- referrerRewardLoyaltyCurrencyId?: string | null;
1934
- /**
1935
- * Flag indicating if the post link is required.
1936
- */
1937
- requirePostLink?: boolean | null;
1938
- /**
1939
- * Flag indicating if media metadata is required.
1940
- */
1941
- requirePostMediaLink?: boolean | null;
1942
- /**
1943
- * Flag indicating if the rule can also reward badges per range.
1944
- */
1945
- rewardBadgePerRange?: boolean;
1946
- /**
1947
- * Flag indicating if the reward is rewarded by batch.
1948
- */
1949
- rewardByBatch?: boolean | null;
1950
- /**
1951
- * Criteria to evaluate the reward.
1952
- */
1953
- rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
1954
- /**
1955
- * Flag indicating if the reward is rewarded per action.
1956
- */
1957
- rewardPerAction?: boolean | null;
1958
- /**
1959
- * Flag indicating if rewards are given per impression.
1960
- */
1961
- rewardPerImpression?: boolean | null;
1962
- /**
1963
- * Flag indicating if the rule should reward based on value of traded tokens
1964
- * instead of count.
1965
- */
1966
- rewardPerValue?: boolean;
1967
- /**
1968
- * Flag indicating if the rule should reward quality posts.
1969
- */
1970
- rewardQualityPosts?: boolean;
1971
- robinhoodSymbols?: Array<string> | null;
1972
- /**
1973
- * Wallet address of the user can only be used if userId is not provided
1974
- */
1975
- royaltyAddress?: string;
1976
- /**
1977
- * Royalty percentage of the item.
1978
- */
1979
- royaltyPercentage?: number;
1980
- /**
1981
- * Currency associated with sales.
1982
- */
1983
- saleCurrency?: string;
1984
- /**
1985
- * Percentage reward given for a second-level referral.
1986
- */
1987
- secondReferralReward?: number | null;
1988
- /**
1989
- * Flag indicating if the multiplier is skipped.
1990
- */
1991
- skipMultiplier?: boolean | null;
1992
- /**
1993
- * Object containing details of the associated smart contract.
1994
- */
1995
- smartContract?: Metadata.SmartContract;
1996
- /**
1997
- * Array of snapshot proposals for the rule.
1998
- */
1999
- snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
2000
- /**
2001
- * Social media platform associated with the rule.
2002
- */
2003
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | 'GitHub' | 'Reddit' | null;
2004
- /**
2005
- * URL of the social platform's logo.
2006
- */
2007
- socialPlatformLogo?: string | null;
2008
- /**
2009
- * Name of the social platform.
2010
- */
2011
- socialPlatformName?: string | null;
2012
- /**
2013
- * ID of the Steam app.
2014
- */
2015
- steamAppId?: string | null;
2016
- /**
2017
- * Array of streak milestones and corresponding rewards.
2018
- */
2019
- streakArray?: Array<Metadata.StreakArray> | null;
2020
- /**
2021
- * Metadata for swap loyalty rules
2022
- */
2023
- swap?: Metadata.Swap;
2024
- /**
2025
- * ID of the Telegram channel.
2026
- */
2027
- telegramChannelId?: string | null;
2028
- /**
2029
- * Time delay in seconds to verify actions.
2030
- */
2031
- timeDelayToVerifySeconds?: string | number | null;
2032
- /**
2033
- * Flag indicating if all contracts are tracked.
2034
- */
2035
- trackAllContracts?: boolean | null;
2036
- /**
2037
- * Flag indicating if the progress is tracked. If enabled, the rule can only be
2038
- * completed once the progress is 100%.
2039
- */
2040
- trackProgress?: boolean | null;
2041
- /**
2042
- * URL of the associated Twitter account.
2043
- */
2044
- twitterAccountUrl?: string;
2045
- /**
2046
- * Hashtag associated with the Twitter post.
2047
- */
2048
- twitterHashtag?: string;
2049
- /**
2050
- * URL of the associated Twitter post.
2051
- */
2052
- twitterPostUrl?: string;
2053
- /**
2054
- * Unique identifier of the Twitter user.
2055
- */
2056
- twitterUserId?: string;
2057
- /**
2058
- * Twitter username of the user.
2059
- */
2060
- twitterUsername?: string;
2061
- /**
2062
- * Minimum length of the verification text.
2063
- */
2064
- verificationTextMinimumLength?: number | null;
2065
- /**
2066
- * Multiplier applied to rewards for verified users.
2067
- */
2068
- verifiedMultiplier?: number | null;
2069
- /**
2070
- * Placeholder text for verification input fields.
2071
- */
2072
- verifyPlaceHolderText?: string | null;
2073
- /**
2074
- * Type of wallet associated with the rule.
2075
- */
2076
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | 'flow_cadence' | 'substrate' | null;
2077
- /**
2078
- * ID of the Youtube channel.
2079
- */
2080
- youtubeChannelId?: string | null;
2081
- /**
2082
- * ID of the Youtube video.
2083
- */
2084
- youtubeVideoId?: string | null;
2085
- }
2086
- namespace Metadata {
2087
- interface Collection {
2088
- /**
2089
- * Blockchain address of the collection.
2090
- */
2091
- address?: string;
2092
- /**
2093
- * Multiplier applied to the rewards for this collection.
2094
- */
2095
- multiplier?: number;
2096
- /**
2097
- * Blockchain network of the collection.
2098
- */
2099
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
2100
- }
2101
- /**
2102
- * Object containing details for the call-to-action.
2103
- */
2104
- interface Cta {
2105
- /**
2106
- * Link for the call-to-action.
2107
- */
2108
- href?: string | null;
2109
- /**
2110
- * Label for the call-to-action.
2111
- */
2112
- label?: string | null;
2113
- }
2114
- interface DiscordServersToJoin {
2115
- /**
2116
- * ID of the Discord server to join.
2117
- */
2118
- id?: string;
2119
- /**
2120
- * Array of Discord channels to join.
2121
- */
2122
- channels?: Array<DiscordServersToJoin.Channel>;
2123
- /**
2124
- * Array of roles to assign in the Discord server.
2125
- */
2126
- roles?: Array<DiscordServersToJoin.Role>;
2127
- }
2128
- namespace DiscordServersToJoin {
2129
- interface Channel {
2130
- /**
2131
- * ID of the Discord channel.
2132
- */
2133
- id?: string;
2134
- /**
2135
- * Array of emojis used in the channel.
2136
- */
2137
- emojis?: Array<Channel.Emoji>;
2138
- /**
2139
- * Phrase of text to be present in the discord message
2140
- */
2141
- text?: string;
2142
- }
2143
- namespace Channel {
2144
- interface Emoji {
2145
- /**
2146
- * ID of the emoji used in the channel.
2147
- */
2148
- id?: string;
2149
- }
2150
- }
2151
- interface Role {
2152
- /**
2153
- * ID of the role in the Discord server.
2154
- */
2155
- id: string;
2156
- }
2157
- }
2158
- interface DripQuestsToComplete {
2159
- /**
2160
- * ID of the drip quest to complete.
2161
- */
2162
- id: string;
2163
- }
2164
- /**
2165
- * Liquidity pool details.
2166
- */
2167
- interface Liquidity {
2168
- /**
2169
- * Calculation type of the liquidity pool.
2170
- */
2171
- calculationType?: 'fixed' | 'custom';
2172
- /**
2173
- * Custom function to calculate the the reward amount based on the liquidity
2174
- * provided per day. X is the reward amount, Y is the liquidity provided per day in
2175
- * USD.
2176
- */
2177
- customFunction?: string;
2178
- /**
2179
- * Liquidity provided per day in USD
2180
- */
2181
- liquidityPerDay?: number;
2182
- /**
2183
- * Blockchain network of the liquidity pool.
2184
- */
2185
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
2186
- /**
2187
- * Indicates if only in-range liquidity is rewarded.
2188
- */
2189
- onlyRewardInRangeLiquidity?: boolean;
2190
- /**
2191
- * Array of liquidity pools associated with the rule.
2192
- */
2193
- pools?: Array<Liquidity.Pool>;
2194
- /**
2195
- * Protocol of the liquidity pool.
2196
- */
2197
- protocol?: string;
2198
- }
2199
- namespace Liquidity {
2200
- interface Pool {
2201
- /**
2202
- * Unique identifier of the liquidity pool.
2203
- */
2204
- id: string;
2205
- }
2206
- }
2207
- interface Range {
2208
- /**
2209
- * Reward amount for this range.
2210
- */
2211
- amount: number;
2212
- /**
2213
- * End value of the range.
2214
- */
2215
- endRange: number;
2216
- /**
2217
- * Start value of the range.
2218
- */
2219
- startRange: number;
2220
- /**
2221
- * ID of the loyalty badge for this range.
2222
- */
2223
- loyaltyBadgeId?: string;
2224
- /**
2225
- * Amount of the loyalty multiplier for this range.
2226
- */
2227
- loyaltyMultiplierAmount?: number;
2228
- }
2229
- /**
2230
- * Object defining referral requirements.
2231
- */
2232
- interface ReferralRequirements {
2233
- /**
2234
- * Flag indicating if achieving points is required.
2235
- */
2236
- achievePoints?: boolean | null;
2237
- /**
2238
- * Flag indicating if completing the profile is required.
2239
- */
2240
- completeProfile?: boolean | null;
2241
- /**
2242
- * Flag indicating if connecting Discord is required.
2243
- */
2244
- connectDiscord?: boolean | null;
2245
- /**
2246
- * Flag indicating if connecting email is required.
2247
- */
2248
- connectEmail?: boolean | null;
2249
- /**
2250
- * Flag indicating if connecting Twitter is required.
2251
- */
2252
- connectTwitter?: boolean | null;
2253
- points?: ReferralRequirements.Points | null;
2254
- }
2255
- namespace ReferralRequirements {
2256
- interface Points {
2257
- /**
2258
- * Points required for referral.
2259
- */
2260
- amount?: number | null;
2261
- /**
2262
- * ID of the loyalty currency for referral.
2263
- */
2264
- loyaltyCurrecyId?: string | null;
2265
- }
2266
- }
2267
- /**
2268
- * Object containing details of the associated smart contract.
2269
- */
2270
- interface SmartContract {
2271
- /**
2272
- * Mapping of addresses for the smart contract.
2273
- */
2274
- addressMapping?: string | null;
2275
- /**
2276
- * Object containing details of the amount multiplier from the event.
2277
- */
2278
- amountMultiplier?: SmartContract.AmountMultiplier | null;
2279
- /**
2280
- * ID of the smart contract.
2281
- */
2282
- contractId?: string | null;
2283
- /**
2284
- * Criteria to evaluate the smart contract event.
2285
- */
2286
- criteria?: 'everyEvent' | 'byParameter' | null;
2287
- /**
2288
- * Event emitted by the smart contract.
2289
- */
2290
- event?: string | null;
2291
- /**
2292
- * Array of parameters for the smart contract.
2293
- */
2294
- params?: Array<SmartContract.Param> | null;
2295
- /**
2296
- * Type of the smart contract interaction.
2297
- */
2298
- type?: 'function' | 'event' | null;
2299
- }
2300
- namespace SmartContract {
2301
- /**
2302
- * Object containing details of the amount multiplier from the event.
2303
- */
2304
- interface AmountMultiplier {
2305
- /**
2306
- * Mapping of the value for the smart contract.
2307
- */
2308
- valueMapping?: string | null;
2309
- }
2310
- interface Param {
2311
- /**
2312
- * Condition to check for the parameter.
2313
- */
2314
- condition?: string | null;
2315
- /**
2316
- * Name of the smart contract parameter.
2317
- */
2318
- name?: string | null;
2319
- /**
2320
- * Value of the parameter.
2321
- */
2322
- value?: string | null;
2323
- }
2324
- }
2325
- interface SnapshotProposal {
2326
- /**
2327
- * ID of the snapshot proposal.
2328
- */
2329
- id: string;
2330
- /**
2331
- * Space associated with the snapshot proposal.
2332
- */
2333
- space: string;
2334
- }
2335
- interface StreakArray {
2336
- /**
2337
- * Reward amount for achieving the streak milestone.
2338
- */
2339
- streakAmount: number;
2340
- /**
2341
- * Milestone required to achieve the streak.
2342
- */
2343
- streakMilestone: number;
2344
- }
2345
- /**
2346
- * Metadata for swap loyalty rules
2347
- */
2348
- interface Swap {
2349
- from?: Swap.From;
2350
- provider?: 'any' | 'relay' | 'lifi';
2351
- relayReferrerId?: string;
2352
- requireCrossChainSwap?: boolean;
2353
- to?: Swap.To;
2354
- }
2355
- namespace Swap {
2356
- interface From {
2357
- chain?: 'any' | number | string;
2358
- mode?: 'any' | 'specific';
2359
- tokens?: Array<From.Token>;
2360
- trackAmount?: boolean;
2361
- }
2362
- namespace From {
2363
- interface Token {
2364
- address: string;
2365
- chainId: string;
2366
- }
2367
- }
2368
- interface To {
2369
- chain?: 'any' | number | string;
2370
- mode?: 'any' | 'specific';
2371
- tokens?: Array<To.Token>;
2372
- trackAmount?: boolean;
2373
- }
2374
- namespace To {
2375
- interface Token {
2376
- address: string;
2377
- chainId: string;
2378
- }
2379
- }
2380
- }
2381
- }
2382
- }
2383
- /**
2384
- * Previous data of the rule before the edit
2385
- */
2386
- interface PreviousData {
2387
- /**
2388
- * Unique identifier for the loyalty rule
2389
- */
2390
- id: string;
2391
- /**
2392
- * Amount associated with the loyalty rule
2393
- */
2394
- amount: number | null;
2395
- /**
2396
- * Timestamp when the loyalty rule was created
2397
- */
2398
- createdAt: string;
2399
- /**
2400
- * Timestamp when the loyalty rule was deleted (if applicable)
2401
- */
2402
- deletedAt: string | null;
2403
- /**
2404
- * Description of the loyalty rule
2405
- */
2406
- description: string;
2407
- /**
2408
- * End time of the loyalty rule
2409
- */
2410
- endTime: string | null;
2411
- /**
2412
- * Frequency of the loyalty rule
2413
- */
2414
- frequency: string;
2415
- /**
2416
- * Name of the loyalty rule
2417
- */
2418
- name: string;
2419
- /**
2420
- * Unique identifier for the organization
2421
- */
2422
- organizationId: string;
2423
- /**
2424
- * Type of the reward
2425
- */
2426
- rewardType: 'points' | 'multiplier' | 'badge';
2427
- /**
2428
- * Start time of the loyalty rule
2429
- */
2430
- startTime: string | null;
2431
- /**
2432
- * Type of the loyalty rule
2433
- */
2434
- type: string;
2435
- /**
2436
- * Timestamp when the loyalty rule was last updated
2437
- */
2438
- updatedAt: string;
2439
- /**
2440
- * Unique identifier for the website
2441
- */
2442
- websiteId: string;
2443
- /**
2444
- * Optional address of the collection
2445
- */
2446
- collectionAddress?: string;
2447
- /**
2448
- * URL of the media associated with the loyalty rule
2449
- */
2450
- mediaUrl?: string | null;
2451
- /**
2452
- * Optional metadata for the loyalty rule
2453
- */
2454
- metadata?: {
2455
- [key: string]: PreviousData.Metadata;
2456
- };
2457
- }
2458
- namespace PreviousData {
2459
- interface Metadata {
2460
- /**
2461
- * Flag indicating if the rule allows multiple redemptions. Applies to Enter a Code
2462
- * only.
2463
- */
2464
- allowMultipleRedemptions?: boolean;
2465
- /**
2466
- * Array of loyalty rule IDs that count as check-in when completed. If ["any"] then
2467
- * any rule completions count as check-in.
2468
- */
2469
- autoCheckInRuleIds?: Array<(string & {}) | 'any'> | null;
2470
- /**
2471
- * Number of tokens per batch.
2472
- */
2473
- batchSize?: number | null;
2474
- /**
2475
- * Text displayed on the action button.
2476
- */
2477
- buttonText?: string | null;
2478
- /**
2479
- * Flag indicating if commenting is required.
2480
- */
2481
- checkComment?: boolean | null;
2482
- /**
2483
- * Flag indicating if liking the post is required.
2484
- */
2485
- checkLike?: boolean | null;
2486
- /**
2487
- * Flag indicating if reposting is required.
2488
- */
2489
- checkRepost?: boolean | null;
2490
- /**
2491
- * Text to check in the Twitter post, username, or bio.
2492
- */
2493
- checkText?: string | Array<string> | null;
2494
- /**
2495
- * Array of collections associated with the rule.
2496
- */
2497
- collection?: Array<Metadata.Collection>;
2498
- /**
2499
- * Conditions for completing the profile.
2500
- */
2501
- completeProfileConditions?: {
2502
- [key: string]: boolean;
2503
- } | null;
2504
- /**
2505
- * Description of the external rule condition (only for external rules)
2506
- */
2507
- conditionDescription?: string;
2508
- /**
2509
- * Object containing details for the call-to-action.
2510
- */
2511
- cta?: Metadata.Cta | null;
2512
- /**
2513
- * API key for custom rewards integration.
2514
- */
2515
- customRewardsApiKey?: string;
2516
- /**
2517
- * Flag indicating if the rule should use direct RPC to get the balance of tokens.
2518
- */
2519
- directRpc?: boolean;
2520
- /**
2521
- * Array of Discord servers, channels, and roles to join.
2522
- */
2523
- discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
2524
- /**
2525
- * Array of drip quests required to complete the rule.
2526
- */
2527
- dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
2528
- /**
2529
- * Flag indicating whether joining Discord servers is required.
2530
- */
2531
- enableJoinDiscordServers?: boolean | null;
2532
- /**
2533
- * Flag indicating whether streaks are enabled.
2534
- */
2535
- enableStreaks?: boolean | null;
2536
- /**
2537
- * Flag indicating whether the verified multiplier is enabled.
2538
- */
2539
- enableVerifiedMultiplier?: boolean;
2540
- /**
2541
- * Type of ERC20 token for the loyalty rule.
2542
- */
2543
- erc20Type?: 'erc20' | 'native';
2544
- /**
2545
- * Fill source of the order for the token sale
2546
- */
2547
- fillSource?: string;
2548
- /**
2549
- * Percentage reward given to a user for their first referral.
2550
- */
2551
- firstReferralReward?: number | null;
2552
- /**
2553
- * Name of the GitHub branch to check for PR merge.
2554
- */
2555
- githubBranchName?: string | null;
2556
- /**
2557
- * URL of the GitHub repository to check for star.
2558
- */
2559
- githubRepoUrl?: string | null;
2560
- /**
2561
- * Flag indicating whether the fill source is included.
2562
- */
2563
- hasFillSource?: boolean;
2564
- /**
2565
- * Indicates if the item has never been sold.
2566
- */
2567
- hasNeverSold?: boolean;
2568
- /**
2569
- * Indicates if the full royalty has been paid for items.
2570
- */
2571
- hasPaidFullRoyalty?: boolean;
2572
- /**
2573
- * Flag indicating if the sale currency is included.
2574
- */
2575
- hasSaleCurrency?: boolean;
2576
- /**
2577
- * Indicates if the user has a verified Twitter account.
2578
- */
2579
- hasVerifiedTwitter?: boolean;
2580
- /**
2581
- * URL of the image associated with the rule.
2582
- */
2583
- imageUrl?: string | null;
2584
- /**
2585
- * If enabled, the first transaction done on the platform will complete this rule
2586
- */
2587
- isCheckInOnEveryTxn?: boolean;
2588
- /**
2589
- * Indicates if the multiplier has been applied to rewards.
2590
- */
2591
- isMultiplierApplied?: boolean;
2592
- /**
2593
- * Flag indicating if the rule is restricted to new users.
2594
- */
2595
- isRestrictedToNewUsers?: boolean;
2596
- /**
2597
- * Flag indicating if rewards are applied retroactively.
2598
- */
2599
- isRetroactive?: boolean | null;
2600
- /**
2601
- * Flag indicating if the token hold multiplier is applied.
2602
- */
2603
- isTokenHoldMultiplier?: boolean;
2604
- /**
2605
- * Optional link associated with the metadata.
2606
- */
2607
- link?: string | null;
2608
- /**
2609
- * Liquidity pool details.
2610
- */
2611
- liquidity?: Metadata.Liquidity;
2612
- /**
2613
- * Maximum quantity constraint for token holding.
2614
- */
2615
- maxQty?: number | null;
2616
- /**
2617
- * Minimum follower count for the rule. Accepts both number and string values.
2618
- */
2619
- minimumFollowerCount?: number | null;
2620
- /**
2621
- * Minimum quantity constraint for token holding.
2622
- */
2623
- minQty?: number | null;
2624
- /**
2625
- * Array of loyalty currency IDs used for multipliers.
2626
- */
2627
- multiplierLoyaltyCurrencyIds?: Array<string> | null;
2628
- /**
2629
- * Flag indicating whether to include only known users.
2630
- */
2631
- onlyKnownUsers?: boolean;
2632
- /**
2633
- * Flag indicating whether to include only native tokens.
2634
- */
2635
- onlyNative?: boolean;
2636
- /**
2637
- * Flag indicating whether to include only non-listed items.
2638
- */
2639
- onlyNonListed?: boolean;
2640
- /**
2641
- * Indicates if only existing users are rewarded.
2642
- */
2643
- onlyRewardExistingUser?: boolean;
2644
- /**
2645
- * give points for only one token ownership per contract
2646
- */
2647
- onlyRewardSingleTokenOwnership?: boolean | null;
2648
- /**
2649
- * Pre-generated text template that will be used to prefill the post content.
2650
- */
2651
- preGeneratedPostText?: string | null;
2652
- /**
2653
- * Promotional code associated with the rule.
2654
- */
2655
- promoCode?: string;
2656
- /**
2657
- * URL of the CSV file containing promo codes.
2658
- */
2659
- promoCodeCsvUrl?: string;
2660
- /**
2661
- * Numbers of the promotional code to be generated.
2662
- */
2663
- promoCodeLength?: number | null;
2664
- /**
2665
- * Type of the promotional code.
2666
- */
2667
- promoCodeType?: 'code' | 'csv' | 'generate';
2668
- /**
2669
- * Array defining ranges and corresponding rewards.
2670
- */
2671
- range?: Array<Metadata.Range>;
2672
- /**
2673
- * ID of the Reddit post.
2674
- */
2675
- redditPostId?: string | null;
2676
- /**
2677
- * Object defining referral requirements.
2678
- */
2679
- referralRequirements?: Metadata.ReferralRequirements | null;
2680
- /**
2681
- * Lump sum reward given to a referrer.
2682
- */
2683
- referrerReward?: number | null;
2684
- /**
2685
- * Loyalty currency ID of the referrer reward.
2686
- */
2687
- referrerRewardLoyaltyCurrencyId?: string | null;
2688
- /**
2689
- * Flag indicating if the post link is required.
2690
- */
2691
- requirePostLink?: boolean | null;
2692
- /**
2693
- * Flag indicating if media metadata is required.
2694
- */
2695
- requirePostMediaLink?: boolean | null;
2696
- /**
2697
- * Flag indicating if the rule can also reward badges per range.
2698
- */
2699
- rewardBadgePerRange?: boolean;
2700
- /**
2701
- * Flag indicating if the reward is rewarded by batch.
2702
- */
2703
- rewardByBatch?: boolean | null;
2704
- /**
2705
- * Criteria to evaluate the reward.
2706
- */
2707
- rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
2708
- /**
2709
- * Flag indicating if the reward is rewarded per action.
2710
- */
2711
- rewardPerAction?: boolean | null;
2712
- /**
2713
- * Flag indicating if rewards are given per impression.
2714
- */
2715
- rewardPerImpression?: boolean | null;
2716
- /**
2717
- * Flag indicating if the rule should reward based on value of traded tokens
2718
- * instead of count.
2719
- */
2720
- rewardPerValue?: boolean;
2721
- /**
2722
- * Flag indicating if the rule should reward quality posts.
2723
- */
2724
- rewardQualityPosts?: boolean;
2725
- robinhoodSymbols?: Array<string> | null;
2726
- /**
2727
- * Wallet address of the user can only be used if userId is not provided
2728
- */
2729
- royaltyAddress?: string;
2730
- /**
2731
- * Royalty percentage of the item.
2732
- */
2733
- royaltyPercentage?: number;
2734
- /**
2735
- * Currency associated with sales.
2736
- */
2737
- saleCurrency?: string;
2738
- /**
2739
- * Percentage reward given for a second-level referral.
2740
- */
2741
- secondReferralReward?: number | null;
2742
- /**
2743
- * Flag indicating if the multiplier is skipped.
2744
- */
2745
- skipMultiplier?: boolean | null;
2746
- /**
2747
- * Object containing details of the associated smart contract.
2748
- */
2749
- smartContract?: Metadata.SmartContract;
2750
- /**
2751
- * Array of snapshot proposals for the rule.
2752
- */
2753
- snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
2754
- /**
2755
- * Social media platform associated with the rule.
2756
- */
2757
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | 'GitHub' | 'Reddit' | null;
2758
- /**
2759
- * URL of the social platform's logo.
2760
- */
2761
- socialPlatformLogo?: string | null;
2762
- /**
2763
- * Name of the social platform.
2764
- */
2765
- socialPlatformName?: string | null;
2766
- /**
2767
- * ID of the Steam app.
2768
- */
2769
- steamAppId?: string | null;
2770
- /**
2771
- * Array of streak milestones and corresponding rewards.
2772
- */
2773
- streakArray?: Array<Metadata.StreakArray> | null;
2774
- /**
2775
- * Metadata for swap loyalty rules
2776
- */
2777
- swap?: Metadata.Swap;
2778
- /**
2779
- * ID of the Telegram channel.
2780
- */
2781
- telegramChannelId?: string | null;
2782
- /**
2783
- * Time delay in seconds to verify actions.
2784
- */
2785
- timeDelayToVerifySeconds?: string | number | null;
2786
- /**
2787
- * Flag indicating if all contracts are tracked.
2788
- */
2789
- trackAllContracts?: boolean | null;
2790
- /**
2791
- * Flag indicating if the progress is tracked. If enabled, the rule can only be
2792
- * completed once the progress is 100%.
2793
- */
2794
- trackProgress?: boolean | null;
2795
- /**
2796
- * URL of the associated Twitter account.
2797
- */
2798
- twitterAccountUrl?: string;
2799
- /**
2800
- * Hashtag associated with the Twitter post.
2801
- */
2802
- twitterHashtag?: string;
2803
- /**
2804
- * URL of the associated Twitter post.
2805
- */
2806
- twitterPostUrl?: string;
2807
- /**
2808
- * Unique identifier of the Twitter user.
2809
- */
2810
- twitterUserId?: string;
2811
- /**
2812
- * Twitter username of the user.
2813
- */
2814
- twitterUsername?: string;
2815
- /**
2816
- * Minimum length of the verification text.
2817
- */
2818
- verificationTextMinimumLength?: number | null;
2819
- /**
2820
- * Multiplier applied to rewards for verified users.
2821
- */
2822
- verifiedMultiplier?: number | null;
2823
- /**
2824
- * Placeholder text for verification input fields.
2825
- */
2826
- verifyPlaceHolderText?: string | null;
2827
- /**
2828
- * Type of wallet associated with the rule.
2829
- */
2830
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | 'flow_cadence' | 'substrate' | null;
2831
- /**
2832
- * ID of the Youtube channel.
2833
- */
2834
- youtubeChannelId?: string | null;
2835
- /**
2836
- * ID of the Youtube video.
2837
- */
2838
- youtubeVideoId?: string | null;
2839
- }
2840
- namespace Metadata {
2841
- interface Collection {
2842
- /**
2843
- * Blockchain address of the collection.
2844
- */
2845
- address?: string;
2846
- /**
2847
- * Multiplier applied to the rewards for this collection.
2848
- */
2849
- multiplier?: number;
2850
- /**
2851
- * Blockchain network of the collection.
2852
- */
2853
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
2854
- }
2855
- /**
2856
- * Object containing details for the call-to-action.
2857
- */
2858
- interface Cta {
2859
- /**
2860
- * Link for the call-to-action.
2861
- */
2862
- href?: string | null;
2863
- /**
2864
- * Label for the call-to-action.
2865
- */
2866
- label?: string | null;
2867
- }
2868
- interface DiscordServersToJoin {
2869
- /**
2870
- * ID of the Discord server to join.
2871
- */
2872
- id?: string;
2873
- /**
2874
- * Array of Discord channels to join.
2875
- */
2876
- channels?: Array<DiscordServersToJoin.Channel>;
2877
- /**
2878
- * Array of roles to assign in the Discord server.
2879
- */
2880
- roles?: Array<DiscordServersToJoin.Role>;
2881
- }
2882
- namespace DiscordServersToJoin {
2883
- interface Channel {
2884
- /**
2885
- * ID of the Discord channel.
2886
- */
2887
- id?: string;
2888
- /**
2889
- * Array of emojis used in the channel.
2890
- */
2891
- emojis?: Array<Channel.Emoji>;
2892
- /**
2893
- * Phrase of text to be present in the discord message
2894
- */
2895
- text?: string;
2896
- }
2897
- namespace Channel {
2898
- interface Emoji {
2899
- /**
2900
- * ID of the emoji used in the channel.
2901
- */
2902
- id?: string;
2903
- }
2904
- }
2905
- interface Role {
2906
- /**
2907
- * ID of the role in the Discord server.
2908
- */
2909
- id: string;
2910
- }
2911
- }
2912
- interface DripQuestsToComplete {
2913
- /**
2914
- * ID of the drip quest to complete.
2915
- */
2916
- id: string;
2917
- }
2918
- /**
2919
- * Liquidity pool details.
2920
- */
2921
- interface Liquidity {
2922
- /**
2923
- * Calculation type of the liquidity pool.
2924
- */
2925
- calculationType?: 'fixed' | 'custom';
2926
- /**
2927
- * Custom function to calculate the the reward amount based on the liquidity
2928
- * provided per day. X is the reward amount, Y is the liquidity provided per day in
2929
- * USD.
2930
- */
2931
- customFunction?: string;
2932
- /**
2933
- * Liquidity provided per day in USD
2934
- */
2935
- liquidityPerDay?: number;
2936
- /**
2937
- * Blockchain network of the liquidity pool.
2938
- */
2939
- 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' | 'skaleEuropa' | 'skaleCalypso' | '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' | 'somnia' | 'zkverify' | 'polkadot' | 'kusama' | 'flow_cadence';
2940
- /**
2941
- * Indicates if only in-range liquidity is rewarded.
2942
- */
2943
- onlyRewardInRangeLiquidity?: boolean;
2944
- /**
2945
- * Array of liquidity pools associated with the rule.
2946
- */
2947
- pools?: Array<Liquidity.Pool>;
2948
- /**
2949
- * Protocol of the liquidity pool.
2950
- */
2951
- protocol?: string;
2952
- }
2953
- namespace Liquidity {
2954
- interface Pool {
2955
- /**
2956
- * Unique identifier of the liquidity pool.
2957
- */
2958
- id: string;
2959
- }
2960
- }
2961
- interface Range {
2962
- /**
2963
- * Reward amount for this range.
2964
- */
2965
- amount: number;
2966
- /**
2967
- * End value of the range.
2968
- */
2969
- endRange: number;
2970
- /**
2971
- * Start value of the range.
2972
- */
2973
- startRange: number;
2974
- /**
2975
- * ID of the loyalty badge for this range.
2976
- */
2977
- loyaltyBadgeId?: string;
2978
- /**
2979
- * Amount of the loyalty multiplier for this range.
2980
- */
2981
- loyaltyMultiplierAmount?: number;
2982
- }
2983
- /**
2984
- * Object defining referral requirements.
2985
- */
2986
- interface ReferralRequirements {
2987
- /**
2988
- * Flag indicating if achieving points is required.
2989
- */
2990
- achievePoints?: boolean | null;
2991
- /**
2992
- * Flag indicating if completing the profile is required.
2993
- */
2994
- completeProfile?: boolean | null;
2995
- /**
2996
- * Flag indicating if connecting Discord is required.
2997
- */
2998
- connectDiscord?: boolean | null;
2999
- /**
3000
- * Flag indicating if connecting email is required.
3001
- */
3002
- connectEmail?: boolean | null;
3003
- /**
3004
- * Flag indicating if connecting Twitter is required.
3005
- */
3006
- connectTwitter?: boolean | null;
3007
- points?: ReferralRequirements.Points | null;
3008
- }
3009
- namespace ReferralRequirements {
3010
- interface Points {
3011
- /**
3012
- * Points required for referral.
3013
- */
3014
- amount?: number | null;
3015
- /**
3016
- * ID of the loyalty currency for referral.
3017
- */
3018
- loyaltyCurrecyId?: string | null;
3019
- }
3020
- }
3021
- /**
3022
- * Object containing details of the associated smart contract.
3023
- */
3024
- interface SmartContract {
3025
- /**
3026
- * Mapping of addresses for the smart contract.
3027
- */
3028
- addressMapping?: string | null;
3029
- /**
3030
- * Object containing details of the amount multiplier from the event.
3031
- */
3032
- amountMultiplier?: SmartContract.AmountMultiplier | null;
3033
- /**
3034
- * ID of the smart contract.
3035
- */
3036
- contractId?: string | null;
3037
- /**
3038
- * Criteria to evaluate the smart contract event.
3039
- */
3040
- criteria?: 'everyEvent' | 'byParameter' | null;
3041
- /**
3042
- * Event emitted by the smart contract.
3043
- */
3044
- event?: string | null;
3045
- /**
3046
- * Array of parameters for the smart contract.
3047
- */
3048
- params?: Array<SmartContract.Param> | null;
3049
- /**
3050
- * Type of the smart contract interaction.
3051
- */
3052
- type?: 'function' | 'event' | null;
3053
- }
3054
- namespace SmartContract {
3055
- /**
3056
- * Object containing details of the amount multiplier from the event.
3057
- */
3058
- interface AmountMultiplier {
3059
- /**
3060
- * Mapping of the value for the smart contract.
3061
- */
3062
- valueMapping?: string | null;
3063
- }
3064
- interface Param {
3065
- /**
3066
- * Condition to check for the parameter.
3067
- */
3068
- condition?: string | null;
3069
- /**
3070
- * Name of the smart contract parameter.
3071
- */
3072
- name?: string | null;
3073
- /**
3074
- * Value of the parameter.
3075
- */
3076
- value?: string | null;
3077
- }
3078
- }
3079
- interface SnapshotProposal {
3080
- /**
3081
- * ID of the snapshot proposal.
3082
- */
3083
- id: string;
3084
- /**
3085
- * Space associated with the snapshot proposal.
3086
- */
3087
- space: string;
3088
- }
3089
- interface StreakArray {
3090
- /**
3091
- * Reward amount for achieving the streak milestone.
3092
- */
3093
- streakAmount: number;
3094
- /**
3095
- * Milestone required to achieve the streak.
3096
- */
3097
- streakMilestone: number;
3098
- }
3099
- /**
3100
- * Metadata for swap loyalty rules
3101
- */
3102
- interface Swap {
3103
- from?: Swap.From;
3104
- provider?: 'any' | 'relay' | 'lifi';
3105
- relayReferrerId?: string;
3106
- requireCrossChainSwap?: boolean;
3107
- to?: Swap.To;
3108
- }
3109
- namespace Swap {
3110
- interface From {
3111
- chain?: 'any' | number | string;
3112
- mode?: 'any' | 'specific';
3113
- tokens?: Array<From.Token>;
3114
- trackAmount?: boolean;
3115
- }
3116
- namespace From {
3117
- interface Token {
3118
- address: string;
3119
- chainId: string;
3120
- }
3121
- }
3122
- interface To {
3123
- chain?: 'any' | number | string;
3124
- mode?: 'any' | 'specific';
3125
- tokens?: Array<To.Token>;
3126
- trackAmount?: boolean;
3127
- }
3128
- namespace To {
3129
- interface Token {
3130
- address: string;
3131
- chainId: string;
3132
- }
3133
- }
3134
- }
3135
- }
3136
- }
3137
- }
3138
- export interface RuleEditListParams {
3139
- /**
3140
- * ID of the loyalty rule
3141
- */
3142
- loyaltyRuleId: boolean;
3143
- /**
3144
- * Maximum number of edits to return
3145
- */
3146
- limit?: number;
3147
- /**
3148
- * Unique identifier for the organization to filter by
3149
- */
3150
- organizationId?: string;
3151
- /**
3152
- * Pagination cursor to start after a specific rule edit ID
3153
- */
3154
- startingAfter?: string;
3155
- /**
3156
- * Unique identifier for the website to filter by
3157
- */
3158
- websiteId?: string;
3159
- }
3160
- export interface RuleEditRestoreParams {
3161
- }
3162
- export declare namespace RuleEdits {
3163
- export { type RuleEditListResponse as RuleEditListResponse, type RuleEditRestoreResponse as RuleEditRestoreResponse, type RuleEditListParams as RuleEditListParams, type RuleEditRestoreParams as RuleEditRestoreParams, };
3164
- }
3165
- //# sourceMappingURL=rule-edits.d.mts.map