@snagsolutions/sdk 0.1.0-alpha.12 → 0.1.0-alpha.121

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 +1056 -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 +876 -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 +26 -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 +2521 -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 +747 -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 +1775 -282
  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 +111 -8
  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 +1055 -83
  295. package/src/resources/loyalty/currencies.ts +26 -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 +3542 -63
  302. package/src/resources/loyalty/rule-groups.ts +1162 -0
  303. package/src/resources/loyalty/rules.ts +2957 -574
  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 +673 -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 +163 -7
  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
@@ -6,33 +6,44 @@ import * as Core from '../../core';
6
6
  export class RuleEdits extends APIResource {
7
7
  /**
8
8
  * Retrieve configured loyalty rule edits with optional pagination and filters
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const ruleEdits = await client.loyalty.ruleEdits.list({
13
+ * loyaltyRuleId: true,
14
+ * });
15
+ * ```
9
16
  */
10
- retrieve(
11
- query: RuleEditRetrieveParams,
12
- options?: Core.RequestOptions,
13
- ): Core.APIPromise<RuleEditRetrieveResponse> {
17
+ list(query: RuleEditListParams, options?: Core.RequestOptions): Core.APIPromise<RuleEditListResponse> {
14
18
  return this._client.get('/api/loyalty/rule_edits', { query, ...options });
15
19
  }
16
20
 
17
21
  /**
18
22
  * Restore a loyalty rule from a rule edit
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const response = await client.loyalty.ruleEdits.restore(
27
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
28
+ * );
29
+ * ```
19
30
  */
20
31
  restore(
21
32
  id: string,
22
33
  body?: RuleEditRestoreParams | null | undefined,
23
34
  options?: Core.RequestOptions,
24
35
  ): Core.APIPromise<RuleEditRestoreResponse> {
25
- return this._client.post(`/api/api/loyalty/rule_edits/${id}/restore`, { body, ...options });
36
+ return this._client.post(`/api/loyalty/rule_edits/${id}/restore`, { body, ...options });
26
37
  }
27
38
  }
28
39
 
29
- export interface RuleEditRetrieveResponse {
30
- data: Array<RuleEditRetrieveResponse.Data>;
40
+ export interface RuleEditListResponse {
41
+ data: Array<RuleEditListResponse.Data>;
31
42
 
32
43
  hasNextPage: boolean;
33
44
  }
34
45
 
35
- export namespace RuleEditRetrieveResponse {
46
+ export namespace RuleEditListResponse {
36
47
  export interface Data {
37
48
  /**
38
49
  * Unique identifier for the rule edit
@@ -110,16 +121,41 @@ export namespace RuleEditRetrieveResponse {
110
121
  */
111
122
  deletedAt: string | null;
112
123
 
124
+ /**
125
+ * Description of the loyalty rule
126
+ */
127
+ description: string;
128
+
129
+ /**
130
+ * End time of the loyalty rule
131
+ */
132
+ endTime: string;
133
+
113
134
  /**
114
135
  * Frequency of the loyalty rule
115
136
  */
116
137
  frequency: string;
117
138
 
139
+ /**
140
+ * Name of the loyalty rule
141
+ */
142
+ name: string;
143
+
118
144
  /**
119
145
  * Unique identifier for the organization
120
146
  */
121
147
  organizationId: string;
122
148
 
149
+ /**
150
+ * Type of the reward
151
+ */
152
+ rewardType: 'points' | 'multiplier' | 'badge';
153
+
154
+ /**
155
+ * Start time of the loyalty rule
156
+ */
157
+ startTime: string;
158
+
123
159
  /**
124
160
  * Type of the loyalty rule
125
161
  */
@@ -140,10 +176,852 @@ export namespace RuleEditRetrieveResponse {
140
176
  */
141
177
  collectionAddress?: string;
142
178
 
179
+ /**
180
+ * URL of the media associated with the loyalty rule
181
+ */
182
+ mediaUrl?: string | null;
183
+
143
184
  /**
144
185
  * Optional metadata for the loyalty rule
145
186
  */
146
- metadata?: Record<string, unknown>;
187
+ metadata?: { [key: string]: Data.Metadata };
188
+ }
189
+
190
+ export namespace Data {
191
+ export interface Metadata {
192
+ /**
193
+ * Number of tokens per batch.
194
+ */
195
+ batchSize?: number | null;
196
+
197
+ /**
198
+ * Text displayed on the action button.
199
+ */
200
+ buttonText?: string | null;
201
+
202
+ /**
203
+ * Flag indicating if commenting is required.
204
+ */
205
+ checkComment?: boolean | null;
206
+
207
+ /**
208
+ * Flag indicating if liking the post is required.
209
+ */
210
+ checkLike?: boolean | null;
211
+
212
+ /**
213
+ * Flag indicating if reposting is required.
214
+ */
215
+ checkRepost?: boolean | null;
216
+
217
+ /**
218
+ * Text to check in the Twitter post, username, or bio.
219
+ */
220
+ checkText?: string | null;
221
+
222
+ /**
223
+ * Array of collections associated with the rule.
224
+ */
225
+ collection?: Array<Metadata.Collection>;
226
+
227
+ /**
228
+ * Conditions for completing the profile.
229
+ */
230
+ completeProfileConditions?: { [key: string]: boolean } | null;
231
+
232
+ /**
233
+ * Object containing details for the call-to-action.
234
+ */
235
+ cta?: Metadata.Cta | null;
236
+
237
+ /**
238
+ * API key for custom rewards integration.
239
+ */
240
+ customRewardsApiKey?: string;
241
+
242
+ /**
243
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
244
+ */
245
+ directRpc?: boolean;
246
+
247
+ /**
248
+ * Array of Discord servers, channels, and roles to join.
249
+ */
250
+ discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
251
+
252
+ /**
253
+ * Array of drip quests required to complete the rule.
254
+ */
255
+ dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
256
+
257
+ /**
258
+ * Flag indicating whether joining Discord servers is required.
259
+ */
260
+ enableJoinDiscordServers?: boolean | null;
261
+
262
+ /**
263
+ * Flag indicating whether streaks are enabled.
264
+ */
265
+ enableStreaks?: boolean | null;
266
+
267
+ /**
268
+ * Flag indicating whether the verified multiplier is enabled.
269
+ */
270
+ enableVerifiedMultiplier?: boolean;
271
+
272
+ /**
273
+ * Fill source of the order for the token sale
274
+ */
275
+ fillSource?: string;
276
+
277
+ /**
278
+ * Percentage reward given to a user for their first referral.
279
+ */
280
+ firstReferralReward?: number | null;
281
+
282
+ /**
283
+ * Flag indicating whether the fill source is included.
284
+ */
285
+ hasFillSource?: boolean;
286
+
287
+ /**
288
+ * Indicates if the item has never been sold.
289
+ */
290
+ hasNeverSold?: boolean;
291
+
292
+ /**
293
+ * Indicates if the full royalty has been paid for items.
294
+ */
295
+ hasPaidFullRoyalty?: boolean;
296
+
297
+ /**
298
+ * Flag indicating if the sale currency is included.
299
+ */
300
+ hasSaleCurrency?: boolean;
301
+
302
+ /**
303
+ * Indicates if the user has a verified Twitter account.
304
+ */
305
+ hasVerifiedTwitter?: boolean;
306
+
307
+ /**
308
+ * URL of the image associated with the rule.
309
+ */
310
+ imageUrl?: string | null;
311
+
312
+ /**
313
+ * If enabled, the first transaction done on the platform will complete this rule
314
+ */
315
+ isCheckInOnEveryTxn?: boolean;
316
+
317
+ /**
318
+ * Indicates if the multiplier has been applied to rewards.
319
+ */
320
+ isMultiplierApplied?: boolean;
321
+
322
+ /**
323
+ * Flag indicating if the rule is restricted to new users.
324
+ */
325
+ isRestrictedToNewUsers?: boolean;
326
+
327
+ /**
328
+ * Flag indicating if rewards are applied retroactively.
329
+ */
330
+ isRetroactive?: boolean | null;
331
+
332
+ /**
333
+ * Flag indicating if the token hold multiplier is applied.
334
+ */
335
+ isTokenHoldMultiplier?: boolean;
336
+
337
+ /**
338
+ * Optional link associated with the metadata.
339
+ */
340
+ link?: string | null;
341
+
342
+ /**
343
+ * Liquidity pool details.
344
+ */
345
+ liquidity?: Metadata.Liquidity;
346
+
347
+ /**
348
+ * Maximum quantity constraint for token holding.
349
+ */
350
+ maxQty?: number | null;
351
+
352
+ /**
353
+ * Minimum quantity constraint for token holding.
354
+ */
355
+ minQty?: number | null;
356
+
357
+ /**
358
+ * Array of loyalty currency IDs used for multipliers.
359
+ */
360
+ multiplierLoyaltyCurrencyIds?: Array<string> | null;
361
+
362
+ /**
363
+ * Flag indicating whether to include only known users.
364
+ */
365
+ onlyKnownUsers?: boolean;
366
+
367
+ /**
368
+ * Flag indicating whether to include only native tokens.
369
+ */
370
+ onlyNative?: boolean;
371
+
372
+ /**
373
+ * Flag indicating whether to include only non-listed items.
374
+ */
375
+ onlyNonListed?: boolean;
376
+
377
+ /**
378
+ * Indicates if only existing users are rewarded.
379
+ */
380
+ onlyRewardExistingUser?: boolean;
381
+
382
+ /**
383
+ * give points for only one token ownership per contract
384
+ */
385
+ onlyRewardSingleTokenOwnership?: boolean | null;
386
+
387
+ /**
388
+ * Promotional code associated with the rule.
389
+ */
390
+ promoCode?: string;
391
+
392
+ /**
393
+ * URL of the CSV file containing promo codes.
394
+ */
395
+ promoCodeCsvUrl?: string;
396
+
397
+ /**
398
+ * Numbers of the promotional code to be generated.
399
+ */
400
+ promoCodeLength?: number | null;
401
+
402
+ /**
403
+ * Type of the promotional code.
404
+ */
405
+ promoCodeType?: 'code' | 'csv' | 'generate';
406
+
407
+ /**
408
+ * Array defining ranges and corresponding rewards.
409
+ */
410
+ range?: Array<Metadata.Range>;
411
+
412
+ /**
413
+ * Object defining referral requirements.
414
+ */
415
+ referralRequirements?: Metadata.ReferralRequirements | null;
416
+
417
+ /**
418
+ * Lump sum reward given to a referrer.
419
+ */
420
+ referrerReward?: number | null;
421
+
422
+ /**
423
+ * Loyalty currency ID of the referrer reward.
424
+ */
425
+ referrerRewardLoyaltyCurrencyId?: string | null;
426
+
427
+ /**
428
+ * Flag indicating if the post link is required.
429
+ */
430
+ requirePostLink?: boolean | null;
431
+
432
+ /**
433
+ * Flag indicating if the rule can also reward badges per range.
434
+ */
435
+ rewardBadgePerRange?: boolean;
436
+
437
+ /**
438
+ * Flag indicating if the reward is rewarded by batch.
439
+ */
440
+ rewardByBatch?: boolean | null;
441
+
442
+ /**
443
+ * Flag indicating if rewards are given per impression.
444
+ */
445
+ rewardPerImpression?: boolean | null;
446
+
447
+ /**
448
+ * Flag indicating if the rule should reward based on value of traded tokens
449
+ * instead of count.
450
+ */
451
+ rewardPerValue?: boolean;
452
+
453
+ /**
454
+ * Currency associated with sales.
455
+ */
456
+ saleCurrency?: string;
457
+
458
+ /**
459
+ * Percentage reward given for a second-level referral.
460
+ */
461
+ secondReferralReward?: number | null;
462
+
463
+ /**
464
+ * Flag indicating if the multiplier is skipped.
465
+ */
466
+ skipMultiplier?: boolean | null;
467
+
468
+ /**
469
+ * Object containing details of the associated smart contract.
470
+ */
471
+ smartContract?: Metadata.SmartContract;
472
+
473
+ /**
474
+ * Array of snapshot proposals for the rule.
475
+ */
476
+ snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
477
+
478
+ /**
479
+ * Social media platform associated with the rule.
480
+ */
481
+ socialPlatform?:
482
+ | 'Custom'
483
+ | 'Discord'
484
+ | 'EpicGames'
485
+ | 'Instagram'
486
+ | 'Steam'
487
+ | 'Telegram'
488
+ | 'TikTok'
489
+ | 'Twitch'
490
+ | 'X(Twitter)'
491
+ | 'YouTube'
492
+ | 'Google'
493
+ | null;
494
+
495
+ /**
496
+ * URL of the social platform's logo.
497
+ */
498
+ socialPlatformLogo?: string | null;
499
+
500
+ /**
501
+ * Name of the social platform.
502
+ */
503
+ socialPlatformName?: string | null;
504
+
505
+ /**
506
+ * ID of the Steam app.
507
+ */
508
+ steamAppId?: string | null;
509
+
510
+ /**
511
+ * Array of streak milestones and corresponding rewards.
512
+ */
513
+ streakArray?: Array<Metadata.StreakArray> | null;
514
+
515
+ /**
516
+ * Metadata for swap loyalty rules
517
+ */
518
+ swap?: Metadata.Swap;
519
+
520
+ /**
521
+ * ID of the Telegram channel.
522
+ */
523
+ telegramChannelId?: string | null;
524
+
525
+ /**
526
+ * Time delay in seconds to verify actions.
527
+ */
528
+ timeDelayToVerifySeconds?: string | number | null;
529
+
530
+ /**
531
+ * Flag indicating if all contracts are tracked.
532
+ */
533
+ trackAllContracts?: boolean | null;
534
+
535
+ /**
536
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
537
+ * completed once the progress is 100%.
538
+ */
539
+ trackProgress?: boolean | null;
540
+
541
+ /**
542
+ * URL of the associated Twitter account.
543
+ */
544
+ twitterAccountUrl?: string;
545
+
546
+ /**
547
+ * Hashtag associated with the Twitter post.
548
+ */
549
+ twitterHashtag?: string;
550
+
551
+ /**
552
+ * URL of the associated Twitter post.
553
+ */
554
+ twitterPostUrl?: string;
555
+
556
+ /**
557
+ * Unique identifier of the Twitter user.
558
+ */
559
+ twitterUserId?: string;
560
+
561
+ /**
562
+ * Twitter username of the user.
563
+ */
564
+ twitterUsername?: string;
565
+
566
+ /**
567
+ * Minimum length of the verification text.
568
+ */
569
+ verificationTextMinimumLength?: number | null;
570
+
571
+ /**
572
+ * Multiplier applied to rewards for verified users.
573
+ */
574
+ verifiedMultiplier?: number | null;
575
+
576
+ /**
577
+ * Placeholder text for verification input fields.
578
+ */
579
+ verifyPlaceHolderText?: string | null;
580
+
581
+ /**
582
+ * Type of wallet associated with the rule.
583
+ */
584
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
585
+
586
+ /**
587
+ * ID of the Youtube channel.
588
+ */
589
+ youtubeChannelId?: string | null;
590
+
591
+ /**
592
+ * ID of the Youtube video.
593
+ */
594
+ youtubeVideoId?: string | null;
595
+ }
596
+
597
+ export namespace Metadata {
598
+ export interface Collection {
599
+ /**
600
+ * Blockchain address of the collection.
601
+ */
602
+ address?: string;
603
+
604
+ /**
605
+ * Multiplier applied to the rewards for this collection.
606
+ */
607
+ multiplier?: number;
608
+
609
+ /**
610
+ * Blockchain network of the collection.
611
+ */
612
+ network?:
613
+ | 'abstract'
614
+ | 'abstractTestnet'
615
+ | 'apechain'
616
+ | 'arbitrum'
617
+ | 'avalanche'
618
+ | 'avalancheFuji'
619
+ | 'base'
620
+ | 'baseSepolia'
621
+ | 'berachain'
622
+ | 'berachainArtio'
623
+ | 'berachainBepolia'
624
+ | 'binance'
625
+ | 'bscTestnet'
626
+ | 'campTestnet'
627
+ | 'fantom'
628
+ | 'fantomTestnet'
629
+ | 'flowMainnet'
630
+ | 'mainnet'
631
+ | 'optimism'
632
+ | 'polygon'
633
+ | 'polygon_mumbai'
634
+ | 'skaleNebula'
635
+ | 'solana'
636
+ | 'sophon'
637
+ | 'sophonTestnet'
638
+ | 'sui'
639
+ | 'superseed'
640
+ | 'superseedSepolia'
641
+ | 'vanar'
642
+ | 'xai'
643
+ | 'zksync'
644
+ | 'coti'
645
+ | 'cotiTestnet'
646
+ | 'morph'
647
+ | 'morphTestnet'
648
+ | 'morphHolesky'
649
+ | 'ultra'
650
+ | 'ultraTestnet'
651
+ | 'nitrograph'
652
+ | 'sepolia'
653
+ | 'optimism_sepolia'
654
+ | 'arbitrumSepolia'
655
+ | 'goerli'
656
+ | 'optimism_goerli'
657
+ | 'arbitrumGoerli'
658
+ | 'basecamp';
659
+ }
660
+
661
+ /**
662
+ * Object containing details for the call-to-action.
663
+ */
664
+ export interface Cta {
665
+ /**
666
+ * Link for the call-to-action.
667
+ */
668
+ href?: string | null;
669
+
670
+ /**
671
+ * Label for the call-to-action.
672
+ */
673
+ label?: string | null;
674
+ }
675
+
676
+ export interface DiscordServersToJoin {
677
+ /**
678
+ * ID of the Discord server to join.
679
+ */
680
+ id?: string;
681
+
682
+ /**
683
+ * Array of Discord channels to join.
684
+ */
685
+ channels?: Array<DiscordServersToJoin.Channel>;
686
+
687
+ /**
688
+ * Array of roles to assign in the Discord server.
689
+ */
690
+ roles?: Array<DiscordServersToJoin.Role>;
691
+ }
692
+
693
+ export namespace DiscordServersToJoin {
694
+ export interface Channel {
695
+ /**
696
+ * ID of the Discord channel.
697
+ */
698
+ id?: string;
699
+
700
+ /**
701
+ * Array of emojis used in the channel.
702
+ */
703
+ emojis?: Array<Channel.Emoji>;
704
+
705
+ /**
706
+ * Phrase of text to be present in the discord message
707
+ */
708
+ text?: string;
709
+ }
710
+
711
+ export namespace Channel {
712
+ export interface Emoji {
713
+ /**
714
+ * ID of the emoji used in the channel.
715
+ */
716
+ id?: string;
717
+ }
718
+ }
719
+
720
+ export interface Role {
721
+ /**
722
+ * ID of the role in the Discord server.
723
+ */
724
+ id: string;
725
+ }
726
+ }
727
+
728
+ export interface DripQuestsToComplete {
729
+ /**
730
+ * ID of the drip quest to complete.
731
+ */
732
+ id: string;
733
+ }
734
+
735
+ /**
736
+ * Liquidity pool details.
737
+ */
738
+ export interface Liquidity {
739
+ /**
740
+ * Calculation type of the liquidity pool.
741
+ */
742
+ calculationType?: 'fixed' | 'custom';
743
+
744
+ /**
745
+ * Custom function to calculate the the reward amount based on the liquidity
746
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
747
+ * USD.
748
+ */
749
+ customFunction?: string;
750
+
751
+ /**
752
+ * Liquidity provided per day in USD
753
+ */
754
+ liquidityPerDay?: number;
755
+
756
+ /**
757
+ * Blockchain network of the liquidity pool.
758
+ */
759
+ network?:
760
+ | 'abstract'
761
+ | 'abstractTestnet'
762
+ | 'apechain'
763
+ | 'arbitrum'
764
+ | 'avalanche'
765
+ | 'avalancheFuji'
766
+ | 'base'
767
+ | 'baseSepolia'
768
+ | 'berachain'
769
+ | 'berachainArtio'
770
+ | 'berachainBepolia'
771
+ | 'binance'
772
+ | 'bscTestnet'
773
+ | 'campTestnet'
774
+ | 'fantom'
775
+ | 'fantomTestnet'
776
+ | 'flowMainnet'
777
+ | 'mainnet'
778
+ | 'optimism'
779
+ | 'polygon'
780
+ | 'polygon_mumbai'
781
+ | 'skaleNebula'
782
+ | 'solana'
783
+ | 'sophon'
784
+ | 'sophonTestnet'
785
+ | 'sui'
786
+ | 'superseed'
787
+ | 'superseedSepolia'
788
+ | 'vanar'
789
+ | 'xai'
790
+ | 'zksync'
791
+ | 'coti'
792
+ | 'cotiTestnet'
793
+ | 'morph'
794
+ | 'morphTestnet'
795
+ | 'morphHolesky'
796
+ | 'ultra'
797
+ | 'ultraTestnet'
798
+ | 'nitrograph'
799
+ | 'sepolia'
800
+ | 'optimism_sepolia'
801
+ | 'arbitrumSepolia'
802
+ | 'goerli'
803
+ | 'optimism_goerli'
804
+ | 'arbitrumGoerli'
805
+ | 'basecamp';
806
+
807
+ /**
808
+ * Indicates if only in-range liquidity is rewarded.
809
+ */
810
+ onlyRewardInRangeLiquidity?: boolean;
811
+
812
+ /**
813
+ * Array of liquidity pools associated with the rule.
814
+ */
815
+ pools?: Array<Liquidity.Pool>;
816
+
817
+ /**
818
+ * Protocol of the liquidity pool.
819
+ */
820
+ protocol?: string;
821
+ }
822
+
823
+ export namespace Liquidity {
824
+ export interface Pool {
825
+ /**
826
+ * Unique identifier of the liquidity pool.
827
+ */
828
+ id: string;
829
+ }
830
+ }
831
+
832
+ export interface Range {
833
+ /**
834
+ * Reward amount for this range.
835
+ */
836
+ amount: number;
837
+
838
+ /**
839
+ * End value of the range.
840
+ */
841
+ endRange: number;
842
+
843
+ /**
844
+ * Start value of the range.
845
+ */
846
+ startRange: number;
847
+
848
+ /**
849
+ * ID of the loyalty badge for this range.
850
+ */
851
+ loyaltyBadgeId?: string;
852
+
853
+ /**
854
+ * Amount of the loyalty multiplier for this range.
855
+ */
856
+ loyaltyMultiplierAmount?: number;
857
+ }
858
+
859
+ /**
860
+ * Object defining referral requirements.
861
+ */
862
+ export interface ReferralRequirements {
863
+ /**
864
+ * Flag indicating if achieving points is required.
865
+ */
866
+ achievePoints?: boolean | null;
867
+
868
+ /**
869
+ * Flag indicating if completing the profile is required.
870
+ */
871
+ completeProfile?: boolean | null;
872
+
873
+ /**
874
+ * Flag indicating if connecting Discord is required.
875
+ */
876
+ connectDiscord?: boolean | null;
877
+
878
+ /**
879
+ * Flag indicating if connecting email is required.
880
+ */
881
+ connectEmail?: boolean | null;
882
+
883
+ /**
884
+ * Flag indicating if connecting Twitter is required.
885
+ */
886
+ connectTwitter?: boolean | null;
887
+
888
+ points?: ReferralRequirements.Points | null;
889
+ }
890
+
891
+ export namespace ReferralRequirements {
892
+ export interface Points {
893
+ /**
894
+ * Points required for referral.
895
+ */
896
+ amount?: number | null;
897
+
898
+ /**
899
+ * ID of the loyalty currency for referral.
900
+ */
901
+ loyaltyCurrecyId?: string | null;
902
+ }
903
+ }
904
+
905
+ /**
906
+ * Object containing details of the associated smart contract.
907
+ */
908
+ export interface SmartContract {
909
+ /**
910
+ * Mapping of addresses for the smart contract.
911
+ */
912
+ addressMapping?: string | null;
913
+
914
+ /**
915
+ * Object containing details of the amount multiplier from the event.
916
+ */
917
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
918
+
919
+ /**
920
+ * ID of the smart contract.
921
+ */
922
+ contractId?: string | null;
923
+
924
+ /**
925
+ * Criteria to evaluate the smart contract event.
926
+ */
927
+ criteria?: 'everyEvent' | 'byParameter' | null;
928
+
929
+ /**
930
+ * Event emitted by the smart contract.
931
+ */
932
+ event?: string | null;
933
+
934
+ /**
935
+ * Array of parameters for the smart contract.
936
+ */
937
+ params?: Array<SmartContract.Param> | null;
938
+
939
+ /**
940
+ * Type of the smart contract interaction.
941
+ */
942
+ type?: 'function' | 'event' | null;
943
+ }
944
+
945
+ export namespace SmartContract {
946
+ /**
947
+ * Object containing details of the amount multiplier from the event.
948
+ */
949
+ export interface AmountMultiplier {
950
+ /**
951
+ * Mapping of the value for the smart contract.
952
+ */
953
+ valueMapping?: string | null;
954
+ }
955
+
956
+ export interface Param {
957
+ /**
958
+ * Condition to check for the parameter.
959
+ */
960
+ condition?: string | null;
961
+
962
+ /**
963
+ * Name of the smart contract parameter.
964
+ */
965
+ name?: string | null;
966
+
967
+ /**
968
+ * Value of the parameter.
969
+ */
970
+ value?: string | null;
971
+ }
972
+ }
973
+
974
+ export interface SnapshotProposal {
975
+ /**
976
+ * ID of the snapshot proposal.
977
+ */
978
+ id: string;
979
+
980
+ /**
981
+ * Space associated with the snapshot proposal.
982
+ */
983
+ space: string;
984
+ }
985
+
986
+ export interface StreakArray {
987
+ /**
988
+ * Reward amount for achieving the streak milestone.
989
+ */
990
+ streakAmount: number;
991
+
992
+ /**
993
+ * Milestone required to achieve the streak.
994
+ */
995
+ streakMilestone: number;
996
+ }
997
+
998
+ /**
999
+ * Metadata for swap loyalty rules
1000
+ */
1001
+ export interface Swap {
1002
+ provider?: 'any' | 'relay' | 'lifi';
1003
+
1004
+ relayReferrerId?: string;
1005
+
1006
+ requireCrossChainSwap?: boolean;
1007
+
1008
+ swappedToChain?: 'any' | number | string;
1009
+
1010
+ swappedToTokens?: Array<Swap.SwappedToToken>;
1011
+
1012
+ tokenMode?: 'any' | 'specific';
1013
+
1014
+ trackTokenAmount?: boolean;
1015
+ }
1016
+
1017
+ export namespace Swap {
1018
+ export interface SwappedToToken {
1019
+ address: string;
1020
+
1021
+ chainId: string;
1022
+ }
1023
+ }
1024
+ }
147
1025
  }
148
1026
 
149
1027
  /**
@@ -170,16 +1048,41 @@ export namespace RuleEditRetrieveResponse {
170
1048
  */
171
1049
  deletedAt: string | null;
172
1050
 
1051
+ /**
1052
+ * Description of the loyalty rule
1053
+ */
1054
+ description: string;
1055
+
1056
+ /**
1057
+ * End time of the loyalty rule
1058
+ */
1059
+ endTime: string;
1060
+
173
1061
  /**
174
1062
  * Frequency of the loyalty rule
175
1063
  */
176
1064
  frequency: string;
177
1065
 
1066
+ /**
1067
+ * Name of the loyalty rule
1068
+ */
1069
+ name: string;
1070
+
178
1071
  /**
179
1072
  * Unique identifier for the organization
180
1073
  */
181
1074
  organizationId: string;
182
1075
 
1076
+ /**
1077
+ * Type of the reward
1078
+ */
1079
+ rewardType: 'points' | 'multiplier' | 'badge';
1080
+
1081
+ /**
1082
+ * Start time of the loyalty rule
1083
+ */
1084
+ startTime: string;
1085
+
183
1086
  /**
184
1087
  * Type of the loyalty rule
185
1088
  */
@@ -200,10 +1103,852 @@ export namespace RuleEditRetrieveResponse {
200
1103
  */
201
1104
  collectionAddress?: string;
202
1105
 
1106
+ /**
1107
+ * URL of the media associated with the loyalty rule
1108
+ */
1109
+ mediaUrl?: string | null;
1110
+
203
1111
  /**
204
1112
  * Optional metadata for the loyalty rule
205
1113
  */
206
- metadata?: Record<string, unknown>;
1114
+ metadata?: { [key: string]: PreviousData.Metadata };
1115
+ }
1116
+
1117
+ export namespace PreviousData {
1118
+ export interface Metadata {
1119
+ /**
1120
+ * Number of tokens per batch.
1121
+ */
1122
+ batchSize?: number | null;
1123
+
1124
+ /**
1125
+ * Text displayed on the action button.
1126
+ */
1127
+ buttonText?: string | null;
1128
+
1129
+ /**
1130
+ * Flag indicating if commenting is required.
1131
+ */
1132
+ checkComment?: boolean | null;
1133
+
1134
+ /**
1135
+ * Flag indicating if liking the post is required.
1136
+ */
1137
+ checkLike?: boolean | null;
1138
+
1139
+ /**
1140
+ * Flag indicating if reposting is required.
1141
+ */
1142
+ checkRepost?: boolean | null;
1143
+
1144
+ /**
1145
+ * Text to check in the Twitter post, username, or bio.
1146
+ */
1147
+ checkText?: string | null;
1148
+
1149
+ /**
1150
+ * Array of collections associated with the rule.
1151
+ */
1152
+ collection?: Array<Metadata.Collection>;
1153
+
1154
+ /**
1155
+ * Conditions for completing the profile.
1156
+ */
1157
+ completeProfileConditions?: { [key: string]: boolean } | null;
1158
+
1159
+ /**
1160
+ * Object containing details for the call-to-action.
1161
+ */
1162
+ cta?: Metadata.Cta | null;
1163
+
1164
+ /**
1165
+ * API key for custom rewards integration.
1166
+ */
1167
+ customRewardsApiKey?: string;
1168
+
1169
+ /**
1170
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
1171
+ */
1172
+ directRpc?: boolean;
1173
+
1174
+ /**
1175
+ * Array of Discord servers, channels, and roles to join.
1176
+ */
1177
+ discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
1178
+
1179
+ /**
1180
+ * Array of drip quests required to complete the rule.
1181
+ */
1182
+ dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
1183
+
1184
+ /**
1185
+ * Flag indicating whether joining Discord servers is required.
1186
+ */
1187
+ enableJoinDiscordServers?: boolean | null;
1188
+
1189
+ /**
1190
+ * Flag indicating whether streaks are enabled.
1191
+ */
1192
+ enableStreaks?: boolean | null;
1193
+
1194
+ /**
1195
+ * Flag indicating whether the verified multiplier is enabled.
1196
+ */
1197
+ enableVerifiedMultiplier?: boolean;
1198
+
1199
+ /**
1200
+ * Fill source of the order for the token sale
1201
+ */
1202
+ fillSource?: string;
1203
+
1204
+ /**
1205
+ * Percentage reward given to a user for their first referral.
1206
+ */
1207
+ firstReferralReward?: number | null;
1208
+
1209
+ /**
1210
+ * Flag indicating whether the fill source is included.
1211
+ */
1212
+ hasFillSource?: boolean;
1213
+
1214
+ /**
1215
+ * Indicates if the item has never been sold.
1216
+ */
1217
+ hasNeverSold?: boolean;
1218
+
1219
+ /**
1220
+ * Indicates if the full royalty has been paid for items.
1221
+ */
1222
+ hasPaidFullRoyalty?: boolean;
1223
+
1224
+ /**
1225
+ * Flag indicating if the sale currency is included.
1226
+ */
1227
+ hasSaleCurrency?: boolean;
1228
+
1229
+ /**
1230
+ * Indicates if the user has a verified Twitter account.
1231
+ */
1232
+ hasVerifiedTwitter?: boolean;
1233
+
1234
+ /**
1235
+ * URL of the image associated with the rule.
1236
+ */
1237
+ imageUrl?: string | null;
1238
+
1239
+ /**
1240
+ * If enabled, the first transaction done on the platform will complete this rule
1241
+ */
1242
+ isCheckInOnEveryTxn?: boolean;
1243
+
1244
+ /**
1245
+ * Indicates if the multiplier has been applied to rewards.
1246
+ */
1247
+ isMultiplierApplied?: boolean;
1248
+
1249
+ /**
1250
+ * Flag indicating if the rule is restricted to new users.
1251
+ */
1252
+ isRestrictedToNewUsers?: boolean;
1253
+
1254
+ /**
1255
+ * Flag indicating if rewards are applied retroactively.
1256
+ */
1257
+ isRetroactive?: boolean | null;
1258
+
1259
+ /**
1260
+ * Flag indicating if the token hold multiplier is applied.
1261
+ */
1262
+ isTokenHoldMultiplier?: boolean;
1263
+
1264
+ /**
1265
+ * Optional link associated with the metadata.
1266
+ */
1267
+ link?: string | null;
1268
+
1269
+ /**
1270
+ * Liquidity pool details.
1271
+ */
1272
+ liquidity?: Metadata.Liquidity;
1273
+
1274
+ /**
1275
+ * Maximum quantity constraint for token holding.
1276
+ */
1277
+ maxQty?: number | null;
1278
+
1279
+ /**
1280
+ * Minimum quantity constraint for token holding.
1281
+ */
1282
+ minQty?: number | null;
1283
+
1284
+ /**
1285
+ * Array of loyalty currency IDs used for multipliers.
1286
+ */
1287
+ multiplierLoyaltyCurrencyIds?: Array<string> | null;
1288
+
1289
+ /**
1290
+ * Flag indicating whether to include only known users.
1291
+ */
1292
+ onlyKnownUsers?: boolean;
1293
+
1294
+ /**
1295
+ * Flag indicating whether to include only native tokens.
1296
+ */
1297
+ onlyNative?: boolean;
1298
+
1299
+ /**
1300
+ * Flag indicating whether to include only non-listed items.
1301
+ */
1302
+ onlyNonListed?: boolean;
1303
+
1304
+ /**
1305
+ * Indicates if only existing users are rewarded.
1306
+ */
1307
+ onlyRewardExistingUser?: boolean;
1308
+
1309
+ /**
1310
+ * give points for only one token ownership per contract
1311
+ */
1312
+ onlyRewardSingleTokenOwnership?: boolean | null;
1313
+
1314
+ /**
1315
+ * Promotional code associated with the rule.
1316
+ */
1317
+ promoCode?: string;
1318
+
1319
+ /**
1320
+ * URL of the CSV file containing promo codes.
1321
+ */
1322
+ promoCodeCsvUrl?: string;
1323
+
1324
+ /**
1325
+ * Numbers of the promotional code to be generated.
1326
+ */
1327
+ promoCodeLength?: number | null;
1328
+
1329
+ /**
1330
+ * Type of the promotional code.
1331
+ */
1332
+ promoCodeType?: 'code' | 'csv' | 'generate';
1333
+
1334
+ /**
1335
+ * Array defining ranges and corresponding rewards.
1336
+ */
1337
+ range?: Array<Metadata.Range>;
1338
+
1339
+ /**
1340
+ * Object defining referral requirements.
1341
+ */
1342
+ referralRequirements?: Metadata.ReferralRequirements | null;
1343
+
1344
+ /**
1345
+ * Lump sum reward given to a referrer.
1346
+ */
1347
+ referrerReward?: number | null;
1348
+
1349
+ /**
1350
+ * Loyalty currency ID of the referrer reward.
1351
+ */
1352
+ referrerRewardLoyaltyCurrencyId?: string | null;
1353
+
1354
+ /**
1355
+ * Flag indicating if the post link is required.
1356
+ */
1357
+ requirePostLink?: boolean | null;
1358
+
1359
+ /**
1360
+ * Flag indicating if the rule can also reward badges per range.
1361
+ */
1362
+ rewardBadgePerRange?: boolean;
1363
+
1364
+ /**
1365
+ * Flag indicating if the reward is rewarded by batch.
1366
+ */
1367
+ rewardByBatch?: boolean | null;
1368
+
1369
+ /**
1370
+ * Flag indicating if rewards are given per impression.
1371
+ */
1372
+ rewardPerImpression?: boolean | null;
1373
+
1374
+ /**
1375
+ * Flag indicating if the rule should reward based on value of traded tokens
1376
+ * instead of count.
1377
+ */
1378
+ rewardPerValue?: boolean;
1379
+
1380
+ /**
1381
+ * Currency associated with sales.
1382
+ */
1383
+ saleCurrency?: string;
1384
+
1385
+ /**
1386
+ * Percentage reward given for a second-level referral.
1387
+ */
1388
+ secondReferralReward?: number | null;
1389
+
1390
+ /**
1391
+ * Flag indicating if the multiplier is skipped.
1392
+ */
1393
+ skipMultiplier?: boolean | null;
1394
+
1395
+ /**
1396
+ * Object containing details of the associated smart contract.
1397
+ */
1398
+ smartContract?: Metadata.SmartContract;
1399
+
1400
+ /**
1401
+ * Array of snapshot proposals for the rule.
1402
+ */
1403
+ snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
1404
+
1405
+ /**
1406
+ * Social media platform associated with the rule.
1407
+ */
1408
+ socialPlatform?:
1409
+ | 'Custom'
1410
+ | 'Discord'
1411
+ | 'EpicGames'
1412
+ | 'Instagram'
1413
+ | 'Steam'
1414
+ | 'Telegram'
1415
+ | 'TikTok'
1416
+ | 'Twitch'
1417
+ | 'X(Twitter)'
1418
+ | 'YouTube'
1419
+ | 'Google'
1420
+ | null;
1421
+
1422
+ /**
1423
+ * URL of the social platform's logo.
1424
+ */
1425
+ socialPlatformLogo?: string | null;
1426
+
1427
+ /**
1428
+ * Name of the social platform.
1429
+ */
1430
+ socialPlatformName?: string | null;
1431
+
1432
+ /**
1433
+ * ID of the Steam app.
1434
+ */
1435
+ steamAppId?: string | null;
1436
+
1437
+ /**
1438
+ * Array of streak milestones and corresponding rewards.
1439
+ */
1440
+ streakArray?: Array<Metadata.StreakArray> | null;
1441
+
1442
+ /**
1443
+ * Metadata for swap loyalty rules
1444
+ */
1445
+ swap?: Metadata.Swap;
1446
+
1447
+ /**
1448
+ * ID of the Telegram channel.
1449
+ */
1450
+ telegramChannelId?: string | null;
1451
+
1452
+ /**
1453
+ * Time delay in seconds to verify actions.
1454
+ */
1455
+ timeDelayToVerifySeconds?: string | number | null;
1456
+
1457
+ /**
1458
+ * Flag indicating if all contracts are tracked.
1459
+ */
1460
+ trackAllContracts?: boolean | null;
1461
+
1462
+ /**
1463
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
1464
+ * completed once the progress is 100%.
1465
+ */
1466
+ trackProgress?: boolean | null;
1467
+
1468
+ /**
1469
+ * URL of the associated Twitter account.
1470
+ */
1471
+ twitterAccountUrl?: string;
1472
+
1473
+ /**
1474
+ * Hashtag associated with the Twitter post.
1475
+ */
1476
+ twitterHashtag?: string;
1477
+
1478
+ /**
1479
+ * URL of the associated Twitter post.
1480
+ */
1481
+ twitterPostUrl?: string;
1482
+
1483
+ /**
1484
+ * Unique identifier of the Twitter user.
1485
+ */
1486
+ twitterUserId?: string;
1487
+
1488
+ /**
1489
+ * Twitter username of the user.
1490
+ */
1491
+ twitterUsername?: string;
1492
+
1493
+ /**
1494
+ * Minimum length of the verification text.
1495
+ */
1496
+ verificationTextMinimumLength?: number | null;
1497
+
1498
+ /**
1499
+ * Multiplier applied to rewards for verified users.
1500
+ */
1501
+ verifiedMultiplier?: number | null;
1502
+
1503
+ /**
1504
+ * Placeholder text for verification input fields.
1505
+ */
1506
+ verifyPlaceHolderText?: string | null;
1507
+
1508
+ /**
1509
+ * Type of wallet associated with the rule.
1510
+ */
1511
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
1512
+
1513
+ /**
1514
+ * ID of the Youtube channel.
1515
+ */
1516
+ youtubeChannelId?: string | null;
1517
+
1518
+ /**
1519
+ * ID of the Youtube video.
1520
+ */
1521
+ youtubeVideoId?: string | null;
1522
+ }
1523
+
1524
+ export namespace Metadata {
1525
+ export interface Collection {
1526
+ /**
1527
+ * Blockchain address of the collection.
1528
+ */
1529
+ address?: string;
1530
+
1531
+ /**
1532
+ * Multiplier applied to the rewards for this collection.
1533
+ */
1534
+ multiplier?: number;
1535
+
1536
+ /**
1537
+ * Blockchain network of the collection.
1538
+ */
1539
+ network?:
1540
+ | 'abstract'
1541
+ | 'abstractTestnet'
1542
+ | 'apechain'
1543
+ | 'arbitrum'
1544
+ | 'avalanche'
1545
+ | 'avalancheFuji'
1546
+ | 'base'
1547
+ | 'baseSepolia'
1548
+ | 'berachain'
1549
+ | 'berachainArtio'
1550
+ | 'berachainBepolia'
1551
+ | 'binance'
1552
+ | 'bscTestnet'
1553
+ | 'campTestnet'
1554
+ | 'fantom'
1555
+ | 'fantomTestnet'
1556
+ | 'flowMainnet'
1557
+ | 'mainnet'
1558
+ | 'optimism'
1559
+ | 'polygon'
1560
+ | 'polygon_mumbai'
1561
+ | 'skaleNebula'
1562
+ | 'solana'
1563
+ | 'sophon'
1564
+ | 'sophonTestnet'
1565
+ | 'sui'
1566
+ | 'superseed'
1567
+ | 'superseedSepolia'
1568
+ | 'vanar'
1569
+ | 'xai'
1570
+ | 'zksync'
1571
+ | 'coti'
1572
+ | 'cotiTestnet'
1573
+ | 'morph'
1574
+ | 'morphTestnet'
1575
+ | 'morphHolesky'
1576
+ | 'ultra'
1577
+ | 'ultraTestnet'
1578
+ | 'nitrograph'
1579
+ | 'sepolia'
1580
+ | 'optimism_sepolia'
1581
+ | 'arbitrumSepolia'
1582
+ | 'goerli'
1583
+ | 'optimism_goerli'
1584
+ | 'arbitrumGoerli'
1585
+ | 'basecamp';
1586
+ }
1587
+
1588
+ /**
1589
+ * Object containing details for the call-to-action.
1590
+ */
1591
+ export interface Cta {
1592
+ /**
1593
+ * Link for the call-to-action.
1594
+ */
1595
+ href?: string | null;
1596
+
1597
+ /**
1598
+ * Label for the call-to-action.
1599
+ */
1600
+ label?: string | null;
1601
+ }
1602
+
1603
+ export interface DiscordServersToJoin {
1604
+ /**
1605
+ * ID of the Discord server to join.
1606
+ */
1607
+ id?: string;
1608
+
1609
+ /**
1610
+ * Array of Discord channels to join.
1611
+ */
1612
+ channels?: Array<DiscordServersToJoin.Channel>;
1613
+
1614
+ /**
1615
+ * Array of roles to assign in the Discord server.
1616
+ */
1617
+ roles?: Array<DiscordServersToJoin.Role>;
1618
+ }
1619
+
1620
+ export namespace DiscordServersToJoin {
1621
+ export interface Channel {
1622
+ /**
1623
+ * ID of the Discord channel.
1624
+ */
1625
+ id?: string;
1626
+
1627
+ /**
1628
+ * Array of emojis used in the channel.
1629
+ */
1630
+ emojis?: Array<Channel.Emoji>;
1631
+
1632
+ /**
1633
+ * Phrase of text to be present in the discord message
1634
+ */
1635
+ text?: string;
1636
+ }
1637
+
1638
+ export namespace Channel {
1639
+ export interface Emoji {
1640
+ /**
1641
+ * ID of the emoji used in the channel.
1642
+ */
1643
+ id?: string;
1644
+ }
1645
+ }
1646
+
1647
+ export interface Role {
1648
+ /**
1649
+ * ID of the role in the Discord server.
1650
+ */
1651
+ id: string;
1652
+ }
1653
+ }
1654
+
1655
+ export interface DripQuestsToComplete {
1656
+ /**
1657
+ * ID of the drip quest to complete.
1658
+ */
1659
+ id: string;
1660
+ }
1661
+
1662
+ /**
1663
+ * Liquidity pool details.
1664
+ */
1665
+ export interface Liquidity {
1666
+ /**
1667
+ * Calculation type of the liquidity pool.
1668
+ */
1669
+ calculationType?: 'fixed' | 'custom';
1670
+
1671
+ /**
1672
+ * Custom function to calculate the the reward amount based on the liquidity
1673
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
1674
+ * USD.
1675
+ */
1676
+ customFunction?: string;
1677
+
1678
+ /**
1679
+ * Liquidity provided per day in USD
1680
+ */
1681
+ liquidityPerDay?: number;
1682
+
1683
+ /**
1684
+ * Blockchain network of the liquidity pool.
1685
+ */
1686
+ network?:
1687
+ | 'abstract'
1688
+ | 'abstractTestnet'
1689
+ | 'apechain'
1690
+ | 'arbitrum'
1691
+ | 'avalanche'
1692
+ | 'avalancheFuji'
1693
+ | 'base'
1694
+ | 'baseSepolia'
1695
+ | 'berachain'
1696
+ | 'berachainArtio'
1697
+ | 'berachainBepolia'
1698
+ | 'binance'
1699
+ | 'bscTestnet'
1700
+ | 'campTestnet'
1701
+ | 'fantom'
1702
+ | 'fantomTestnet'
1703
+ | 'flowMainnet'
1704
+ | 'mainnet'
1705
+ | 'optimism'
1706
+ | 'polygon'
1707
+ | 'polygon_mumbai'
1708
+ | 'skaleNebula'
1709
+ | 'solana'
1710
+ | 'sophon'
1711
+ | 'sophonTestnet'
1712
+ | 'sui'
1713
+ | 'superseed'
1714
+ | 'superseedSepolia'
1715
+ | 'vanar'
1716
+ | 'xai'
1717
+ | 'zksync'
1718
+ | 'coti'
1719
+ | 'cotiTestnet'
1720
+ | 'morph'
1721
+ | 'morphTestnet'
1722
+ | 'morphHolesky'
1723
+ | 'ultra'
1724
+ | 'ultraTestnet'
1725
+ | 'nitrograph'
1726
+ | 'sepolia'
1727
+ | 'optimism_sepolia'
1728
+ | 'arbitrumSepolia'
1729
+ | 'goerli'
1730
+ | 'optimism_goerli'
1731
+ | 'arbitrumGoerli'
1732
+ | 'basecamp';
1733
+
1734
+ /**
1735
+ * Indicates if only in-range liquidity is rewarded.
1736
+ */
1737
+ onlyRewardInRangeLiquidity?: boolean;
1738
+
1739
+ /**
1740
+ * Array of liquidity pools associated with the rule.
1741
+ */
1742
+ pools?: Array<Liquidity.Pool>;
1743
+
1744
+ /**
1745
+ * Protocol of the liquidity pool.
1746
+ */
1747
+ protocol?: string;
1748
+ }
1749
+
1750
+ export namespace Liquidity {
1751
+ export interface Pool {
1752
+ /**
1753
+ * Unique identifier of the liquidity pool.
1754
+ */
1755
+ id: string;
1756
+ }
1757
+ }
1758
+
1759
+ export interface Range {
1760
+ /**
1761
+ * Reward amount for this range.
1762
+ */
1763
+ amount: number;
1764
+
1765
+ /**
1766
+ * End value of the range.
1767
+ */
1768
+ endRange: number;
1769
+
1770
+ /**
1771
+ * Start value of the range.
1772
+ */
1773
+ startRange: number;
1774
+
1775
+ /**
1776
+ * ID of the loyalty badge for this range.
1777
+ */
1778
+ loyaltyBadgeId?: string;
1779
+
1780
+ /**
1781
+ * Amount of the loyalty multiplier for this range.
1782
+ */
1783
+ loyaltyMultiplierAmount?: number;
1784
+ }
1785
+
1786
+ /**
1787
+ * Object defining referral requirements.
1788
+ */
1789
+ export interface ReferralRequirements {
1790
+ /**
1791
+ * Flag indicating if achieving points is required.
1792
+ */
1793
+ achievePoints?: boolean | null;
1794
+
1795
+ /**
1796
+ * Flag indicating if completing the profile is required.
1797
+ */
1798
+ completeProfile?: boolean | null;
1799
+
1800
+ /**
1801
+ * Flag indicating if connecting Discord is required.
1802
+ */
1803
+ connectDiscord?: boolean | null;
1804
+
1805
+ /**
1806
+ * Flag indicating if connecting email is required.
1807
+ */
1808
+ connectEmail?: boolean | null;
1809
+
1810
+ /**
1811
+ * Flag indicating if connecting Twitter is required.
1812
+ */
1813
+ connectTwitter?: boolean | null;
1814
+
1815
+ points?: ReferralRequirements.Points | null;
1816
+ }
1817
+
1818
+ export namespace ReferralRequirements {
1819
+ export interface Points {
1820
+ /**
1821
+ * Points required for referral.
1822
+ */
1823
+ amount?: number | null;
1824
+
1825
+ /**
1826
+ * ID of the loyalty currency for referral.
1827
+ */
1828
+ loyaltyCurrecyId?: string | null;
1829
+ }
1830
+ }
1831
+
1832
+ /**
1833
+ * Object containing details of the associated smart contract.
1834
+ */
1835
+ export interface SmartContract {
1836
+ /**
1837
+ * Mapping of addresses for the smart contract.
1838
+ */
1839
+ addressMapping?: string | null;
1840
+
1841
+ /**
1842
+ * Object containing details of the amount multiplier from the event.
1843
+ */
1844
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
1845
+
1846
+ /**
1847
+ * ID of the smart contract.
1848
+ */
1849
+ contractId?: string | null;
1850
+
1851
+ /**
1852
+ * Criteria to evaluate the smart contract event.
1853
+ */
1854
+ criteria?: 'everyEvent' | 'byParameter' | null;
1855
+
1856
+ /**
1857
+ * Event emitted by the smart contract.
1858
+ */
1859
+ event?: string | null;
1860
+
1861
+ /**
1862
+ * Array of parameters for the smart contract.
1863
+ */
1864
+ params?: Array<SmartContract.Param> | null;
1865
+
1866
+ /**
1867
+ * Type of the smart contract interaction.
1868
+ */
1869
+ type?: 'function' | 'event' | null;
1870
+ }
1871
+
1872
+ export namespace SmartContract {
1873
+ /**
1874
+ * Object containing details of the amount multiplier from the event.
1875
+ */
1876
+ export interface AmountMultiplier {
1877
+ /**
1878
+ * Mapping of the value for the smart contract.
1879
+ */
1880
+ valueMapping?: string | null;
1881
+ }
1882
+
1883
+ export interface Param {
1884
+ /**
1885
+ * Condition to check for the parameter.
1886
+ */
1887
+ condition?: string | null;
1888
+
1889
+ /**
1890
+ * Name of the smart contract parameter.
1891
+ */
1892
+ name?: string | null;
1893
+
1894
+ /**
1895
+ * Value of the parameter.
1896
+ */
1897
+ value?: string | null;
1898
+ }
1899
+ }
1900
+
1901
+ export interface SnapshotProposal {
1902
+ /**
1903
+ * ID of the snapshot proposal.
1904
+ */
1905
+ id: string;
1906
+
1907
+ /**
1908
+ * Space associated with the snapshot proposal.
1909
+ */
1910
+ space: string;
1911
+ }
1912
+
1913
+ export interface StreakArray {
1914
+ /**
1915
+ * Reward amount for achieving the streak milestone.
1916
+ */
1917
+ streakAmount: number;
1918
+
1919
+ /**
1920
+ * Milestone required to achieve the streak.
1921
+ */
1922
+ streakMilestone: number;
1923
+ }
1924
+
1925
+ /**
1926
+ * Metadata for swap loyalty rules
1927
+ */
1928
+ export interface Swap {
1929
+ provider?: 'any' | 'relay' | 'lifi';
1930
+
1931
+ relayReferrerId?: string;
1932
+
1933
+ requireCrossChainSwap?: boolean;
1934
+
1935
+ swappedToChain?: 'any' | number | string;
1936
+
1937
+ swappedToTokens?: Array<Swap.SwappedToToken>;
1938
+
1939
+ tokenMode?: 'any' | 'specific';
1940
+
1941
+ trackTokenAmount?: boolean;
1942
+ }
1943
+
1944
+ export namespace Swap {
1945
+ export interface SwappedToToken {
1946
+ address: string;
1947
+
1948
+ chainId: string;
1949
+ }
1950
+ }
1951
+ }
207
1952
  }
208
1953
  }
209
1954
  }
@@ -285,16 +2030,41 @@ export namespace RuleEditRestoreResponse {
285
2030
  */
286
2031
  deletedAt: string | null;
287
2032
 
2033
+ /**
2034
+ * Description of the loyalty rule
2035
+ */
2036
+ description: string;
2037
+
2038
+ /**
2039
+ * End time of the loyalty rule
2040
+ */
2041
+ endTime: string;
2042
+
288
2043
  /**
289
2044
  * Frequency of the loyalty rule
290
2045
  */
291
2046
  frequency: string;
292
2047
 
2048
+ /**
2049
+ * Name of the loyalty rule
2050
+ */
2051
+ name: string;
2052
+
293
2053
  /**
294
2054
  * Unique identifier for the organization
295
2055
  */
296
2056
  organizationId: string;
297
2057
 
2058
+ /**
2059
+ * Type of the reward
2060
+ */
2061
+ rewardType: 'points' | 'multiplier' | 'badge';
2062
+
2063
+ /**
2064
+ * Start time of the loyalty rule
2065
+ */
2066
+ startTime: string;
2067
+
298
2068
  /**
299
2069
  * Type of the loyalty rule
300
2070
  */
@@ -316,73 +2086,1782 @@ export namespace RuleEditRestoreResponse {
316
2086
  collectionAddress?: string;
317
2087
 
318
2088
  /**
319
- * Optional metadata for the loyalty rule
2089
+ * URL of the media associated with the loyalty rule
320
2090
  */
321
- metadata?: Record<string, unknown>;
322
- }
2091
+ mediaUrl?: string | null;
323
2092
 
324
- /**
325
- * Previous data of the rule before the edit
326
- */
327
- export interface PreviousData {
328
2093
  /**
329
- * Unique identifier for the loyalty rule
2094
+ * Optional metadata for the loyalty rule
330
2095
  */
331
- id: string;
2096
+ metadata?: { [key: string]: Data.Metadata };
2097
+ }
332
2098
 
333
- /**
334
- * Amount associated with the loyalty rule
335
- */
336
- amount: number;
2099
+ export namespace Data {
2100
+ export interface Metadata {
2101
+ /**
2102
+ * Number of tokens per batch.
2103
+ */
2104
+ batchSize?: number | null;
337
2105
 
338
- /**
339
- * Timestamp when the loyalty rule was created
340
- */
341
- createdAt: string;
2106
+ /**
2107
+ * Text displayed on the action button.
2108
+ */
2109
+ buttonText?: string | null;
342
2110
 
343
- /**
344
- * Timestamp when the loyalty rule was deleted (if applicable)
345
- */
346
- deletedAt: string | null;
2111
+ /**
2112
+ * Flag indicating if commenting is required.
2113
+ */
2114
+ checkComment?: boolean | null;
347
2115
 
348
- /**
349
- * Frequency of the loyalty rule
350
- */
351
- frequency: string;
2116
+ /**
2117
+ * Flag indicating if liking the post is required.
2118
+ */
2119
+ checkLike?: boolean | null;
352
2120
 
353
- /**
354
- * Unique identifier for the organization
355
- */
356
- organizationId: string;
2121
+ /**
2122
+ * Flag indicating if reposting is required.
2123
+ */
2124
+ checkRepost?: boolean | null;
357
2125
 
358
- /**
359
- * Type of the loyalty rule
360
- */
361
- type: string;
2126
+ /**
2127
+ * Text to check in the Twitter post, username, or bio.
2128
+ */
2129
+ checkText?: string | null;
362
2130
 
363
- /**
364
- * Timestamp when the loyalty rule was last updated
365
- */
366
- updatedAt: string;
2131
+ /**
2132
+ * Array of collections associated with the rule.
2133
+ */
2134
+ collection?: Array<Metadata.Collection>;
367
2135
 
368
- /**
369
- * Unique identifier for the website
370
- */
371
- websiteId: string;
2136
+ /**
2137
+ * Conditions for completing the profile.
2138
+ */
2139
+ completeProfileConditions?: { [key: string]: boolean } | null;
372
2140
 
373
- /**
374
- * Optional address of the collection
375
- */
376
- collectionAddress?: string;
2141
+ /**
2142
+ * Object containing details for the call-to-action.
2143
+ */
2144
+ cta?: Metadata.Cta | null;
377
2145
 
378
- /**
379
- * Optional metadata for the loyalty rule
380
- */
381
- metadata?: Record<string, unknown>;
2146
+ /**
2147
+ * API key for custom rewards integration.
2148
+ */
2149
+ customRewardsApiKey?: string;
2150
+
2151
+ /**
2152
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
2153
+ */
2154
+ directRpc?: boolean;
2155
+
2156
+ /**
2157
+ * Array of Discord servers, channels, and roles to join.
2158
+ */
2159
+ discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
2160
+
2161
+ /**
2162
+ * Array of drip quests required to complete the rule.
2163
+ */
2164
+ dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
2165
+
2166
+ /**
2167
+ * Flag indicating whether joining Discord servers is required.
2168
+ */
2169
+ enableJoinDiscordServers?: boolean | null;
2170
+
2171
+ /**
2172
+ * Flag indicating whether streaks are enabled.
2173
+ */
2174
+ enableStreaks?: boolean | null;
2175
+
2176
+ /**
2177
+ * Flag indicating whether the verified multiplier is enabled.
2178
+ */
2179
+ enableVerifiedMultiplier?: boolean;
2180
+
2181
+ /**
2182
+ * Fill source of the order for the token sale
2183
+ */
2184
+ fillSource?: string;
2185
+
2186
+ /**
2187
+ * Percentage reward given to a user for their first referral.
2188
+ */
2189
+ firstReferralReward?: number | null;
2190
+
2191
+ /**
2192
+ * Flag indicating whether the fill source is included.
2193
+ */
2194
+ hasFillSource?: boolean;
2195
+
2196
+ /**
2197
+ * Indicates if the item has never been sold.
2198
+ */
2199
+ hasNeverSold?: boolean;
2200
+
2201
+ /**
2202
+ * Indicates if the full royalty has been paid for items.
2203
+ */
2204
+ hasPaidFullRoyalty?: boolean;
2205
+
2206
+ /**
2207
+ * Flag indicating if the sale currency is included.
2208
+ */
2209
+ hasSaleCurrency?: boolean;
2210
+
2211
+ /**
2212
+ * Indicates if the user has a verified Twitter account.
2213
+ */
2214
+ hasVerifiedTwitter?: boolean;
2215
+
2216
+ /**
2217
+ * URL of the image associated with the rule.
2218
+ */
2219
+ imageUrl?: string | null;
2220
+
2221
+ /**
2222
+ * If enabled, the first transaction done on the platform will complete this rule
2223
+ */
2224
+ isCheckInOnEveryTxn?: boolean;
2225
+
2226
+ /**
2227
+ * Indicates if the multiplier has been applied to rewards.
2228
+ */
2229
+ isMultiplierApplied?: boolean;
2230
+
2231
+ /**
2232
+ * Flag indicating if the rule is restricted to new users.
2233
+ */
2234
+ isRestrictedToNewUsers?: boolean;
2235
+
2236
+ /**
2237
+ * Flag indicating if rewards are applied retroactively.
2238
+ */
2239
+ isRetroactive?: boolean | null;
2240
+
2241
+ /**
2242
+ * Flag indicating if the token hold multiplier is applied.
2243
+ */
2244
+ isTokenHoldMultiplier?: boolean;
2245
+
2246
+ /**
2247
+ * Optional link associated with the metadata.
2248
+ */
2249
+ link?: string | null;
2250
+
2251
+ /**
2252
+ * Liquidity pool details.
2253
+ */
2254
+ liquidity?: Metadata.Liquidity;
2255
+
2256
+ /**
2257
+ * Maximum quantity constraint for token holding.
2258
+ */
2259
+ maxQty?: number | null;
2260
+
2261
+ /**
2262
+ * Minimum quantity constraint for token holding.
2263
+ */
2264
+ minQty?: number | null;
2265
+
2266
+ /**
2267
+ * Array of loyalty currency IDs used for multipliers.
2268
+ */
2269
+ multiplierLoyaltyCurrencyIds?: Array<string> | null;
2270
+
2271
+ /**
2272
+ * Flag indicating whether to include only known users.
2273
+ */
2274
+ onlyKnownUsers?: boolean;
2275
+
2276
+ /**
2277
+ * Flag indicating whether to include only native tokens.
2278
+ */
2279
+ onlyNative?: boolean;
2280
+
2281
+ /**
2282
+ * Flag indicating whether to include only non-listed items.
2283
+ */
2284
+ onlyNonListed?: boolean;
2285
+
2286
+ /**
2287
+ * Indicates if only existing users are rewarded.
2288
+ */
2289
+ onlyRewardExistingUser?: boolean;
2290
+
2291
+ /**
2292
+ * give points for only one token ownership per contract
2293
+ */
2294
+ onlyRewardSingleTokenOwnership?: boolean | null;
2295
+
2296
+ /**
2297
+ * Promotional code associated with the rule.
2298
+ */
2299
+ promoCode?: string;
2300
+
2301
+ /**
2302
+ * URL of the CSV file containing promo codes.
2303
+ */
2304
+ promoCodeCsvUrl?: string;
2305
+
2306
+ /**
2307
+ * Numbers of the promotional code to be generated.
2308
+ */
2309
+ promoCodeLength?: number | null;
2310
+
2311
+ /**
2312
+ * Type of the promotional code.
2313
+ */
2314
+ promoCodeType?: 'code' | 'csv' | 'generate';
2315
+
2316
+ /**
2317
+ * Array defining ranges and corresponding rewards.
2318
+ */
2319
+ range?: Array<Metadata.Range>;
2320
+
2321
+ /**
2322
+ * Object defining referral requirements.
2323
+ */
2324
+ referralRequirements?: Metadata.ReferralRequirements | null;
2325
+
2326
+ /**
2327
+ * Lump sum reward given to a referrer.
2328
+ */
2329
+ referrerReward?: number | null;
2330
+
2331
+ /**
2332
+ * Loyalty currency ID of the referrer reward.
2333
+ */
2334
+ referrerRewardLoyaltyCurrencyId?: string | null;
2335
+
2336
+ /**
2337
+ * Flag indicating if the post link is required.
2338
+ */
2339
+ requirePostLink?: boolean | null;
2340
+
2341
+ /**
2342
+ * Flag indicating if the rule can also reward badges per range.
2343
+ */
2344
+ rewardBadgePerRange?: boolean;
2345
+
2346
+ /**
2347
+ * Flag indicating if the reward is rewarded by batch.
2348
+ */
2349
+ rewardByBatch?: boolean | null;
2350
+
2351
+ /**
2352
+ * Flag indicating if rewards are given per impression.
2353
+ */
2354
+ rewardPerImpression?: boolean | null;
2355
+
2356
+ /**
2357
+ * Flag indicating if the rule should reward based on value of traded tokens
2358
+ * instead of count.
2359
+ */
2360
+ rewardPerValue?: boolean;
2361
+
2362
+ /**
2363
+ * Currency associated with sales.
2364
+ */
2365
+ saleCurrency?: string;
2366
+
2367
+ /**
2368
+ * Percentage reward given for a second-level referral.
2369
+ */
2370
+ secondReferralReward?: number | null;
2371
+
2372
+ /**
2373
+ * Flag indicating if the multiplier is skipped.
2374
+ */
2375
+ skipMultiplier?: boolean | null;
2376
+
2377
+ /**
2378
+ * Object containing details of the associated smart contract.
2379
+ */
2380
+ smartContract?: Metadata.SmartContract;
2381
+
2382
+ /**
2383
+ * Array of snapshot proposals for the rule.
2384
+ */
2385
+ snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
2386
+
2387
+ /**
2388
+ * Social media platform associated with the rule.
2389
+ */
2390
+ socialPlatform?:
2391
+ | 'Custom'
2392
+ | 'Discord'
2393
+ | 'EpicGames'
2394
+ | 'Instagram'
2395
+ | 'Steam'
2396
+ | 'Telegram'
2397
+ | 'TikTok'
2398
+ | 'Twitch'
2399
+ | 'X(Twitter)'
2400
+ | 'YouTube'
2401
+ | 'Google'
2402
+ | null;
2403
+
2404
+ /**
2405
+ * URL of the social platform's logo.
2406
+ */
2407
+ socialPlatformLogo?: string | null;
2408
+
2409
+ /**
2410
+ * Name of the social platform.
2411
+ */
2412
+ socialPlatformName?: string | null;
2413
+
2414
+ /**
2415
+ * ID of the Steam app.
2416
+ */
2417
+ steamAppId?: string | null;
2418
+
2419
+ /**
2420
+ * Array of streak milestones and corresponding rewards.
2421
+ */
2422
+ streakArray?: Array<Metadata.StreakArray> | null;
2423
+
2424
+ /**
2425
+ * Metadata for swap loyalty rules
2426
+ */
2427
+ swap?: Metadata.Swap;
2428
+
2429
+ /**
2430
+ * ID of the Telegram channel.
2431
+ */
2432
+ telegramChannelId?: string | null;
2433
+
2434
+ /**
2435
+ * Time delay in seconds to verify actions.
2436
+ */
2437
+ timeDelayToVerifySeconds?: string | number | null;
2438
+
2439
+ /**
2440
+ * Flag indicating if all contracts are tracked.
2441
+ */
2442
+ trackAllContracts?: boolean | null;
2443
+
2444
+ /**
2445
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
2446
+ * completed once the progress is 100%.
2447
+ */
2448
+ trackProgress?: boolean | null;
2449
+
2450
+ /**
2451
+ * URL of the associated Twitter account.
2452
+ */
2453
+ twitterAccountUrl?: string;
2454
+
2455
+ /**
2456
+ * Hashtag associated with the Twitter post.
2457
+ */
2458
+ twitterHashtag?: string;
2459
+
2460
+ /**
2461
+ * URL of the associated Twitter post.
2462
+ */
2463
+ twitterPostUrl?: string;
2464
+
2465
+ /**
2466
+ * Unique identifier of the Twitter user.
2467
+ */
2468
+ twitterUserId?: string;
2469
+
2470
+ /**
2471
+ * Twitter username of the user.
2472
+ */
2473
+ twitterUsername?: string;
2474
+
2475
+ /**
2476
+ * Minimum length of the verification text.
2477
+ */
2478
+ verificationTextMinimumLength?: number | null;
2479
+
2480
+ /**
2481
+ * Multiplier applied to rewards for verified users.
2482
+ */
2483
+ verifiedMultiplier?: number | null;
2484
+
2485
+ /**
2486
+ * Placeholder text for verification input fields.
2487
+ */
2488
+ verifyPlaceHolderText?: string | null;
2489
+
2490
+ /**
2491
+ * Type of wallet associated with the rule.
2492
+ */
2493
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
2494
+
2495
+ /**
2496
+ * ID of the Youtube channel.
2497
+ */
2498
+ youtubeChannelId?: string | null;
2499
+
2500
+ /**
2501
+ * ID of the Youtube video.
2502
+ */
2503
+ youtubeVideoId?: string | null;
2504
+ }
2505
+
2506
+ export namespace Metadata {
2507
+ export interface Collection {
2508
+ /**
2509
+ * Blockchain address of the collection.
2510
+ */
2511
+ address?: string;
2512
+
2513
+ /**
2514
+ * Multiplier applied to the rewards for this collection.
2515
+ */
2516
+ multiplier?: number;
2517
+
2518
+ /**
2519
+ * Blockchain network of the collection.
2520
+ */
2521
+ network?:
2522
+ | 'abstract'
2523
+ | 'abstractTestnet'
2524
+ | 'apechain'
2525
+ | 'arbitrum'
2526
+ | 'avalanche'
2527
+ | 'avalancheFuji'
2528
+ | 'base'
2529
+ | 'baseSepolia'
2530
+ | 'berachain'
2531
+ | 'berachainArtio'
2532
+ | 'berachainBepolia'
2533
+ | 'binance'
2534
+ | 'bscTestnet'
2535
+ | 'campTestnet'
2536
+ | 'fantom'
2537
+ | 'fantomTestnet'
2538
+ | 'flowMainnet'
2539
+ | 'mainnet'
2540
+ | 'optimism'
2541
+ | 'polygon'
2542
+ | 'polygon_mumbai'
2543
+ | 'skaleNebula'
2544
+ | 'solana'
2545
+ | 'sophon'
2546
+ | 'sophonTestnet'
2547
+ | 'sui'
2548
+ | 'superseed'
2549
+ | 'superseedSepolia'
2550
+ | 'vanar'
2551
+ | 'xai'
2552
+ | 'zksync'
2553
+ | 'coti'
2554
+ | 'cotiTestnet'
2555
+ | 'morph'
2556
+ | 'morphTestnet'
2557
+ | 'morphHolesky'
2558
+ | 'ultra'
2559
+ | 'ultraTestnet'
2560
+ | 'nitrograph'
2561
+ | 'sepolia'
2562
+ | 'optimism_sepolia'
2563
+ | 'arbitrumSepolia'
2564
+ | 'goerli'
2565
+ | 'optimism_goerli'
2566
+ | 'arbitrumGoerli'
2567
+ | 'basecamp';
2568
+ }
2569
+
2570
+ /**
2571
+ * Object containing details for the call-to-action.
2572
+ */
2573
+ export interface Cta {
2574
+ /**
2575
+ * Link for the call-to-action.
2576
+ */
2577
+ href?: string | null;
2578
+
2579
+ /**
2580
+ * Label for the call-to-action.
2581
+ */
2582
+ label?: string | null;
2583
+ }
2584
+
2585
+ export interface DiscordServersToJoin {
2586
+ /**
2587
+ * ID of the Discord server to join.
2588
+ */
2589
+ id?: string;
2590
+
2591
+ /**
2592
+ * Array of Discord channels to join.
2593
+ */
2594
+ channels?: Array<DiscordServersToJoin.Channel>;
2595
+
2596
+ /**
2597
+ * Array of roles to assign in the Discord server.
2598
+ */
2599
+ roles?: Array<DiscordServersToJoin.Role>;
2600
+ }
2601
+
2602
+ export namespace DiscordServersToJoin {
2603
+ export interface Channel {
2604
+ /**
2605
+ * ID of the Discord channel.
2606
+ */
2607
+ id?: string;
2608
+
2609
+ /**
2610
+ * Array of emojis used in the channel.
2611
+ */
2612
+ emojis?: Array<Channel.Emoji>;
2613
+
2614
+ /**
2615
+ * Phrase of text to be present in the discord message
2616
+ */
2617
+ text?: string;
2618
+ }
2619
+
2620
+ export namespace Channel {
2621
+ export interface Emoji {
2622
+ /**
2623
+ * ID of the emoji used in the channel.
2624
+ */
2625
+ id?: string;
2626
+ }
2627
+ }
2628
+
2629
+ export interface Role {
2630
+ /**
2631
+ * ID of the role in the Discord server.
2632
+ */
2633
+ id: string;
2634
+ }
2635
+ }
2636
+
2637
+ export interface DripQuestsToComplete {
2638
+ /**
2639
+ * ID of the drip quest to complete.
2640
+ */
2641
+ id: string;
2642
+ }
2643
+
2644
+ /**
2645
+ * Liquidity pool details.
2646
+ */
2647
+ export interface Liquidity {
2648
+ /**
2649
+ * Calculation type of the liquidity pool.
2650
+ */
2651
+ calculationType?: 'fixed' | 'custom';
2652
+
2653
+ /**
2654
+ * Custom function to calculate the the reward amount based on the liquidity
2655
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
2656
+ * USD.
2657
+ */
2658
+ customFunction?: string;
2659
+
2660
+ /**
2661
+ * Liquidity provided per day in USD
2662
+ */
2663
+ liquidityPerDay?: number;
2664
+
2665
+ /**
2666
+ * Blockchain network of the liquidity pool.
2667
+ */
2668
+ network?:
2669
+ | 'abstract'
2670
+ | 'abstractTestnet'
2671
+ | 'apechain'
2672
+ | 'arbitrum'
2673
+ | 'avalanche'
2674
+ | 'avalancheFuji'
2675
+ | 'base'
2676
+ | 'baseSepolia'
2677
+ | 'berachain'
2678
+ | 'berachainArtio'
2679
+ | 'berachainBepolia'
2680
+ | 'binance'
2681
+ | 'bscTestnet'
2682
+ | 'campTestnet'
2683
+ | 'fantom'
2684
+ | 'fantomTestnet'
2685
+ | 'flowMainnet'
2686
+ | 'mainnet'
2687
+ | 'optimism'
2688
+ | 'polygon'
2689
+ | 'polygon_mumbai'
2690
+ | 'skaleNebula'
2691
+ | 'solana'
2692
+ | 'sophon'
2693
+ | 'sophonTestnet'
2694
+ | 'sui'
2695
+ | 'superseed'
2696
+ | 'superseedSepolia'
2697
+ | 'vanar'
2698
+ | 'xai'
2699
+ | 'zksync'
2700
+ | 'coti'
2701
+ | 'cotiTestnet'
2702
+ | 'morph'
2703
+ | 'morphTestnet'
2704
+ | 'morphHolesky'
2705
+ | 'ultra'
2706
+ | 'ultraTestnet'
2707
+ | 'nitrograph'
2708
+ | 'sepolia'
2709
+ | 'optimism_sepolia'
2710
+ | 'arbitrumSepolia'
2711
+ | 'goerli'
2712
+ | 'optimism_goerli'
2713
+ | 'arbitrumGoerli'
2714
+ | 'basecamp';
2715
+
2716
+ /**
2717
+ * Indicates if only in-range liquidity is rewarded.
2718
+ */
2719
+ onlyRewardInRangeLiquidity?: boolean;
2720
+
2721
+ /**
2722
+ * Array of liquidity pools associated with the rule.
2723
+ */
2724
+ pools?: Array<Liquidity.Pool>;
2725
+
2726
+ /**
2727
+ * Protocol of the liquidity pool.
2728
+ */
2729
+ protocol?: string;
2730
+ }
2731
+
2732
+ export namespace Liquidity {
2733
+ export interface Pool {
2734
+ /**
2735
+ * Unique identifier of the liquidity pool.
2736
+ */
2737
+ id: string;
2738
+ }
2739
+ }
2740
+
2741
+ export interface Range {
2742
+ /**
2743
+ * Reward amount for this range.
2744
+ */
2745
+ amount: number;
2746
+
2747
+ /**
2748
+ * End value of the range.
2749
+ */
2750
+ endRange: number;
2751
+
2752
+ /**
2753
+ * Start value of the range.
2754
+ */
2755
+ startRange: number;
2756
+
2757
+ /**
2758
+ * ID of the loyalty badge for this range.
2759
+ */
2760
+ loyaltyBadgeId?: string;
2761
+
2762
+ /**
2763
+ * Amount of the loyalty multiplier for this range.
2764
+ */
2765
+ loyaltyMultiplierAmount?: number;
2766
+ }
2767
+
2768
+ /**
2769
+ * Object defining referral requirements.
2770
+ */
2771
+ export interface ReferralRequirements {
2772
+ /**
2773
+ * Flag indicating if achieving points is required.
2774
+ */
2775
+ achievePoints?: boolean | null;
2776
+
2777
+ /**
2778
+ * Flag indicating if completing the profile is required.
2779
+ */
2780
+ completeProfile?: boolean | null;
2781
+
2782
+ /**
2783
+ * Flag indicating if connecting Discord is required.
2784
+ */
2785
+ connectDiscord?: boolean | null;
2786
+
2787
+ /**
2788
+ * Flag indicating if connecting email is required.
2789
+ */
2790
+ connectEmail?: boolean | null;
2791
+
2792
+ /**
2793
+ * Flag indicating if connecting Twitter is required.
2794
+ */
2795
+ connectTwitter?: boolean | null;
2796
+
2797
+ points?: ReferralRequirements.Points | null;
2798
+ }
2799
+
2800
+ export namespace ReferralRequirements {
2801
+ export interface Points {
2802
+ /**
2803
+ * Points required for referral.
2804
+ */
2805
+ amount?: number | null;
2806
+
2807
+ /**
2808
+ * ID of the loyalty currency for referral.
2809
+ */
2810
+ loyaltyCurrecyId?: string | null;
2811
+ }
2812
+ }
2813
+
2814
+ /**
2815
+ * Object containing details of the associated smart contract.
2816
+ */
2817
+ export interface SmartContract {
2818
+ /**
2819
+ * Mapping of addresses for the smart contract.
2820
+ */
2821
+ addressMapping?: string | null;
2822
+
2823
+ /**
2824
+ * Object containing details of the amount multiplier from the event.
2825
+ */
2826
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
2827
+
2828
+ /**
2829
+ * ID of the smart contract.
2830
+ */
2831
+ contractId?: string | null;
2832
+
2833
+ /**
2834
+ * Criteria to evaluate the smart contract event.
2835
+ */
2836
+ criteria?: 'everyEvent' | 'byParameter' | null;
2837
+
2838
+ /**
2839
+ * Event emitted by the smart contract.
2840
+ */
2841
+ event?: string | null;
2842
+
2843
+ /**
2844
+ * Array of parameters for the smart contract.
2845
+ */
2846
+ params?: Array<SmartContract.Param> | null;
2847
+
2848
+ /**
2849
+ * Type of the smart contract interaction.
2850
+ */
2851
+ type?: 'function' | 'event' | null;
2852
+ }
2853
+
2854
+ export namespace SmartContract {
2855
+ /**
2856
+ * Object containing details of the amount multiplier from the event.
2857
+ */
2858
+ export interface AmountMultiplier {
2859
+ /**
2860
+ * Mapping of the value for the smart contract.
2861
+ */
2862
+ valueMapping?: string | null;
2863
+ }
2864
+
2865
+ export interface Param {
2866
+ /**
2867
+ * Condition to check for the parameter.
2868
+ */
2869
+ condition?: string | null;
2870
+
2871
+ /**
2872
+ * Name of the smart contract parameter.
2873
+ */
2874
+ name?: string | null;
2875
+
2876
+ /**
2877
+ * Value of the parameter.
2878
+ */
2879
+ value?: string | null;
2880
+ }
2881
+ }
2882
+
2883
+ export interface SnapshotProposal {
2884
+ /**
2885
+ * ID of the snapshot proposal.
2886
+ */
2887
+ id: string;
2888
+
2889
+ /**
2890
+ * Space associated with the snapshot proposal.
2891
+ */
2892
+ space: string;
2893
+ }
2894
+
2895
+ export interface StreakArray {
2896
+ /**
2897
+ * Reward amount for achieving the streak milestone.
2898
+ */
2899
+ streakAmount: number;
2900
+
2901
+ /**
2902
+ * Milestone required to achieve the streak.
2903
+ */
2904
+ streakMilestone: number;
2905
+ }
2906
+
2907
+ /**
2908
+ * Metadata for swap loyalty rules
2909
+ */
2910
+ export interface Swap {
2911
+ provider?: 'any' | 'relay' | 'lifi';
2912
+
2913
+ relayReferrerId?: string;
2914
+
2915
+ requireCrossChainSwap?: boolean;
2916
+
2917
+ swappedToChain?: 'any' | number | string;
2918
+
2919
+ swappedToTokens?: Array<Swap.SwappedToToken>;
2920
+
2921
+ tokenMode?: 'any' | 'specific';
2922
+
2923
+ trackTokenAmount?: boolean;
2924
+ }
2925
+
2926
+ export namespace Swap {
2927
+ export interface SwappedToToken {
2928
+ address: string;
2929
+
2930
+ chainId: string;
2931
+ }
2932
+ }
2933
+ }
2934
+ }
2935
+
2936
+ /**
2937
+ * Previous data of the rule before the edit
2938
+ */
2939
+ export interface PreviousData {
2940
+ /**
2941
+ * Unique identifier for the loyalty rule
2942
+ */
2943
+ id: string;
2944
+
2945
+ /**
2946
+ * Amount associated with the loyalty rule
2947
+ */
2948
+ amount: number;
2949
+
2950
+ /**
2951
+ * Timestamp when the loyalty rule was created
2952
+ */
2953
+ createdAt: string;
2954
+
2955
+ /**
2956
+ * Timestamp when the loyalty rule was deleted (if applicable)
2957
+ */
2958
+ deletedAt: string | null;
2959
+
2960
+ /**
2961
+ * Description of the loyalty rule
2962
+ */
2963
+ description: string;
2964
+
2965
+ /**
2966
+ * End time of the loyalty rule
2967
+ */
2968
+ endTime: string;
2969
+
2970
+ /**
2971
+ * Frequency of the loyalty rule
2972
+ */
2973
+ frequency: string;
2974
+
2975
+ /**
2976
+ * Name of the loyalty rule
2977
+ */
2978
+ name: string;
2979
+
2980
+ /**
2981
+ * Unique identifier for the organization
2982
+ */
2983
+ organizationId: string;
2984
+
2985
+ /**
2986
+ * Type of the reward
2987
+ */
2988
+ rewardType: 'points' | 'multiplier' | 'badge';
2989
+
2990
+ /**
2991
+ * Start time of the loyalty rule
2992
+ */
2993
+ startTime: string;
2994
+
2995
+ /**
2996
+ * Type of the loyalty rule
2997
+ */
2998
+ type: string;
2999
+
3000
+ /**
3001
+ * Timestamp when the loyalty rule was last updated
3002
+ */
3003
+ updatedAt: string;
3004
+
3005
+ /**
3006
+ * Unique identifier for the website
3007
+ */
3008
+ websiteId: string;
3009
+
3010
+ /**
3011
+ * Optional address of the collection
3012
+ */
3013
+ collectionAddress?: string;
3014
+
3015
+ /**
3016
+ * URL of the media associated with the loyalty rule
3017
+ */
3018
+ mediaUrl?: string | null;
3019
+
3020
+ /**
3021
+ * Optional metadata for the loyalty rule
3022
+ */
3023
+ metadata?: { [key: string]: PreviousData.Metadata };
3024
+ }
3025
+
3026
+ export namespace PreviousData {
3027
+ export interface Metadata {
3028
+ /**
3029
+ * Number of tokens per batch.
3030
+ */
3031
+ batchSize?: number | null;
3032
+
3033
+ /**
3034
+ * Text displayed on the action button.
3035
+ */
3036
+ buttonText?: string | null;
3037
+
3038
+ /**
3039
+ * Flag indicating if commenting is required.
3040
+ */
3041
+ checkComment?: boolean | null;
3042
+
3043
+ /**
3044
+ * Flag indicating if liking the post is required.
3045
+ */
3046
+ checkLike?: boolean | null;
3047
+
3048
+ /**
3049
+ * Flag indicating if reposting is required.
3050
+ */
3051
+ checkRepost?: boolean | null;
3052
+
3053
+ /**
3054
+ * Text to check in the Twitter post, username, or bio.
3055
+ */
3056
+ checkText?: string | null;
3057
+
3058
+ /**
3059
+ * Array of collections associated with the rule.
3060
+ */
3061
+ collection?: Array<Metadata.Collection>;
3062
+
3063
+ /**
3064
+ * Conditions for completing the profile.
3065
+ */
3066
+ completeProfileConditions?: { [key: string]: boolean } | null;
3067
+
3068
+ /**
3069
+ * Object containing details for the call-to-action.
3070
+ */
3071
+ cta?: Metadata.Cta | null;
3072
+
3073
+ /**
3074
+ * API key for custom rewards integration.
3075
+ */
3076
+ customRewardsApiKey?: string;
3077
+
3078
+ /**
3079
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
3080
+ */
3081
+ directRpc?: boolean;
3082
+
3083
+ /**
3084
+ * Array of Discord servers, channels, and roles to join.
3085
+ */
3086
+ discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
3087
+
3088
+ /**
3089
+ * Array of drip quests required to complete the rule.
3090
+ */
3091
+ dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
3092
+
3093
+ /**
3094
+ * Flag indicating whether joining Discord servers is required.
3095
+ */
3096
+ enableJoinDiscordServers?: boolean | null;
3097
+
3098
+ /**
3099
+ * Flag indicating whether streaks are enabled.
3100
+ */
3101
+ enableStreaks?: boolean | null;
3102
+
3103
+ /**
3104
+ * Flag indicating whether the verified multiplier is enabled.
3105
+ */
3106
+ enableVerifiedMultiplier?: boolean;
3107
+
3108
+ /**
3109
+ * Fill source of the order for the token sale
3110
+ */
3111
+ fillSource?: string;
3112
+
3113
+ /**
3114
+ * Percentage reward given to a user for their first referral.
3115
+ */
3116
+ firstReferralReward?: number | null;
3117
+
3118
+ /**
3119
+ * Flag indicating whether the fill source is included.
3120
+ */
3121
+ hasFillSource?: boolean;
3122
+
3123
+ /**
3124
+ * Indicates if the item has never been sold.
3125
+ */
3126
+ hasNeverSold?: boolean;
3127
+
3128
+ /**
3129
+ * Indicates if the full royalty has been paid for items.
3130
+ */
3131
+ hasPaidFullRoyalty?: boolean;
3132
+
3133
+ /**
3134
+ * Flag indicating if the sale currency is included.
3135
+ */
3136
+ hasSaleCurrency?: boolean;
3137
+
3138
+ /**
3139
+ * Indicates if the user has a verified Twitter account.
3140
+ */
3141
+ hasVerifiedTwitter?: boolean;
3142
+
3143
+ /**
3144
+ * URL of the image associated with the rule.
3145
+ */
3146
+ imageUrl?: string | null;
3147
+
3148
+ /**
3149
+ * If enabled, the first transaction done on the platform will complete this rule
3150
+ */
3151
+ isCheckInOnEveryTxn?: boolean;
3152
+
3153
+ /**
3154
+ * Indicates if the multiplier has been applied to rewards.
3155
+ */
3156
+ isMultiplierApplied?: boolean;
3157
+
3158
+ /**
3159
+ * Flag indicating if the rule is restricted to new users.
3160
+ */
3161
+ isRestrictedToNewUsers?: boolean;
3162
+
3163
+ /**
3164
+ * Flag indicating if rewards are applied retroactively.
3165
+ */
3166
+ isRetroactive?: boolean | null;
3167
+
3168
+ /**
3169
+ * Flag indicating if the token hold multiplier is applied.
3170
+ */
3171
+ isTokenHoldMultiplier?: boolean;
3172
+
3173
+ /**
3174
+ * Optional link associated with the metadata.
3175
+ */
3176
+ link?: string | null;
3177
+
3178
+ /**
3179
+ * Liquidity pool details.
3180
+ */
3181
+ liquidity?: Metadata.Liquidity;
3182
+
3183
+ /**
3184
+ * Maximum quantity constraint for token holding.
3185
+ */
3186
+ maxQty?: number | null;
3187
+
3188
+ /**
3189
+ * Minimum quantity constraint for token holding.
3190
+ */
3191
+ minQty?: number | null;
3192
+
3193
+ /**
3194
+ * Array of loyalty currency IDs used for multipliers.
3195
+ */
3196
+ multiplierLoyaltyCurrencyIds?: Array<string> | null;
3197
+
3198
+ /**
3199
+ * Flag indicating whether to include only known users.
3200
+ */
3201
+ onlyKnownUsers?: boolean;
3202
+
3203
+ /**
3204
+ * Flag indicating whether to include only native tokens.
3205
+ */
3206
+ onlyNative?: boolean;
3207
+
3208
+ /**
3209
+ * Flag indicating whether to include only non-listed items.
3210
+ */
3211
+ onlyNonListed?: boolean;
3212
+
3213
+ /**
3214
+ * Indicates if only existing users are rewarded.
3215
+ */
3216
+ onlyRewardExistingUser?: boolean;
3217
+
3218
+ /**
3219
+ * give points for only one token ownership per contract
3220
+ */
3221
+ onlyRewardSingleTokenOwnership?: boolean | null;
3222
+
3223
+ /**
3224
+ * Promotional code associated with the rule.
3225
+ */
3226
+ promoCode?: string;
3227
+
3228
+ /**
3229
+ * URL of the CSV file containing promo codes.
3230
+ */
3231
+ promoCodeCsvUrl?: string;
3232
+
3233
+ /**
3234
+ * Numbers of the promotional code to be generated.
3235
+ */
3236
+ promoCodeLength?: number | null;
3237
+
3238
+ /**
3239
+ * Type of the promotional code.
3240
+ */
3241
+ promoCodeType?: 'code' | 'csv' | 'generate';
3242
+
3243
+ /**
3244
+ * Array defining ranges and corresponding rewards.
3245
+ */
3246
+ range?: Array<Metadata.Range>;
3247
+
3248
+ /**
3249
+ * Object defining referral requirements.
3250
+ */
3251
+ referralRequirements?: Metadata.ReferralRequirements | null;
3252
+
3253
+ /**
3254
+ * Lump sum reward given to a referrer.
3255
+ */
3256
+ referrerReward?: number | null;
3257
+
3258
+ /**
3259
+ * Loyalty currency ID of the referrer reward.
3260
+ */
3261
+ referrerRewardLoyaltyCurrencyId?: string | null;
3262
+
3263
+ /**
3264
+ * Flag indicating if the post link is required.
3265
+ */
3266
+ requirePostLink?: boolean | null;
3267
+
3268
+ /**
3269
+ * Flag indicating if the rule can also reward badges per range.
3270
+ */
3271
+ rewardBadgePerRange?: boolean;
3272
+
3273
+ /**
3274
+ * Flag indicating if the reward is rewarded by batch.
3275
+ */
3276
+ rewardByBatch?: boolean | null;
3277
+
3278
+ /**
3279
+ * Flag indicating if rewards are given per impression.
3280
+ */
3281
+ rewardPerImpression?: boolean | null;
3282
+
3283
+ /**
3284
+ * Flag indicating if the rule should reward based on value of traded tokens
3285
+ * instead of count.
3286
+ */
3287
+ rewardPerValue?: boolean;
3288
+
3289
+ /**
3290
+ * Currency associated with sales.
3291
+ */
3292
+ saleCurrency?: string;
3293
+
3294
+ /**
3295
+ * Percentage reward given for a second-level referral.
3296
+ */
3297
+ secondReferralReward?: number | null;
3298
+
3299
+ /**
3300
+ * Flag indicating if the multiplier is skipped.
3301
+ */
3302
+ skipMultiplier?: boolean | null;
3303
+
3304
+ /**
3305
+ * Object containing details of the associated smart contract.
3306
+ */
3307
+ smartContract?: Metadata.SmartContract;
3308
+
3309
+ /**
3310
+ * Array of snapshot proposals for the rule.
3311
+ */
3312
+ snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
3313
+
3314
+ /**
3315
+ * Social media platform associated with the rule.
3316
+ */
3317
+ socialPlatform?:
3318
+ | 'Custom'
3319
+ | 'Discord'
3320
+ | 'EpicGames'
3321
+ | 'Instagram'
3322
+ | 'Steam'
3323
+ | 'Telegram'
3324
+ | 'TikTok'
3325
+ | 'Twitch'
3326
+ | 'X(Twitter)'
3327
+ | 'YouTube'
3328
+ | 'Google'
3329
+ | null;
3330
+
3331
+ /**
3332
+ * URL of the social platform's logo.
3333
+ */
3334
+ socialPlatformLogo?: string | null;
3335
+
3336
+ /**
3337
+ * Name of the social platform.
3338
+ */
3339
+ socialPlatformName?: string | null;
3340
+
3341
+ /**
3342
+ * ID of the Steam app.
3343
+ */
3344
+ steamAppId?: string | null;
3345
+
3346
+ /**
3347
+ * Array of streak milestones and corresponding rewards.
3348
+ */
3349
+ streakArray?: Array<Metadata.StreakArray> | null;
3350
+
3351
+ /**
3352
+ * Metadata for swap loyalty rules
3353
+ */
3354
+ swap?: Metadata.Swap;
3355
+
3356
+ /**
3357
+ * ID of the Telegram channel.
3358
+ */
3359
+ telegramChannelId?: string | null;
3360
+
3361
+ /**
3362
+ * Time delay in seconds to verify actions.
3363
+ */
3364
+ timeDelayToVerifySeconds?: string | number | null;
3365
+
3366
+ /**
3367
+ * Flag indicating if all contracts are tracked.
3368
+ */
3369
+ trackAllContracts?: boolean | null;
3370
+
3371
+ /**
3372
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
3373
+ * completed once the progress is 100%.
3374
+ */
3375
+ trackProgress?: boolean | null;
3376
+
3377
+ /**
3378
+ * URL of the associated Twitter account.
3379
+ */
3380
+ twitterAccountUrl?: string;
3381
+
3382
+ /**
3383
+ * Hashtag associated with the Twitter post.
3384
+ */
3385
+ twitterHashtag?: string;
3386
+
3387
+ /**
3388
+ * URL of the associated Twitter post.
3389
+ */
3390
+ twitterPostUrl?: string;
3391
+
3392
+ /**
3393
+ * Unique identifier of the Twitter user.
3394
+ */
3395
+ twitterUserId?: string;
3396
+
3397
+ /**
3398
+ * Twitter username of the user.
3399
+ */
3400
+ twitterUsername?: string;
3401
+
3402
+ /**
3403
+ * Minimum length of the verification text.
3404
+ */
3405
+ verificationTextMinimumLength?: number | null;
3406
+
3407
+ /**
3408
+ * Multiplier applied to rewards for verified users.
3409
+ */
3410
+ verifiedMultiplier?: number | null;
3411
+
3412
+ /**
3413
+ * Placeholder text for verification input fields.
3414
+ */
3415
+ verifyPlaceHolderText?: string | null;
3416
+
3417
+ /**
3418
+ * Type of wallet associated with the rule.
3419
+ */
3420
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
3421
+
3422
+ /**
3423
+ * ID of the Youtube channel.
3424
+ */
3425
+ youtubeChannelId?: string | null;
3426
+
3427
+ /**
3428
+ * ID of the Youtube video.
3429
+ */
3430
+ youtubeVideoId?: string | null;
3431
+ }
3432
+
3433
+ export namespace Metadata {
3434
+ export interface Collection {
3435
+ /**
3436
+ * Blockchain address of the collection.
3437
+ */
3438
+ address?: string;
3439
+
3440
+ /**
3441
+ * Multiplier applied to the rewards for this collection.
3442
+ */
3443
+ multiplier?: number;
3444
+
3445
+ /**
3446
+ * Blockchain network of the collection.
3447
+ */
3448
+ network?:
3449
+ | 'abstract'
3450
+ | 'abstractTestnet'
3451
+ | 'apechain'
3452
+ | 'arbitrum'
3453
+ | 'avalanche'
3454
+ | 'avalancheFuji'
3455
+ | 'base'
3456
+ | 'baseSepolia'
3457
+ | 'berachain'
3458
+ | 'berachainArtio'
3459
+ | 'berachainBepolia'
3460
+ | 'binance'
3461
+ | 'bscTestnet'
3462
+ | 'campTestnet'
3463
+ | 'fantom'
3464
+ | 'fantomTestnet'
3465
+ | 'flowMainnet'
3466
+ | 'mainnet'
3467
+ | 'optimism'
3468
+ | 'polygon'
3469
+ | 'polygon_mumbai'
3470
+ | 'skaleNebula'
3471
+ | 'solana'
3472
+ | 'sophon'
3473
+ | 'sophonTestnet'
3474
+ | 'sui'
3475
+ | 'superseed'
3476
+ | 'superseedSepolia'
3477
+ | 'vanar'
3478
+ | 'xai'
3479
+ | 'zksync'
3480
+ | 'coti'
3481
+ | 'cotiTestnet'
3482
+ | 'morph'
3483
+ | 'morphTestnet'
3484
+ | 'morphHolesky'
3485
+ | 'ultra'
3486
+ | 'ultraTestnet'
3487
+ | 'nitrograph'
3488
+ | 'sepolia'
3489
+ | 'optimism_sepolia'
3490
+ | 'arbitrumSepolia'
3491
+ | 'goerli'
3492
+ | 'optimism_goerli'
3493
+ | 'arbitrumGoerli'
3494
+ | 'basecamp';
3495
+ }
3496
+
3497
+ /**
3498
+ * Object containing details for the call-to-action.
3499
+ */
3500
+ export interface Cta {
3501
+ /**
3502
+ * Link for the call-to-action.
3503
+ */
3504
+ href?: string | null;
3505
+
3506
+ /**
3507
+ * Label for the call-to-action.
3508
+ */
3509
+ label?: string | null;
3510
+ }
3511
+
3512
+ export interface DiscordServersToJoin {
3513
+ /**
3514
+ * ID of the Discord server to join.
3515
+ */
3516
+ id?: string;
3517
+
3518
+ /**
3519
+ * Array of Discord channels to join.
3520
+ */
3521
+ channels?: Array<DiscordServersToJoin.Channel>;
3522
+
3523
+ /**
3524
+ * Array of roles to assign in the Discord server.
3525
+ */
3526
+ roles?: Array<DiscordServersToJoin.Role>;
3527
+ }
3528
+
3529
+ export namespace DiscordServersToJoin {
3530
+ export interface Channel {
3531
+ /**
3532
+ * ID of the Discord channel.
3533
+ */
3534
+ id?: string;
3535
+
3536
+ /**
3537
+ * Array of emojis used in the channel.
3538
+ */
3539
+ emojis?: Array<Channel.Emoji>;
3540
+
3541
+ /**
3542
+ * Phrase of text to be present in the discord message
3543
+ */
3544
+ text?: string;
3545
+ }
3546
+
3547
+ export namespace Channel {
3548
+ export interface Emoji {
3549
+ /**
3550
+ * ID of the emoji used in the channel.
3551
+ */
3552
+ id?: string;
3553
+ }
3554
+ }
3555
+
3556
+ export interface Role {
3557
+ /**
3558
+ * ID of the role in the Discord server.
3559
+ */
3560
+ id: string;
3561
+ }
3562
+ }
3563
+
3564
+ export interface DripQuestsToComplete {
3565
+ /**
3566
+ * ID of the drip quest to complete.
3567
+ */
3568
+ id: string;
3569
+ }
3570
+
3571
+ /**
3572
+ * Liquidity pool details.
3573
+ */
3574
+ export interface Liquidity {
3575
+ /**
3576
+ * Calculation type of the liquidity pool.
3577
+ */
3578
+ calculationType?: 'fixed' | 'custom';
3579
+
3580
+ /**
3581
+ * Custom function to calculate the the reward amount based on the liquidity
3582
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
3583
+ * USD.
3584
+ */
3585
+ customFunction?: string;
3586
+
3587
+ /**
3588
+ * Liquidity provided per day in USD
3589
+ */
3590
+ liquidityPerDay?: number;
3591
+
3592
+ /**
3593
+ * Blockchain network of the liquidity pool.
3594
+ */
3595
+ network?:
3596
+ | 'abstract'
3597
+ | 'abstractTestnet'
3598
+ | 'apechain'
3599
+ | 'arbitrum'
3600
+ | 'avalanche'
3601
+ | 'avalancheFuji'
3602
+ | 'base'
3603
+ | 'baseSepolia'
3604
+ | 'berachain'
3605
+ | 'berachainArtio'
3606
+ | 'berachainBepolia'
3607
+ | 'binance'
3608
+ | 'bscTestnet'
3609
+ | 'campTestnet'
3610
+ | 'fantom'
3611
+ | 'fantomTestnet'
3612
+ | 'flowMainnet'
3613
+ | 'mainnet'
3614
+ | 'optimism'
3615
+ | 'polygon'
3616
+ | 'polygon_mumbai'
3617
+ | 'skaleNebula'
3618
+ | 'solana'
3619
+ | 'sophon'
3620
+ | 'sophonTestnet'
3621
+ | 'sui'
3622
+ | 'superseed'
3623
+ | 'superseedSepolia'
3624
+ | 'vanar'
3625
+ | 'xai'
3626
+ | 'zksync'
3627
+ | 'coti'
3628
+ | 'cotiTestnet'
3629
+ | 'morph'
3630
+ | 'morphTestnet'
3631
+ | 'morphHolesky'
3632
+ | 'ultra'
3633
+ | 'ultraTestnet'
3634
+ | 'nitrograph'
3635
+ | 'sepolia'
3636
+ | 'optimism_sepolia'
3637
+ | 'arbitrumSepolia'
3638
+ | 'goerli'
3639
+ | 'optimism_goerli'
3640
+ | 'arbitrumGoerli'
3641
+ | 'basecamp';
3642
+
3643
+ /**
3644
+ * Indicates if only in-range liquidity is rewarded.
3645
+ */
3646
+ onlyRewardInRangeLiquidity?: boolean;
3647
+
3648
+ /**
3649
+ * Array of liquidity pools associated with the rule.
3650
+ */
3651
+ pools?: Array<Liquidity.Pool>;
3652
+
3653
+ /**
3654
+ * Protocol of the liquidity pool.
3655
+ */
3656
+ protocol?: string;
3657
+ }
3658
+
3659
+ export namespace Liquidity {
3660
+ export interface Pool {
3661
+ /**
3662
+ * Unique identifier of the liquidity pool.
3663
+ */
3664
+ id: string;
3665
+ }
3666
+ }
3667
+
3668
+ export interface Range {
3669
+ /**
3670
+ * Reward amount for this range.
3671
+ */
3672
+ amount: number;
3673
+
3674
+ /**
3675
+ * End value of the range.
3676
+ */
3677
+ endRange: number;
3678
+
3679
+ /**
3680
+ * Start value of the range.
3681
+ */
3682
+ startRange: number;
3683
+
3684
+ /**
3685
+ * ID of the loyalty badge for this range.
3686
+ */
3687
+ loyaltyBadgeId?: string;
3688
+
3689
+ /**
3690
+ * Amount of the loyalty multiplier for this range.
3691
+ */
3692
+ loyaltyMultiplierAmount?: number;
3693
+ }
3694
+
3695
+ /**
3696
+ * Object defining referral requirements.
3697
+ */
3698
+ export interface ReferralRequirements {
3699
+ /**
3700
+ * Flag indicating if achieving points is required.
3701
+ */
3702
+ achievePoints?: boolean | null;
3703
+
3704
+ /**
3705
+ * Flag indicating if completing the profile is required.
3706
+ */
3707
+ completeProfile?: boolean | null;
3708
+
3709
+ /**
3710
+ * Flag indicating if connecting Discord is required.
3711
+ */
3712
+ connectDiscord?: boolean | null;
3713
+
3714
+ /**
3715
+ * Flag indicating if connecting email is required.
3716
+ */
3717
+ connectEmail?: boolean | null;
3718
+
3719
+ /**
3720
+ * Flag indicating if connecting Twitter is required.
3721
+ */
3722
+ connectTwitter?: boolean | null;
3723
+
3724
+ points?: ReferralRequirements.Points | null;
3725
+ }
3726
+
3727
+ export namespace ReferralRequirements {
3728
+ export interface Points {
3729
+ /**
3730
+ * Points required for referral.
3731
+ */
3732
+ amount?: number | null;
3733
+
3734
+ /**
3735
+ * ID of the loyalty currency for referral.
3736
+ */
3737
+ loyaltyCurrecyId?: string | null;
3738
+ }
3739
+ }
3740
+
3741
+ /**
3742
+ * Object containing details of the associated smart contract.
3743
+ */
3744
+ export interface SmartContract {
3745
+ /**
3746
+ * Mapping of addresses for the smart contract.
3747
+ */
3748
+ addressMapping?: string | null;
3749
+
3750
+ /**
3751
+ * Object containing details of the amount multiplier from the event.
3752
+ */
3753
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
3754
+
3755
+ /**
3756
+ * ID of the smart contract.
3757
+ */
3758
+ contractId?: string | null;
3759
+
3760
+ /**
3761
+ * Criteria to evaluate the smart contract event.
3762
+ */
3763
+ criteria?: 'everyEvent' | 'byParameter' | null;
3764
+
3765
+ /**
3766
+ * Event emitted by the smart contract.
3767
+ */
3768
+ event?: string | null;
3769
+
3770
+ /**
3771
+ * Array of parameters for the smart contract.
3772
+ */
3773
+ params?: Array<SmartContract.Param> | null;
3774
+
3775
+ /**
3776
+ * Type of the smart contract interaction.
3777
+ */
3778
+ type?: 'function' | 'event' | null;
3779
+ }
3780
+
3781
+ export namespace SmartContract {
3782
+ /**
3783
+ * Object containing details of the amount multiplier from the event.
3784
+ */
3785
+ export interface AmountMultiplier {
3786
+ /**
3787
+ * Mapping of the value for the smart contract.
3788
+ */
3789
+ valueMapping?: string | null;
3790
+ }
3791
+
3792
+ export interface Param {
3793
+ /**
3794
+ * Condition to check for the parameter.
3795
+ */
3796
+ condition?: string | null;
3797
+
3798
+ /**
3799
+ * Name of the smart contract parameter.
3800
+ */
3801
+ name?: string | null;
3802
+
3803
+ /**
3804
+ * Value of the parameter.
3805
+ */
3806
+ value?: string | null;
3807
+ }
3808
+ }
3809
+
3810
+ export interface SnapshotProposal {
3811
+ /**
3812
+ * ID of the snapshot proposal.
3813
+ */
3814
+ id: string;
3815
+
3816
+ /**
3817
+ * Space associated with the snapshot proposal.
3818
+ */
3819
+ space: string;
3820
+ }
3821
+
3822
+ export interface StreakArray {
3823
+ /**
3824
+ * Reward amount for achieving the streak milestone.
3825
+ */
3826
+ streakAmount: number;
3827
+
3828
+ /**
3829
+ * Milestone required to achieve the streak.
3830
+ */
3831
+ streakMilestone: number;
3832
+ }
3833
+
3834
+ /**
3835
+ * Metadata for swap loyalty rules
3836
+ */
3837
+ export interface Swap {
3838
+ provider?: 'any' | 'relay' | 'lifi';
3839
+
3840
+ relayReferrerId?: string;
3841
+
3842
+ requireCrossChainSwap?: boolean;
3843
+
3844
+ swappedToChain?: 'any' | number | string;
3845
+
3846
+ swappedToTokens?: Array<Swap.SwappedToToken>;
3847
+
3848
+ tokenMode?: 'any' | 'specific';
3849
+
3850
+ trackTokenAmount?: boolean;
3851
+ }
3852
+
3853
+ export namespace Swap {
3854
+ export interface SwappedToToken {
3855
+ address: string;
3856
+
3857
+ chainId: string;
3858
+ }
3859
+ }
3860
+ }
382
3861
  }
383
3862
  }
384
3863
 
385
- export interface RuleEditRetrieveParams {
3864
+ export interface RuleEditListParams {
386
3865
  /**
387
3866
  * ID of the loyalty rule
388
3867
  */
@@ -391,7 +3870,7 @@ export interface RuleEditRetrieveParams {
391
3870
  /**
392
3871
  * Maximum number of edits to return
393
3872
  */
394
- limit?: number | null;
3873
+ limit?: number;
395
3874
 
396
3875
  /**
397
3876
  * Unique identifier for the organization to filter by
@@ -413,9 +3892,9 @@ export interface RuleEditRestoreParams {}
413
3892
 
414
3893
  export declare namespace RuleEdits {
415
3894
  export {
416
- type RuleEditRetrieveResponse as RuleEditRetrieveResponse,
3895
+ type RuleEditListResponse as RuleEditListResponse,
417
3896
  type RuleEditRestoreResponse as RuleEditRestoreResponse,
418
- type RuleEditRetrieveParams as RuleEditRetrieveParams,
3897
+ type RuleEditListParams as RuleEditListParams,
419
3898
  type RuleEditRestoreParams as RuleEditRestoreParams,
420
3899
  };
421
3900
  }