@snagsolutions/sdk 0.1.0-alpha.13 → 0.1.0-alpha.130

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