@snagsolutions/sdk 0.1.0-alpha.20 → 0.1.0-alpha.201

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 (272) hide show
  1. package/CHANGELOG.md +1634 -0
  2. package/README.md +13 -23
  3. package/core.d.ts +19 -5
  4. package/core.d.ts.map +1 -1
  5. package/core.js +24 -17
  6. package/core.js.map +1 -1
  7. package/core.mjs +24 -17
  8. package/core.mjs.map +1 -1
  9. package/index.d.mts +7 -4
  10. package/index.d.ts +7 -4
  11. package/index.d.ts.map +1 -1
  12. package/index.js +8 -4
  13. package/index.js.map +1 -1
  14. package/index.mjs +8 -4
  15. package/index.mjs.map +1 -1
  16. package/package.json +4 -5
  17. package/resource.d.ts +1 -1
  18. package/resource.d.ts.map +1 -1
  19. package/resource.js.map +1 -1
  20. package/resource.mjs.map +1 -1
  21. package/resources/assets.d.ts +16 -2
  22. package/resources/assets.d.ts.map +1 -1
  23. package/resources/assets.js +8 -0
  24. package/resources/assets.js.map +1 -1
  25. package/resources/assets.mjs +8 -0
  26. package/resources/assets.mjs.map +1 -1
  27. package/resources/auctions/auctions.d.ts +368 -0
  28. package/resources/auctions/auctions.d.ts.map +1 -0
  29. package/resources/auctions/auctions.js +72 -0
  30. package/resources/auctions/auctions.js.map +1 -0
  31. package/resources/auctions/auctions.mjs +45 -0
  32. package/resources/auctions/auctions.mjs.map +1 -0
  33. package/resources/auctions/index.d.ts +3 -0
  34. package/resources/auctions/index.d.ts.map +1 -0
  35. package/resources/auctions/index.js +9 -0
  36. package/resources/auctions/index.js.map +1 -0
  37. package/resources/auctions/index.mjs +4 -0
  38. package/resources/auctions/index.mjs.map +1 -0
  39. package/resources/auctions/website-user-attributes/index.d.ts +3 -0
  40. package/resources/auctions/website-user-attributes/index.d.ts.map +1 -0
  41. package/resources/auctions/website-user-attributes/index.js +9 -0
  42. package/resources/auctions/website-user-attributes/index.js.map +1 -0
  43. package/resources/auctions/website-user-attributes/index.mjs +4 -0
  44. package/resources/auctions/website-user-attributes/index.mjs.map +1 -0
  45. package/resources/auctions/website-user-attributes/values.d.ts +126 -0
  46. package/resources/auctions/website-user-attributes/values.d.ts.map +1 -0
  47. package/resources/auctions/website-user-attributes/values.js +49 -0
  48. package/resources/auctions/website-user-attributes/values.js.map +1 -0
  49. package/resources/auctions/website-user-attributes/values.mjs +45 -0
  50. package/resources/auctions/website-user-attributes/values.mjs.map +1 -0
  51. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts +136 -0
  52. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts.map +1 -0
  53. package/resources/auctions/website-user-attributes/website-user-attributes.js +76 -0
  54. package/resources/auctions/website-user-attributes/website-user-attributes.js.map +1 -0
  55. package/resources/auctions/website-user-attributes/website-user-attributes.mjs +49 -0
  56. package/resources/auctions/website-user-attributes/website-user-attributes.mjs.map +1 -0
  57. package/resources/auctions/website-user-attributes.d.ts +2 -0
  58. package/resources/auctions/website-user-attributes.d.ts.map +1 -0
  59. package/resources/auctions/website-user-attributes.js +19 -0
  60. package/resources/auctions/website-user-attributes.js.map +1 -0
  61. package/resources/auctions/website-user-attributes.mjs +3 -0
  62. package/resources/auctions/website-user-attributes.mjs.map +1 -0
  63. package/resources/auctions.d.ts +1 -133
  64. package/resources/auctions.d.ts.map +1 -1
  65. package/resources/auctions.js +15 -22
  66. package/resources/auctions.js.map +1 -1
  67. package/resources/auctions.mjs +1 -20
  68. package/resources/auctions.mjs.map +1 -1
  69. package/resources/auth.d.ts +17 -4
  70. package/resources/auth.d.ts.map +1 -1
  71. package/resources/auth.js.map +1 -1
  72. package/resources/auth.mjs.map +1 -1
  73. package/resources/index.d.ts +2 -2
  74. package/resources/index.d.ts.map +1 -1
  75. package/resources/index.js +1 -1
  76. package/resources/index.js.map +1 -1
  77. package/resources/index.mjs +1 -1
  78. package/resources/index.mjs.map +1 -1
  79. package/resources/loyalty/account-streaks.d.ts +81 -0
  80. package/resources/loyalty/account-streaks.d.ts.map +1 -0
  81. package/resources/loyalty/account-streaks.js +24 -0
  82. package/resources/loyalty/account-streaks.js.map +1 -0
  83. package/resources/loyalty/account-streaks.mjs +20 -0
  84. package/resources/loyalty/account-streaks.mjs.map +1 -0
  85. package/resources/loyalty/accounts.d.ts +60 -16
  86. package/resources/loyalty/accounts.d.ts.map +1 -1
  87. package/resources/loyalty/accounts.js +14 -0
  88. package/resources/loyalty/accounts.js.map +1 -1
  89. package/resources/loyalty/accounts.mjs +14 -0
  90. package/resources/loyalty/accounts.mjs.map +1 -1
  91. package/resources/loyalty/badges.d.ts +666 -135
  92. package/resources/loyalty/badges.d.ts.map +1 -1
  93. package/resources/loyalty/badges.js +19 -1
  94. package/resources/loyalty/badges.js.map +1 -1
  95. package/resources/loyalty/badges.mjs +19 -1
  96. package/resources/loyalty/badges.mjs.map +1 -1
  97. package/resources/loyalty/currencies.d.ts +19 -0
  98. package/resources/loyalty/currencies.d.ts.map +1 -1
  99. package/resources/loyalty/currencies.js +19 -0
  100. package/resources/loyalty/currencies.js.map +1 -1
  101. package/resources/loyalty/currencies.mjs +19 -0
  102. package/resources/loyalty/currencies.mjs.map +1 -1
  103. package/resources/loyalty/index.d.ts +4 -4
  104. package/resources/loyalty/index.d.ts.map +1 -1
  105. package/resources/loyalty/index.js +5 -5
  106. package/resources/loyalty/index.js.map +1 -1
  107. package/resources/loyalty/index.mjs +3 -3
  108. package/resources/loyalty/index.mjs.map +1 -1
  109. package/resources/loyalty/loyalty.d.ts +11 -11
  110. package/resources/loyalty/loyalty.d.ts.map +1 -1
  111. package/resources/loyalty/loyalty.js +6 -6
  112. package/resources/loyalty/loyalty.js.map +1 -1
  113. package/resources/loyalty/loyalty.mjs +7 -7
  114. package/resources/loyalty/loyalty.mjs.map +1 -1
  115. package/resources/loyalty/multipliers.d.ts +39 -2
  116. package/resources/loyalty/multipliers.d.ts.map +1 -1
  117. package/resources/loyalty/multipliers.js +23 -0
  118. package/resources/loyalty/multipliers.js.map +1 -1
  119. package/resources/loyalty/multipliers.mjs +23 -0
  120. package/resources/loyalty/multipliers.mjs.map +1 -1
  121. package/resources/loyalty/questions-responses.d.ts +55 -4
  122. package/resources/loyalty/questions-responses.d.ts.map +1 -1
  123. package/resources/loyalty/questions-responses.js +9 -0
  124. package/resources/loyalty/questions-responses.js.map +1 -1
  125. package/resources/loyalty/questions-responses.mjs +9 -0
  126. package/resources/loyalty/questions-responses.mjs.map +1 -1
  127. package/resources/loyalty/questions.d.ts +52 -6
  128. package/resources/loyalty/questions.d.ts.map +1 -1
  129. package/resources/loyalty/questions.js +31 -0
  130. package/resources/loyalty/questions.js.map +1 -1
  131. package/resources/loyalty/questions.mjs +31 -0
  132. package/resources/loyalty/questions.mjs.map +1 -1
  133. package/resources/loyalty/rule-edits.d.ts +2646 -8
  134. package/resources/loyalty/rule-edits.d.ts.map +1 -1
  135. package/resources/loyalty/rule-edits.js +14 -0
  136. package/resources/loyalty/rule-edits.js.map +1 -1
  137. package/resources/loyalty/rule-edits.mjs +14 -0
  138. package/resources/loyalty/rule-edits.mjs.map +1 -1
  139. package/resources/loyalty/rule-groups.d.ts +283 -64
  140. package/resources/loyalty/rule-groups.d.ts.map +1 -1
  141. package/resources/loyalty/rule-groups.js +38 -2
  142. package/resources/loyalty/rule-groups.js.map +1 -1
  143. package/resources/loyalty/rule-groups.mjs +38 -2
  144. package/resources/loyalty/rule-groups.mjs.map +1 -1
  145. package/resources/loyalty/rules.d.ts +1930 -269
  146. package/resources/loyalty/rules.d.ts.map +1 -1
  147. package/resources/loyalty/rules.js +40 -9
  148. package/resources/loyalty/rules.js.map +1 -1
  149. package/resources/loyalty/rules.mjs +40 -9
  150. package/resources/loyalty/rules.mjs.map +1 -1
  151. package/resources/loyalty/transactions/index.d.ts +3 -0
  152. package/resources/loyalty/transactions/index.d.ts.map +1 -0
  153. package/resources/loyalty/transactions/index.js +9 -0
  154. package/resources/loyalty/transactions/index.js.map +1 -0
  155. package/resources/loyalty/transactions/index.mjs +4 -0
  156. package/resources/loyalty/transactions/index.mjs.map +1 -0
  157. package/resources/loyalty/transactions/rule-statuses.d.ts +120 -0
  158. package/resources/loyalty/transactions/rule-statuses.d.ts.map +1 -0
  159. package/resources/loyalty/transactions/rule-statuses.js +30 -0
  160. package/resources/loyalty/transactions/rule-statuses.js.map +1 -0
  161. package/resources/loyalty/transactions/rule-statuses.mjs +26 -0
  162. package/resources/loyalty/transactions/rule-statuses.mjs.map +1 -0
  163. package/resources/loyalty/transactions/transactions.d.ts +410 -0
  164. package/resources/loyalty/transactions/transactions.d.ts.map +1 -0
  165. package/resources/loyalty/transactions/transactions.js +76 -0
  166. package/resources/loyalty/transactions/transactions.js.map +1 -0
  167. package/resources/loyalty/transactions/transactions.mjs +49 -0
  168. package/resources/loyalty/transactions/transactions.mjs.map +1 -0
  169. package/resources/loyalty/transactions.d.ts +1 -247
  170. package/resources/loyalty/transactions.d.ts.map +1 -1
  171. package/resources/loyalty/transactions.js +15 -18
  172. package/resources/loyalty/transactions.js.map +1 -1
  173. package/resources/loyalty/transactions.mjs +1 -16
  174. package/resources/loyalty/transactions.mjs.map +1 -1
  175. package/resources/minting.d.ts +5 -5
  176. package/resources/minting.d.ts.map +1 -1
  177. package/resources/referral/referral.d.ts +11 -3
  178. package/resources/referral/referral.d.ts.map +1 -1
  179. package/resources/referral/referral.js +11 -5
  180. package/resources/referral/referral.js.map +1 -1
  181. package/resources/referral/referral.mjs +11 -5
  182. package/resources/referral/referral.mjs.map +1 -1
  183. package/resources/referral/users.d.ts +29 -3
  184. package/resources/referral/users.d.ts.map +1 -1
  185. package/resources/referral/users.js +12 -4
  186. package/resources/referral/users.js.map +1 -1
  187. package/resources/referral/users.mjs +12 -4
  188. package/resources/referral/users.mjs.map +1 -1
  189. package/resources/users/index.d.ts +1 -1
  190. package/resources/users/index.d.ts.map +1 -1
  191. package/resources/users/index.js.map +1 -1
  192. package/resources/users/index.mjs.map +1 -1
  193. package/resources/users/metadatas.d.ts +36 -3
  194. package/resources/users/metadatas.d.ts.map +1 -1
  195. package/resources/users/metadatas.js.map +1 -1
  196. package/resources/users/metadatas.mjs.map +1 -1
  197. package/resources/users/users.d.ts +184 -35
  198. package/resources/users/users.d.ts.map +1 -1
  199. package/resources/users/users.js +58 -1
  200. package/resources/users/users.js.map +1 -1
  201. package/resources/users/users.mjs +58 -1
  202. package/resources/users/users.mjs.map +1 -1
  203. package/resources/websites/website-collections.d.ts +22 -1
  204. package/resources/websites/website-collections.d.ts.map +1 -1
  205. package/resources/websites/website-collections.js +21 -0
  206. package/resources/websites/website-collections.js.map +1 -1
  207. package/resources/websites/website-collections.mjs +21 -0
  208. package/resources/websites/website-collections.mjs.map +1 -1
  209. package/resources/websites/website-user-roles.d.ts +24 -1
  210. package/resources/websites/website-user-roles.d.ts.map +1 -1
  211. package/resources/websites/website-user-roles.js +23 -0
  212. package/resources/websites/website-user-roles.js.map +1 -1
  213. package/resources/websites/website-user-roles.mjs +23 -0
  214. package/resources/websites/website-user-roles.mjs.map +1 -1
  215. package/resources/websites/websites.d.ts +12 -0
  216. package/resources/websites/websites.d.ts.map +1 -1
  217. package/resources/websites/websites.js +7 -0
  218. package/resources/websites/websites.js.map +1 -1
  219. package/resources/websites/websites.mjs +7 -0
  220. package/resources/websites/websites.mjs.map +1 -1
  221. package/src/core.ts +39 -16
  222. package/src/index.ts +31 -2
  223. package/src/resource.ts +1 -1
  224. package/src/resources/assets.ts +18 -3
  225. package/src/resources/auctions/auctions.ts +561 -0
  226. package/src/resources/auctions/index.ts +19 -0
  227. package/src/resources/auctions/website-user-attributes/index.ts +18 -0
  228. package/src/resources/auctions/website-user-attributes/values.ts +170 -0
  229. package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +212 -0
  230. package/src/resources/auctions/website-user-attributes.ts +3 -0
  231. package/src/resources/auctions.ts +1 -207
  232. package/src/resources/auth.ts +21 -5
  233. package/src/resources/index.ts +12 -1
  234. package/src/resources/loyalty/account-streaks.ts +110 -0
  235. package/src/resources/loyalty/accounts.ts +65 -18
  236. package/src/resources/loyalty/badges.ts +790 -146
  237. package/src/resources/loyalty/currencies.ts +19 -0
  238. package/src/resources/loyalty/index.ts +19 -3
  239. package/src/resources/loyalty/loyalty.ts +39 -15
  240. package/src/resources/loyalty/multipliers.ts +43 -4
  241. package/src/resources/loyalty/questions-responses.ts +64 -4
  242. package/src/resources/loyalty/questions.ts +56 -6
  243. package/src/resources/loyalty/rule-edits.ts +3854 -100
  244. package/src/resources/loyalty/rule-groups.ts +500 -76
  245. package/src/resources/loyalty/rules.ts +3040 -318
  246. package/src/resources/loyalty/transactions/index.ts +18 -0
  247. package/src/resources/loyalty/transactions/rule-statuses.ts +178 -0
  248. package/src/resources/loyalty/transactions/transactions.ts +689 -0
  249. package/src/resources/loyalty/transactions.ts +1 -330
  250. package/src/resources/minting.ts +25 -5
  251. package/src/resources/referral/referral.ts +13 -11
  252. package/src/resources/referral/users.ts +43 -5
  253. package/src/resources/users/index.ts +4 -0
  254. package/src/resources/users/metadatas.ts +61 -3
  255. package/src/resources/users/users.ts +249 -38
  256. package/src/resources/websites/website-collections.ts +42 -1
  257. package/src/resources/websites/website-user-roles.ts +25 -1
  258. package/src/resources/websites/websites.ts +12 -0
  259. package/src/version.ts +1 -1
  260. package/version.d.ts +1 -1
  261. package/version.d.ts.map +1 -1
  262. package/version.js +1 -1
  263. package/version.js.map +1 -1
  264. package/version.mjs +1 -1
  265. package/version.mjs.map +1 -1
  266. package/resources/loyalty/rule-chains.d.ts +0 -34
  267. package/resources/loyalty/rule-chains.d.ts.map +0 -1
  268. package/resources/loyalty/rule-chains.js +0 -15
  269. package/resources/loyalty/rule-chains.js.map +0 -1
  270. package/resources/loyalty/rule-chains.mjs +0 -11
  271. package/resources/loyalty/rule-chains.mjs.map +0 -1
  272. package/src/resources/loyalty/rule-chains.ts +0 -45
@@ -1,332 +1,3 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
- import { APIResource } from '../../resource';
4
- import { isRequestOptions } from '../../core';
5
- import * as Core from '../../core';
6
-
7
- export class Transactions extends APIResource {
8
- /**
9
- * Create a loyalty transaction to update account balances.
10
- */
11
- createTransaction(
12
- body: TransactionCreateTransactionParams,
13
- options?: Core.RequestOptions,
14
- ): Core.APIPromise<TransactionCreateTransactionResponse> {
15
- return this._client.post('/api/loyalty/transactions', { body, ...options });
16
- }
17
-
18
- /**
19
- * Fetch loyalty transaction entries for wallets or users, representing account
20
- * balance changes.
21
- */
22
- getTransactionEntries(
23
- query?: TransactionGetTransactionEntriesParams,
24
- options?: Core.RequestOptions,
25
- ): Core.APIPromise<TransactionGetTransactionEntriesResponse>;
26
- getTransactionEntries(
27
- options?: Core.RequestOptions,
28
- ): Core.APIPromise<TransactionGetTransactionEntriesResponse>;
29
- getTransactionEntries(
30
- query: TransactionGetTransactionEntriesParams | Core.RequestOptions = {},
31
- options?: Core.RequestOptions,
32
- ): Core.APIPromise<TransactionGetTransactionEntriesResponse> {
33
- if (isRequestOptions(query)) {
34
- return this.getTransactionEntries({}, query);
35
- }
36
- return this._client.get('/api/loyalty/transaction_entries', { query, ...options });
37
- }
38
- }
39
-
40
- export interface TransactionCreateTransactionResponse {
41
- id: string;
42
-
43
- createdAt: string;
44
-
45
- description: string;
46
-
47
- entries: Array<TransactionCreateTransactionResponse.Entry>;
48
-
49
- updatedAt: string;
50
- }
51
-
52
- export namespace TransactionCreateTransactionResponse {
53
- export interface Entry {
54
- amount: number;
55
-
56
- /**
57
- * Direction of the transaction entry
58
- */
59
- direction: 'credit' | 'debit';
60
-
61
- walletAddress: string;
62
-
63
- idempotencyKey?: string;
64
- }
65
- }
66
-
67
- export interface TransactionGetTransactionEntriesResponse {
68
- data: Array<TransactionGetTransactionEntriesResponse.Data>;
69
-
70
- hasNextPage: boolean;
71
- }
72
-
73
- export namespace TransactionGetTransactionEntriesResponse {
74
- /**
75
- * Schema for a loyalty transaction entry
76
- */
77
- export interface Data {
78
- /**
79
- * Unique identifier for the transaction entry
80
- */
81
- id: string;
82
-
83
- /**
84
- * Amount involved in the transaction
85
- */
86
- amount: number;
87
-
88
- /**
89
- * Timestamp when the transaction entry was created
90
- */
91
- createdAt: string;
92
-
93
- /**
94
- * Direction of the transaction entry
95
- */
96
- direction: 'credit' | 'debit';
97
-
98
- /**
99
- * Unique identifier for the loyalty account
100
- */
101
- loyaltyAccountId: string;
102
-
103
- /**
104
- * Details of the loyalty transaction
105
- */
106
- loyaltyTransaction: Data.LoyaltyTransaction;
107
-
108
- /**
109
- * Unique identifier for the organization
110
- */
111
- organizationId: string;
112
-
113
- /**
114
- * Type of the loyalty transaction
115
- */
116
- type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
117
-
118
- /**
119
- * Timestamp when the transaction entry was last updated
120
- */
121
- updatedAt: string;
122
-
123
- /**
124
- * Unique identifier for the website
125
- */
126
- websiteId: string;
127
-
128
- /**
129
- * Optional metadata for the transaction entry
130
- */
131
- metadata?: Record<string, unknown>;
132
- }
133
-
134
- export namespace Data {
135
- /**
136
- * Details of the loyalty transaction
137
- */
138
- export interface LoyaltyTransaction {
139
- /**
140
- * Unique identifier for the loyalty transaction
141
- */
142
- id: string;
143
-
144
- /**
145
- * Type of the loyalty transaction
146
- */
147
- type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
148
-
149
- /**
150
- * Details of the loyalty rule associated with the transaction
151
- */
152
- loyaltyRule?: LoyaltyTransaction.LoyaltyRule;
153
- }
154
-
155
- export namespace LoyaltyTransaction {
156
- /**
157
- * Details of the loyalty rule associated with the transaction
158
- */
159
- export interface LoyaltyRule {
160
- /**
161
- * Unique identifier for the loyalty rule
162
- */
163
- id: string;
164
-
165
- /**
166
- * Type of the loyalty rule
167
- */
168
- type: string;
169
-
170
- /**
171
- * Description of the loyalty rule
172
- */
173
- description?: string;
174
-
175
- /**
176
- * Optional metadata for the loyalty rule
177
- */
178
- metadata?: Record<string, unknown>;
179
-
180
- /**
181
- * Name of the loyalty rule
182
- */
183
- name?: string;
184
- }
185
- }
186
- }
187
- }
188
-
189
- export interface TransactionCreateTransactionParams {
190
- /**
191
- * Description of the loyalty transaction
192
- */
193
- description: string;
194
-
195
- /**
196
- * Array of transaction entries
197
- */
198
- entries: Array<TransactionCreateTransactionParams.Entry>;
199
-
200
- /**
201
- * Unique identifier for the loyalty currency
202
- */
203
- loyaltyCurrencyId?: string;
204
- }
205
-
206
- export namespace TransactionCreateTransactionParams {
207
- export interface Entry {
208
- /**
209
- * Transaction entry amount.
210
- */
211
- amount: number;
212
-
213
- /**
214
- * Direction of the transaction entry for this wallet address
215
- */
216
- direction?: 'credit' | 'debit';
217
-
218
- /**
219
- * Idempotency key for the transaction entry. Creation will fail if already exists
220
- * for this wallet address.
221
- */
222
- idempotencyKey?: string;
223
-
224
- /**
225
- * The wallet address of the user
226
- */
227
- walletAddress?: string;
228
- }
229
- }
230
-
231
- export interface TransactionGetTransactionEntriesParams {
232
- /**
233
- * End date to filter by (exclusive, less than)
234
- */
235
- createdAtEnd?: string;
236
-
237
- /**
238
- * Start date to filter by (inclusive, greater than or equal to)
239
- */
240
- createdAtStart?: string;
241
-
242
- /**
243
- * Direction of the transaction entry to filter by
244
- */
245
- direction?: 'credit' | 'debit';
246
-
247
- /**
248
- * Key to ensure idempotency of the request
249
- */
250
- idempotencyKey?: string;
251
-
252
- /**
253
- * Maximum number of records to return (max 1000)
254
- */
255
- limit?: number;
256
-
257
- /**
258
- * Unique identifier for the loyalty rule to filter by
259
- */
260
- loyaltyRuleId?: string;
261
-
262
- /**
263
- * Unique identifier for the loyalty transaction to filter by
264
- */
265
- loyaltyTransactionId?: string;
266
-
267
- /**
268
- * Field to order the results by
269
- */
270
- orderBy?: 'createdAt' | 'updatedAt' | 'loyaltyAccountLockVersion';
271
-
272
- /**
273
- * Unique identifier for the organization to filter by
274
- */
275
- organizationId?: string;
276
-
277
- /**
278
- * Pagination cursor to start after a specific resource ID
279
- */
280
- startingAfter?: string;
281
-
282
- /**
283
- * Type of the loyalty transaction to filter by
284
- */
285
- type?: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
286
-
287
- /**
288
- * When passed in return the list of fulfilled entries for loyalty rules. If a
289
- * loyalty rule has a fulfilled entry this means the user cannot currently complete
290
- * the rule. Must be passed in with userId or walletAddress.
291
- */
292
- userCompletedLoyaltyRuleId?: string | Array<string>;
293
-
294
- /**
295
- * External identifier for the user group controlled by you
296
- */
297
- userGroupExternalIdentifier?: string;
298
-
299
- /**
300
- * Unique identifier for the user group
301
- */
302
- userGroupId?: string;
303
-
304
- /**
305
- * User ID or array of User IDs to filter by
306
- */
307
- userId?: string | Array<string>;
308
-
309
- /**
310
- * Wallet address or array of wallet addresses to filter by
311
- */
312
- walletAddress?: string | Array<string>;
313
-
314
- /**
315
- * Identifier for the wallet group to filter by
316
- */
317
- walletGroupIdentifier?: string;
318
-
319
- /**
320
- * Unique identifier for the website to filter by
321
- */
322
- websiteId?: string;
323
- }
324
-
325
- export declare namespace Transactions {
326
- export {
327
- type TransactionCreateTransactionResponse as TransactionCreateTransactionResponse,
328
- type TransactionGetTransactionEntriesResponse as TransactionGetTransactionEntriesResponse,
329
- type TransactionCreateTransactionParams as TransactionCreateTransactionParams,
330
- type TransactionGetTransactionEntriesParams as TransactionGetTransactionEntriesParams,
331
- };
332
- }
3
+ export * from './transactions/index';
@@ -89,13 +89,17 @@ export interface MintingGetAssetsParams {
89
89
  * Network
90
90
  */
91
91
  network?:
92
+ | 'abstract'
93
+ | 'abstractTestnet'
92
94
  | 'apechain'
93
95
  | 'arbitrum'
94
96
  | 'avalanche'
95
97
  | 'avalancheFuji'
96
98
  | 'base'
97
99
  | 'baseSepolia'
100
+ | 'berachain'
98
101
  | 'berachainArtio'
102
+ | 'berachainBepolia'
99
103
  | 'binance'
100
104
  | 'bscTestnet'
101
105
  | 'campTestnet'
@@ -103,18 +107,30 @@ export interface MintingGetAssetsParams {
103
107
  | 'fantomTestnet'
104
108
  | 'flowMainnet'
105
109
  | 'mainnet'
110
+ | 'nexusTestnet'
106
111
  | 'optimism'
107
112
  | 'polygon'
108
113
  | 'polygon_mumbai'
109
114
  | 'skaleNebula'
115
+ | 'skaleEuropa'
116
+ | 'skaleCalypso'
110
117
  | 'solana'
111
118
  | 'sophon'
119
+ | 'sophonTestnet'
112
120
  | 'sui'
113
121
  | 'superseed'
114
122
  | 'superseedSepolia'
115
123
  | 'vanar'
116
124
  | 'xai'
117
125
  | 'zksync'
126
+ | 'coti'
127
+ | 'cotiTestnet'
128
+ | 'morph'
129
+ | 'morphTestnet'
130
+ | 'morphHolesky'
131
+ | 'ultra'
132
+ | 'ultraTestnet'
133
+ | 'nitrograph'
118
134
  | 'sepolia'
119
135
  | 'optimism_sepolia'
120
136
  | 'arbitrumSepolia'
@@ -122,17 +138,21 @@ export interface MintingGetAssetsParams {
122
138
  | 'optimism_goerli'
123
139
  | 'arbitrumGoerli'
124
140
  | 'basecamp'
125
- | 'abstract';
141
+ | 'somnia'
142
+ | 'zkverify'
143
+ | 'polkadot'
144
+ | 'kusama'
145
+ | 'flow_cadence';
126
146
 
127
147
  /**
128
- * Sort Dir
148
+ * Sort Key
129
149
  */
130
- sortDir?: 'asc' | 'desc' | null;
150
+ sortBy?: 'price' | 'startsAt' | 'assetNr' | null;
131
151
 
132
152
  /**
133
- * Sort Key
153
+ * Sort Dir
134
154
  */
135
- sortKey?: 'price' | 'startsAt' | 'assetNr' | null;
155
+ sortDir?: 'asc' | 'desc' | null;
136
156
 
137
157
  /**
138
158
  * Status
@@ -1,7 +1,6 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../resource';
4
- import { isRequestOptions } from '../../core';
5
4
  import * as Core from '../../core';
6
5
  import * as UsersAPI from './users';
7
6
  import { UserCreateParams, UserCreateResponse, UserListParams, UserListResponse, Users } from './users';
@@ -11,19 +10,18 @@ export class Referral extends APIResource {
11
10
 
12
11
  /**
13
12
  * This endpoint allows you to create a referral code
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const response = await client.referral.createCode({
17
+ * loyaltyRuleId: '558bcf56-24f1-4ef4-9787-043086295780',
18
+ * });
19
+ * ```
14
20
  */
15
21
  createCode(
16
- body?: ReferralCreateCodeParams,
17
- options?: Core.RequestOptions,
18
- ): Core.APIPromise<ReferralCreateCodeResponse>;
19
- createCode(options?: Core.RequestOptions): Core.APIPromise<ReferralCreateCodeResponse>;
20
- createCode(
21
- body: ReferralCreateCodeParams | Core.RequestOptions = {},
22
+ body: ReferralCreateCodeParams,
22
23
  options?: Core.RequestOptions,
23
24
  ): Core.APIPromise<ReferralCreateCodeResponse> {
24
- if (isRequestOptions(body)) {
25
- return this.createCode({}, body);
26
- }
27
25
  return this._client.post('/api/referral/codes', { body, ...options });
28
26
  }
29
27
  }
@@ -47,9 +45,13 @@ export interface ReferralCreateCodeResponse {
47
45
  }
48
46
 
49
47
  export interface ReferralCreateCodeParams {
50
- loyaltyRuleId?: string;
48
+ loyaltyRuleId: string;
49
+
50
+ organizationId?: string;
51
51
 
52
52
  userId?: string;
53
+
54
+ websiteId?: string;
53
55
  }
54
56
 
55
57
  Referral.Users = Users;
@@ -1,11 +1,19 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../resource';
4
+ import { isRequestOptions } from '../../core';
4
5
  import * as Core from '../../core';
5
6
 
6
7
  export class Users extends APIResource {
7
8
  /**
8
9
  * This endpoint allows you to create a referral user
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const user = await client.referral.users.create({
14
+ * userIds: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
15
+ * });
16
+ * ```
9
17
  */
10
18
  create(body: UserCreateParams, options?: Core.RequestOptions): Core.APIPromise<UserCreateResponse> {
11
19
  return this._client.post('/api/referral/users', { body, ...options });
@@ -13,8 +21,21 @@ export class Users extends APIResource {
13
21
 
14
22
  /**
15
23
  * This endpoint allows you to get referrals
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const users = await client.referral.users.list();
28
+ * ```
16
29
  */
17
- list(query: UserListParams, options?: Core.RequestOptions): Core.APIPromise<UserListResponse> {
30
+ list(query?: UserListParams, options?: Core.RequestOptions): Core.APIPromise<UserListResponse>;
31
+ list(options?: Core.RequestOptions): Core.APIPromise<UserListResponse>;
32
+ list(
33
+ query: UserListParams | Core.RequestOptions = {},
34
+ options?: Core.RequestOptions,
35
+ ): Core.APIPromise<UserListResponse> {
36
+ if (isRequestOptions(query)) {
37
+ return this.list({}, query);
38
+ }
18
39
  return this._client.get('/api/referral/users', { query, ...options });
19
40
  }
20
41
  }
@@ -36,18 +57,35 @@ export namespace UserListResponse {
36
57
  referralCode: Data.ReferralCode;
37
58
 
38
59
  user: Data.User;
60
+
61
+ eligible?: boolean | null;
39
62
  }
40
63
 
41
64
  export namespace Data {
42
65
  export interface ReferralCode {
43
66
  id: string;
44
67
 
68
+ /**
69
+ * This will only return data for earnings after 2025-04-24
70
+ */
71
+ amount: number;
72
+
45
73
  createdAt: string;
46
74
 
47
75
  deletedAt: string | null;
48
76
 
49
77
  referralCode: string;
50
78
 
79
+ /**
80
+ * This will only return data for earnings after 2025-04-24
81
+ */
82
+ tier1Amount: number;
83
+
84
+ /**
85
+ * This will only return data for earnings after 2025-04-24
86
+ */
87
+ tier2Amount: number;
88
+
51
89
  updatedAt: string;
52
90
 
53
91
  userId: string;
@@ -70,16 +108,16 @@ export interface UserCreateParams {
70
108
  }
71
109
 
72
110
  export interface UserListParams {
73
- walletAddress: string | Array<string>;
74
-
75
- includeEligibility?: boolean | null;
76
-
77
111
  limit?: number;
78
112
 
113
+ loyaltyRuleId?: string;
114
+
79
115
  organizationId?: string;
80
116
 
81
117
  startingAfter?: string;
82
118
 
119
+ walletAddress?: string | Array<string>;
120
+
83
121
  websiteId?: string;
84
122
  }
85
123
 
@@ -12,9 +12,13 @@ export {
12
12
  type UserListResponse,
13
13
  type UserConnectResponse,
14
14
  type UserCountResponse,
15
+ type UserCreateDeviceResponse,
15
16
  type UserDisconnectResponse,
17
+ type UserVerifyResponse,
16
18
  type UserListParams,
17
19
  type UserConnectParams,
18
20
  type UserCountParams,
21
+ type UserCreateDeviceParams,
19
22
  type UserDisconnectParams,
23
+ type UserVerifyParams,
20
24
  } from './users';
@@ -7,6 +7,11 @@ import * as Core from '../../core';
7
7
  export class Metadatas extends APIResource {
8
8
  /**
9
9
  * This endpoint is used to create user metadata
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const metadata = await client.users.metadatas.create();
14
+ * ```
10
15
  */
11
16
  create(body?: MetadataCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
12
17
  create(options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
@@ -22,6 +27,11 @@ export class Metadatas extends APIResource {
22
27
 
23
28
  /**
24
29
  * This endpoint is used to get user metadata
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const metadatas = await client.users.metadatas.list();
34
+ * ```
25
35
  */
26
36
  list(query?: MetadataListParams, options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
27
37
  list(options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
@@ -57,7 +67,10 @@ export interface MetadataCreateResponse {
57
67
 
58
68
  user: MetadataCreateResponse.User;
59
69
 
60
- userGroup: MetadataCreateResponse.UserGroup;
70
+ /**
71
+ * User group associated with the user
72
+ */
73
+ userGroup: MetadataCreateResponse.UserGroup | null;
61
74
 
62
75
  /**
63
76
  * Identifier for the user group set via api
@@ -88,6 +101,9 @@ export namespace MetadataCreateResponse {
88
101
  walletAddress: string;
89
102
  }
90
103
 
104
+ /**
105
+ * User group associated with the user
106
+ */
91
107
  export interface UserGroup {
92
108
  /**
93
109
  * id for the user group
@@ -123,6 +139,18 @@ export namespace MetadataListResponse {
123
139
  }
124
140
 
125
141
  export interface MetadataCreateParams {
142
+ bio?: string | null;
143
+
144
+ blockStatusReason?:
145
+ | 'sybil_and_multi_account'
146
+ | 'account_migration'
147
+ | 'abuse_manipulation'
148
+ | 'not_sybil'
149
+ | 'issue_resolved'
150
+ | 'twitter_suspended'
151
+ | 'other'
152
+ | null;
153
+
126
154
  discordUser?: string | null;
127
155
 
128
156
  discordUserId?: string | null;
@@ -135,22 +163,48 @@ export interface MetadataCreateParams {
135
163
 
136
164
  externalIdentifier?: string | null;
137
165
 
166
+ externalLoyaltyScore?: string | null;
167
+
168
+ githubUser?: string | null;
169
+
170
+ githubUserId?: string | null;
171
+
172
+ googleUser?: string | null;
173
+
174
+ googleUserId?: string | null;
175
+
176
+ internalNotes?: string | null;
177
+
138
178
  isBlocked?: boolean;
139
179
 
180
+ isBlockExempt?: boolean;
181
+
182
+ location?: string | null;
183
+
140
184
  logoUrl?: string | null;
141
185
 
142
186
  organizationId?: string;
143
187
 
144
- stardustProfileIdentifier?: string | null;
188
+ portfolioUrl?: string | null;
189
+
190
+ steamUserId?: string | null;
191
+
192
+ steamUsername?: string | null;
145
193
 
146
- stardustWalletIdentifier?: string | null;
194
+ sybilScore?: number | null;
147
195
 
148
196
  telegramUserId?: string | null;
149
197
 
150
198
  telegramUsername?: string | null;
151
199
 
200
+ tiktokUser?: string | null;
201
+
202
+ tiktokUserId?: string | null;
203
+
152
204
  twitterUser?: string | null;
153
205
 
206
+ twitterUserFollowersCount?: number | null;
207
+
154
208
  twitterUserId?: string | null;
155
209
 
156
210
  userGroupExternalIdentifier?: string | null;
@@ -164,6 +218,8 @@ export interface MetadataCreateParams {
164
218
  walletGroupIdentifier?: string | null;
165
219
 
166
220
  websiteId?: string;
221
+
222
+ YTChannelId?: string | null;
167
223
  }
168
224
 
169
225
  export interface MetadataListParams {
@@ -192,6 +248,8 @@ export interface MetadataListParams {
192
248
  */
193
249
  userId?: string;
194
250
 
251
+ userSearch?: string;
252
+
195
253
  /**
196
254
  * Wallet address of the user
197
255
  */