@snagsolutions/sdk 0.1.0-alpha.15 → 0.1.0-alpha.151

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 (426) hide show
  1. package/CHANGELOG.md +1261 -45
  2. package/README.md +17 -29
  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 +26 -17
  9. package/core.js.map +1 -1
  10. package/core.mjs +27 -18
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +30 -6
  13. package/index.d.ts +30 -6
  14. package/index.d.ts.map +1 -1
  15. package/index.js +36 -11
  16. package/index.js.map +1 -1
  17. package/index.mjs +36 -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 +64 -0
  25. package/resources/assets.d.ts.map +1 -0
  26. package/resources/assets.js +25 -0
  27. package/resources/assets.js.map +1 -0
  28. package/resources/assets.mjs +21 -0
  29. package/resources/assets.mjs.map +1 -0
  30. package/resources/auctions/auctions.d.ts +285 -0
  31. package/resources/auctions/auctions.d.ts.map +1 -0
  32. package/resources/auctions/auctions.js +76 -0
  33. package/resources/auctions/auctions.js.map +1 -0
  34. package/resources/auctions/auctions.mjs +49 -0
  35. package/resources/auctions/auctions.mjs.map +1 -0
  36. package/resources/auctions/index.d.ts +3 -0
  37. package/resources/auctions/index.d.ts.map +1 -0
  38. package/resources/auctions/index.js +9 -0
  39. package/resources/auctions/index.js.map +1 -0
  40. package/resources/auctions/index.mjs +4 -0
  41. package/resources/auctions/index.mjs.map +1 -0
  42. package/resources/auctions/website-user-attributes/index.d.ts +3 -0
  43. package/resources/auctions/website-user-attributes/index.d.ts.map +1 -0
  44. package/resources/auctions/website-user-attributes/index.js +9 -0
  45. package/resources/auctions/website-user-attributes/index.js.map +1 -0
  46. package/resources/auctions/website-user-attributes/index.mjs +4 -0
  47. package/resources/auctions/website-user-attributes/index.mjs.map +1 -0
  48. package/resources/auctions/website-user-attributes/values.d.ts +122 -0
  49. package/resources/auctions/website-user-attributes/values.d.ts.map +1 -0
  50. package/resources/auctions/website-user-attributes/values.js +49 -0
  51. package/resources/auctions/website-user-attributes/values.js.map +1 -0
  52. package/resources/auctions/website-user-attributes/values.mjs +45 -0
  53. package/resources/auctions/website-user-attributes/values.mjs.map +1 -0
  54. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts +132 -0
  55. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts.map +1 -0
  56. package/resources/auctions/website-user-attributes/website-user-attributes.js +76 -0
  57. package/resources/auctions/website-user-attributes/website-user-attributes.js.map +1 -0
  58. package/resources/auctions/website-user-attributes/website-user-attributes.mjs +49 -0
  59. package/resources/auctions/website-user-attributes/website-user-attributes.mjs.map +1 -0
  60. package/resources/auctions/website-user-attributes.d.ts +2 -0
  61. package/resources/auctions/website-user-attributes.d.ts.map +1 -0
  62. package/resources/auctions/website-user-attributes.js +19 -0
  63. package/resources/auctions/website-user-attributes.js.map +1 -0
  64. package/resources/auctions/website-user-attributes.mjs +3 -0
  65. package/resources/auctions/website-user-attributes.mjs.map +1 -0
  66. package/resources/auctions.d.ts +2 -0
  67. package/resources/auctions.d.ts.map +1 -0
  68. package/resources/{api.js → auctions.js} +2 -2
  69. package/resources/auctions.js.map +1 -0
  70. package/resources/{api.mjs → auctions.mjs} +2 -2
  71. package/resources/auctions.mjs.map +1 -0
  72. package/resources/auth.d.ts +48 -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 +8 -1
  79. package/resources/index.d.ts.map +1 -1
  80. package/resources/index.js +17 -3
  81. package/resources/index.js.map +1 -1
  82. package/resources/index.mjs +8 -1
  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/{api/loyalty → loyalty}/accounts.d.ts +36 -27
  91. package/resources/loyalty/accounts.d.ts.map +1 -0
  92. package/resources/{api/loyalty → loyalty}/accounts.js +17 -4
  93. package/resources/loyalty/accounts.js.map +1 -0
  94. package/resources/loyalty/accounts.mjs +33 -0
  95. package/resources/loyalty/accounts.mjs.map +1 -0
  96. package/resources/{api/loyalty → loyalty}/badges.d.ts +474 -24
  97. package/resources/loyalty/badges.d.ts.map +1 -0
  98. package/resources/{api/loyalty → loyalty}/badges.js +21 -3
  99. package/resources/loyalty/badges.js.map +1 -0
  100. package/resources/{api/loyalty → loyalty}/badges.mjs +21 -3
  101. package/resources/loyalty/badges.mjs.map +1 -0
  102. package/resources/{api/loyalty → loyalty}/currencies.d.ts +27 -2
  103. package/resources/loyalty/currencies.d.ts.map +1 -0
  104. package/resources/loyalty/currencies.js +40 -0
  105. package/resources/loyalty/currencies.js.map +1 -0
  106. package/resources/loyalty/currencies.mjs +36 -0
  107. package/resources/loyalty/currencies.mjs.map +1 -0
  108. package/resources/{api/loyalty → loyalty}/index.d.ts +6 -3
  109. package/resources/loyalty/index.d.ts.map +1 -0
  110. package/resources/{api/loyalty → loyalty}/index.js +7 -1
  111. package/resources/loyalty/index.js.map +1 -0
  112. package/resources/{api/loyalty → loyalty}/index.mjs +4 -1
  113. package/resources/loyalty/index.mjs.map +1 -0
  114. package/resources/loyalty/loyalty.d.ts +50 -0
  115. package/resources/loyalty/loyalty.d.ts.map +1 -0
  116. package/resources/{api/loyalty → loyalty}/loyalty.js +13 -20
  117. package/resources/loyalty/loyalty.js.map +1 -0
  118. package/resources/{api/loyalty → loyalty}/loyalty.mjs +13 -20
  119. package/resources/loyalty/loyalty.mjs.map +1 -0
  120. package/resources/{api/loyalty → loyalty}/multipliers.d.ts +65 -4
  121. package/resources/loyalty/multipliers.d.ts.map +1 -0
  122. package/resources/{api/loyalty → loyalty}/multipliers.js +25 -2
  123. package/resources/loyalty/multipliers.js.map +1 -0
  124. package/resources/{api/loyalty → loyalty}/multipliers.mjs +25 -2
  125. package/resources/loyalty/multipliers.mjs.map +1 -0
  126. package/resources/{api/loyalty → loyalty}/questions-responses.d.ts +41 -2
  127. package/resources/loyalty/questions-responses.d.ts.map +1 -0
  128. package/resources/{api/loyalty → loyalty}/questions-responses.js +11 -2
  129. package/resources/loyalty/questions-responses.js.map +1 -0
  130. package/resources/{api/loyalty → loyalty}/questions-responses.mjs +11 -2
  131. package/resources/loyalty/questions-responses.mjs.map +1 -0
  132. package/resources/{api/loyalty → loyalty}/questions.d.ts +39 -4
  133. package/resources/loyalty/questions.d.ts.map +1 -0
  134. package/resources/loyalty/questions.js +58 -0
  135. package/resources/loyalty/questions.js.map +1 -0
  136. package/resources/loyalty/questions.mjs +54 -0
  137. package/resources/loyalty/questions.mjs.map +1 -0
  138. package/resources/loyalty/rule-edits.d.ts +2920 -0
  139. package/resources/loyalty/rule-edits.d.ts.map +1 -0
  140. package/resources/{api/loyalty → loyalty}/rule-edits.js +15 -1
  141. package/resources/loyalty/rule-edits.js.map +1 -0
  142. package/resources/{api/loyalty → loyalty}/rule-edits.mjs +15 -1
  143. package/resources/loyalty/rule-edits.mjs.map +1 -0
  144. package/resources/{api/loyalty/loyalty.d.ts → loyalty/rule-groups.d.ts} +280 -321
  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/{api/loyalty → loyalty}/rules.d.ts +1778 -239
  151. package/resources/loyalty/rules.d.ts.map +1 -0
  152. package/resources/loyalty/rules.js +77 -0
  153. package/resources/loyalty/rules.js.map +1 -0
  154. package/resources/loyalty/rules.mjs +73 -0
  155. package/resources/loyalty/rules.mjs.map +1 -0
  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.map +1 -0
  181. package/resources/loyalty.js.map +1 -0
  182. package/resources/loyalty.mjs.map +1 -0
  183. package/resources/{api/minting.d.ts → minting.d.ts} +7 -7
  184. package/resources/minting.d.ts.map +1 -0
  185. package/resources/{api/minting.js → minting.js} +1 -1
  186. package/resources/minting.js.map +1 -0
  187. package/resources/{api/minting.mjs → minting.mjs} +1 -1
  188. package/resources/minting.mjs.map +1 -0
  189. package/resources/referral/index.d.ts.map +1 -0
  190. package/resources/referral/index.js.map +1 -0
  191. package/resources/referral/index.mjs.map +1 -0
  192. package/resources/{api/referral → referral}/referral.d.ts +13 -5
  193. package/resources/referral/referral.d.ts.map +1 -0
  194. package/resources/{api/referral → referral}/referral.js +12 -6
  195. package/resources/referral/referral.js.map +1 -0
  196. package/resources/{api/referral → referral}/referral.mjs +12 -6
  197. package/resources/referral/referral.mjs.map +1 -0
  198. package/resources/{api/referral → referral}/users.d.ts +30 -3
  199. package/resources/referral/users.d.ts.map +1 -0
  200. package/resources/{api/referral → referral}/users.js +15 -1
  201. package/resources/referral/users.js.map +1 -0
  202. package/resources/{api/referral → referral}/users.mjs +15 -1
  203. package/resources/referral/users.mjs.map +1 -0
  204. package/resources/referral.d.ts.map +1 -0
  205. package/resources/referral.js.map +1 -0
  206. package/resources/referral.mjs.map +1 -0
  207. package/resources/users/index.d.ts +3 -0
  208. package/resources/users/index.d.ts.map +1 -0
  209. package/resources/users/index.js.map +1 -0
  210. package/resources/users/index.mjs.map +1 -0
  211. package/resources/{api/users → users}/metadatas.d.ts +34 -2
  212. package/resources/users/metadatas.d.ts.map +1 -0
  213. package/resources/{api/users → users}/metadatas.js +2 -2
  214. package/resources/users/metadatas.js.map +1 -0
  215. package/resources/{api/users → users}/metadatas.mjs +2 -2
  216. package/resources/users/metadatas.mjs.map +1 -0
  217. package/resources/users/users.d.ts +422 -0
  218. package/resources/users/users.d.ts.map +1 -0
  219. package/resources/{api/users → users}/users.js +61 -2
  220. package/resources/users/users.js.map +1 -0
  221. package/resources/users/users.mjs +89 -0
  222. package/resources/users/users.mjs.map +1 -0
  223. package/resources/users.d.ts.map +1 -0
  224. package/resources/users.js.map +1 -0
  225. package/resources/users.mjs.map +1 -0
  226. package/resources/websites/index.d.ts +4 -0
  227. package/resources/websites/index.d.ts.map +1 -0
  228. package/resources/websites/index.js +11 -0
  229. package/resources/websites/index.js.map +1 -0
  230. package/resources/{api → websites}/index.mjs +0 -5
  231. package/resources/websites/index.mjs.map +1 -0
  232. package/resources/{api → websites}/website-collections.d.ts +22 -1
  233. package/resources/websites/website-collections.d.ts.map +1 -0
  234. package/resources/{api → websites}/website-collections.js +21 -0
  235. package/resources/websites/website-collections.js.map +1 -0
  236. package/resources/websites/website-collections.mjs +42 -0
  237. package/resources/websites/website-collections.mjs.map +1 -0
  238. package/resources/{api → websites}/website-user-roles.d.ts +23 -0
  239. package/resources/websites/website-user-roles.d.ts.map +1 -0
  240. package/resources/{api → websites}/website-user-roles.js +23 -0
  241. package/resources/websites/website-user-roles.js.map +1 -0
  242. package/resources/websites/website-user-roles.mjs +41 -0
  243. package/resources/websites/website-user-roles.mjs.map +1 -0
  244. package/resources/{api → websites}/websites.d.ts +20 -0
  245. package/resources/websites/websites.d.ts.map +1 -0
  246. package/resources/websites/websites.js +63 -0
  247. package/resources/websites/websites.js.map +1 -0
  248. package/resources/websites/websites.mjs +36 -0
  249. package/resources/websites/websites.mjs.map +1 -0
  250. package/resources/websites.d.ts +2 -0
  251. package/resources/websites.d.ts.map +1 -0
  252. package/resources/websites.js +19 -0
  253. package/resources/websites.js.map +1 -0
  254. package/resources/websites.mjs +3 -0
  255. package/resources/websites.mjs.map +1 -0
  256. package/src/_shims/index.d.ts +2 -0
  257. package/src/_shims/index.js +5 -1
  258. package/src/_shims/index.mjs +5 -1
  259. package/src/core.ts +45 -17
  260. package/src/index.ts +126 -24
  261. package/src/resource.ts +1 -1
  262. package/src/resources/assets.ts +93 -0
  263. package/src/resources/auctions/auctions.ts +436 -0
  264. package/src/resources/auctions/index.ts +18 -0
  265. package/src/resources/auctions/website-user-attributes/index.ts +18 -0
  266. package/src/resources/auctions/website-user-attributes/values.ts +165 -0
  267. package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +207 -0
  268. package/src/resources/auctions/website-user-attributes.ts +3 -0
  269. package/src/resources/{api.ts → auctions.ts} +1 -1
  270. package/src/resources/auth.ts +79 -0
  271. package/src/resources/index.ts +37 -8
  272. package/src/resources/loyalty/account-streaks.ts +110 -0
  273. package/src/resources/{api/loyalty → loyalty}/accounts.ts +41 -35
  274. package/src/resources/{api/loyalty → loyalty}/badges.ts +570 -27
  275. package/src/resources/{api/loyalty → loyalty}/currencies.ts +27 -2
  276. package/src/resources/{api/loyalty → loyalty}/index.ts +28 -11
  277. package/src/resources/loyalty/loyalty.ts +259 -0
  278. package/src/resources/{api/loyalty → loyalty}/multipliers.ts +70 -7
  279. package/src/resources/{api/loyalty → loyalty}/questions-responses.ts +48 -3
  280. package/src/resources/{api/loyalty → loyalty}/questions.ts +40 -4
  281. package/src/resources/loyalty/rule-edits.ts +4008 -0
  282. package/src/resources/{api/loyalty/loyalty.ts → loyalty/rule-groups.ts} +443 -551
  283. package/src/resources/{api/loyalty → loyalty}/rules.ts +2927 -526
  284. package/src/resources/loyalty/transactions/index.ts +18 -0
  285. package/src/resources/loyalty/transactions/rule-statuses.ts +178 -0
  286. package/src/resources/loyalty/transactions/transactions.ts +677 -0
  287. package/src/resources/loyalty/transactions.ts +3 -0
  288. package/src/resources/{api/minting.ts → minting.ts} +37 -23
  289. package/src/resources/{api/referral → referral}/referral.ts +15 -13
  290. package/src/resources/{api/referral → referral}/users.ts +35 -4
  291. package/src/resources/{api/users → users}/index.ts +6 -0
  292. package/src/resources/{api/users → users}/metadatas.ts +62 -3
  293. package/src/resources/users/users.ts +603 -0
  294. package/src/resources/websites/index.ts +22 -0
  295. package/src/resources/{api → websites}/website-collections.ts +52 -17
  296. package/src/resources/{api → websites}/website-user-roles.ts +23 -0
  297. package/src/resources/{api → websites}/websites.ts +52 -0
  298. package/src/resources/websites.ts +3 -0
  299. package/src/version.ts +1 -1
  300. package/version.d.ts +1 -1
  301. package/version.d.ts.map +1 -1
  302. package/version.js +1 -1
  303. package/version.js.map +1 -1
  304. package/version.mjs +1 -1
  305. package/version.mjs.map +1 -1
  306. package/resources/api/api.d.ts +0 -365
  307. package/resources/api/api.d.ts.map +0 -1
  308. package/resources/api/api.js +0 -94
  309. package/resources/api/api.js.map +0 -1
  310. package/resources/api/api.mjs +0 -67
  311. package/resources/api/api.mjs.map +0 -1
  312. package/resources/api/index.d.ts +0 -9
  313. package/resources/api/index.d.ts.map +0 -1
  314. package/resources/api/index.js +0 -21
  315. package/resources/api/index.js.map +0 -1
  316. package/resources/api/index.mjs.map +0 -1
  317. package/resources/api/loyalty/accounts.d.ts.map +0 -1
  318. package/resources/api/loyalty/accounts.js.map +0 -1
  319. package/resources/api/loyalty/accounts.mjs +0 -20
  320. package/resources/api/loyalty/accounts.mjs.map +0 -1
  321. package/resources/api/loyalty/badges.d.ts.map +0 -1
  322. package/resources/api/loyalty/badges.js.map +0 -1
  323. package/resources/api/loyalty/badges.mjs.map +0 -1
  324. package/resources/api/loyalty/currencies.d.ts.map +0 -1
  325. package/resources/api/loyalty/currencies.js +0 -21
  326. package/resources/api/loyalty/currencies.js.map +0 -1
  327. package/resources/api/loyalty/currencies.mjs +0 -17
  328. package/resources/api/loyalty/currencies.mjs.map +0 -1
  329. package/resources/api/loyalty/index.d.ts.map +0 -1
  330. package/resources/api/loyalty/index.js.map +0 -1
  331. package/resources/api/loyalty/index.mjs.map +0 -1
  332. package/resources/api/loyalty/loyalty.d.ts.map +0 -1
  333. package/resources/api/loyalty/loyalty.js.map +0 -1
  334. package/resources/api/loyalty/loyalty.mjs.map +0 -1
  335. package/resources/api/loyalty/multipliers.d.ts.map +0 -1
  336. package/resources/api/loyalty/multipliers.js.map +0 -1
  337. package/resources/api/loyalty/multipliers.mjs.map +0 -1
  338. package/resources/api/loyalty/questions-responses.d.ts.map +0 -1
  339. package/resources/api/loyalty/questions-responses.js.map +0 -1
  340. package/resources/api/loyalty/questions-responses.mjs.map +0 -1
  341. package/resources/api/loyalty/questions.d.ts.map +0 -1
  342. package/resources/api/loyalty/questions.js +0 -27
  343. package/resources/api/loyalty/questions.js.map +0 -1
  344. package/resources/api/loyalty/questions.mjs +0 -23
  345. package/resources/api/loyalty/questions.mjs.map +0 -1
  346. package/resources/api/loyalty/rule-edits.d.ts +0 -330
  347. package/resources/api/loyalty/rule-edits.d.ts.map +0 -1
  348. package/resources/api/loyalty/rule-edits.js.map +0 -1
  349. package/resources/api/loyalty/rule-edits.mjs.map +0 -1
  350. package/resources/api/loyalty/rules.d.ts.map +0 -1
  351. package/resources/api/loyalty/rules.js +0 -46
  352. package/resources/api/loyalty/rules.js.map +0 -1
  353. package/resources/api/loyalty/rules.mjs +0 -42
  354. package/resources/api/loyalty/rules.mjs.map +0 -1
  355. package/resources/api/loyalty.d.ts.map +0 -1
  356. package/resources/api/loyalty.js.map +0 -1
  357. package/resources/api/loyalty.mjs.map +0 -1
  358. package/resources/api/minting.d.ts.map +0 -1
  359. package/resources/api/minting.js.map +0 -1
  360. package/resources/api/minting.mjs.map +0 -1
  361. package/resources/api/referral/index.d.ts.map +0 -1
  362. package/resources/api/referral/index.js.map +0 -1
  363. package/resources/api/referral/index.mjs.map +0 -1
  364. package/resources/api/referral/referral.d.ts.map +0 -1
  365. package/resources/api/referral/referral.js.map +0 -1
  366. package/resources/api/referral/referral.mjs.map +0 -1
  367. package/resources/api/referral/users.d.ts.map +0 -1
  368. package/resources/api/referral/users.js.map +0 -1
  369. package/resources/api/referral/users.mjs.map +0 -1
  370. package/resources/api/referral.d.ts.map +0 -1
  371. package/resources/api/referral.js.map +0 -1
  372. package/resources/api/referral.mjs.map +0 -1
  373. package/resources/api/users/index.d.ts +0 -3
  374. package/resources/api/users/index.d.ts.map +0 -1
  375. package/resources/api/users/index.js.map +0 -1
  376. package/resources/api/users/index.mjs.map +0 -1
  377. package/resources/api/users/metadatas.d.ts.map +0 -1
  378. package/resources/api/users/metadatas.js.map +0 -1
  379. package/resources/api/users/metadatas.mjs.map +0 -1
  380. package/resources/api/users/users.d.ts +0 -133
  381. package/resources/api/users/users.d.ts.map +0 -1
  382. package/resources/api/users/users.js.map +0 -1
  383. package/resources/api/users/users.mjs +0 -30
  384. package/resources/api/users/users.mjs.map +0 -1
  385. package/resources/api/users.d.ts.map +0 -1
  386. package/resources/api/users.js.map +0 -1
  387. package/resources/api/users.mjs.map +0 -1
  388. package/resources/api/website-collections.d.ts.map +0 -1
  389. package/resources/api/website-collections.js.map +0 -1
  390. package/resources/api/website-collections.mjs +0 -21
  391. package/resources/api/website-collections.mjs.map +0 -1
  392. package/resources/api/website-user-roles.d.ts.map +0 -1
  393. package/resources/api/website-user-roles.js.map +0 -1
  394. package/resources/api/website-user-roles.mjs +0 -18
  395. package/resources/api/website-user-roles.mjs.map +0 -1
  396. package/resources/api/websites.d.ts.map +0 -1
  397. package/resources/api/websites.js +0 -22
  398. package/resources/api/websites.js.map +0 -1
  399. package/resources/api/websites.mjs +0 -18
  400. package/resources/api/websites.mjs.map +0 -1
  401. package/resources/api.d.ts +0 -2
  402. package/resources/api.d.ts.map +0 -1
  403. package/resources/api.js.map +0 -1
  404. package/resources/api.mjs.map +0 -1
  405. package/src/resources/api/api.ts +0 -629
  406. package/src/resources/api/index.ts +0 -51
  407. package/src/resources/api/loyalty/rule-edits.ts +0 -418
  408. package/src/resources/api/users/users.ts +0 -203
  409. /package/resources/{api/loyalty.d.ts → loyalty.d.ts} +0 -0
  410. /package/resources/{api/loyalty.js → loyalty.js} +0 -0
  411. /package/resources/{api/loyalty.mjs → loyalty.mjs} +0 -0
  412. /package/resources/{api/referral → referral}/index.d.ts +0 -0
  413. /package/resources/{api/referral → referral}/index.js +0 -0
  414. /package/resources/{api/referral → referral}/index.mjs +0 -0
  415. /package/resources/{api/referral.d.ts → referral.d.ts} +0 -0
  416. /package/resources/{api/referral.js → referral.js} +0 -0
  417. /package/resources/{api/referral.mjs → referral.mjs} +0 -0
  418. /package/resources/{api/users → users}/index.js +0 -0
  419. /package/resources/{api/users → users}/index.mjs +0 -0
  420. /package/resources/{api/users.d.ts → users.d.ts} +0 -0
  421. /package/resources/{api/users.js → users.js} +0 -0
  422. /package/resources/{api/users.mjs → users.mjs} +0 -0
  423. /package/src/resources/{api/loyalty.ts → loyalty.ts} +0 -0
  424. /package/src/resources/{api/referral → referral}/index.ts +0 -0
  425. /package/src/resources/{api/referral.ts → referral.ts} +0 -0
  426. /package/src/resources/{api/users.ts → users.ts} +0 -0
@@ -1,69 +1,78 @@
1
- import { APIResource } from "../../../resource.js";
2
- import * as Core from "../../../core.js";
3
- import * as AccountsAPI from "./accounts.js";
4
- import { AccountGetRankParams, AccountGetRankResponse, AccountListParams, AccountListResponse, Accounts } from "./accounts.js";
5
- import * as BadgesAPI from "./badges.js";
6
- import { BadgeCreateParams, BadgeCreateResponse, BadgeDeleteResponse, BadgeListParams, BadgeListResponse, BadgeRevokeParams, BadgeRevokeResponse, BadgeRewardParams, BadgeRewardResponse, BadgeUpdateParams, BadgeUpdateResponse, Badges } from "./badges.js";
7
- import * as CurrenciesAPI from "./currencies.js";
8
- import { Currencies, CurrencyCreateParams, CurrencyCreateResponse, CurrencyListParams, CurrencyListResponse } from "./currencies.js";
9
- import * as MultipliersAPI from "./multipliers.js";
10
- import { MultiplierCreateParams, MultiplierCreateResponse, MultiplierDeleteByExternalIDParams, MultiplierDeleteByExternalIDResponse, MultiplierDeleteResponse, MultiplierListParams, MultiplierListResponse, MultiplierUpdateParams, MultiplierUpdateResponse, Multipliers } from "./multipliers.js";
11
- import * as QuestionsAPI from "./questions.js";
12
- import { QuestionCreateParams, QuestionCreateResponse, QuestionListParams, QuestionListResponse, QuestionUpdateParams, QuestionUpdateResponse, Questions } from "./questions.js";
13
- import * as QuestionsResponsesAPI from "./questions-responses.js";
14
- import { QuestionsResponseListParams, QuestionsResponseListResponse, QuestionsResponseSubmitParams, QuestionsResponseSubmitResponse, QuestionsResponses } from "./questions-responses.js";
15
- import * as RuleEditsAPI from "./rule-edits.js";
16
- import { RuleEditListParams, RuleEditListResponse, RuleEditRestoreParams, RuleEditRestoreResponse, RuleEdits } from "./rule-edits.js";
17
- import * as RulesAPI from "./rules.js";
18
- import { RuleCompleteParams, RuleCompleteResponse, RuleCreateParams, RuleCreateResponse, RuleDeleteResponse, RuleGetStatusParams, RuleGetStatusResponse, RuleListParams, RuleListResponse, RuleUpdateParams, RuleUpdateResponse, Rules } from "./rules.js";
19
- export declare class Loyalty extends APIResource {
20
- accounts: AccountsAPI.Accounts;
21
- badges: BadgesAPI.Badges;
22
- currencies: CurrenciesAPI.Currencies;
23
- multipliers: MultipliersAPI.Multipliers;
24
- ruleEdits: RuleEditsAPI.RuleEdits;
25
- rules: RulesAPI.Rules;
26
- questions: QuestionsAPI.Questions;
27
- questionsResponses: QuestionsResponsesAPI.QuestionsResponses;
1
+ import { APIResource } from "../../resource.js";
2
+ import * as Core from "../../core.js";
3
+ export declare class RuleGroups extends APIResource {
28
4
  /**
29
- * Create a loyalty transaction to update account balances.
5
+ * Create a new loyalty rule groups
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const response =
10
+ * await client.loyalty.ruleGroups.createRuleGroup({
11
+ * name: 'name',
12
+ * organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
13
+ * websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
14
+ * });
15
+ * ```
30
16
  */
31
- createTransaction(body: LoyaltyCreateTransactionParams, options?: Core.RequestOptions): Core.APIPromise<LoyaltyCreateTransactionResponse>;
17
+ createRuleGroup(body: RuleGroupCreateRuleGroupParams, options?: Core.RequestOptions): Core.APIPromise<RuleGroupCreateRuleGroupResponse>;
18
+ /**
19
+ * Delete loyalty rule group by ID
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const response =
24
+ * await client.loyalty.ruleGroups.deleteRuleGroup(
25
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
26
+ * );
27
+ * ```
28
+ */
29
+ deleteRuleGroup(id: string, options?: Core.RequestOptions): Core.APIPromise<unknown>;
32
30
  /**
33
31
  * Retrieve configured loyalty rule groups
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const response =
36
+ * await client.loyalty.ruleGroups.getRuleGroups();
37
+ * ```
34
38
  */
35
- getRuleGroups(query?: LoyaltyGetRuleGroupsParams, options?: Core.RequestOptions): Core.APIPromise<LoyaltyGetRuleGroupsResponse>;
36
- getRuleGroups(options?: Core.RequestOptions): Core.APIPromise<LoyaltyGetRuleGroupsResponse>;
39
+ getRuleGroups(query?: RuleGroupGetRuleGroupsParams, options?: Core.RequestOptions): Core.APIPromise<RuleGroupGetRuleGroupsResponse>;
40
+ getRuleGroups(options?: Core.RequestOptions): Core.APIPromise<RuleGroupGetRuleGroupsResponse>;
37
41
  /**
38
- * Fetch loyalty transaction entries for wallets or users, representing account
39
- * balance changes.
42
+ * Update loyalty rule group by ID
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const response =
47
+ * await client.loyalty.ruleGroups.updateRuleGroup(
48
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
49
+ * );
50
+ * ```
40
51
  */
41
- listTransactionEntries(query?: LoyaltyListTransactionEntriesParams, options?: Core.RequestOptions): Core.APIPromise<LoyaltyListTransactionEntriesResponse>;
42
- listTransactionEntries(options?: Core.RequestOptions): Core.APIPromise<LoyaltyListTransactionEntriesResponse>;
52
+ updateRuleGroup(id: string, body?: RuleGroupUpdateRuleGroupParams, options?: Core.RequestOptions): Core.APIPromise<RuleGroupUpdateRuleGroupResponse>;
53
+ updateRuleGroup(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleGroupUpdateRuleGroupResponse>;
43
54
  }
44
- export interface LoyaltyCreateTransactionResponse {
55
+ export interface RuleGroupCreateRuleGroupResponse {
45
56
  id: string;
46
57
  createdAt: string;
47
- description: string;
48
- entries: Array<LoyaltyCreateTransactionResponse.Entry>;
58
+ isCollapsible: boolean;
59
+ isRequired: boolean;
60
+ name: string;
61
+ organizationId: string;
62
+ sortId: number;
63
+ subTitle: string | null;
49
64
  updatedAt: string;
65
+ websiteId: string;
50
66
  }
51
- export declare namespace LoyaltyCreateTransactionResponse {
52
- interface Entry {
53
- amount: number;
54
- /**
55
- * Direction of the transaction entry
56
- */
57
- direction: 'credit' | 'debit';
58
- walletAddress: string;
59
- idempotencyKey?: string;
60
- }
61
- }
62
- export interface LoyaltyGetRuleGroupsResponse {
63
- data: Array<LoyaltyGetRuleGroupsResponse.Data>;
67
+ export type RuleGroupDeleteRuleGroupResponse = unknown;
68
+ export interface RuleGroupGetRuleGroupsResponse {
69
+ data: Array<RuleGroupGetRuleGroupsResponse.Data>;
64
70
  hasNextPage: boolean;
65
71
  }
66
- export declare namespace LoyaltyGetRuleGroupsResponse {
72
+ export declare namespace RuleGroupGetRuleGroupsResponse {
73
+ /**
74
+ * Schema for a get loyalty rule groups response
75
+ */
67
76
  interface Data {
68
77
  id: string;
69
78
  isCollapsible: boolean;
@@ -89,15 +98,27 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
89
98
  frequency: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately' | null;
90
99
  hideInUi: boolean;
91
100
  isRequired: boolean;
101
+ loyaltyBadge: LoyaltyRule.LoyaltyBadge;
92
102
  loyaltyCurrencyId: string;
103
+ mediaUrl: string | null;
93
104
  metadata: LoyaltyRule.Metadata;
94
105
  name: string;
95
- rewardType: 'points' | 'multiplier';
106
+ rewardType: 'points' | 'multiplier' | 'badge';
96
107
  startTime: string | null;
97
- type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll';
108
+ type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll' | 'steam_wishlist' | 'liquidity_uniswap_v2' | 'liquidity_uniswap_v3' | 'points_airdrop' | 'youtube_subscribers' | 'youtube_comment' | 'shopify_spend' | 'swap' | 'tiktok_post' | 'post_impressions' | 'discord_join' | 'connected_youtube';
98
109
  }
99
110
  namespace LoyaltyRule {
111
+ interface LoyaltyBadge {
112
+ id: string;
113
+ description: string | null;
114
+ imageUrl: string | null;
115
+ name: string;
116
+ }
100
117
  interface Metadata {
118
+ /**
119
+ * Number of tokens per batch.
120
+ */
121
+ batchSize?: number | null;
101
122
  /**
102
123
  * Text displayed on the action button.
103
124
  */
@@ -117,11 +138,21 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
117
138
  /**
118
139
  * Text to check in the Twitter post, username, or bio.
119
140
  */
120
- checkText?: string | null;
141
+ checkText?: string | Array<string> | null;
121
142
  /**
122
143
  * Array of collections associated with the rule.
123
144
  */
124
145
  collection?: Array<Metadata.Collection>;
146
+ /**
147
+ * Conditions for completing the profile.
148
+ */
149
+ completeProfileConditions?: {
150
+ [key: string]: boolean;
151
+ } | null;
152
+ /**
153
+ * Description of the external rule condition (only for external rules)
154
+ */
155
+ conditionDescription?: string;
125
156
  /**
126
157
  * Object containing details for the call-to-action.
127
158
  */
@@ -130,6 +161,10 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
130
161
  * API key for custom rewards integration.
131
162
  */
132
163
  customRewardsApiKey?: string;
164
+ /**
165
+ * Flag indicating if the rule should use direct RPC to get the balance of tokens.
166
+ */
167
+ directRpc?: boolean;
133
168
  /**
134
169
  * Array of Discord servers, channels, and roles to join.
135
170
  */
@@ -150,10 +185,18 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
150
185
  * Flag indicating whether the verified multiplier is enabled.
151
186
  */
152
187
  enableVerifiedMultiplier?: boolean;
188
+ /**
189
+ * Fill source of the order for the token sale
190
+ */
191
+ fillSource?: string;
153
192
  /**
154
193
  * Percentage reward given to a user for their first referral.
155
194
  */
156
195
  firstReferralReward?: number | null;
196
+ /**
197
+ * Flag indicating whether the fill source is included.
198
+ */
199
+ hasFillSource?: boolean;
157
200
  /**
158
201
  * Indicates if the item has never been sold.
159
202
  */
@@ -174,10 +217,18 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
174
217
  * URL of the image associated with the rule.
175
218
  */
176
219
  imageUrl?: string | null;
220
+ /**
221
+ * If enabled, the first transaction done on the platform will complete this rule
222
+ */
223
+ isCheckInOnEveryTxn?: boolean;
177
224
  /**
178
225
  * Indicates if the multiplier has been applied to rewards.
179
226
  */
180
227
  isMultiplierApplied?: boolean;
228
+ /**
229
+ * Flag indicating if the rule is restricted to new users.
230
+ */
231
+ isRestrictedToNewUsers?: boolean;
181
232
  /**
182
233
  * Flag indicating if rewards are applied retroactively.
183
234
  */
@@ -190,6 +241,10 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
190
241
  * Optional link associated with the metadata.
191
242
  */
192
243
  link?: string | null;
244
+ /**
245
+ * Liquidity pool details.
246
+ */
247
+ liquidity?: Metadata.Liquidity;
193
248
  /**
194
249
  * Maximum quantity constraint for token holding.
195
250
  */
@@ -226,6 +281,18 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
226
281
  * Promotional code associated with the rule.
227
282
  */
228
283
  promoCode?: string;
284
+ /**
285
+ * URL of the CSV file containing promo codes.
286
+ */
287
+ promoCodeCsvUrl?: string;
288
+ /**
289
+ * Numbers of the promotional code to be generated.
290
+ */
291
+ promoCodeLength?: number | null;
292
+ /**
293
+ * Type of the promotional code.
294
+ */
295
+ promoCodeType?: 'code' | 'csv' | 'generate';
229
296
  /**
230
297
  * Array defining ranges and corresponding rewards.
231
298
  */
@@ -238,10 +305,47 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
238
305
  * Lump sum reward given to a referrer.
239
306
  */
240
307
  referrerReward?: number | null;
308
+ /**
309
+ * Loyalty currency ID of the referrer reward.
310
+ */
311
+ referrerRewardLoyaltyCurrencyId?: string | null;
312
+ /**
313
+ * Flag indicating if the post link is required.
314
+ */
315
+ requirePostLink?: boolean | null;
316
+ /**
317
+ * Flag indicating if media metadata is required.
318
+ */
319
+ requirePostMediaLink?: boolean | null;
320
+ /**
321
+ * Flag indicating if the rule can also reward badges per range.
322
+ */
323
+ rewardBadgePerRange?: boolean;
324
+ /**
325
+ * Flag indicating if the reward is rewarded by batch.
326
+ */
327
+ rewardByBatch?: boolean | null;
328
+ /**
329
+ * Flag indicating if the reward is rewarded per action.
330
+ */
331
+ rewardPerAction?: boolean | null;
241
332
  /**
242
333
  * Flag indicating if rewards are given per impression.
243
334
  */
244
335
  rewardPerImpression?: boolean | null;
336
+ /**
337
+ * Flag indicating if the rule should reward based on value of traded tokens
338
+ * instead of count.
339
+ */
340
+ rewardPerValue?: boolean;
341
+ /**
342
+ * Wallet address of the user can only be used if userId is not provided
343
+ */
344
+ royaltyAddress?: string;
345
+ /**
346
+ * Royalty percentage of the item.
347
+ */
348
+ royaltyPercentage?: number;
245
349
  /**
246
350
  * Currency associated with sales.
247
351
  */
@@ -265,7 +369,7 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
265
369
  /**
266
370
  * Social media platform associated with the rule.
267
371
  */
268
- socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
372
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
269
373
  /**
270
374
  * URL of the social platform's logo.
271
375
  */
@@ -274,10 +378,18 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
274
378
  * Name of the social platform.
275
379
  */
276
380
  socialPlatformName?: string | null;
381
+ /**
382
+ * ID of the Steam app.
383
+ */
384
+ steamAppId?: string | null;
277
385
  /**
278
386
  * Array of streak milestones and corresponding rewards.
279
387
  */
280
388
  streakArray?: Array<Metadata.StreakArray> | null;
389
+ /**
390
+ * Metadata for swap loyalty rules
391
+ */
392
+ swap?: Metadata.Swap;
281
393
  /**
282
394
  * ID of the Telegram channel.
283
395
  */
@@ -290,6 +402,11 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
290
402
  * Flag indicating if all contracts are tracked.
291
403
  */
292
404
  trackAllContracts?: boolean | null;
405
+ /**
406
+ * Flag indicating if the progress is tracked. If enabled, the rule can only be
407
+ * completed once the progress is 100%.
408
+ */
409
+ trackProgress?: boolean | null;
293
410
  /**
294
411
  * URL of the associated Twitter account.
295
412
  */
@@ -325,7 +442,15 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
325
442
  /**
326
443
  * Type of wallet associated with the rule.
327
444
  */
328
- walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
445
+ walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
446
+ /**
447
+ * ID of the Youtube channel.
448
+ */
449
+ youtubeChannelId?: string | null;
450
+ /**
451
+ * ID of the Youtube video.
452
+ */
453
+ youtubeVideoId?: string | null;
329
454
  }
330
455
  namespace Metadata {
331
456
  interface Collection {
@@ -340,7 +465,7 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
340
465
  /**
341
466
  * Blockchain network of the collection.
342
467
  */
343
- network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'superseed' | 'superseedSepolia' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp' | 'abstract';
468
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
344
469
  }
345
470
  /**
346
471
  * Object containing details for the call-to-action.
@@ -405,6 +530,49 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
405
530
  */
406
531
  id: string;
407
532
  }
533
+ /**
534
+ * Liquidity pool details.
535
+ */
536
+ interface Liquidity {
537
+ /**
538
+ * Calculation type of the liquidity pool.
539
+ */
540
+ calculationType?: 'fixed' | 'custom';
541
+ /**
542
+ * Custom function to calculate the the reward amount based on the liquidity
543
+ * provided per day. X is the reward amount, Y is the liquidity provided per day in
544
+ * USD.
545
+ */
546
+ customFunction?: string;
547
+ /**
548
+ * Liquidity provided per day in USD
549
+ */
550
+ liquidityPerDay?: number;
551
+ /**
552
+ * Blockchain network of the liquidity pool.
553
+ */
554
+ network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'nexusTestnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'ultra' | 'ultraTestnet' | 'nitrograph' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
555
+ /**
556
+ * Indicates if only in-range liquidity is rewarded.
557
+ */
558
+ onlyRewardInRangeLiquidity?: boolean;
559
+ /**
560
+ * Array of liquidity pools associated with the rule.
561
+ */
562
+ pools?: Array<Liquidity.Pool>;
563
+ /**
564
+ * Protocol of the liquidity pool.
565
+ */
566
+ protocol?: string;
567
+ }
568
+ namespace Liquidity {
569
+ interface Pool {
570
+ /**
571
+ * Unique identifier of the liquidity pool.
572
+ */
573
+ id: string;
574
+ }
575
+ }
408
576
  interface Range {
409
577
  /**
410
578
  * Reward amount for this range.
@@ -418,6 +586,14 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
418
586
  * Start value of the range.
419
587
  */
420
588
  startRange: number;
589
+ /**
590
+ * ID of the loyalty badge for this range.
591
+ */
592
+ loyaltyBadgeId?: string;
593
+ /**
594
+ * Amount of the loyalty multiplier for this range.
595
+ */
596
+ loyaltyMultiplierAmount?: number;
421
597
  }
422
598
  /**
423
599
  * Object defining referral requirements.
@@ -461,18 +637,14 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
461
637
  * Object containing details of the associated smart contract.
462
638
  */
463
639
  interface SmartContract {
464
- /**
465
- * ABI of the smart contract.
466
- */
467
- abi?: string | null;
468
640
  /**
469
641
  * Mapping of addresses for the smart contract.
470
642
  */
471
643
  addressMapping?: string | null;
472
644
  /**
473
- * Array of bonus details applied to the rule.
645
+ * Object containing details of the amount multiplier from the event.
474
646
  */
475
- bonus?: Array<SmartContract.Bonus> | null;
647
+ amountMultiplier?: SmartContract.AmountMultiplier | null;
476
648
  /**
477
649
  * ID of the smart contract.
478
650
  */
@@ -481,58 +653,28 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
481
653
  * Criteria to evaluate the smart contract event.
482
654
  */
483
655
  criteria?: 'everyEvent' | 'byParameter' | null;
484
- /**
485
- * Time range applied to the rule.
486
- */
487
- customRange?: SmartContract.CustomRange | null;
488
656
  /**
489
657
  * Event emitted by the smart contract.
490
658
  */
491
659
  event?: string | null;
492
- /**
493
- * Maximum value allowed for the parameter.
494
- */
495
- max?: number | null;
496
660
  /**
497
661
  * Array of parameters for the smart contract.
498
662
  */
499
663
  params?: Array<SmartContract.Param> | null;
500
664
  /**
501
- * Flag indicating if a bonus is applied.
665
+ * Type of the smart contract interaction.
502
666
  */
503
- withBonus?: boolean | null;
504
- /**
505
- * Flag indicating if a custom range is applied.
506
- */
507
- withCustomRange?: boolean | null;
508
- /**
509
- * Flag indicating if a maximum limit is applied.
510
- */
511
- withMax?: boolean | null;
667
+ type?: 'function' | 'event' | null;
512
668
  }
513
669
  namespace SmartContract {
514
- interface Bonus {
515
- /**
516
- * Amount of the bonus.
517
- */
518
- amount?: number | null;
519
- /**
520
- * Number of times the bonus is applied.
521
- */
522
- count?: number | null;
523
- }
524
670
  /**
525
- * Time range applied to the rule.
671
+ * Object containing details of the amount multiplier from the event.
526
672
  */
527
- interface CustomRange {
528
- /**
529
- * End time of the custom range.
530
- */
531
- endsAt?: string | null;
673
+ interface AmountMultiplier {
532
674
  /**
533
- * Start time of the custom range.
675
+ * Mapping of the value for the smart contract.
534
676
  */
535
- startsAt?: string | null;
677
+ valueMapping?: string | null;
536
678
  }
537
679
  interface Param {
538
680
  /**
@@ -569,239 +711,56 @@ export declare namespace LoyaltyGetRuleGroupsResponse {
569
711
  */
570
712
  streakMilestone: number;
571
713
  }
714
+ /**
715
+ * Metadata for swap loyalty rules
716
+ */
717
+ interface Swap {
718
+ provider?: 'any' | 'relay' | 'lifi';
719
+ relayReferrerId?: string;
720
+ requireCrossChainSwap?: boolean;
721
+ swappedToChain?: 'any' | number | string;
722
+ swappedToTokens?: Array<Swap.SwappedToToken>;
723
+ tokenMode?: 'any' | 'specific';
724
+ trackTokenAmount?: boolean;
725
+ }
726
+ namespace Swap {
727
+ interface SwappedToToken {
728
+ address: string;
729
+ chainId: string;
730
+ }
731
+ }
572
732
  }
573
733
  }
574
734
  }
575
735
  }
576
736
  }
577
- export interface LoyaltyListTransactionEntriesResponse {
578
- data: Array<LoyaltyListTransactionEntriesResponse.Data>;
579
- hasNextPage: boolean;
737
+ export interface RuleGroupUpdateRuleGroupResponse {
738
+ isCollapsible?: boolean;
739
+ name?: string;
740
+ subTitle?: string;
580
741
  }
581
- export declare namespace LoyaltyListTransactionEntriesResponse {
582
- /**
583
- * Schema for a loyalty transaction entry
584
- */
585
- interface Data {
586
- /**
587
- * Unique identifier for the transaction entry
588
- */
589
- id: string;
590
- /**
591
- * Amount involved in the transaction
592
- */
593
- amount: number;
594
- /**
595
- * Timestamp when the transaction entry was created
596
- */
597
- createdAt: string;
598
- /**
599
- * Direction of the transaction entry
600
- */
601
- direction: 'credit' | 'debit';
602
- /**
603
- * Unique identifier for the loyalty account
604
- */
605
- loyaltyAccountId: string;
606
- /**
607
- * Details of the loyalty transaction
608
- */
609
- loyaltyTransaction: Data.LoyaltyTransaction;
610
- /**
611
- * Unique identifier for the organization
612
- */
613
- organizationId: string;
614
- /**
615
- * Type of the loyalty transaction
616
- */
617
- type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
618
- /**
619
- * Timestamp when the transaction entry was last updated
620
- */
621
- updatedAt: string;
622
- /**
623
- * Unique identifier for the website
624
- */
625
- websiteId: string;
626
- /**
627
- * Optional metadata for the transaction entry
628
- */
629
- metadata?: Record<string, unknown>;
630
- }
631
- namespace Data {
632
- /**
633
- * Details of the loyalty transaction
634
- */
635
- interface LoyaltyTransaction {
636
- /**
637
- * Unique identifier for the loyalty transaction
638
- */
639
- id: string;
640
- /**
641
- * Type of the loyalty transaction
642
- */
643
- type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
644
- /**
645
- * Details of the loyalty rule associated with the transaction
646
- */
647
- loyaltyRule?: LoyaltyTransaction.LoyaltyRule;
648
- }
649
- namespace LoyaltyTransaction {
650
- /**
651
- * Details of the loyalty rule associated with the transaction
652
- */
653
- interface LoyaltyRule {
654
- /**
655
- * Unique identifier for the loyalty rule
656
- */
657
- id: string;
658
- /**
659
- * Type of the loyalty rule
660
- */
661
- type: string;
662
- /**
663
- * Description of the loyalty rule
664
- */
665
- description?: string;
666
- /**
667
- * Optional metadata for the loyalty rule
668
- */
669
- metadata?: Record<string, unknown>;
670
- /**
671
- * Name of the loyalty rule
672
- */
673
- name?: string;
674
- }
675
- }
676
- }
677
- }
678
- export interface LoyaltyCreateTransactionParams {
679
- /**
680
- * Description of the loyalty transaction
681
- */
682
- description: string;
683
- /**
684
- * Array of transaction entries
685
- */
686
- entries: Array<LoyaltyCreateTransactionParams.Entry>;
687
- /**
688
- * Unique identifier for the loyalty currency
689
- */
690
- loyaltyCurrencyId?: string;
742
+ export interface RuleGroupCreateRuleGroupParams {
743
+ name: string;
744
+ organizationId: string;
745
+ websiteId: string;
746
+ isCollapsible?: boolean;
747
+ isRequired?: boolean;
748
+ sortId?: number;
749
+ subTitle?: string;
691
750
  }
692
- export declare namespace LoyaltyCreateTransactionParams {
693
- interface Entry {
694
- /**
695
- * Transaction entry amount.
696
- */
697
- amount: number;
698
- /**
699
- * Direction of the transaction entry for this wallet address
700
- */
701
- direction?: 'credit' | 'debit';
702
- /**
703
- * Idempotency key for the transaction entry. Creation will fail if already exists
704
- * for this wallet address.
705
- */
706
- idempotencyKey?: string;
707
- /**
708
- * The wallet address of the user
709
- */
710
- walletAddress?: string;
711
- }
712
- }
713
- export interface LoyaltyGetRuleGroupsParams {
751
+ export interface RuleGroupGetRuleGroupsParams {
714
752
  excludeHidden?: string;
715
753
  limit?: number;
716
754
  organizationId?: string;
717
755
  startingAfter?: string;
718
756
  websiteId?: string;
719
757
  }
720
- export interface LoyaltyListTransactionEntriesParams {
721
- /**
722
- * End date to filter by (exclusive, less than)
723
- */
724
- createdAtEnd?: string;
725
- /**
726
- * Start date to filter by (inclusive, greater than or equal to)
727
- */
728
- createdAtStart?: string;
729
- /**
730
- * Direction of the transaction entry to filter by
731
- */
732
- direction?: 'credit' | 'debit';
733
- /**
734
- * Key to ensure idempotency of the request
735
- */
736
- idempotencyKey?: string;
737
- /**
738
- * Maximum number of records to return (max 1000)
739
- */
740
- limit?: number;
741
- /**
742
- * Unique identifier for the loyalty rule to filter by
743
- */
744
- loyaltyRuleId?: string;
745
- /**
746
- * Unique identifier for the loyalty transaction to filter by
747
- */
748
- loyaltyTransactionId?: string;
749
- /**
750
- * Field to order the results by
751
- */
752
- orderBy?: 'createdAt' | 'updatedAt' | 'loyaltyAccountLockVersion';
753
- /**
754
- * Unique identifier for the organization to filter by
755
- */
756
- organizationId?: string;
757
- /**
758
- * Pagination cursor to start after a specific resource ID
759
- */
760
- startingAfter?: string;
761
- /**
762
- * Type of the loyalty transaction to filter by
763
- */
764
- type?: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
765
- /**
766
- * When passed in return the list of fulfilled entries for loyalty rules. If a
767
- * loyalty rule has a fulfilled entry this means the user cannot currently complete
768
- * the rule. Must be passed in with userId or walletAddress.
769
- */
770
- userCompletedLoyaltyRuleId?: string | Array<string>;
771
- /**
772
- * External identifier for the user group controlled by you
773
- */
774
- userGroupExternalIdentifier?: string;
775
- /**
776
- * Unique identifier for the user group
777
- */
778
- userGroupId?: string;
779
- /**
780
- * User ID or array of User IDs to filter by
781
- */
782
- userId?: string | Array<string>;
783
- /**
784
- * Wallet address or array of wallet addresses to filter by
785
- */
786
- walletAddress?: string | Array<string>;
787
- /**
788
- * Identifier for the wallet group to filter by
789
- */
790
- walletGroupIdentifier?: string;
791
- /**
792
- * Unique identifier for the website to filter by
793
- */
794
- websiteId?: string;
758
+ export interface RuleGroupUpdateRuleGroupParams {
759
+ isCollapsible?: boolean;
760
+ name?: string | null;
761
+ subtitle?: string | null;
795
762
  }
796
- export declare namespace Loyalty {
797
- export { type LoyaltyCreateTransactionResponse as LoyaltyCreateTransactionResponse, type LoyaltyGetRuleGroupsResponse as LoyaltyGetRuleGroupsResponse, type LoyaltyListTransactionEntriesResponse as LoyaltyListTransactionEntriesResponse, type LoyaltyCreateTransactionParams as LoyaltyCreateTransactionParams, type LoyaltyGetRuleGroupsParams as LoyaltyGetRuleGroupsParams, type LoyaltyListTransactionEntriesParams as LoyaltyListTransactionEntriesParams, };
798
- export { Accounts as Accounts, type AccountListResponse as AccountListResponse, type AccountGetRankResponse as AccountGetRankResponse, type AccountListParams as AccountListParams, type AccountGetRankParams as AccountGetRankParams, };
799
- export { Badges as Badges, type BadgeCreateResponse as BadgeCreateResponse, type BadgeUpdateResponse as BadgeUpdateResponse, type BadgeListResponse as BadgeListResponse, type BadgeDeleteResponse as BadgeDeleteResponse, type BadgeRevokeResponse as BadgeRevokeResponse, type BadgeRewardResponse as BadgeRewardResponse, type BadgeCreateParams as BadgeCreateParams, type BadgeUpdateParams as BadgeUpdateParams, type BadgeListParams as BadgeListParams, type BadgeRevokeParams as BadgeRevokeParams, type BadgeRewardParams as BadgeRewardParams, };
800
- export { Currencies as Currencies, type CurrencyCreateResponse as CurrencyCreateResponse, type CurrencyListResponse as CurrencyListResponse, type CurrencyCreateParams as CurrencyCreateParams, type CurrencyListParams as CurrencyListParams, };
801
- export { Multipliers as Multipliers, type MultiplierCreateResponse as MultiplierCreateResponse, type MultiplierUpdateResponse as MultiplierUpdateResponse, type MultiplierListResponse as MultiplierListResponse, type MultiplierDeleteResponse as MultiplierDeleteResponse, type MultiplierDeleteByExternalIDResponse as MultiplierDeleteByExternalIDResponse, type MultiplierCreateParams as MultiplierCreateParams, type MultiplierUpdateParams as MultiplierUpdateParams, type MultiplierListParams as MultiplierListParams, type MultiplierDeleteByExternalIDParams as MultiplierDeleteByExternalIDParams, };
802
- export { RuleEdits as RuleEdits, type RuleEditListResponse as RuleEditListResponse, type RuleEditRestoreResponse as RuleEditRestoreResponse, type RuleEditListParams as RuleEditListParams, type RuleEditRestoreParams as RuleEditRestoreParams, };
803
- export { Rules as Rules, type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleGetStatusResponse as RuleGetStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleCompleteParams as RuleCompleteParams, type RuleGetStatusParams as RuleGetStatusParams, };
804
- export { Questions as Questions, type QuestionCreateResponse as QuestionCreateResponse, type QuestionUpdateResponse as QuestionUpdateResponse, type QuestionListResponse as QuestionListResponse, type QuestionCreateParams as QuestionCreateParams, type QuestionUpdateParams as QuestionUpdateParams, type QuestionListParams as QuestionListParams, };
805
- export { QuestionsResponses as QuestionsResponses, type QuestionsResponseListResponse as QuestionsResponseListResponse, type QuestionsResponseSubmitResponse as QuestionsResponseSubmitResponse, type QuestionsResponseListParams as QuestionsResponseListParams, type QuestionsResponseSubmitParams as QuestionsResponseSubmitParams, };
763
+ export declare namespace RuleGroups {
764
+ export { type RuleGroupCreateRuleGroupResponse as RuleGroupCreateRuleGroupResponse, type RuleGroupDeleteRuleGroupResponse as RuleGroupDeleteRuleGroupResponse, type RuleGroupGetRuleGroupsResponse as RuleGroupGetRuleGroupsResponse, type RuleGroupUpdateRuleGroupResponse as RuleGroupUpdateRuleGroupResponse, type RuleGroupCreateRuleGroupParams as RuleGroupCreateRuleGroupParams, type RuleGroupGetRuleGroupsParams as RuleGroupGetRuleGroupsParams, type RuleGroupUpdateRuleGroupParams as RuleGroupUpdateRuleGroupParams, };
806
765
  }
807
- //# sourceMappingURL=loyalty.d.ts.map
766
+ //# sourceMappingURL=rule-groups.d.ts.map