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

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 (352) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +19 -13
  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.map +1 -1
  7. package/core.js +4 -1
  8. package/core.js.map +1 -1
  9. package/core.mjs +5 -2
  10. package/core.mjs.map +1 -1
  11. package/index.d.mts +17 -11
  12. package/index.d.ts +17 -11
  13. package/index.d.ts.map +1 -1
  14. package/index.js +14 -8
  15. package/index.js.map +1 -1
  16. package/index.mjs +15 -9
  17. package/index.mjs.map +1 -1
  18. package/package.json +8 -29
  19. package/resources/assets.d.ts +50 -0
  20. package/resources/assets.d.ts.map +1 -0
  21. package/resources/assets.js +17 -0
  22. package/resources/assets.js.map +1 -0
  23. package/resources/assets.mjs +13 -0
  24. package/resources/assets.mjs.map +1 -0
  25. package/resources/auctions.d.ts +134 -0
  26. package/resources/auctions.d.ts.map +1 -0
  27. package/resources/{auction-bids.js → auctions.js} +12 -6
  28. package/resources/auctions.js.map +1 -0
  29. package/resources/{auction-bids.mjs → auctions.mjs} +10 -4
  30. package/resources/auctions.mjs.map +1 -0
  31. package/resources/auth.d.ts +40 -0
  32. package/resources/auth.d.ts.map +1 -0
  33. package/resources/auth.js +16 -0
  34. package/resources/auth.js.map +1 -0
  35. package/resources/auth.mjs +12 -0
  36. package/resources/auth.mjs.map +1 -0
  37. package/resources/index.d.ts +7 -5
  38. package/resources/index.d.ts.map +1 -1
  39. package/resources/index.js +11 -7
  40. package/resources/index.js.map +1 -1
  41. package/resources/index.mjs +7 -5
  42. package/resources/index.mjs.map +1 -1
  43. package/resources/loyalty/accounts.d.ts +190 -0
  44. package/resources/loyalty/accounts.d.ts.map +1 -1
  45. package/resources/loyalty/accounts.js +15 -0
  46. package/resources/loyalty/accounts.js.map +1 -1
  47. package/resources/loyalty/accounts.mjs +15 -0
  48. package/resources/loyalty/accounts.mjs.map +1 -1
  49. package/resources/loyalty/badges.d.ts +4 -0
  50. package/resources/loyalty/badges.d.ts.map +1 -1
  51. package/resources/loyalty/currencies.d.ts +6 -0
  52. package/resources/loyalty/currencies.d.ts.map +1 -1
  53. package/resources/loyalty/index.d.ts +8 -5
  54. package/resources/loyalty/index.d.ts.map +1 -1
  55. package/resources/loyalty/index.js +9 -3
  56. package/resources/loyalty/index.js.map +1 -1
  57. package/resources/loyalty/index.mjs +5 -2
  58. package/resources/loyalty/index.mjs.map +1 -1
  59. package/resources/loyalty/loyalty.d.ts +29 -17
  60. package/resources/loyalty/loyalty.d.ts.map +1 -1
  61. package/resources/loyalty/loyalty.js +24 -12
  62. package/resources/loyalty/loyalty.js.map +1 -1
  63. package/resources/loyalty/loyalty.mjs +25 -13
  64. package/resources/loyalty/loyalty.mjs.map +1 -1
  65. package/resources/loyalty/multipliers.d.ts +37 -6
  66. package/resources/loyalty/multipliers.d.ts.map +1 -1
  67. package/resources/loyalty/multipliers.js +7 -1
  68. package/resources/loyalty/multipliers.js.map +1 -1
  69. package/resources/loyalty/multipliers.mjs +7 -1
  70. package/resources/loyalty/multipliers.mjs.map +1 -1
  71. package/resources/loyalty/{transaction-entries/questions-responses.d.ts → questions-responses.d.ts} +2 -2
  72. package/resources/loyalty/questions-responses.d.ts.map +1 -0
  73. package/resources/loyalty/{transaction-entries/questions-responses.js → questions-responses.js} +2 -2
  74. package/resources/loyalty/questions-responses.js.map +1 -0
  75. package/resources/loyalty/{transaction-entries/questions-responses.mjs → questions-responses.mjs} +2 -2
  76. package/resources/loyalty/questions-responses.mjs.map +1 -0
  77. package/resources/loyalty/{transaction-entries/questions.d.ts → questions.d.ts} +2 -2
  78. package/resources/loyalty/questions.d.ts.map +1 -0
  79. package/resources/loyalty/{transaction-entries/questions.js → questions.js} +1 -1
  80. package/resources/loyalty/questions.js.map +1 -0
  81. package/resources/loyalty/{transaction-entries/questions.mjs → questions.mjs} +1 -1
  82. package/resources/loyalty/questions.mjs.map +1 -0
  83. package/resources/loyalty/rule-edits.d.ts +6 -6
  84. package/resources/loyalty/rule-edits.d.ts.map +1 -1
  85. package/resources/loyalty/rule-edits.js +1 -1
  86. package/resources/loyalty/rule-edits.js.map +1 -1
  87. package/resources/loyalty/rule-edits.mjs +1 -1
  88. package/resources/loyalty/rule-edits.mjs.map +1 -1
  89. package/resources/loyalty/rule-groups.d.ts +559 -0
  90. package/resources/loyalty/rule-groups.d.ts.map +1 -0
  91. package/resources/loyalty/rule-groups.js +16 -0
  92. package/resources/loyalty/rule-groups.js.map +1 -0
  93. package/resources/loyalty/rule-groups.mjs +12 -0
  94. package/resources/loyalty/rule-groups.mjs.map +1 -0
  95. package/resources/loyalty/rules.d.ts +144 -23
  96. package/resources/loyalty/rules.d.ts.map +1 -1
  97. package/resources/loyalty/rules.js +1 -1
  98. package/resources/loyalty/rules.js.map +1 -1
  99. package/resources/loyalty/rules.mjs +1 -1
  100. package/resources/loyalty/rules.mjs.map +1 -1
  101. package/resources/loyalty/transactions.d.ts +248 -0
  102. package/resources/loyalty/transactions.d.ts.map +1 -0
  103. package/resources/loyalty/transactions.js +22 -0
  104. package/resources/loyalty/transactions.js.map +1 -0
  105. package/resources/loyalty/transactions.mjs +18 -0
  106. package/resources/loyalty/transactions.mjs.map +1 -0
  107. package/resources/loyalty.d.ts +2 -0
  108. package/resources/loyalty.d.ts.map +1 -0
  109. package/resources/loyalty.js +19 -0
  110. package/resources/loyalty.js.map +1 -0
  111. package/resources/loyalty.mjs +3 -0
  112. package/resources/loyalty.mjs.map +1 -0
  113. package/resources/{assets/minting.d.ts → minting.d.ts} +10 -10
  114. package/resources/minting.d.ts.map +1 -0
  115. package/resources/{assets/minting.js → minting.js} +2 -2
  116. package/resources/minting.js.map +1 -0
  117. package/resources/{assets/minting.mjs → minting.mjs} +2 -2
  118. package/resources/minting.mjs.map +1 -0
  119. package/resources/referral/index.d.ts +3 -0
  120. package/resources/referral/index.d.ts.map +1 -0
  121. package/resources/referral/index.js.map +1 -0
  122. package/resources/{assets/referral → referral}/index.mjs +1 -1
  123. package/resources/referral/index.mjs.map +1 -0
  124. package/resources/referral/referral.d.ts +31 -0
  125. package/resources/referral/referral.d.ts.map +1 -0
  126. package/resources/{assets/referral → referral}/referral.js +4 -4
  127. package/resources/referral/referral.js.map +1 -0
  128. package/resources/{assets/referral → referral}/referral.mjs +5 -5
  129. package/resources/referral/referral.mjs.map +1 -0
  130. package/resources/{assets/referral → referral}/users.d.ts +11 -11
  131. package/resources/referral/users.d.ts.map +1 -0
  132. package/resources/{assets/referral → referral}/users.js +3 -3
  133. package/resources/referral/users.js.map +1 -0
  134. package/resources/{assets/referral → referral}/users.mjs +3 -3
  135. package/resources/referral/users.mjs.map +1 -0
  136. package/resources/referral.d.ts +2 -0
  137. package/resources/referral.d.ts.map +1 -0
  138. package/resources/referral.js +19 -0
  139. package/resources/referral.js.map +1 -0
  140. package/resources/referral.mjs +3 -0
  141. package/resources/referral.mjs.map +1 -0
  142. package/resources/users/index.d.ts +2 -3
  143. package/resources/users/index.d.ts.map +1 -1
  144. package/resources/users/index.js +1 -3
  145. package/resources/users/index.js.map +1 -1
  146. package/resources/users/index.mjs +1 -2
  147. package/resources/users/index.mjs.map +1 -1
  148. package/resources/users/metadatas.d.ts +17 -7
  149. package/resources/users/metadatas.d.ts.map +1 -1
  150. package/resources/users/metadatas.js +2 -2
  151. package/resources/users/metadatas.js.map +1 -1
  152. package/resources/users/metadatas.mjs +2 -2
  153. package/resources/users/metadatas.mjs.map +1 -1
  154. package/resources/users/users.d.ts +296 -6
  155. package/resources/users/users.d.ts.map +1 -1
  156. package/resources/users/users.js +25 -4
  157. package/resources/users/users.js.map +1 -1
  158. package/resources/users/users.mjs +25 -4
  159. package/resources/users/users.mjs.map +1 -1
  160. package/resources/users.d.ts +2 -0
  161. package/resources/users.d.ts.map +1 -0
  162. package/resources/users.js +19 -0
  163. package/resources/users.js.map +1 -0
  164. package/resources/users.mjs +3 -0
  165. package/resources/users.mjs.map +1 -0
  166. package/resources/websites/index.d.ts +4 -0
  167. package/resources/websites/index.d.ts.map +1 -0
  168. package/resources/websites/index.js +11 -0
  169. package/resources/websites/index.js.map +1 -0
  170. package/resources/{assets → websites}/index.mjs +1 -4
  171. package/resources/websites/index.mjs.map +1 -0
  172. package/resources/websites/website-collections.d.ts +73 -0
  173. package/resources/websites/website-collections.d.ts.map +1 -0
  174. package/resources/{assets → websites}/website-collections.js +2 -2
  175. package/resources/websites/website-collections.js.map +1 -0
  176. package/resources/{assets → websites}/website-collections.mjs +2 -2
  177. package/resources/websites/website-collections.mjs.map +1 -0
  178. package/resources/{assets → websites}/website-user-roles.d.ts +28 -28
  179. package/resources/websites/website-user-roles.d.ts.map +1 -0
  180. package/resources/{assets → websites}/website-user-roles.js +7 -7
  181. package/resources/websites/website-user-roles.js.map +1 -0
  182. package/resources/{assets → websites}/website-user-roles.mjs +7 -7
  183. package/resources/websites/website-user-roles.mjs.map +1 -0
  184. package/resources/websites/websites.d.ts +211 -0
  185. package/resources/websites/websites.d.ts.map +1 -0
  186. package/resources/{assets/assets.js → websites/websites.js} +14 -27
  187. package/resources/websites/websites.js.map +1 -0
  188. package/resources/websites/websites.mjs +29 -0
  189. package/resources/websites/websites.mjs.map +1 -0
  190. package/resources/websites.d.ts +1 -202
  191. package/resources/websites.d.ts.map +1 -1
  192. package/resources/websites.js +15 -18
  193. package/resources/websites.js.map +1 -1
  194. package/resources/websites.mjs +1 -16
  195. package/resources/websites.mjs.map +1 -1
  196. package/resources.d.ts +2 -0
  197. package/resources.d.ts.map +1 -0
  198. package/resources.js +18 -0
  199. package/resources.js.map +1 -0
  200. package/resources.mjs +2 -0
  201. package/resources.mjs.map +1 -0
  202. package/src/_shims/index.d.ts +2 -0
  203. package/src/_shims/index.js +5 -1
  204. package/src/_shims/index.mjs +5 -1
  205. package/src/core.ts +8 -3
  206. package/src/index.ts +66 -22
  207. package/src/resources/assets.ts +77 -0
  208. package/src/resources/auctions.ts +209 -0
  209. package/src/resources/auth.ts +69 -0
  210. package/src/resources/index.ts +21 -10
  211. package/src/resources/loyalty/accounts.ts +250 -1
  212. package/src/resources/loyalty/badges.ts +5 -0
  213. package/src/resources/loyalty/currencies.ts +6 -0
  214. package/src/resources/loyalty/index.ts +40 -14
  215. package/src/resources/loyalty/loyalty.ts +129 -69
  216. package/src/resources/loyalty/multipliers.ts +44 -8
  217. package/src/resources/loyalty/{transaction-entries/questions-responses.ts → questions-responses.ts} +3 -3
  218. package/src/resources/loyalty/{transaction-entries/questions.ts → questions.ts} +2 -2
  219. package/src/resources/loyalty/rule-edits.ts +7 -10
  220. package/src/resources/loyalty/rule-groups.ts +818 -0
  221. package/src/resources/loyalty/rules.ts +406 -192
  222. package/src/resources/loyalty/transactions.ts +332 -0
  223. package/src/resources/loyalty.ts +3 -0
  224. package/src/resources/{assets/minting.ts → minting.ts} +32 -27
  225. package/src/resources/referral/index.ts +10 -0
  226. package/src/resources/referral/referral.ts +70 -0
  227. package/src/resources/{assets/referral → referral}/users.ts +14 -20
  228. package/src/resources/referral.ts +3 -0
  229. package/src/resources/users/index.ts +13 -4
  230. package/src/resources/users/metadatas.ts +26 -15
  231. package/src/resources/users/users.ts +423 -9
  232. package/src/resources/users.ts +3 -0
  233. package/src/resources/websites/index.ts +22 -0
  234. package/src/resources/{assets → websites}/website-collections.ts +32 -30
  235. package/src/resources/{assets → websites}/website-user-roles.ts +40 -40
  236. package/src/resources/websites/websites.ts +299 -0
  237. package/src/resources/websites.ts +1 -257
  238. package/src/resources.ts +1 -0
  239. package/src/version.ts +1 -1
  240. package/version.d.ts +1 -1
  241. package/version.js +1 -1
  242. package/version.mjs +1 -1
  243. package/resources/assets/assets.d.ts +0 -153
  244. package/resources/assets/assets.d.ts.map +0 -1
  245. package/resources/assets/assets.js.map +0 -1
  246. package/resources/assets/assets.mjs +0 -42
  247. package/resources/assets/assets.mjs.map +0 -1
  248. package/resources/assets/index.d.ts +0 -7
  249. package/resources/assets/index.d.ts.map +0 -1
  250. package/resources/assets/index.js +0 -17
  251. package/resources/assets/index.js.map +0 -1
  252. package/resources/assets/index.mjs.map +0 -1
  253. package/resources/assets/minting.d.ts.map +0 -1
  254. package/resources/assets/minting.js.map +0 -1
  255. package/resources/assets/minting.mjs.map +0 -1
  256. package/resources/assets/referral/index.d.ts +0 -3
  257. package/resources/assets/referral/index.d.ts.map +0 -1
  258. package/resources/assets/referral/index.js.map +0 -1
  259. package/resources/assets/referral/index.mjs.map +0 -1
  260. package/resources/assets/referral/referral.d.ts +0 -30
  261. package/resources/assets/referral/referral.d.ts.map +0 -1
  262. package/resources/assets/referral/referral.js.map +0 -1
  263. package/resources/assets/referral/referral.mjs.map +0 -1
  264. package/resources/assets/referral/users.d.ts.map +0 -1
  265. package/resources/assets/referral/users.js.map +0 -1
  266. package/resources/assets/referral/users.mjs.map +0 -1
  267. package/resources/assets/users.d.ts +0 -285
  268. package/resources/assets/users.d.ts.map +0 -1
  269. package/resources/assets/users.js +0 -34
  270. package/resources/assets/users.js.map +0 -1
  271. package/resources/assets/users.mjs +0 -30
  272. package/resources/assets/users.mjs.map +0 -1
  273. package/resources/assets/website-collections.d.ts +0 -73
  274. package/resources/assets/website-collections.d.ts.map +0 -1
  275. package/resources/assets/website-collections.js.map +0 -1
  276. package/resources/assets/website-collections.mjs.map +0 -1
  277. package/resources/assets/website-user-roles.d.ts.map +0 -1
  278. package/resources/assets/website-user-roles.js.map +0 -1
  279. package/resources/assets/website-user-roles.mjs.map +0 -1
  280. package/resources/auction-bids.d.ts +0 -51
  281. package/resources/auction-bids.d.ts.map +0 -1
  282. package/resources/auction-bids.js.map +0 -1
  283. package/resources/auction-bids.mjs.map +0 -1
  284. package/resources/drip/drip.d.ts +0 -14
  285. package/resources/drip/drip.d.ts.map +0 -1
  286. package/resources/drip/drip.js +0 -43
  287. package/resources/drip/drip.js.map +0 -1
  288. package/resources/drip/drip.mjs +0 -16
  289. package/resources/drip/drip.mjs.map +0 -1
  290. package/resources/drip/index.d.ts +0 -4
  291. package/resources/drip/index.d.ts.map +0 -1
  292. package/resources/drip/index.js +0 -11
  293. package/resources/drip/index.js.map +0 -1
  294. package/resources/drip/index.mjs +0 -5
  295. package/resources/drip/index.mjs.map +0 -1
  296. package/resources/drip/quests.d.ts +0 -4
  297. package/resources/drip/quests.d.ts.map +0 -1
  298. package/resources/drip/quests.js +0 -9
  299. package/resources/drip/quests.js.map +0 -1
  300. package/resources/drip/quests.mjs +0 -5
  301. package/resources/drip/quests.mjs.map +0 -1
  302. package/resources/drip/status.d.ts +0 -4
  303. package/resources/drip/status.d.ts.map +0 -1
  304. package/resources/drip/status.js +0 -9
  305. package/resources/drip/status.js.map +0 -1
  306. package/resources/drip/status.mjs +0 -5
  307. package/resources/drip/status.mjs.map +0 -1
  308. package/resources/loyalty/transaction-entries/accounts.d.ts +0 -191
  309. package/resources/loyalty/transaction-entries/accounts.d.ts.map +0 -1
  310. package/resources/loyalty/transaction-entries/accounts.js +0 -24
  311. package/resources/loyalty/transaction-entries/accounts.js.map +0 -1
  312. package/resources/loyalty/transaction-entries/accounts.mjs +0 -20
  313. package/resources/loyalty/transaction-entries/accounts.mjs.map +0 -1
  314. package/resources/loyalty/transaction-entries/index.d.ts +0 -5
  315. package/resources/loyalty/transaction-entries/index.d.ts.map +0 -1
  316. package/resources/loyalty/transaction-entries/index.js +0 -13
  317. package/resources/loyalty/transaction-entries/index.js.map +0 -1
  318. package/resources/loyalty/transaction-entries/index.mjs +0 -6
  319. package/resources/loyalty/transaction-entries/index.mjs.map +0 -1
  320. package/resources/loyalty/transaction-entries/questions-responses.d.ts.map +0 -1
  321. package/resources/loyalty/transaction-entries/questions-responses.js.map +0 -1
  322. package/resources/loyalty/transaction-entries/questions-responses.mjs.map +0 -1
  323. package/resources/loyalty/transaction-entries/questions.d.ts.map +0 -1
  324. package/resources/loyalty/transaction-entries/questions.js.map +0 -1
  325. package/resources/loyalty/transaction-entries/questions.mjs.map +0 -1
  326. package/resources/loyalty/transaction-entries/transaction-entries.d.ts +0 -300
  327. package/resources/loyalty/transaction-entries/transaction-entries.d.ts.map +0 -1
  328. package/resources/loyalty/transaction-entries/transaction-entries.js +0 -66
  329. package/resources/loyalty/transaction-entries/transaction-entries.js.map +0 -1
  330. package/resources/loyalty/transaction-entries/transaction-entries.mjs +0 -39
  331. package/resources/loyalty/transaction-entries/transaction-entries.mjs.map +0 -1
  332. package/resources/users/wallets.d.ts +0 -4
  333. package/resources/users/wallets.d.ts.map +0 -1
  334. package/resources/users/wallets.js +0 -9
  335. package/resources/users/wallets.js.map +0 -1
  336. package/resources/users/wallets.mjs +0 -5
  337. package/resources/users/wallets.mjs.map +0 -1
  338. package/src/resources/assets/assets.ts +0 -294
  339. package/src/resources/assets/index.ts +0 -38
  340. package/src/resources/assets/referral/index.ts +0 -14
  341. package/src/resources/assets/referral/referral.ts +0 -74
  342. package/src/resources/assets/users.ts +0 -415
  343. package/src/resources/auction-bids.ts +0 -77
  344. package/src/resources/drip/drip.ts +0 -21
  345. package/src/resources/drip/index.ts +0 -5
  346. package/src/resources/drip/quests.ts +0 -5
  347. package/src/resources/drip/status.ts +0 -5
  348. package/src/resources/loyalty/transaction-entries/accounts.ts +0 -251
  349. package/src/resources/loyalty/transaction-entries/index.ts +0 -34
  350. package/src/resources/loyalty/transaction-entries/transaction-entries.ts +0 -525
  351. package/src/resources/users/wallets.ts +0 -5
  352. /package/resources/{assets/referral → referral}/index.js +0 -0
@@ -50,7 +50,7 @@ export class Rules extends APIResource {
50
50
  * endpoint currently only supports following rule types code_entry, text_input,
51
51
  * link_click, discord_member, connect_wallet, check_in, external_rule,
52
52
  * drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name,
53
- * drip_x_text_in_comment, drip_x_tweet, telegram_join
53
+ * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages
54
54
  */
55
55
  complete(
56
56
  id: string,
@@ -72,7 +72,10 @@ export class Rules extends APIResource {
72
72
  /**
73
73
  * This will return the processing status of quests for a specific user
74
74
  */
75
- status(query: RuleStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleStatusResponse> {
75
+ getStatus(
76
+ query: RuleGetStatusParams,
77
+ options?: Core.RequestOptions,
78
+ ): Core.APIPromise<RuleGetStatusResponse> {
76
79
  return this._client.get('/api/loyalty/rules/status', { query, ...options });
77
80
  }
78
81
  }
@@ -231,7 +234,7 @@ export interface RuleCreateResponse {
231
234
  /**
232
235
  * Interval between rule executions
233
236
  */
234
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
237
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
235
238
 
236
239
  /**
237
240
  * Whether this rule is mandatory
@@ -243,39 +246,49 @@ export interface RuleCreateResponse {
243
246
  */
244
247
  loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
245
248
 
249
+ /**
250
+ * URL of the media to be displayed
251
+ */
252
+ mediaUrl?: string | null;
253
+
246
254
  /**
247
255
  * Blockchain network where the rule will apply
248
256
  */
249
257
  network?:
250
- | 'mainnet'
251
- | 'polygon'
252
- | 'polygon_mumbai'
253
- | 'optimism'
258
+ | 'apechain'
254
259
  | 'arbitrum'
255
- | 'binance'
256
- | 'bscTestnet'
257
260
  | 'avalanche'
258
261
  | 'avalancheFuji'
259
- | 'zksync'
260
- | 'fantom'
261
- | 'fantomTestnet'
262
262
  | 'base'
263
263
  | 'baseSepolia'
264
- | 'skaleNebula'
265
- | 'xai'
266
264
  | 'berachainArtio'
267
- | 'solana'
268
- | 'apechain'
269
- | 'flowMainnet'
265
+ | 'binance'
266
+ | 'bscTestnet'
270
267
  | 'campTestnet'
268
+ | 'fantom'
269
+ | 'fantomTestnet'
270
+ | 'flowMainnet'
271
+ | 'mainnet'
272
+ | 'optimism'
273
+ | 'polygon'
274
+ | 'polygon_mumbai'
275
+ | 'skaleNebula'
276
+ | 'solana'
277
+ | 'sophon'
271
278
  | 'sui'
279
+ | 'superseed'
280
+ | 'superseedSepolia'
272
281
  | 'vanar'
282
+ | 'xai'
283
+ | 'zksync'
273
284
  | 'sepolia'
274
285
  | 'optimism_sepolia'
275
286
  | 'arbitrumSepolia'
276
287
  | 'goerli'
277
288
  | 'optimism_goerli'
278
- | 'arbitrumGoerli';
289
+ | 'arbitrumGoerli'
290
+ | 'basecamp'
291
+ | 'abstract';
279
292
 
280
293
  /**
281
294
  * OAuth credentials associated with the rule
@@ -328,6 +341,11 @@ export namespace RuleCreateResponse {
328
341
  */
329
342
  collection?: Array<Metadata.Collection>;
330
343
 
344
+ /**
345
+ * Conditions for completing the profile.
346
+ */
347
+ completeProfileConditions?: Record<string, boolean> | null;
348
+
331
349
  /**
332
350
  * Object containing details for the call-to-action.
333
351
  */
@@ -363,16 +381,31 @@ export namespace RuleCreateResponse {
363
381
  */
364
382
  enableVerifiedMultiplier?: boolean;
365
383
 
384
+ /**
385
+ * Fill source of the order for the token sale
386
+ */
387
+ fillSource?: string;
388
+
366
389
  /**
367
390
  * Percentage reward given to a user for their first referral.
368
391
  */
369
392
  firstReferralReward?: number | null;
370
393
 
394
+ /**
395
+ * Flag indicating whether the fill source is included.
396
+ */
397
+ hasFillSource?: boolean;
398
+
371
399
  /**
372
400
  * Indicates if the item has never been sold.
373
401
  */
374
402
  hasNeverSold?: boolean;
375
403
 
404
+ /**
405
+ * Flag indicating whether the order source is included.
406
+ */
407
+ hasOrderSource?: boolean;
408
+
376
409
  /**
377
410
  * Indicates if the full royalty has been paid for items.
378
411
  */
@@ -443,11 +476,21 @@ export namespace RuleCreateResponse {
443
476
  */
444
477
  onlyNonListed?: boolean;
445
478
 
479
+ /**
480
+ * Indicates if only existing users are rewarded.
481
+ */
482
+ onlyRewardExistingUser?: boolean;
483
+
446
484
  /**
447
485
  * give points for only one token ownership per contract
448
486
  */
449
487
  onlyRewardSingleTokenOwnership?: boolean | null;
450
488
 
489
+ /**
490
+ * Order source of the order for the token sale
491
+ */
492
+ orderSource?: string;
493
+
451
494
  /**
452
495
  * Promotional code associated with the rule.
453
496
  */
@@ -606,35 +649,40 @@ export namespace RuleCreateResponse {
606
649
  * Blockchain network of the collection.
607
650
  */
608
651
  network?:
609
- | 'mainnet'
610
- | 'polygon'
611
- | 'polygon_mumbai'
612
- | 'optimism'
652
+ | 'apechain'
613
653
  | 'arbitrum'
614
- | 'binance'
615
- | 'bscTestnet'
616
654
  | 'avalanche'
617
655
  | 'avalancheFuji'
618
- | 'zksync'
619
- | 'fantom'
620
- | 'fantomTestnet'
621
656
  | 'base'
622
657
  | 'baseSepolia'
623
- | 'skaleNebula'
624
- | 'xai'
625
658
  | 'berachainArtio'
626
- | 'solana'
627
- | 'apechain'
628
- | 'flowMainnet'
659
+ | 'binance'
660
+ | 'bscTestnet'
629
661
  | 'campTestnet'
662
+ | 'fantom'
663
+ | 'fantomTestnet'
664
+ | 'flowMainnet'
665
+ | 'mainnet'
666
+ | 'optimism'
667
+ | 'polygon'
668
+ | 'polygon_mumbai'
669
+ | 'skaleNebula'
670
+ | 'solana'
671
+ | 'sophon'
630
672
  | 'sui'
673
+ | 'superseed'
674
+ | 'superseedSepolia'
631
675
  | 'vanar'
676
+ | 'xai'
677
+ | 'zksync'
632
678
  | 'sepolia'
633
679
  | 'optimism_sepolia'
634
680
  | 'arbitrumSepolia'
635
681
  | 'goerli'
636
682
  | 'optimism_goerli'
637
- | 'arbitrumGoerli';
683
+ | 'arbitrumGoerli'
684
+ | 'basecamp'
685
+ | 'abstract';
638
686
  }
639
687
 
640
688
  /**
@@ -920,35 +968,40 @@ export namespace RuleCreateResponse {
920
968
  * Blockchain network for the collection
921
969
  */
922
970
  network:
923
- | 'mainnet'
924
- | 'polygon'
925
- | 'polygon_mumbai'
926
- | 'optimism'
971
+ | 'apechain'
927
972
  | 'arbitrum'
928
- | 'binance'
929
- | 'bscTestnet'
930
973
  | 'avalanche'
931
974
  | 'avalancheFuji'
932
- | 'zksync'
933
- | 'fantom'
934
- | 'fantomTestnet'
935
975
  | 'base'
936
976
  | 'baseSepolia'
937
- | 'skaleNebula'
938
- | 'xai'
939
977
  | 'berachainArtio'
940
- | 'solana'
941
- | 'apechain'
942
- | 'flowMainnet'
978
+ | 'binance'
979
+ | 'bscTestnet'
943
980
  | 'campTestnet'
981
+ | 'fantom'
982
+ | 'fantomTestnet'
983
+ | 'flowMainnet'
984
+ | 'mainnet'
985
+ | 'optimism'
986
+ | 'polygon'
987
+ | 'polygon_mumbai'
988
+ | 'skaleNebula'
989
+ | 'solana'
990
+ | 'sophon'
944
991
  | 'sui'
992
+ | 'superseed'
993
+ | 'superseedSepolia'
945
994
  | 'vanar'
995
+ | 'xai'
996
+ | 'zksync'
946
997
  | 'sepolia'
947
998
  | 'optimism_sepolia'
948
999
  | 'arbitrumSepolia'
949
1000
  | 'goerli'
950
1001
  | 'optimism_goerli'
951
- | 'arbitrumGoerli';
1002
+ | 'arbitrumGoerli'
1003
+ | 'basecamp'
1004
+ | 'abstract';
952
1005
  }
953
1006
  }
954
1007
 
@@ -1018,7 +1071,7 @@ export interface RuleUpdateResponse {
1018
1071
  /**
1019
1072
  * Time interval for recurring rule execution
1020
1073
  */
1021
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
1074
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
1022
1075
 
1023
1076
  /**
1024
1077
  * Whether this rule is required for participation
@@ -1030,6 +1083,11 @@ export interface RuleUpdateResponse {
1030
1083
  */
1031
1084
  loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
1032
1085
 
1086
+ /**
1087
+ * URL of the media to be displayed
1088
+ */
1089
+ mediaUrl?: string | null;
1090
+
1033
1091
  /**
1034
1092
  * Additional metadata for the loyalty rule
1035
1093
  */
@@ -1039,35 +1097,40 @@ export interface RuleUpdateResponse {
1039
1097
  * Blockchain network where the rule will apply
1040
1098
  */
1041
1099
  network?:
1042
- | 'mainnet'
1043
- | 'polygon'
1044
- | 'polygon_mumbai'
1045
- | 'optimism'
1100
+ | 'apechain'
1046
1101
  | 'arbitrum'
1047
- | 'binance'
1048
- | 'bscTestnet'
1049
1102
  | 'avalanche'
1050
1103
  | 'avalancheFuji'
1051
- | 'zksync'
1052
- | 'fantom'
1053
- | 'fantomTestnet'
1054
1104
  | 'base'
1055
1105
  | 'baseSepolia'
1056
- | 'skaleNebula'
1057
- | 'xai'
1058
1106
  | 'berachainArtio'
1059
- | 'solana'
1060
- | 'apechain'
1061
- | 'flowMainnet'
1107
+ | 'binance'
1108
+ | 'bscTestnet'
1062
1109
  | 'campTestnet'
1110
+ | 'fantom'
1111
+ | 'fantomTestnet'
1112
+ | 'flowMainnet'
1113
+ | 'mainnet'
1114
+ | 'optimism'
1115
+ | 'polygon'
1116
+ | 'polygon_mumbai'
1117
+ | 'skaleNebula'
1118
+ | 'solana'
1119
+ | 'sophon'
1063
1120
  | 'sui'
1121
+ | 'superseed'
1122
+ | 'superseedSepolia'
1064
1123
  | 'vanar'
1124
+ | 'xai'
1125
+ | 'zksync'
1065
1126
  | 'sepolia'
1066
1127
  | 'optimism_sepolia'
1067
1128
  | 'arbitrumSepolia'
1068
1129
  | 'goerli'
1069
1130
  | 'optimism_goerli'
1070
- | 'arbitrumGoerli';
1131
+ | 'arbitrumGoerli'
1132
+ | 'basecamp'
1133
+ | 'abstract';
1071
1134
 
1072
1135
  /**
1073
1136
  * ID for associated OAuth credentials
@@ -1101,35 +1164,40 @@ export namespace RuleUpdateResponse {
1101
1164
  * Blockchain network for the collection
1102
1165
  */
1103
1166
  network:
1104
- | 'mainnet'
1105
- | 'polygon'
1106
- | 'polygon_mumbai'
1107
- | 'optimism'
1167
+ | 'apechain'
1108
1168
  | 'arbitrum'
1109
- | 'binance'
1110
- | 'bscTestnet'
1111
1169
  | 'avalanche'
1112
1170
  | 'avalancheFuji'
1113
- | 'zksync'
1114
- | 'fantom'
1115
- | 'fantomTestnet'
1116
1171
  | 'base'
1117
1172
  | 'baseSepolia'
1118
- | 'skaleNebula'
1119
- | 'xai'
1120
1173
  | 'berachainArtio'
1121
- | 'solana'
1122
- | 'apechain'
1123
- | 'flowMainnet'
1174
+ | 'binance'
1175
+ | 'bscTestnet'
1124
1176
  | 'campTestnet'
1177
+ | 'fantom'
1178
+ | 'fantomTestnet'
1179
+ | 'flowMainnet'
1180
+ | 'mainnet'
1181
+ | 'optimism'
1182
+ | 'polygon'
1183
+ | 'polygon_mumbai'
1184
+ | 'skaleNebula'
1185
+ | 'solana'
1186
+ | 'sophon'
1125
1187
  | 'sui'
1188
+ | 'superseed'
1189
+ | 'superseedSepolia'
1126
1190
  | 'vanar'
1191
+ | 'xai'
1192
+ | 'zksync'
1127
1193
  | 'sepolia'
1128
1194
  | 'optimism_sepolia'
1129
1195
  | 'arbitrumSepolia'
1130
1196
  | 'goerli'
1131
1197
  | 'optimism_goerli'
1132
- | 'arbitrumGoerli';
1198
+ | 'arbitrumGoerli'
1199
+ | 'basecamp'
1200
+ | 'abstract';
1133
1201
  }
1134
1202
 
1135
1203
  /**
@@ -1166,6 +1234,11 @@ export namespace RuleUpdateResponse {
1166
1234
  */
1167
1235
  collection?: Array<Metadata.Collection>;
1168
1236
 
1237
+ /**
1238
+ * Conditions for completing the profile.
1239
+ */
1240
+ completeProfileConditions?: Record<string, boolean> | null;
1241
+
1169
1242
  /**
1170
1243
  * Object containing details for the call-to-action.
1171
1244
  */
@@ -1201,16 +1274,31 @@ export namespace RuleUpdateResponse {
1201
1274
  */
1202
1275
  enableVerifiedMultiplier?: boolean;
1203
1276
 
1277
+ /**
1278
+ * Fill source of the order for the token sale
1279
+ */
1280
+ fillSource?: string;
1281
+
1204
1282
  /**
1205
1283
  * Percentage reward given to a user for their first referral.
1206
1284
  */
1207
1285
  firstReferralReward?: number | null;
1208
1286
 
1287
+ /**
1288
+ * Flag indicating whether the fill source is included.
1289
+ */
1290
+ hasFillSource?: boolean;
1291
+
1209
1292
  /**
1210
1293
  * Indicates if the item has never been sold.
1211
1294
  */
1212
1295
  hasNeverSold?: boolean;
1213
1296
 
1297
+ /**
1298
+ * Flag indicating whether the order source is included.
1299
+ */
1300
+ hasOrderSource?: boolean;
1301
+
1214
1302
  /**
1215
1303
  * Indicates if the full royalty has been paid for items.
1216
1304
  */
@@ -1281,11 +1369,21 @@ export namespace RuleUpdateResponse {
1281
1369
  */
1282
1370
  onlyNonListed?: boolean;
1283
1371
 
1372
+ /**
1373
+ * Indicates if only existing users are rewarded.
1374
+ */
1375
+ onlyRewardExistingUser?: boolean;
1376
+
1284
1377
  /**
1285
1378
  * give points for only one token ownership per contract
1286
1379
  */
1287
1380
  onlyRewardSingleTokenOwnership?: boolean | null;
1288
1381
 
1382
+ /**
1383
+ * Order source of the order for the token sale
1384
+ */
1385
+ orderSource?: string;
1386
+
1289
1387
  /**
1290
1388
  * Promotional code associated with the rule.
1291
1389
  */
@@ -1444,35 +1542,40 @@ export namespace RuleUpdateResponse {
1444
1542
  * Blockchain network of the collection.
1445
1543
  */
1446
1544
  network?:
1447
- | 'mainnet'
1448
- | 'polygon'
1449
- | 'polygon_mumbai'
1450
- | 'optimism'
1545
+ | 'apechain'
1451
1546
  | 'arbitrum'
1452
- | 'binance'
1453
- | 'bscTestnet'
1454
1547
  | 'avalanche'
1455
1548
  | 'avalancheFuji'
1456
- | 'zksync'
1457
- | 'fantom'
1458
- | 'fantomTestnet'
1459
1549
  | 'base'
1460
1550
  | 'baseSepolia'
1461
- | 'skaleNebula'
1462
- | 'xai'
1463
1551
  | 'berachainArtio'
1464
- | 'solana'
1465
- | 'apechain'
1466
- | 'flowMainnet'
1552
+ | 'binance'
1553
+ | 'bscTestnet'
1467
1554
  | 'campTestnet'
1555
+ | 'fantom'
1556
+ | 'fantomTestnet'
1557
+ | 'flowMainnet'
1558
+ | 'mainnet'
1559
+ | 'optimism'
1560
+ | 'polygon'
1561
+ | 'polygon_mumbai'
1562
+ | 'skaleNebula'
1563
+ | 'solana'
1564
+ | 'sophon'
1468
1565
  | 'sui'
1566
+ | 'superseed'
1567
+ | 'superseedSepolia'
1469
1568
  | 'vanar'
1569
+ | 'xai'
1570
+ | 'zksync'
1470
1571
  | 'sepolia'
1471
1572
  | 'optimism_sepolia'
1472
1573
  | 'arbitrumSepolia'
1473
1574
  | 'goerli'
1474
1575
  | 'optimism_goerli'
1475
- | 'arbitrumGoerli';
1576
+ | 'arbitrumGoerli'
1577
+ | 'basecamp'
1578
+ | 'abstract';
1476
1579
  }
1477
1580
 
1478
1581
  /**
@@ -1827,11 +1930,11 @@ export interface RuleCompleteResponse {
1827
1930
  message: string;
1828
1931
  }
1829
1932
 
1830
- export interface RuleStatusResponse {
1831
- data: Array<RuleStatusResponse.Data>;
1933
+ export interface RuleGetStatusResponse {
1934
+ data: Array<RuleGetStatusResponse.Data>;
1832
1935
  }
1833
1936
 
1834
- export namespace RuleStatusResponse {
1937
+ export namespace RuleGetStatusResponse {
1835
1938
  export interface Data {
1836
1939
  loyaltyRuleId: string;
1837
1940
 
@@ -1995,7 +2098,7 @@ export interface RuleCreateParams {
1995
2098
  /**
1996
2099
  * Interval between rule executions
1997
2100
  */
1998
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
2101
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
1999
2102
 
2000
2103
  /**
2001
2104
  * Whether this rule is mandatory
@@ -2007,39 +2110,49 @@ export interface RuleCreateParams {
2007
2110
  */
2008
2111
  loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
2009
2112
 
2113
+ /**
2114
+ * URL of the media to be displayed
2115
+ */
2116
+ mediaUrl?: string | null;
2117
+
2010
2118
  /**
2011
2119
  * Blockchain network where the rule will apply
2012
2120
  */
2013
2121
  network?:
2014
- | 'mainnet'
2015
- | 'polygon'
2016
- | 'polygon_mumbai'
2017
- | 'optimism'
2122
+ | 'apechain'
2018
2123
  | 'arbitrum'
2019
- | 'binance'
2020
- | 'bscTestnet'
2021
2124
  | 'avalanche'
2022
2125
  | 'avalancheFuji'
2023
- | 'zksync'
2024
- | 'fantom'
2025
- | 'fantomTestnet'
2026
2126
  | 'base'
2027
2127
  | 'baseSepolia'
2028
- | 'skaleNebula'
2029
- | 'xai'
2030
2128
  | 'berachainArtio'
2031
- | 'solana'
2032
- | 'apechain'
2033
- | 'flowMainnet'
2129
+ | 'binance'
2130
+ | 'bscTestnet'
2034
2131
  | 'campTestnet'
2132
+ | 'fantom'
2133
+ | 'fantomTestnet'
2134
+ | 'flowMainnet'
2135
+ | 'mainnet'
2136
+ | 'optimism'
2137
+ | 'polygon'
2138
+ | 'polygon_mumbai'
2139
+ | 'skaleNebula'
2140
+ | 'solana'
2141
+ | 'sophon'
2035
2142
  | 'sui'
2143
+ | 'superseed'
2144
+ | 'superseedSepolia'
2036
2145
  | 'vanar'
2146
+ | 'xai'
2147
+ | 'zksync'
2037
2148
  | 'sepolia'
2038
2149
  | 'optimism_sepolia'
2039
2150
  | 'arbitrumSepolia'
2040
2151
  | 'goerli'
2041
2152
  | 'optimism_goerli'
2042
- | 'arbitrumGoerli';
2153
+ | 'arbitrumGoerli'
2154
+ | 'basecamp'
2155
+ | 'abstract';
2043
2156
 
2044
2157
  /**
2045
2158
  * OAuth credentials associated with the rule
@@ -2092,6 +2205,11 @@ export namespace RuleCreateParams {
2092
2205
  */
2093
2206
  collection?: Array<Metadata.Collection>;
2094
2207
 
2208
+ /**
2209
+ * Conditions for completing the profile.
2210
+ */
2211
+ completeProfileConditions?: Record<string, boolean> | null;
2212
+
2095
2213
  /**
2096
2214
  * Object containing details for the call-to-action.
2097
2215
  */
@@ -2127,16 +2245,31 @@ export namespace RuleCreateParams {
2127
2245
  */
2128
2246
  enableVerifiedMultiplier?: boolean;
2129
2247
 
2248
+ /**
2249
+ * Fill source of the order for the token sale
2250
+ */
2251
+ fillSource?: string;
2252
+
2130
2253
  /**
2131
2254
  * Percentage reward given to a user for their first referral.
2132
2255
  */
2133
2256
  firstReferralReward?: number | null;
2134
2257
 
2258
+ /**
2259
+ * Flag indicating whether the fill source is included.
2260
+ */
2261
+ hasFillSource?: boolean;
2262
+
2135
2263
  /**
2136
2264
  * Indicates if the item has never been sold.
2137
2265
  */
2138
2266
  hasNeverSold?: boolean;
2139
2267
 
2268
+ /**
2269
+ * Flag indicating whether the order source is included.
2270
+ */
2271
+ hasOrderSource?: boolean;
2272
+
2140
2273
  /**
2141
2274
  * Indicates if the full royalty has been paid for items.
2142
2275
  */
@@ -2207,11 +2340,21 @@ export namespace RuleCreateParams {
2207
2340
  */
2208
2341
  onlyNonListed?: boolean;
2209
2342
 
2343
+ /**
2344
+ * Indicates if only existing users are rewarded.
2345
+ */
2346
+ onlyRewardExistingUser?: boolean;
2347
+
2210
2348
  /**
2211
2349
  * give points for only one token ownership per contract
2212
2350
  */
2213
2351
  onlyRewardSingleTokenOwnership?: boolean | null;
2214
2352
 
2353
+ /**
2354
+ * Order source of the order for the token sale
2355
+ */
2356
+ orderSource?: string;
2357
+
2215
2358
  /**
2216
2359
  * Promotional code associated with the rule.
2217
2360
  */
@@ -2370,35 +2513,40 @@ export namespace RuleCreateParams {
2370
2513
  * Blockchain network of the collection.
2371
2514
  */
2372
2515
  network?:
2373
- | 'mainnet'
2374
- | 'polygon'
2375
- | 'polygon_mumbai'
2376
- | 'optimism'
2516
+ | 'apechain'
2377
2517
  | 'arbitrum'
2378
- | 'binance'
2379
- | 'bscTestnet'
2380
2518
  | 'avalanche'
2381
2519
  | 'avalancheFuji'
2382
- | 'zksync'
2383
- | 'fantom'
2384
- | 'fantomTestnet'
2385
2520
  | 'base'
2386
2521
  | 'baseSepolia'
2387
- | 'skaleNebula'
2388
- | 'xai'
2389
2522
  | 'berachainArtio'
2390
- | 'solana'
2391
- | 'apechain'
2392
- | 'flowMainnet'
2523
+ | 'binance'
2524
+ | 'bscTestnet'
2393
2525
  | 'campTestnet'
2526
+ | 'fantom'
2527
+ | 'fantomTestnet'
2528
+ | 'flowMainnet'
2529
+ | 'mainnet'
2530
+ | 'optimism'
2531
+ | 'polygon'
2532
+ | 'polygon_mumbai'
2533
+ | 'skaleNebula'
2534
+ | 'solana'
2535
+ | 'sophon'
2394
2536
  | 'sui'
2537
+ | 'superseed'
2538
+ | 'superseedSepolia'
2395
2539
  | 'vanar'
2540
+ | 'xai'
2541
+ | 'zksync'
2396
2542
  | 'sepolia'
2397
2543
  | 'optimism_sepolia'
2398
2544
  | 'arbitrumSepolia'
2399
2545
  | 'goerli'
2400
2546
  | 'optimism_goerli'
2401
- | 'arbitrumGoerli';
2547
+ | 'arbitrumGoerli'
2548
+ | 'basecamp'
2549
+ | 'abstract';
2402
2550
  }
2403
2551
 
2404
2552
  /**
@@ -2684,35 +2832,40 @@ export namespace RuleCreateParams {
2684
2832
  * Blockchain network for the collection
2685
2833
  */
2686
2834
  network:
2687
- | 'mainnet'
2688
- | 'polygon'
2689
- | 'polygon_mumbai'
2690
- | 'optimism'
2835
+ | 'apechain'
2691
2836
  | 'arbitrum'
2692
- | 'binance'
2693
- | 'bscTestnet'
2694
2837
  | 'avalanche'
2695
2838
  | 'avalancheFuji'
2696
- | 'zksync'
2697
- | 'fantom'
2698
- | 'fantomTestnet'
2699
2839
  | 'base'
2700
2840
  | 'baseSepolia'
2701
- | 'skaleNebula'
2702
- | 'xai'
2703
2841
  | 'berachainArtio'
2704
- | 'solana'
2705
- | 'apechain'
2706
- | 'flowMainnet'
2842
+ | 'binance'
2843
+ | 'bscTestnet'
2707
2844
  | 'campTestnet'
2845
+ | 'fantom'
2846
+ | 'fantomTestnet'
2847
+ | 'flowMainnet'
2848
+ | 'mainnet'
2849
+ | 'optimism'
2850
+ | 'polygon'
2851
+ | 'polygon_mumbai'
2852
+ | 'skaleNebula'
2853
+ | 'solana'
2854
+ | 'sophon'
2708
2855
  | 'sui'
2856
+ | 'superseed'
2857
+ | 'superseedSepolia'
2709
2858
  | 'vanar'
2859
+ | 'xai'
2860
+ | 'zksync'
2710
2861
  | 'sepolia'
2711
2862
  | 'optimism_sepolia'
2712
2863
  | 'arbitrumSepolia'
2713
2864
  | 'goerli'
2714
2865
  | 'optimism_goerli'
2715
- | 'arbitrumGoerli';
2866
+ | 'arbitrumGoerli'
2867
+ | 'basecamp'
2868
+ | 'abstract';
2716
2869
  }
2717
2870
  }
2718
2871
 
@@ -2780,7 +2933,7 @@ export interface RuleUpdateParams {
2780
2933
  /**
2781
2934
  * Time interval for recurring rule execution
2782
2935
  */
2783
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | null;
2936
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
2784
2937
 
2785
2938
  /**
2786
2939
  * Whether this rule is required for participation
@@ -2792,6 +2945,11 @@ export interface RuleUpdateParams {
2792
2945
  */
2793
2946
  loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
2794
2947
 
2948
+ /**
2949
+ * URL of the media to be displayed
2950
+ */
2951
+ mediaUrl?: string | null;
2952
+
2795
2953
  /**
2796
2954
  * Additional metadata for the loyalty rule
2797
2955
  */
@@ -2801,35 +2959,40 @@ export interface RuleUpdateParams {
2801
2959
  * Blockchain network where the rule will apply
2802
2960
  */
2803
2961
  network?:
2804
- | 'mainnet'
2805
- | 'polygon'
2806
- | 'polygon_mumbai'
2807
- | 'optimism'
2962
+ | 'apechain'
2808
2963
  | 'arbitrum'
2809
- | 'binance'
2810
- | 'bscTestnet'
2811
2964
  | 'avalanche'
2812
2965
  | 'avalancheFuji'
2813
- | 'zksync'
2814
- | 'fantom'
2815
- | 'fantomTestnet'
2816
2966
  | 'base'
2817
2967
  | 'baseSepolia'
2818
- | 'skaleNebula'
2819
- | 'xai'
2820
2968
  | 'berachainArtio'
2821
- | 'solana'
2822
- | 'apechain'
2823
- | 'flowMainnet'
2969
+ | 'binance'
2970
+ | 'bscTestnet'
2824
2971
  | 'campTestnet'
2972
+ | 'fantom'
2973
+ | 'fantomTestnet'
2974
+ | 'flowMainnet'
2975
+ | 'mainnet'
2976
+ | 'optimism'
2977
+ | 'polygon'
2978
+ | 'polygon_mumbai'
2979
+ | 'skaleNebula'
2980
+ | 'solana'
2981
+ | 'sophon'
2825
2982
  | 'sui'
2983
+ | 'superseed'
2984
+ | 'superseedSepolia'
2826
2985
  | 'vanar'
2986
+ | 'xai'
2987
+ | 'zksync'
2827
2988
  | 'sepolia'
2828
2989
  | 'optimism_sepolia'
2829
2990
  | 'arbitrumSepolia'
2830
2991
  | 'goerli'
2831
2992
  | 'optimism_goerli'
2832
- | 'arbitrumGoerli';
2993
+ | 'arbitrumGoerli'
2994
+ | 'basecamp'
2995
+ | 'abstract';
2833
2996
 
2834
2997
  /**
2835
2998
  * ID for associated OAuth credentials
@@ -2863,35 +3026,40 @@ export namespace RuleUpdateParams {
2863
3026
  * Blockchain network for the collection
2864
3027
  */
2865
3028
  network:
2866
- | 'mainnet'
2867
- | 'polygon'
2868
- | 'polygon_mumbai'
2869
- | 'optimism'
3029
+ | 'apechain'
2870
3030
  | 'arbitrum'
2871
- | 'binance'
2872
- | 'bscTestnet'
2873
3031
  | 'avalanche'
2874
3032
  | 'avalancheFuji'
2875
- | 'zksync'
2876
- | 'fantom'
2877
- | 'fantomTestnet'
2878
3033
  | 'base'
2879
3034
  | 'baseSepolia'
2880
- | 'skaleNebula'
2881
- | 'xai'
2882
3035
  | 'berachainArtio'
2883
- | 'solana'
2884
- | 'apechain'
2885
- | 'flowMainnet'
3036
+ | 'binance'
3037
+ | 'bscTestnet'
2886
3038
  | 'campTestnet'
3039
+ | 'fantom'
3040
+ | 'fantomTestnet'
3041
+ | 'flowMainnet'
3042
+ | 'mainnet'
3043
+ | 'optimism'
3044
+ | 'polygon'
3045
+ | 'polygon_mumbai'
3046
+ | 'skaleNebula'
3047
+ | 'solana'
3048
+ | 'sophon'
2887
3049
  | 'sui'
3050
+ | 'superseed'
3051
+ | 'superseedSepolia'
2888
3052
  | 'vanar'
3053
+ | 'xai'
3054
+ | 'zksync'
2889
3055
  | 'sepolia'
2890
3056
  | 'optimism_sepolia'
2891
3057
  | 'arbitrumSepolia'
2892
3058
  | 'goerli'
2893
3059
  | 'optimism_goerli'
2894
- | 'arbitrumGoerli';
3060
+ | 'arbitrumGoerli'
3061
+ | 'basecamp'
3062
+ | 'abstract';
2895
3063
  }
2896
3064
 
2897
3065
  /**
@@ -2928,6 +3096,11 @@ export namespace RuleUpdateParams {
2928
3096
  */
2929
3097
  collection?: Array<Metadata.Collection>;
2930
3098
 
3099
+ /**
3100
+ * Conditions for completing the profile.
3101
+ */
3102
+ completeProfileConditions?: Record<string, boolean> | null;
3103
+
2931
3104
  /**
2932
3105
  * Object containing details for the call-to-action.
2933
3106
  */
@@ -2963,16 +3136,31 @@ export namespace RuleUpdateParams {
2963
3136
  */
2964
3137
  enableVerifiedMultiplier?: boolean;
2965
3138
 
3139
+ /**
3140
+ * Fill source of the order for the token sale
3141
+ */
3142
+ fillSource?: string;
3143
+
2966
3144
  /**
2967
3145
  * Percentage reward given to a user for their first referral.
2968
3146
  */
2969
3147
  firstReferralReward?: number | null;
2970
3148
 
3149
+ /**
3150
+ * Flag indicating whether the fill source is included.
3151
+ */
3152
+ hasFillSource?: boolean;
3153
+
2971
3154
  /**
2972
3155
  * Indicates if the item has never been sold.
2973
3156
  */
2974
3157
  hasNeverSold?: boolean;
2975
3158
 
3159
+ /**
3160
+ * Flag indicating whether the order source is included.
3161
+ */
3162
+ hasOrderSource?: boolean;
3163
+
2976
3164
  /**
2977
3165
  * Indicates if the full royalty has been paid for items.
2978
3166
  */
@@ -3043,11 +3231,21 @@ export namespace RuleUpdateParams {
3043
3231
  */
3044
3232
  onlyNonListed?: boolean;
3045
3233
 
3234
+ /**
3235
+ * Indicates if only existing users are rewarded.
3236
+ */
3237
+ onlyRewardExistingUser?: boolean;
3238
+
3046
3239
  /**
3047
3240
  * give points for only one token ownership per contract
3048
3241
  */
3049
3242
  onlyRewardSingleTokenOwnership?: boolean | null;
3050
3243
 
3244
+ /**
3245
+ * Order source of the order for the token sale
3246
+ */
3247
+ orderSource?: string;
3248
+
3051
3249
  /**
3052
3250
  * Promotional code associated with the rule.
3053
3251
  */
@@ -3206,35 +3404,40 @@ export namespace RuleUpdateParams {
3206
3404
  * Blockchain network of the collection.
3207
3405
  */
3208
3406
  network?:
3209
- | 'mainnet'
3210
- | 'polygon'
3211
- | 'polygon_mumbai'
3212
- | 'optimism'
3407
+ | 'apechain'
3213
3408
  | 'arbitrum'
3214
- | 'binance'
3215
- | 'bscTestnet'
3216
3409
  | 'avalanche'
3217
3410
  | 'avalancheFuji'
3218
- | 'zksync'
3219
- | 'fantom'
3220
- | 'fantomTestnet'
3221
3411
  | 'base'
3222
3412
  | 'baseSepolia'
3223
- | 'skaleNebula'
3224
- | 'xai'
3225
3413
  | 'berachainArtio'
3226
- | 'solana'
3227
- | 'apechain'
3228
- | 'flowMainnet'
3414
+ | 'binance'
3415
+ | 'bscTestnet'
3229
3416
  | 'campTestnet'
3417
+ | 'fantom'
3418
+ | 'fantomTestnet'
3419
+ | 'flowMainnet'
3420
+ | 'mainnet'
3421
+ | 'optimism'
3422
+ | 'polygon'
3423
+ | 'polygon_mumbai'
3424
+ | 'skaleNebula'
3425
+ | 'solana'
3426
+ | 'sophon'
3230
3427
  | 'sui'
3428
+ | 'superseed'
3429
+ | 'superseedSepolia'
3231
3430
  | 'vanar'
3431
+ | 'xai'
3432
+ | 'zksync'
3232
3433
  | 'sepolia'
3233
3434
  | 'optimism_sepolia'
3234
3435
  | 'arbitrumSepolia'
3235
3436
  | 'goerli'
3236
3437
  | 'optimism_goerli'
3237
- | 'arbitrumGoerli';
3438
+ | 'arbitrumGoerli'
3439
+ | 'basecamp'
3440
+ | 'abstract';
3238
3441
  }
3239
3442
 
3240
3443
  /**
@@ -3527,6 +3730,11 @@ export interface RuleListParams {
3527
3730
  */
3528
3731
  loyaltyRuleGroupId?: string;
3529
3732
 
3733
+ /**
3734
+ * The IDs of the loyalty rule
3735
+ */
3736
+ loyaltyRuleId?: string | Array<string>;
3737
+
3530
3738
  /**
3531
3739
  * Unique identifier for the organization to filter by
3532
3740
  */
@@ -3544,6 +3752,12 @@ export interface RuleListParams {
3544
3752
  }
3545
3753
 
3546
3754
  export interface RuleCompleteParams {
3755
+ /**
3756
+ * Override amount for the reward (rounded to nearest whole number). This will
3757
+ * override the rule amount and reward the integer passed.
3758
+ */
3759
+ amount?: number | null;
3760
+
3547
3761
  /**
3548
3762
  * Link to the comment made by user
3549
3763
  */
@@ -3576,7 +3790,7 @@ export interface RuleCompleteParams {
3576
3790
  walletAddress?: string;
3577
3791
  }
3578
3792
 
3579
- export interface RuleStatusParams {
3793
+ export interface RuleGetStatusParams {
3580
3794
  organizationId: string;
3581
3795
 
3582
3796
  websiteId: string;
@@ -3591,11 +3805,11 @@ export declare namespace Rules {
3591
3805
  type RuleListResponse as RuleListResponse,
3592
3806
  type RuleDeleteResponse as RuleDeleteResponse,
3593
3807
  type RuleCompleteResponse as RuleCompleteResponse,
3594
- type RuleStatusResponse as RuleStatusResponse,
3808
+ type RuleGetStatusResponse as RuleGetStatusResponse,
3595
3809
  type RuleCreateParams as RuleCreateParams,
3596
3810
  type RuleUpdateParams as RuleUpdateParams,
3597
3811
  type RuleListParams as RuleListParams,
3598
3812
  type RuleCompleteParams as RuleCompleteParams,
3599
- type RuleStatusParams as RuleStatusParams,
3813
+ type RuleGetStatusParams as RuleGetStatusParams,
3600
3814
  };
3601
3815
  }