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

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 (325) hide show
  1. package/CHANGELOG.md +98 -0
  2. package/README.md +22 -14
  3. package/core.d.ts.map +1 -1
  4. package/core.js +14 -7
  5. package/core.js.map +1 -1
  6. package/core.mjs +14 -7
  7. package/core.mjs.map +1 -1
  8. package/index.d.mts +11 -26
  9. package/index.d.ts +11 -26
  10. package/index.d.ts.map +1 -1
  11. package/index.js +8 -23
  12. package/index.js.map +1 -1
  13. package/index.mjs +8 -23
  14. package/index.mjs.map +1 -1
  15. package/package.json +1 -1
  16. package/resources/api/api.d.ts +365 -0
  17. package/resources/api/api.d.ts.map +1 -0
  18. package/resources/api/api.js +94 -0
  19. package/resources/api/api.js.map +1 -0
  20. package/resources/api/api.mjs +67 -0
  21. package/resources/api/api.mjs.map +1 -0
  22. package/resources/api/index.d.ts +9 -0
  23. package/resources/api/index.d.ts.map +1 -0
  24. package/resources/api/index.js +21 -0
  25. package/resources/api/index.js.map +1 -0
  26. package/resources/api/index.mjs +10 -0
  27. package/resources/api/index.mjs.map +1 -0
  28. package/resources/{loyalty → api/loyalty}/accounts.d.ts +44 -6
  29. package/resources/api/loyalty/accounts.d.ts.map +1 -0
  30. package/resources/api/loyalty/accounts.js +24 -0
  31. package/resources/api/loyalty/accounts.js.map +1 -0
  32. package/resources/api/loyalty/accounts.mjs +20 -0
  33. package/resources/api/loyalty/accounts.mjs.map +1 -0
  34. package/resources/api/loyalty/badges.d.ts +870 -0
  35. package/resources/api/loyalty/badges.d.ts.map +1 -0
  36. package/resources/{loyalty → api/loyalty}/badges.js +2 -2
  37. package/resources/api/loyalty/badges.js.map +1 -0
  38. package/resources/{loyalty → api/loyalty}/badges.mjs +2 -2
  39. package/resources/api/loyalty/badges.mjs.map +1 -0
  40. package/resources/{loyalty → api/loyalty}/currencies.d.ts +3 -9
  41. package/resources/api/loyalty/currencies.d.ts.map +1 -0
  42. package/resources/{loyalty → api/loyalty}/currencies.js +1 -1
  43. package/resources/api/loyalty/currencies.js.map +1 -0
  44. package/resources/{loyalty → api/loyalty}/currencies.mjs +1 -1
  45. package/resources/api/loyalty/currencies.mjs.map +1 -0
  46. package/resources/api/loyalty/index.d.ts +10 -0
  47. package/resources/api/loyalty/index.d.ts.map +1 -0
  48. package/resources/{loyalty → api/loyalty}/index.js +5 -3
  49. package/resources/api/loyalty/index.js.map +1 -0
  50. package/resources/{loyalty → api/loyalty}/index.mjs +4 -3
  51. package/resources/api/loyalty/index.mjs.map +1 -0
  52. package/resources/api/loyalty/loyalty.d.ts +807 -0
  53. package/resources/api/loyalty/loyalty.d.ts.map +1 -0
  54. package/resources/{loyalty → api/loyalty}/loyalty.js +36 -13
  55. package/resources/api/loyalty/loyalty.js.map +1 -0
  56. package/resources/api/loyalty/loyalty.mjs +59 -0
  57. package/resources/api/loyalty/loyalty.mjs.map +1 -0
  58. package/resources/{loyalty → api/loyalty}/multipliers.d.ts +36 -4
  59. package/resources/api/loyalty/multipliers.d.ts.map +1 -0
  60. package/resources/{loyalty → api/loyalty}/multipliers.js +8 -2
  61. package/resources/api/loyalty/multipliers.js.map +1 -0
  62. package/resources/{loyalty → api/loyalty}/multipliers.mjs +8 -2
  63. package/resources/api/loyalty/multipliers.mjs.map +1 -0
  64. package/resources/api/loyalty/questions-responses.d.ts +97 -0
  65. package/resources/api/loyalty/questions-responses.d.ts.map +1 -0
  66. package/resources/api/loyalty/questions-responses.js +22 -0
  67. package/resources/api/loyalty/questions-responses.js.map +1 -0
  68. package/resources/api/loyalty/questions-responses.mjs +18 -0
  69. package/resources/api/loyalty/questions-responses.mjs.map +1 -0
  70. package/resources/api/loyalty/questions.d.ts +150 -0
  71. package/resources/api/loyalty/questions.d.ts.map +1 -0
  72. package/resources/api/loyalty/questions.js +27 -0
  73. package/resources/api/loyalty/questions.js.map +1 -0
  74. package/resources/api/loyalty/questions.mjs +23 -0
  75. package/resources/api/loyalty/questions.mjs.map +1 -0
  76. package/resources/{loyalty → api/loyalty}/rule-edits.d.ts +9 -9
  77. package/resources/api/loyalty/rule-edits.d.ts.map +1 -0
  78. package/resources/{loyalty → api/loyalty}/rule-edits.js +3 -3
  79. package/resources/api/loyalty/rule-edits.js.map +1 -0
  80. package/resources/{loyalty → api/loyalty}/rule-edits.mjs +3 -3
  81. package/resources/api/loyalty/rule-edits.mjs.map +1 -0
  82. package/resources/{loyalty → api/loyalty}/rules.d.ts +167 -90
  83. package/resources/api/loyalty/rules.d.ts.map +1 -0
  84. package/resources/{loyalty → api/loyalty}/rules.js +3 -3
  85. package/resources/api/loyalty/rules.js.map +1 -0
  86. package/resources/{loyalty → api/loyalty}/rules.mjs +3 -3
  87. package/resources/api/loyalty/rules.mjs.map +1 -0
  88. package/resources/api/loyalty.d.ts +2 -0
  89. package/resources/api/loyalty.d.ts.map +1 -0
  90. package/resources/api/loyalty.js +19 -0
  91. package/resources/api/loyalty.js.map +1 -0
  92. package/resources/api/loyalty.mjs +3 -0
  93. package/resources/api/loyalty.mjs.map +1 -0
  94. package/resources/api/minting.d.ts +95 -0
  95. package/resources/api/minting.d.ts.map +1 -0
  96. package/resources/api/minting.js +15 -0
  97. package/resources/api/minting.js.map +1 -0
  98. package/resources/api/minting.mjs +11 -0
  99. package/resources/api/minting.mjs.map +1 -0
  100. package/resources/api/referral/index.d.ts +3 -0
  101. package/resources/api/referral/index.d.ts.map +1 -0
  102. package/resources/api/referral/index.js +9 -0
  103. package/resources/api/referral/index.js.map +1 -0
  104. package/resources/api/referral/index.mjs +4 -0
  105. package/resources/api/referral/index.mjs.map +1 -0
  106. package/resources/api/referral/referral.d.ts +31 -0
  107. package/resources/api/referral/referral.d.ts.map +1 -0
  108. package/resources/{drip/drip.js → api/referral/referral.js} +16 -13
  109. package/resources/api/referral/referral.js.map +1 -0
  110. package/resources/api/referral/referral.mjs +19 -0
  111. package/resources/api/referral/referral.mjs.map +1 -0
  112. package/resources/api/referral/users.d.ts +57 -0
  113. package/resources/api/referral/users.d.ts.map +1 -0
  114. package/resources/api/referral/users.js +21 -0
  115. package/resources/api/referral/users.js.map +1 -0
  116. package/resources/api/referral/users.mjs +17 -0
  117. package/resources/api/referral/users.mjs.map +1 -0
  118. package/resources/api/referral.d.ts +2 -0
  119. package/resources/api/referral.d.ts.map +1 -0
  120. package/resources/api/referral.js +19 -0
  121. package/resources/api/referral.js.map +1 -0
  122. package/resources/api/referral.mjs +3 -0
  123. package/resources/api/referral.mjs.map +1 -0
  124. package/resources/api/users/index.d.ts +3 -0
  125. package/resources/api/users/index.d.ts.map +1 -0
  126. package/resources/{users → api/users}/index.js +1 -3
  127. package/resources/api/users/index.js.map +1 -0
  128. package/resources/api/users/index.mjs +4 -0
  129. package/resources/api/users/index.mjs.map +1 -0
  130. package/resources/api/users/metadatas.d.ts +137 -0
  131. package/resources/api/users/metadatas.d.ts.map +1 -0
  132. package/resources/{users → api/users}/metadatas.js +8 -2
  133. package/resources/api/users/metadatas.js.map +1 -0
  134. package/resources/api/users/metadatas.mjs +18 -0
  135. package/resources/api/users/metadatas.mjs.map +1 -0
  136. package/resources/api/users/users.d.ts +133 -0
  137. package/resources/api/users/users.d.ts.map +1 -0
  138. package/resources/{users → api/users}/users.js +19 -5
  139. package/resources/api/users/users.js.map +1 -0
  140. package/resources/api/users/users.mjs +30 -0
  141. package/resources/api/users/users.mjs.map +1 -0
  142. package/resources/api/users.d.ts +2 -0
  143. package/resources/api/users.d.ts.map +1 -0
  144. package/resources/api/users.js +19 -0
  145. package/resources/api/users.js.map +1 -0
  146. package/resources/api/users.mjs +3 -0
  147. package/resources/api/users.mjs.map +1 -0
  148. package/resources/api/website-collections.d.ts +73 -0
  149. package/resources/api/website-collections.d.ts.map +1 -0
  150. package/resources/api/website-collections.js +25 -0
  151. package/resources/api/website-collections.js.map +1 -0
  152. package/resources/api/website-collections.mjs +21 -0
  153. package/resources/api/website-collections.mjs.map +1 -0
  154. package/resources/api/website-user-roles.d.ts +73 -0
  155. package/resources/api/website-user-roles.d.ts.map +1 -0
  156. package/resources/api/website-user-roles.js +22 -0
  157. package/resources/api/website-user-roles.js.map +1 -0
  158. package/resources/api/website-user-roles.mjs +18 -0
  159. package/resources/api/website-user-roles.mjs.map +1 -0
  160. package/resources/{websites.d.ts → api/websites.d.ts} +2 -2
  161. package/resources/api/websites.d.ts.map +1 -0
  162. package/resources/{websites.js → api/websites.js} +2 -2
  163. package/resources/api/websites.js.map +1 -0
  164. package/resources/{websites.mjs → api/websites.mjs} +2 -2
  165. package/resources/api/websites.mjs.map +1 -0
  166. package/resources/api.d.ts +2 -0
  167. package/resources/api.d.ts.map +1 -0
  168. package/resources/api.js +19 -0
  169. package/resources/api.js.map +1 -0
  170. package/resources/api.mjs +3 -0
  171. package/resources/api.mjs.map +1 -0
  172. package/resources/index.d.ts +1 -6
  173. package/resources/index.d.ts.map +1 -1
  174. package/resources/index.js +3 -13
  175. package/resources/index.js.map +1 -1
  176. package/resources/index.mjs +1 -6
  177. package/resources/index.mjs.map +1 -1
  178. package/resources.d.ts +2 -0
  179. package/resources.d.ts.map +1 -0
  180. package/resources.js +18 -0
  181. package/resources.js.map +1 -0
  182. package/resources.mjs +2 -0
  183. package/resources.mjs.map +1 -0
  184. package/src/core.ts +16 -8
  185. package/src/index.ts +28 -57
  186. package/src/resources/api/api.ts +629 -0
  187. package/src/resources/api/index.ts +51 -0
  188. package/src/resources/{loyalty → api/loyalty}/accounts.ts +65 -8
  189. package/src/resources/api/loyalty/badges.ts +1142 -0
  190. package/src/resources/{loyalty → api/loyalty}/currencies.ts +3 -9
  191. package/src/resources/{loyalty → api/loyalty}/index.ts +38 -11
  192. package/src/resources/api/loyalty/loyalty.ts +1297 -0
  193. package/src/resources/{loyalty → api/loyalty}/multipliers.ts +61 -4
  194. package/src/resources/api/loyalty/questions-responses.ts +146 -0
  195. package/src/resources/api/loyalty/questions.ts +208 -0
  196. package/src/resources/{loyalty → api/loyalty}/rule-edits.ts +11 -14
  197. package/src/resources/{loyalty → api/loyalty}/rules.ts +339 -180
  198. package/src/resources/api/loyalty.ts +3 -0
  199. package/src/resources/api/minting.ts +157 -0
  200. package/src/resources/api/referral/index.ts +10 -0
  201. package/src/resources/api/referral/referral.ts +70 -0
  202. package/src/resources/api/referral/users.ts +93 -0
  203. package/src/resources/api/referral.ts +3 -0
  204. package/src/resources/api/users/index.ts +18 -0
  205. package/src/resources/api/users/metadatas.ts +206 -0
  206. package/src/resources/api/users/users.ts +203 -0
  207. package/src/resources/api/users.ts +3 -0
  208. package/src/resources/api/website-collections.ts +148 -0
  209. package/src/resources/api/website-user-roles.ts +107 -0
  210. package/src/resources/{websites.ts → api/websites.ts} +3 -3
  211. package/src/resources/api.ts +3 -0
  212. package/src/resources/index.ts +8 -11
  213. package/src/resources.ts +1 -0
  214. package/src/version.ts +1 -1
  215. package/version.d.ts +1 -1
  216. package/version.js +1 -1
  217. package/version.mjs +1 -1
  218. package/resources/assets.d.ts +0 -50
  219. package/resources/assets.d.ts.map +0 -1
  220. package/resources/assets.js +0 -17
  221. package/resources/assets.js.map +0 -1
  222. package/resources/assets.mjs +0 -13
  223. package/resources/assets.mjs.map +0 -1
  224. package/resources/auction-bids.d.ts +0 -81
  225. package/resources/auction-bids.d.ts.map +0 -1
  226. package/resources/auction-bids.js +0 -30
  227. package/resources/auction-bids.js.map +0 -1
  228. package/resources/auction-bids.mjs +0 -26
  229. package/resources/auction-bids.mjs.map +0 -1
  230. package/resources/drip/drip.d.ts +0 -14
  231. package/resources/drip/drip.d.ts.map +0 -1
  232. package/resources/drip/drip.js.map +0 -1
  233. package/resources/drip/drip.mjs +0 -16
  234. package/resources/drip/drip.mjs.map +0 -1
  235. package/resources/drip/index.d.ts +0 -4
  236. package/resources/drip/index.d.ts.map +0 -1
  237. package/resources/drip/index.js +0 -11
  238. package/resources/drip/index.js.map +0 -1
  239. package/resources/drip/index.mjs +0 -5
  240. package/resources/drip/index.mjs.map +0 -1
  241. package/resources/drip/quests.d.ts +0 -168
  242. package/resources/drip/quests.d.ts.map +0 -1
  243. package/resources/drip/quests.js +0 -17
  244. package/resources/drip/quests.js.map +0 -1
  245. package/resources/drip/quests.mjs +0 -13
  246. package/resources/drip/quests.mjs.map +0 -1
  247. package/resources/drip/status.d.ts +0 -26
  248. package/resources/drip/status.d.ts.map +0 -1
  249. package/resources/drip/status.js +0 -16
  250. package/resources/drip/status.js.map +0 -1
  251. package/resources/drip/status.mjs +0 -12
  252. package/resources/drip/status.mjs.map +0 -1
  253. package/resources/loyalty/accounts.d.ts.map +0 -1
  254. package/resources/loyalty/accounts.js +0 -16
  255. package/resources/loyalty/accounts.js.map +0 -1
  256. package/resources/loyalty/accounts.mjs +0 -12
  257. package/resources/loyalty/accounts.mjs.map +0 -1
  258. package/resources/loyalty/badges.d.ts +0 -299
  259. package/resources/loyalty/badges.d.ts.map +0 -1
  260. package/resources/loyalty/badges.js.map +0 -1
  261. package/resources/loyalty/badges.mjs.map +0 -1
  262. package/resources/loyalty/currencies.d.ts.map +0 -1
  263. package/resources/loyalty/currencies.js.map +0 -1
  264. package/resources/loyalty/currencies.mjs.map +0 -1
  265. package/resources/loyalty/index.d.ts +0 -9
  266. package/resources/loyalty/index.d.ts.map +0 -1
  267. package/resources/loyalty/index.js.map +0 -1
  268. package/resources/loyalty/index.mjs.map +0 -1
  269. package/resources/loyalty/loyalty.d.ts +0 -34
  270. package/resources/loyalty/loyalty.d.ts.map +0 -1
  271. package/resources/loyalty/loyalty.js.map +0 -1
  272. package/resources/loyalty/loyalty.mjs +0 -36
  273. package/resources/loyalty/loyalty.mjs.map +0 -1
  274. package/resources/loyalty/multipliers.d.ts.map +0 -1
  275. package/resources/loyalty/multipliers.js.map +0 -1
  276. package/resources/loyalty/multipliers.mjs.map +0 -1
  277. package/resources/loyalty/rule-edits.d.ts.map +0 -1
  278. package/resources/loyalty/rule-edits.js.map +0 -1
  279. package/resources/loyalty/rule-edits.mjs.map +0 -1
  280. package/resources/loyalty/rules.d.ts.map +0 -1
  281. package/resources/loyalty/rules.js.map +0 -1
  282. package/resources/loyalty/rules.mjs.map +0 -1
  283. package/resources/loyalty/transaction-entries.d.ts +0 -175
  284. package/resources/loyalty/transaction-entries.d.ts.map +0 -1
  285. package/resources/loyalty/transaction-entries.js +0 -16
  286. package/resources/loyalty/transaction-entries.js.map +0 -1
  287. package/resources/loyalty/transaction-entries.mjs +0 -12
  288. package/resources/loyalty/transaction-entries.mjs.map +0 -1
  289. package/resources/users/index.d.ts +0 -4
  290. package/resources/users/index.d.ts.map +0 -1
  291. package/resources/users/index.js.map +0 -1
  292. package/resources/users/index.mjs +0 -5
  293. package/resources/users/index.mjs.map +0 -1
  294. package/resources/users/metadatas.d.ts +0 -64
  295. package/resources/users/metadatas.d.ts.map +0 -1
  296. package/resources/users/metadatas.js.map +0 -1
  297. package/resources/users/metadatas.mjs +0 -12
  298. package/resources/users/metadatas.mjs.map +0 -1
  299. package/resources/users/users.d.ts +0 -14
  300. package/resources/users/users.d.ts.map +0 -1
  301. package/resources/users/users.js.map +0 -1
  302. package/resources/users/users.mjs +0 -16
  303. package/resources/users/users.mjs.map +0 -1
  304. package/resources/users/wallets.d.ts +0 -193
  305. package/resources/users/wallets.d.ts.map +0 -1
  306. package/resources/users/wallets.js +0 -28
  307. package/resources/users/wallets.js.map +0 -1
  308. package/resources/users/wallets.mjs +0 -24
  309. package/resources/users/wallets.mjs.map +0 -1
  310. package/resources/websites.d.ts.map +0 -1
  311. package/resources/websites.js.map +0 -1
  312. package/resources/websites.mjs.map +0 -1
  313. package/src/resources/assets.ts +0 -71
  314. package/src/resources/auction-bids.ts +0 -123
  315. package/src/resources/drip/drip.ts +0 -25
  316. package/src/resources/drip/index.ts +0 -5
  317. package/src/resources/drip/quests.ts +0 -210
  318. package/src/resources/drip/status.ts +0 -33
  319. package/src/resources/loyalty/badges.ts +0 -435
  320. package/src/resources/loyalty/loyalty.ts +0 -159
  321. package/src/resources/loyalty/transaction-entries.ts +0 -229
  322. package/src/resources/users/index.ts +0 -12
  323. package/src/resources/users/metadatas.ts +0 -103
  324. package/src/resources/users/users.ts +0 -39
  325. package/src/resources/users/wallets.ts +0 -271
@@ -1,5 +1,5 @@
1
- import { APIResource } from "../../resource.js";
2
- import * as Core from "../../core.js";
1
+ import { APIResource } from "../../../resource.js";
2
+ import * as Core from "../../../core.js";
3
3
  export declare class Rules extends APIResource {
4
4
  /**
5
5
  * Create a new Loyalty Rule
@@ -20,17 +20,17 @@ export declare class Rules extends APIResource {
20
20
  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
21
21
  /**
22
22
  * Verify a loyalty rule based on user action and reward them if applicable. This
23
- * endpoint currenlty onlu supports following rule types code_entry, text_input,
23
+ * endpoint currently only supports following rule types code_entry, text_input,
24
24
  * link_click, discord_member, connect_wallet, check_in, external_rule,
25
25
  * drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name,
26
- * drip_x_text_in_comment, drip_x_tweet, telegram_join
26
+ * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages
27
27
  */
28
28
  complete(id: string, body?: RuleCompleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleCompleteResponse>;
29
29
  complete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleCompleteResponse>;
30
30
  /**
31
31
  * This will return the processing status of quests for a specific user
32
32
  */
33
- status(query: RuleStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleStatusResponse>;
33
+ getStatus(query: RuleGetStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
34
34
  }
35
35
  export interface RuleCreateResponse {
36
36
  id: string;
@@ -77,7 +77,7 @@ export interface RuleCreateResponse {
77
77
  /**
78
78
  * Type of loyalty rule being created
79
79
  */
80
- 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';
80
+ 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';
81
81
  /**
82
82
  * Unique identifier for the associated website
83
83
  */
@@ -113,7 +113,7 @@ export interface RuleCreateResponse {
113
113
  /**
114
114
  * Interval between rule executions
115
115
  */
116
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
116
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
117
117
  /**
118
118
  * Whether this rule is mandatory
119
119
  */
@@ -125,7 +125,7 @@ export interface RuleCreateResponse {
125
125
  /**
126
126
  * Blockchain network where the rule will apply
127
127
  */
128
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
128
+ 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';
129
129
  /**
130
130
  * OAuth credentials associated with the rule
131
131
  */
@@ -260,6 +260,14 @@ export declare namespace RuleCreateResponse {
260
260
  * Flag indicating whether to include only non-listed items.
261
261
  */
262
262
  onlyNonListed?: boolean;
263
+ /**
264
+ * Indicates if only existing users are rewarded.
265
+ */
266
+ onlyRewardExistingUser?: boolean;
267
+ /**
268
+ * give points for only one token ownership per contract
269
+ */
270
+ onlyRewardSingleTokenOwnership?: boolean | null;
263
271
  /**
264
272
  * Promotional code associated with the rule.
265
273
  */
@@ -288,6 +296,10 @@ export declare namespace RuleCreateResponse {
288
296
  * Percentage reward given for a second-level referral.
289
297
  */
290
298
  secondReferralReward?: number | null;
299
+ /**
300
+ * Flag indicating if the multiplier is skipped.
301
+ */
302
+ skipMultiplier?: boolean | null;
291
303
  /**
292
304
  * Object containing details of the associated smart contract.
293
305
  */
@@ -299,7 +311,7 @@ export declare namespace RuleCreateResponse {
299
311
  /**
300
312
  * Social media platform associated with the rule.
301
313
  */
302
- socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
314
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
303
315
  /**
304
316
  * URL of the social platform's logo.
305
317
  */
@@ -374,7 +386,7 @@ export declare namespace RuleCreateResponse {
374
386
  /**
375
387
  * Blockchain network of the collection.
376
388
  */
377
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
389
+ 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';
378
390
  }
379
391
  /**
380
392
  * Object containing details for the call-to-action.
@@ -413,6 +425,10 @@ export declare namespace RuleCreateResponse {
413
425
  * Array of emojis used in the channel.
414
426
  */
415
427
  emojis?: Array<Channel.Emoji>;
428
+ /**
429
+ * Phrase of text to be present in the discord message
430
+ */
431
+ text?: string;
416
432
  }
417
433
  namespace Channel {
418
434
  interface Emoji {
@@ -608,7 +624,7 @@ export declare namespace RuleCreateResponse {
608
624
  /**
609
625
  * Blockchain network for the collection
610
626
  */
611
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
627
+ 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';
612
628
  }
613
629
  }
614
630
  export interface RuleUpdateResponse {
@@ -617,34 +633,14 @@ export interface RuleUpdateResponse {
617
633
  * Reward amount for the loyalty rule
618
634
  */
619
635
  amount: unknown;
620
- /**
621
- * Effective end time of the rule
622
- */
623
- effectiveEndTime: string | null;
624
- /**
625
- * Effective start time of the rule
626
- */
627
- effectiveStartTime: string | null;
628
636
  /**
629
637
  * End time for the loyalty rule
630
638
  */
631
639
  endTime: string | null;
632
- /**
633
- * Frequency of the rule execution
634
- */
635
- frequency: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
636
- /**
637
- * Additional metadata for the loyalty rule
638
- */
639
- metadata: RuleUpdateResponse.Metadata;
640
640
  /**
641
641
  * Name of the loyalty rule
642
642
  */
643
643
  name: string;
644
- /**
645
- * Start time for the loyalty rule
646
- */
647
- startTime: string | null;
648
644
  /**
649
645
  * Blockchain address of the associated collection
650
646
  */
@@ -665,6 +661,18 @@ export interface RuleUpdateResponse {
665
661
  * Optional description of the loyalty rule
666
662
  */
667
663
  description?: string;
664
+ /**
665
+ * Effective end time of the rule
666
+ */
667
+ effectiveEndTime?: string | null;
668
+ /**
669
+ * Effective start time of the rule
670
+ */
671
+ effectiveStartTime?: string | null;
672
+ /**
673
+ * Frequency of the rule execution
674
+ */
675
+ frequency?: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
668
676
  /**
669
677
  * Whether to hide this rule in the user interface
670
678
  */
@@ -672,7 +680,7 @@ export interface RuleUpdateResponse {
672
680
  /**
673
681
  * Time interval for recurring rule execution
674
682
  */
675
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
683
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
676
684
  /**
677
685
  * Whether this rule is required for participation
678
686
  */
@@ -681,10 +689,14 @@ export interface RuleUpdateResponse {
681
689
  * ID of the rule group section to associate with the rule
682
690
  */
683
691
  loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
692
+ /**
693
+ * Additional metadata for the loyalty rule
694
+ */
695
+ metadata?: RuleUpdateResponse.Metadata;
684
696
  /**
685
697
  * Blockchain network where the rule will apply
686
698
  */
687
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
699
+ 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';
688
700
  /**
689
701
  * ID for associated OAuth credentials
690
702
  */
@@ -693,12 +705,26 @@ export interface RuleUpdateResponse {
693
705
  * Type of reward issued by this rule
694
706
  */
695
707
  rewardType?: 'points' | 'multiplier';
708
+ /**
709
+ * Start time for the loyalty rule
710
+ */
711
+ startTime?: string | null;
696
712
  /**
697
713
  * Optional subscription identifier for the rule
698
714
  */
699
715
  subscriptionIdentifier?: string | null;
700
716
  }
701
717
  export declare namespace RuleUpdateResponse {
718
+ interface Collection {
719
+ /**
720
+ * Blockchain address of the collection
721
+ */
722
+ address: string;
723
+ /**
724
+ * Blockchain network for the collection
725
+ */
726
+ 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';
727
+ }
702
728
  /**
703
729
  * Additional metadata for the loyalty rule
704
730
  */
@@ -819,6 +845,14 @@ export declare namespace RuleUpdateResponse {
819
845
  * Flag indicating whether to include only non-listed items.
820
846
  */
821
847
  onlyNonListed?: boolean;
848
+ /**
849
+ * Indicates if only existing users are rewarded.
850
+ */
851
+ onlyRewardExistingUser?: boolean;
852
+ /**
853
+ * give points for only one token ownership per contract
854
+ */
855
+ onlyRewardSingleTokenOwnership?: boolean | null;
822
856
  /**
823
857
  * Promotional code associated with the rule.
824
858
  */
@@ -847,6 +881,10 @@ export declare namespace RuleUpdateResponse {
847
881
  * Percentage reward given for a second-level referral.
848
882
  */
849
883
  secondReferralReward?: number | null;
884
+ /**
885
+ * Flag indicating if the multiplier is skipped.
886
+ */
887
+ skipMultiplier?: boolean | null;
850
888
  /**
851
889
  * Object containing details of the associated smart contract.
852
890
  */
@@ -858,7 +896,7 @@ export declare namespace RuleUpdateResponse {
858
896
  /**
859
897
  * Social media platform associated with the rule.
860
898
  */
861
- socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
899
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
862
900
  /**
863
901
  * URL of the social platform's logo.
864
902
  */
@@ -933,7 +971,7 @@ export declare namespace RuleUpdateResponse {
933
971
  /**
934
972
  * Blockchain network of the collection.
935
973
  */
936
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
974
+ 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';
937
975
  }
938
976
  /**
939
977
  * Object containing details for the call-to-action.
@@ -972,6 +1010,10 @@ export declare namespace RuleUpdateResponse {
972
1010
  * Array of emojis used in the channel.
973
1011
  */
974
1012
  emojis?: Array<Channel.Emoji>;
1013
+ /**
1014
+ * Phrase of text to be present in the discord message
1015
+ */
1016
+ text?: string;
975
1017
  }
976
1018
  namespace Channel {
977
1019
  interface Emoji {
@@ -1159,16 +1201,6 @@ export declare namespace RuleUpdateResponse {
1159
1201
  streakMilestone: number;
1160
1202
  }
1161
1203
  }
1162
- interface Collection {
1163
- /**
1164
- * Blockchain address of the collection
1165
- */
1166
- address: string;
1167
- /**
1168
- * Blockchain network for the collection
1169
- */
1170
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
1171
- }
1172
1204
  }
1173
1205
  export interface RuleListResponse {
1174
1206
  data: Array<RuleListResponse.Data>;
@@ -1232,10 +1264,10 @@ export interface RuleDeleteResponse {
1232
1264
  export interface RuleCompleteResponse {
1233
1265
  message: string;
1234
1266
  }
1235
- export interface RuleStatusResponse {
1236
- data: Array<RuleStatusResponse.Data>;
1267
+ export interface RuleGetStatusResponse {
1268
+ data: Array<RuleGetStatusResponse.Data>;
1237
1269
  }
1238
- export declare namespace RuleStatusResponse {
1270
+ export declare namespace RuleGetStatusResponse {
1239
1271
  interface Data {
1240
1272
  loyaltyRuleId: string;
1241
1273
  status: 'pending' | 'processing' | 'completed' | 'failed';
@@ -1287,7 +1319,7 @@ export interface RuleCreateParams {
1287
1319
  /**
1288
1320
  * Type of loyalty rule being created
1289
1321
  */
1290
- 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';
1322
+ 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';
1291
1323
  /**
1292
1324
  * Unique identifier for the associated website
1293
1325
  */
@@ -1323,7 +1355,7 @@ export interface RuleCreateParams {
1323
1355
  /**
1324
1356
  * Interval between rule executions
1325
1357
  */
1326
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
1358
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
1327
1359
  /**
1328
1360
  * Whether this rule is mandatory
1329
1361
  */
@@ -1335,7 +1367,7 @@ export interface RuleCreateParams {
1335
1367
  /**
1336
1368
  * Blockchain network where the rule will apply
1337
1369
  */
1338
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
1370
+ 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';
1339
1371
  /**
1340
1372
  * OAuth credentials associated with the rule
1341
1373
  */
@@ -1470,6 +1502,14 @@ export declare namespace RuleCreateParams {
1470
1502
  * Flag indicating whether to include only non-listed items.
1471
1503
  */
1472
1504
  onlyNonListed?: boolean;
1505
+ /**
1506
+ * Indicates if only existing users are rewarded.
1507
+ */
1508
+ onlyRewardExistingUser?: boolean;
1509
+ /**
1510
+ * give points for only one token ownership per contract
1511
+ */
1512
+ onlyRewardSingleTokenOwnership?: boolean | null;
1473
1513
  /**
1474
1514
  * Promotional code associated with the rule.
1475
1515
  */
@@ -1498,6 +1538,10 @@ export declare namespace RuleCreateParams {
1498
1538
  * Percentage reward given for a second-level referral.
1499
1539
  */
1500
1540
  secondReferralReward?: number | null;
1541
+ /**
1542
+ * Flag indicating if the multiplier is skipped.
1543
+ */
1544
+ skipMultiplier?: boolean | null;
1501
1545
  /**
1502
1546
  * Object containing details of the associated smart contract.
1503
1547
  */
@@ -1509,7 +1553,7 @@ export declare namespace RuleCreateParams {
1509
1553
  /**
1510
1554
  * Social media platform associated with the rule.
1511
1555
  */
1512
- socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
1556
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
1513
1557
  /**
1514
1558
  * URL of the social platform's logo.
1515
1559
  */
@@ -1584,7 +1628,7 @@ export declare namespace RuleCreateParams {
1584
1628
  /**
1585
1629
  * Blockchain network of the collection.
1586
1630
  */
1587
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
1631
+ 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';
1588
1632
  }
1589
1633
  /**
1590
1634
  * Object containing details for the call-to-action.
@@ -1623,6 +1667,10 @@ export declare namespace RuleCreateParams {
1623
1667
  * Array of emojis used in the channel.
1624
1668
  */
1625
1669
  emojis?: Array<Channel.Emoji>;
1670
+ /**
1671
+ * Phrase of text to be present in the discord message
1672
+ */
1673
+ text?: string;
1626
1674
  }
1627
1675
  namespace Channel {
1628
1676
  interface Emoji {
@@ -1818,7 +1866,7 @@ export declare namespace RuleCreateParams {
1818
1866
  /**
1819
1867
  * Blockchain network for the collection
1820
1868
  */
1821
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
1869
+ 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';
1822
1870
  }
1823
1871
  }
1824
1872
  export interface RuleUpdateParams {
@@ -1826,34 +1874,14 @@ export interface RuleUpdateParams {
1826
1874
  * Reward amount for the loyalty rule
1827
1875
  */
1828
1876
  amount: unknown;
1829
- /**
1830
- * Effective end time of the rule
1831
- */
1832
- effectiveEndTime: string | null;
1833
- /**
1834
- * Effective start time of the rule
1835
- */
1836
- effectiveStartTime: string | null;
1837
1877
  /**
1838
1878
  * End time for the loyalty rule
1839
1879
  */
1840
1880
  endTime: string | null;
1841
- /**
1842
- * Frequency of the rule execution
1843
- */
1844
- frequency: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
1845
- /**
1846
- * Additional metadata for the loyalty rule
1847
- */
1848
- metadata: RuleUpdateParams.Metadata;
1849
1881
  /**
1850
1882
  * Name of the loyalty rule
1851
1883
  */
1852
1884
  name: string;
1853
- /**
1854
- * Start time for the loyalty rule
1855
- */
1856
- startTime: string | null;
1857
1885
  /**
1858
1886
  * Blockchain address of the associated collection
1859
1887
  */
@@ -1874,6 +1902,18 @@ export interface RuleUpdateParams {
1874
1902
  * Optional description of the loyalty rule
1875
1903
  */
1876
1904
  description?: string;
1905
+ /**
1906
+ * Effective end time of the rule
1907
+ */
1908
+ effectiveEndTime?: string | null;
1909
+ /**
1910
+ * Effective start time of the rule
1911
+ */
1912
+ effectiveStartTime?: string | null;
1913
+ /**
1914
+ * Frequency of the rule execution
1915
+ */
1916
+ frequency?: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
1877
1917
  /**
1878
1918
  * Whether to hide this rule in the user interface
1879
1919
  */
@@ -1881,7 +1921,7 @@ export interface RuleUpdateParams {
1881
1921
  /**
1882
1922
  * Time interval for recurring rule execution
1883
1923
  */
1884
- interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
1924
+ interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
1885
1925
  /**
1886
1926
  * Whether this rule is required for participation
1887
1927
  */
@@ -1890,10 +1930,14 @@ export interface RuleUpdateParams {
1890
1930
  * ID of the rule group section to associate with the rule
1891
1931
  */
1892
1932
  loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
1933
+ /**
1934
+ * Additional metadata for the loyalty rule
1935
+ */
1936
+ metadata?: RuleUpdateParams.Metadata;
1893
1937
  /**
1894
1938
  * Blockchain network where the rule will apply
1895
1939
  */
1896
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
1940
+ 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';
1897
1941
  /**
1898
1942
  * ID for associated OAuth credentials
1899
1943
  */
@@ -1902,12 +1946,26 @@ export interface RuleUpdateParams {
1902
1946
  * Type of reward issued by this rule
1903
1947
  */
1904
1948
  rewardType?: 'points' | 'multiplier';
1949
+ /**
1950
+ * Start time for the loyalty rule
1951
+ */
1952
+ startTime?: string | null;
1905
1953
  /**
1906
1954
  * Optional subscription identifier for the rule
1907
1955
  */
1908
1956
  subscriptionIdentifier?: string | null;
1909
1957
  }
1910
1958
  export declare namespace RuleUpdateParams {
1959
+ interface Collection {
1960
+ /**
1961
+ * Blockchain address of the collection
1962
+ */
1963
+ address: string;
1964
+ /**
1965
+ * Blockchain network for the collection
1966
+ */
1967
+ 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';
1968
+ }
1911
1969
  /**
1912
1970
  * Additional metadata for the loyalty rule
1913
1971
  */
@@ -2028,6 +2086,14 @@ export declare namespace RuleUpdateParams {
2028
2086
  * Flag indicating whether to include only non-listed items.
2029
2087
  */
2030
2088
  onlyNonListed?: boolean;
2089
+ /**
2090
+ * Indicates if only existing users are rewarded.
2091
+ */
2092
+ onlyRewardExistingUser?: boolean;
2093
+ /**
2094
+ * give points for only one token ownership per contract
2095
+ */
2096
+ onlyRewardSingleTokenOwnership?: boolean | null;
2031
2097
  /**
2032
2098
  * Promotional code associated with the rule.
2033
2099
  */
@@ -2056,6 +2122,10 @@ export declare namespace RuleUpdateParams {
2056
2122
  * Percentage reward given for a second-level referral.
2057
2123
  */
2058
2124
  secondReferralReward?: number | null;
2125
+ /**
2126
+ * Flag indicating if the multiplier is skipped.
2127
+ */
2128
+ skipMultiplier?: boolean | null;
2059
2129
  /**
2060
2130
  * Object containing details of the associated smart contract.
2061
2131
  */
@@ -2067,7 +2137,7 @@ export declare namespace RuleUpdateParams {
2067
2137
  /**
2068
2138
  * Social media platform associated with the rule.
2069
2139
  */
2070
- socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
2140
+ socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | null;
2071
2141
  /**
2072
2142
  * URL of the social platform's logo.
2073
2143
  */
@@ -2142,7 +2212,7 @@ export declare namespace RuleUpdateParams {
2142
2212
  /**
2143
2213
  * Blockchain network of the collection.
2144
2214
  */
2145
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
2215
+ 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';
2146
2216
  }
2147
2217
  /**
2148
2218
  * Object containing details for the call-to-action.
@@ -2181,6 +2251,10 @@ export declare namespace RuleUpdateParams {
2181
2251
  * Array of emojis used in the channel.
2182
2252
  */
2183
2253
  emojis?: Array<Channel.Emoji>;
2254
+ /**
2255
+ * Phrase of text to be present in the discord message
2256
+ */
2257
+ text?: string;
2184
2258
  }
2185
2259
  namespace Channel {
2186
2260
  interface Emoji {
@@ -2368,16 +2442,6 @@ export declare namespace RuleUpdateParams {
2368
2442
  streakMilestone: number;
2369
2443
  }
2370
2444
  }
2371
- interface Collection {
2372
- /**
2373
- * Blockchain address of the collection
2374
- */
2375
- address: string;
2376
- /**
2377
- * Blockchain network for the collection
2378
- */
2379
- 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' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
2380
- }
2381
2445
  }
2382
2446
  export interface RuleListParams {
2383
2447
  /**
@@ -2388,6 +2452,10 @@ export interface RuleListParams {
2388
2452
  * Maximum number of records to return (max 1000)
2389
2453
  */
2390
2454
  limit?: number;
2455
+ /**
2456
+ * ID of the loyalty rule group to filter results
2457
+ */
2458
+ loyaltyRuleGroupId?: string;
2391
2459
  /**
2392
2460
  * Unique identifier for the organization to filter by
2393
2461
  */
@@ -2406,6 +2474,10 @@ export interface RuleCompleteParams {
2406
2474
  * Link to the comment made by user
2407
2475
  */
2408
2476
  commentLink?: string;
2477
+ /**
2478
+ * ID of the choice selected by the user
2479
+ */
2480
+ loyaltyQuestionChoiceId?: string;
2409
2481
  /**
2410
2482
  * Unique identifier for the user
2411
2483
  */
@@ -2414,17 +2486,22 @@ export interface RuleCompleteParams {
2414
2486
  * Optional verification code for completing the loyalty rule
2415
2487
  */
2416
2488
  verificationCode?: string;
2489
+ /**
2490
+ * Flag indicating if only verification is required, this will not create a
2491
+ * transaction and reward the user
2492
+ */
2493
+ verifyOnly?: string;
2417
2494
  /**
2418
2495
  * Wallet address of the user can only be used if userId is not provided
2419
2496
  */
2420
2497
  walletAddress?: string;
2421
2498
  }
2422
- export interface RuleStatusParams {
2499
+ export interface RuleGetStatusParams {
2423
2500
  organizationId: string;
2424
2501
  websiteId: string;
2425
2502
  userId?: string;
2426
2503
  }
2427
2504
  export declare namespace Rules {
2428
- export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleStatusResponse as RuleStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleCompleteParams as RuleCompleteParams, type RuleStatusParams as RuleStatusParams, };
2505
+ export { 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, };
2429
2506
  }
2430
2507
  //# sourceMappingURL=rules.d.ts.map