@snagsolutions/sdk 0.1.0-alpha.26 → 0.1.0-alpha.260
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.
- package/CHANGELOG.md +140 -153
- package/LICENSE +1 -1
- package/README.md +15 -23
- package/core.d.ts +9 -6
- package/core.d.ts.map +1 -1
- package/core.js +36 -33
- package/core.js.map +1 -1
- package/core.mjs +36 -33
- package/core.mjs.map +1 -1
- package/index.d.mts +15 -9
- package/index.d.ts +15 -9
- package/index.d.ts.map +1 -1
- package/index.js +13 -6
- package/index.js.map +1 -1
- package/index.mjs +14 -7
- package/index.mjs.map +1 -1
- package/internal/utils/query.d.ts +2 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +33 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +6 -0
- package/internal/utils/query.mjs.map +1 -0
- package/package.json +4 -5
- package/resource.d.ts +1 -1
- package/resource.d.ts.map +1 -1
- package/resource.js.map +1 -1
- package/resource.mjs.map +1 -1
- package/resources/assets.d.ts +16 -2
- package/resources/assets.d.ts.map +1 -1
- package/resources/assets.js +8 -0
- package/resources/assets.js.map +1 -1
- package/resources/assets.mjs +8 -0
- package/resources/assets.mjs.map +1 -1
- package/resources/auctions/auctions.d.ts +341 -0
- package/resources/auctions/auctions.d.ts.map +1 -0
- package/resources/auctions/auctions.js +72 -0
- package/resources/auctions/auctions.js.map +1 -0
- package/resources/auctions/auctions.mjs +45 -0
- package/resources/auctions/auctions.mjs.map +1 -0
- package/resources/auctions/index.d.ts +3 -0
- package/resources/auctions/index.d.ts.map +1 -0
- package/resources/auctions/index.js +9 -0
- package/resources/auctions/index.js.map +1 -0
- package/resources/auctions/index.mjs +4 -0
- package/resources/auctions/index.mjs.map +1 -0
- package/resources/auctions/website-user-attributes/index.d.ts +3 -0
- package/resources/auctions/website-user-attributes/index.d.ts.map +1 -0
- package/resources/auctions/website-user-attributes/index.js +9 -0
- package/resources/auctions/website-user-attributes/index.js.map +1 -0
- package/resources/auctions/website-user-attributes/index.mjs +4 -0
- package/resources/auctions/website-user-attributes/index.mjs.map +1 -0
- package/resources/auctions/website-user-attributes/values.d.ts +126 -0
- package/resources/auctions/website-user-attributes/values.d.ts.map +1 -0
- package/resources/auctions/website-user-attributes/values.js +49 -0
- package/resources/auctions/website-user-attributes/values.js.map +1 -0
- package/resources/auctions/website-user-attributes/values.mjs +45 -0
- package/resources/auctions/website-user-attributes/values.mjs.map +1 -0
- package/resources/auctions/website-user-attributes/website-user-attributes.d.ts +136 -0
- package/resources/auctions/website-user-attributes/website-user-attributes.d.ts.map +1 -0
- package/resources/auctions/website-user-attributes/website-user-attributes.js +76 -0
- package/resources/auctions/website-user-attributes/website-user-attributes.js.map +1 -0
- package/resources/auctions/website-user-attributes/website-user-attributes.mjs +49 -0
- package/resources/auctions/website-user-attributes/website-user-attributes.mjs.map +1 -0
- package/resources/auctions/website-user-attributes.d.ts +2 -0
- package/resources/auctions/website-user-attributes.d.ts.map +1 -0
- package/resources/auctions/website-user-attributes.js +19 -0
- package/resources/auctions/website-user-attributes.js.map +1 -0
- package/resources/auctions/website-user-attributes.mjs +3 -0
- package/resources/auctions/website-user-attributes.mjs.map +1 -0
- package/resources/auctions.d.ts +1 -133
- package/resources/auctions.d.ts.map +1 -1
- package/resources/auctions.js +15 -22
- package/resources/auctions.js.map +1 -1
- package/resources/auctions.mjs +1 -20
- package/resources/auctions.mjs.map +1 -1
- package/resources/auth.d.ts +66 -6
- package/resources/auth.d.ts.map +1 -1
- package/resources/auth.js +6 -0
- package/resources/auth.js.map +1 -1
- package/resources/auth.mjs +6 -0
- package/resources/auth.mjs.map +1 -1
- package/resources/index.d.ts +5 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +4 -3
- package/resources/index.mjs.map +1 -1
- package/resources/loyalty/account-streaks.d.ts +96 -0
- package/resources/loyalty/account-streaks.d.ts.map +1 -0
- package/resources/loyalty/account-streaks.js +24 -0
- package/resources/loyalty/account-streaks.js.map +1 -0
- package/resources/loyalty/account-streaks.mjs +20 -0
- package/resources/loyalty/account-streaks.mjs.map +1 -0
- package/resources/loyalty/accounts.d.ts +60 -16
- package/resources/loyalty/accounts.d.ts.map +1 -1
- package/resources/loyalty/accounts.js +14 -0
- package/resources/loyalty/accounts.js.map +1 -1
- package/resources/loyalty/accounts.mjs +14 -0
- package/resources/loyalty/accounts.mjs.map +1 -1
- package/resources/loyalty/badges.d.ts +885 -136
- package/resources/loyalty/badges.d.ts.map +1 -1
- package/resources/loyalty/badges.js +19 -1
- package/resources/loyalty/badges.js.map +1 -1
- package/resources/loyalty/badges.mjs +19 -1
- package/resources/loyalty/badges.mjs.map +1 -1
- package/resources/loyalty/currencies.d.ts +19 -0
- package/resources/loyalty/currencies.d.ts.map +1 -1
- package/resources/loyalty/currencies.js +19 -0
- package/resources/loyalty/currencies.js.map +1 -1
- package/resources/loyalty/currencies.mjs +19 -0
- package/resources/loyalty/currencies.mjs.map +1 -1
- package/resources/loyalty/index.d.ts +3 -3
- package/resources/loyalty/index.d.ts.map +1 -1
- package/resources/loyalty/index.js +5 -5
- package/resources/loyalty/index.js.map +1 -1
- package/resources/loyalty/index.mjs +2 -2
- package/resources/loyalty/index.mjs.map +1 -1
- package/resources/loyalty/loyalty.d.ts +9 -9
- package/resources/loyalty/loyalty.d.ts.map +1 -1
- package/resources/loyalty/loyalty.js +6 -6
- package/resources/loyalty/loyalty.js.map +1 -1
- package/resources/loyalty/loyalty.mjs +6 -6
- package/resources/loyalty/loyalty.mjs.map +1 -1
- package/resources/loyalty/multipliers.d.ts +39 -2
- package/resources/loyalty/multipliers.d.ts.map +1 -1
- package/resources/loyalty/multipliers.js +23 -0
- package/resources/loyalty/multipliers.js.map +1 -1
- package/resources/loyalty/multipliers.mjs +23 -0
- package/resources/loyalty/multipliers.mjs.map +1 -1
- package/resources/loyalty/questions-responses.d.ts +55 -4
- package/resources/loyalty/questions-responses.d.ts.map +1 -1
- package/resources/loyalty/questions-responses.js +9 -0
- package/resources/loyalty/questions-responses.js.map +1 -1
- package/resources/loyalty/questions-responses.mjs +9 -0
- package/resources/loyalty/questions-responses.mjs.map +1 -1
- package/resources/loyalty/questions.d.ts +60 -6
- package/resources/loyalty/questions.d.ts.map +1 -1
- package/resources/loyalty/questions.js +39 -0
- package/resources/loyalty/questions.js.map +1 -1
- package/resources/loyalty/questions.mjs +39 -0
- package/resources/loyalty/questions.mjs.map +1 -1
- package/resources/loyalty/rule-edits.d.ts +2898 -8
- package/resources/loyalty/rule-edits.d.ts.map +1 -1
- package/resources/loyalty/rule-edits.js +14 -0
- package/resources/loyalty/rule-edits.js.map +1 -1
- package/resources/loyalty/rule-edits.mjs +14 -0
- package/resources/loyalty/rule-edits.mjs.map +1 -1
- package/resources/loyalty/rule-groups.d.ts +284 -56
- package/resources/loyalty/rule-groups.d.ts.map +1 -1
- package/resources/loyalty/rule-groups.js +18 -0
- package/resources/loyalty/rule-groups.js.map +1 -1
- package/resources/loyalty/rule-groups.mjs +18 -0
- package/resources/loyalty/rule-groups.mjs.map +1 -1
- package/resources/loyalty/rules.d.ts +2368 -346
- package/resources/loyalty/rules.d.ts.map +1 -1
- package/resources/loyalty/rules.js +40 -9
- package/resources/loyalty/rules.js.map +1 -1
- package/resources/loyalty/rules.mjs +40 -9
- package/resources/loyalty/rules.mjs.map +1 -1
- package/resources/loyalty/transactions/index.d.ts +4 -0
- package/resources/loyalty/transactions/index.d.ts.map +1 -0
- package/resources/loyalty/transactions/index.js +11 -0
- package/resources/loyalty/transactions/index.js.map +1 -0
- package/resources/loyalty/transactions/index.mjs +5 -0
- package/resources/loyalty/transactions/index.mjs.map +1 -0
- package/resources/loyalty/transactions/posts.d.ts +145 -0
- package/resources/loyalty/transactions/posts.d.ts.map +1 -0
- package/resources/loyalty/transactions/posts.js +32 -0
- package/resources/loyalty/transactions/posts.js.map +1 -0
- package/resources/loyalty/transactions/posts.mjs +28 -0
- package/resources/loyalty/transactions/posts.mjs.map +1 -0
- package/resources/loyalty/transactions/rule-statuses.d.ts +121 -0
- package/resources/loyalty/transactions/rule-statuses.d.ts.map +1 -0
- package/resources/loyalty/transactions/rule-statuses.js +30 -0
- package/resources/loyalty/transactions/rule-statuses.js.map +1 -0
- package/resources/loyalty/transactions/rule-statuses.mjs +26 -0
- package/resources/loyalty/transactions/rule-statuses.mjs.map +1 -0
- package/resources/loyalty/transactions/transactions.d.ts +566 -0
- package/resources/loyalty/transactions/transactions.d.ts.map +1 -0
- package/resources/loyalty/transactions/transactions.js +110 -0
- package/resources/loyalty/transactions/transactions.js.map +1 -0
- package/resources/loyalty/transactions/transactions.mjs +83 -0
- package/resources/loyalty/transactions/transactions.mjs.map +1 -0
- package/resources/loyalty/transactions.d.ts +1 -253
- package/resources/loyalty/transactions.d.ts.map +1 -1
- package/resources/loyalty/transactions.js +15 -18
- package/resources/loyalty/transactions.js.map +1 -1
- package/resources/loyalty/transactions.mjs +1 -16
- package/resources/loyalty/transactions.mjs.map +1 -1
- package/resources/minting/allowlist.d.ts +84 -0
- package/resources/minting/allowlist.d.ts.map +1 -0
- package/resources/minting/allowlist.js +42 -0
- package/resources/minting/allowlist.js.map +1 -0
- package/resources/minting/allowlist.mjs +38 -0
- package/resources/minting/allowlist.mjs.map +1 -0
- package/resources/minting/contracts.d.ts +165 -0
- package/resources/minting/contracts.d.ts.map +1 -0
- package/resources/minting/contracts.js +30 -0
- package/resources/minting/contracts.js.map +1 -0
- package/resources/minting/contracts.mjs +26 -0
- package/resources/minting/contracts.mjs.map +1 -0
- package/resources/minting/index.d.ts +5 -0
- package/resources/minting/index.d.ts.map +1 -0
- package/resources/minting/index.js +13 -0
- package/resources/minting/index.js.map +1 -0
- package/resources/minting/index.mjs +6 -0
- package/resources/minting/index.mjs.map +1 -0
- package/resources/minting/minting.d.ts +146 -0
- package/resources/minting/minting.d.ts.map +1 -0
- package/resources/minting/minting.js +79 -0
- package/resources/minting/minting.js.map +1 -0
- package/resources/minting/minting.mjs +52 -0
- package/resources/minting/minting.mjs.map +1 -0
- package/resources/minting/status.d.ts +44 -0
- package/resources/minting/status.d.ts.map +1 -0
- package/resources/minting/status.js +33 -0
- package/resources/minting/status.js.map +1 -0
- package/resources/minting/status.mjs +29 -0
- package/resources/minting/status.mjs.map +1 -0
- package/resources/minting.d.ts +1 -94
- package/resources/minting.d.ts.map +1 -1
- package/resources/minting.js +15 -11
- package/resources/minting.js.map +1 -1
- package/resources/minting.mjs +1 -9
- package/resources/minting.mjs.map +1 -1
- package/resources/referral/referral.d.ts +12 -3
- package/resources/referral/referral.d.ts.map +1 -1
- package/resources/referral/referral.js +11 -5
- package/resources/referral/referral.js.map +1 -1
- package/resources/referral/referral.mjs +11 -5
- package/resources/referral/referral.mjs.map +1 -1
- package/resources/referral/users.d.ts +30 -3
- package/resources/referral/users.d.ts.map +1 -1
- package/resources/referral/users.js +12 -4
- package/resources/referral/users.js.map +1 -1
- package/resources/referral/users.mjs +12 -4
- package/resources/referral/users.mjs.map +1 -1
- package/resources/token-claims.d.ts +162 -0
- package/resources/token-claims.d.ts.map +1 -0
- package/resources/token-claims.js +46 -0
- package/resources/token-claims.js.map +1 -0
- package/resources/token-claims.mjs +42 -0
- package/resources/token-claims.mjs.map +1 -0
- package/resources/users/index.d.ts +1 -1
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/index.js.map +1 -1
- package/resources/users/index.mjs.map +1 -1
- package/resources/users/metadatas.d.ts +40 -3
- package/resources/users/metadatas.d.ts.map +1 -1
- package/resources/users/metadatas.js.map +1 -1
- package/resources/users/metadatas.mjs.map +1 -1
- package/resources/users/users.d.ts +203 -36
- package/resources/users/users.d.ts.map +1 -1
- package/resources/users/users.js +58 -1
- package/resources/users/users.js.map +1 -1
- package/resources/users/users.mjs +58 -1
- package/resources/users/users.mjs.map +1 -1
- package/resources/websites/index.d.ts +1 -1
- package/resources/websites/index.d.ts.map +1 -1
- package/resources/websites/index.js.map +1 -1
- package/resources/websites/index.mjs +1 -1
- package/resources/websites/index.mjs.map +1 -1
- package/resources/websites/website-collections.d.ts +0 -69
- package/resources/websites/website-collections.d.ts.map +1 -1
- package/resources/websites/website-collections.js +0 -16
- package/resources/websites/website-collections.js.map +1 -1
- package/resources/websites/website-collections.mjs +0 -16
- package/resources/websites/website-collections.mjs.map +1 -1
- package/resources/websites/website-user-roles.d.ts +24 -1
- package/resources/websites/website-user-roles.d.ts.map +1 -1
- package/resources/websites/website-user-roles.js +23 -0
- package/resources/websites/website-user-roles.js.map +1 -1
- package/resources/websites/website-user-roles.mjs +23 -0
- package/resources/websites/website-user-roles.mjs.map +1 -1
- package/resources/websites/websites.d.ts +21 -99
- package/resources/websites/websites.d.ts.map +1 -1
- package/resources/websites/websites.js +9 -1
- package/resources/websites/websites.js.map +1 -1
- package/resources/websites/websites.mjs +10 -2
- package/resources/websites/websites.mjs.map +1 -1
- package/src/core.ts +40 -36
- package/src/index.ts +84 -6
- package/src/internal/utils/query.ts +7 -0
- package/src/resource.ts +1 -1
- package/src/resources/assets.ts +18 -3
- package/src/resources/auctions/auctions.ts +523 -0
- package/src/resources/auctions/index.ts +19 -0
- package/src/resources/auctions/website-user-attributes/index.ts +18 -0
- package/src/resources/auctions/website-user-attributes/values.ts +170 -0
- package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +212 -0
- package/src/resources/auctions/website-user-attributes.ts +3 -0
- package/src/resources/auctions.ts +1 -207
- package/src/resources/auth.ts +124 -6
- package/src/resources/index.ts +41 -3
- package/src/resources/loyalty/account-streaks.ts +128 -0
- package/src/resources/loyalty/accounts.ts +65 -18
- package/src/resources/loyalty/badges.ts +1058 -146
- package/src/resources/loyalty/currencies.ts +19 -0
- package/src/resources/loyalty/index.ts +13 -2
- package/src/resources/loyalty/loyalty.ts +30 -12
- package/src/resources/loyalty/multipliers.ts +43 -4
- package/src/resources/loyalty/questions-responses.ts +64 -4
- package/src/resources/loyalty/questions.ts +64 -6
- package/src/resources/loyalty/rule-edits.ts +4208 -94
- package/src/resources/loyalty/rule-groups.ts +473 -64
- package/src/resources/loyalty/rules.ts +3706 -403
- package/src/resources/loyalty/transactions/index.ts +29 -0
- package/src/resources/loyalty/transactions/posts.ts +221 -0
- package/src/resources/loyalty/transactions/rule-statuses.ts +179 -0
- package/src/resources/loyalty/transactions/transactions.ts +930 -0
- package/src/resources/loyalty/transactions.ts +1 -446
- package/src/resources/minting/allowlist.ts +116 -0
- package/src/resources/minting/contracts.ts +415 -0
- package/src/resources/minting/index.ts +29 -0
- package/src/resources/minting/minting.ts +285 -0
- package/src/resources/minting/status.ts +70 -0
- package/src/resources/minting.ts +1 -157
- package/src/resources/referral/referral.ts +15 -11
- package/src/resources/referral/users.ts +45 -5
- package/src/resources/token-claims.ts +311 -0
- package/src/resources/users/index.ts +4 -0
- package/src/resources/users/metadatas.ts +66 -3
- package/src/resources/users/users.ts +277 -39
- package/src/resources/websites/index.ts +1 -6
- package/src/resources/websites/website-collections.ts +1 -146
- package/src/resources/websites/website-user-roles.ts +26 -1
- package/src/resources/websites/websites.ts +22 -127
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/loyalty/rule-chains.d.ts +0 -34
- package/resources/loyalty/rule-chains.d.ts.map +0 -1
- package/resources/loyalty/rule-chains.js +0 -15
- package/resources/loyalty/rule-chains.js.map +0 -1
- package/resources/loyalty/rule-chains.mjs +0 -11
- package/resources/loyalty/rule-chains.mjs.map +0 -1
- package/src/resources/loyalty/rule-chains.ts +0 -45
|
@@ -0,0 +1,930 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../../resource';
|
|
4
|
+
import { isRequestOptions } from '../../../core';
|
|
5
|
+
import * as Core from '../../../core';
|
|
6
|
+
import * as PostsAPI from './posts';
|
|
7
|
+
import { PostListParams, PostListResponse, PostRewardParams, PostRewardResponse, Posts } from './posts';
|
|
8
|
+
import * as RuleStatusesAPI from './rule-statuses';
|
|
9
|
+
import {
|
|
10
|
+
RuleStatusListParams,
|
|
11
|
+
RuleStatusListResponse,
|
|
12
|
+
RuleStatusUpdateParams,
|
|
13
|
+
RuleStatusUpdateResponse,
|
|
14
|
+
RuleStatuses,
|
|
15
|
+
} from './rule-statuses';
|
|
16
|
+
|
|
17
|
+
export class Transactions extends APIResource {
|
|
18
|
+
ruleStatuses: RuleStatusesAPI.RuleStatuses = new RuleStatusesAPI.RuleStatuses(this._client);
|
|
19
|
+
posts: PostsAPI.Posts = new PostsAPI.Posts(this._client);
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Create a loyalty transaction to update account balances.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const response =
|
|
27
|
+
* await client.loyalty.transactions.createTransaction({
|
|
28
|
+
* description: 'Purchase of item X',
|
|
29
|
+
* entries: [{ amount: 5 }],
|
|
30
|
+
* });
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
createTransaction(
|
|
34
|
+
body: TransactionCreateTransactionParams,
|
|
35
|
+
options?: Core.RequestOptions,
|
|
36
|
+
): Core.APIPromise<TransactionCreateTransactionResponse> {
|
|
37
|
+
return this._client.post('/api/loyalty/transactions', { body, ...options });
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Fetch loyalty transaction entries for wallets or users, representing account
|
|
42
|
+
* balance changes.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const response =
|
|
47
|
+
* await client.loyalty.transactions.getTransactionEntries();
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
getTransactionEntries(
|
|
51
|
+
query?: TransactionGetTransactionEntriesParams,
|
|
52
|
+
options?: Core.RequestOptions,
|
|
53
|
+
): Core.APIPromise<TransactionGetTransactionEntriesResponse>;
|
|
54
|
+
getTransactionEntries(
|
|
55
|
+
options?: Core.RequestOptions,
|
|
56
|
+
): Core.APIPromise<TransactionGetTransactionEntriesResponse>;
|
|
57
|
+
getTransactionEntries(
|
|
58
|
+
query: TransactionGetTransactionEntriesParams | Core.RequestOptions = {},
|
|
59
|
+
options?: Core.RequestOptions,
|
|
60
|
+
): Core.APIPromise<TransactionGetTransactionEntriesResponse> {
|
|
61
|
+
if (isRequestOptions(query)) {
|
|
62
|
+
return this.getTransactionEntries({}, query);
|
|
63
|
+
}
|
|
64
|
+
return this._client.get('/api/loyalty/transaction_entries', { query, ...options });
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* This endpoint allows you to fetch users for a specific badge.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const response =
|
|
73
|
+
* await client.loyalty.transactions.listBadgeUsers({
|
|
74
|
+
* loyaltyBadgeId: '123e4567-e89b-12d3-a456-426614174222',
|
|
75
|
+
* });
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
listBadgeUsers(
|
|
79
|
+
query: TransactionListBadgeUsersParams,
|
|
80
|
+
options?: Core.RequestOptions,
|
|
81
|
+
): Core.APIPromise<TransactionListBadgeUsersResponse> {
|
|
82
|
+
return this._client.get('/api/loyalty/badge_users', { query, ...options });
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Retrieve configured loyalty rule chains
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const response =
|
|
91
|
+
* await client.loyalty.transactions.listRuleChains({
|
|
92
|
+
* organizationId: '123e4567-e89b-12d3-a456-426614174001',
|
|
93
|
+
* websiteId: '123e4567-e89b-12d3-a456-426614174002',
|
|
94
|
+
* });
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
listRuleChains(
|
|
98
|
+
query: TransactionListRuleChainsParams,
|
|
99
|
+
options?: Core.RequestOptions,
|
|
100
|
+
): Core.APIPromise<TransactionListRuleChainsResponse> {
|
|
101
|
+
return this._client.get('/api/loyalty/rule_chains', { query, ...options });
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Reset Loyalty Currency of a website
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* ```ts
|
|
109
|
+
* const response =
|
|
110
|
+
* await client.loyalty.transactions.resetLoyaltyCurrency({
|
|
111
|
+
* loyaltyCurrencyId:
|
|
112
|
+
* '123e4567-e89b-12d3-a456-426614174000',
|
|
113
|
+
* type: 'loyalty_reset_balances',
|
|
114
|
+
* });
|
|
115
|
+
* ```
|
|
116
|
+
*/
|
|
117
|
+
resetLoyaltyCurrency(
|
|
118
|
+
body: TransactionResetLoyaltyCurrencyParams,
|
|
119
|
+
options?: Core.RequestOptions,
|
|
120
|
+
): Core.APIPromise<TransactionResetLoyaltyCurrencyResponse> {
|
|
121
|
+
return this._client.post('/api/loyalty/reset', { body, ...options });
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
export interface TransactionCreateTransactionResponse {
|
|
126
|
+
id: string;
|
|
127
|
+
|
|
128
|
+
createdAt: string;
|
|
129
|
+
|
|
130
|
+
description: string;
|
|
131
|
+
|
|
132
|
+
entries: Array<TransactionCreateTransactionResponse.Entry>;
|
|
133
|
+
|
|
134
|
+
updatedAt: string;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
export namespace TransactionCreateTransactionResponse {
|
|
138
|
+
export interface Entry {
|
|
139
|
+
amount: number;
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Direction of the transaction entry
|
|
143
|
+
*/
|
|
144
|
+
direction: 'credit' | 'debit';
|
|
145
|
+
|
|
146
|
+
walletAddress: string;
|
|
147
|
+
|
|
148
|
+
idempotencyKey?: string;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
export interface TransactionGetTransactionEntriesResponse {
|
|
153
|
+
data: Array<TransactionGetTransactionEntriesResponse.Data>;
|
|
154
|
+
|
|
155
|
+
hasNextPage: boolean;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export namespace TransactionGetTransactionEntriesResponse {
|
|
159
|
+
/**
|
|
160
|
+
* Schema for a loyalty transaction entry
|
|
161
|
+
*/
|
|
162
|
+
export interface Data {
|
|
163
|
+
/**
|
|
164
|
+
* Unique identifier for the transaction entry
|
|
165
|
+
*/
|
|
166
|
+
id: string;
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Amount involved in the transaction
|
|
170
|
+
*/
|
|
171
|
+
amount: number;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Timestamp when the transaction entry was created
|
|
175
|
+
*/
|
|
176
|
+
createdAt: string;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Direction of the transaction entry
|
|
180
|
+
*/
|
|
181
|
+
direction: 'credit' | 'debit';
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Unique identifier for the loyalty account
|
|
185
|
+
*/
|
|
186
|
+
loyaltyAccountId: string;
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Details of the loyalty transaction
|
|
190
|
+
*/
|
|
191
|
+
loyaltyTransaction: Data.LoyaltyTransaction;
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Unique identifier for the organization
|
|
195
|
+
*/
|
|
196
|
+
organizationId: string;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Type of the loyalty transaction
|
|
200
|
+
*/
|
|
201
|
+
type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order' | null;
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Timestamp when the transaction entry was last updated
|
|
205
|
+
*/
|
|
206
|
+
updatedAt: string;
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Unique identifier for the website
|
|
210
|
+
*/
|
|
211
|
+
websiteId: string;
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Optional metadata for the transaction entry
|
|
215
|
+
*/
|
|
216
|
+
metadata?: { [key: string]: unknown };
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
export namespace Data {
|
|
220
|
+
/**
|
|
221
|
+
* Details of the loyalty transaction
|
|
222
|
+
*/
|
|
223
|
+
export interface LoyaltyTransaction {
|
|
224
|
+
/**
|
|
225
|
+
* Unique identifier for the loyalty transaction
|
|
226
|
+
*/
|
|
227
|
+
id: string;
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Type of the loyalty transaction
|
|
231
|
+
*/
|
|
232
|
+
type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order' | null;
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Details of the loyalty rule associated with the transaction
|
|
236
|
+
*/
|
|
237
|
+
loyaltyRule?: LoyaltyTransaction.LoyaltyRule;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
export namespace LoyaltyTransaction {
|
|
241
|
+
/**
|
|
242
|
+
* Details of the loyalty rule associated with the transaction
|
|
243
|
+
*/
|
|
244
|
+
export interface LoyaltyRule {
|
|
245
|
+
/**
|
|
246
|
+
* Unique identifier for the loyalty rule
|
|
247
|
+
*/
|
|
248
|
+
id: string;
|
|
249
|
+
|
|
250
|
+
/**
|
|
251
|
+
* Type of the loyalty rule
|
|
252
|
+
*/
|
|
253
|
+
type: string;
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Description of the loyalty rule
|
|
257
|
+
*/
|
|
258
|
+
description?: string;
|
|
259
|
+
|
|
260
|
+
loyaltyRuleGroupItem?: LoyaltyRule.LoyaltyRuleGroupItem;
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Optional metadata for the loyalty rule
|
|
264
|
+
*/
|
|
265
|
+
metadata?: { [key: string]: unknown };
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Name of the loyalty rule
|
|
269
|
+
*/
|
|
270
|
+
name?: string;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
export namespace LoyaltyRule {
|
|
274
|
+
export interface LoyaltyRuleGroupItem {
|
|
275
|
+
loyaltyRuleGroupId: string;
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* Response returned upon successful fetching of the badge users.
|
|
284
|
+
*/
|
|
285
|
+
export interface TransactionListBadgeUsersResponse {
|
|
286
|
+
/**
|
|
287
|
+
* UUID of the user badge (converted to lowercase)
|
|
288
|
+
*/
|
|
289
|
+
id: string;
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* The date and time the user badge was created
|
|
293
|
+
*/
|
|
294
|
+
createdAt: string;
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* The date and time the user badge was deleted
|
|
298
|
+
*/
|
|
299
|
+
deletedAt: string | null;
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* UUID of the badge (converted to lowercase)
|
|
303
|
+
*/
|
|
304
|
+
loyaltyBadgeId: string;
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* UUID of the organization (converted to lowercase)
|
|
308
|
+
*/
|
|
309
|
+
organizationId: string;
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Array of progress for the badge
|
|
313
|
+
*/
|
|
314
|
+
progress: Array<unknown>;
|
|
315
|
+
|
|
316
|
+
/**
|
|
317
|
+
* The status of the badge
|
|
318
|
+
*/
|
|
319
|
+
status: 'active' | 'inactive' | 'revoked';
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* The date and time the user badge was updated
|
|
323
|
+
*/
|
|
324
|
+
updatedAt: string;
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* UUID of the user (converted to lowercase)
|
|
328
|
+
*/
|
|
329
|
+
userId: string;
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* UUID of the website (converted to lowercase)
|
|
333
|
+
*/
|
|
334
|
+
websiteId: string;
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* Whether the user has dismissed the badge in the UI
|
|
338
|
+
*/
|
|
339
|
+
dismissedInUi?: boolean;
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* User associated with the user badge
|
|
343
|
+
*/
|
|
344
|
+
user?: TransactionListBadgeUsersResponse.User | null;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
export namespace TransactionListBadgeUsersResponse {
|
|
348
|
+
/**
|
|
349
|
+
* User associated with the user badge
|
|
350
|
+
*/
|
|
351
|
+
export interface User {
|
|
352
|
+
/**
|
|
353
|
+
* Wallet address of the user
|
|
354
|
+
*/
|
|
355
|
+
walletAddress: string;
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
export interface TransactionListRuleChainsResponse {
|
|
360
|
+
data: Array<TransactionListRuleChainsResponse.Data>;
|
|
361
|
+
|
|
362
|
+
hasNextPage: boolean;
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
export namespace TransactionListRuleChainsResponse {
|
|
366
|
+
export interface Data {
|
|
367
|
+
/**
|
|
368
|
+
* Unique identifier for the rule chain
|
|
369
|
+
*/
|
|
370
|
+
id: string;
|
|
371
|
+
|
|
372
|
+
loyaltyConditions: Array<Data.LoyaltyCondition>;
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* Unique identifier for the loyalty rule
|
|
376
|
+
*/
|
|
377
|
+
loyaltyRuleId: string;
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Name of the rule chain
|
|
381
|
+
*/
|
|
382
|
+
name: string;
|
|
383
|
+
|
|
384
|
+
/**
|
|
385
|
+
* Type of the operator. AND if all conditions must be met, OR if any condition can
|
|
386
|
+
* be met.
|
|
387
|
+
*/
|
|
388
|
+
operatorType?: 'AND' | 'OR';
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
export namespace Data {
|
|
392
|
+
export interface LoyaltyCondition {
|
|
393
|
+
/**
|
|
394
|
+
* Unique identifier for the condition
|
|
395
|
+
*/
|
|
396
|
+
id: string;
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* Amount of the condition
|
|
400
|
+
*/
|
|
401
|
+
amount: number | null;
|
|
402
|
+
|
|
403
|
+
association: Array<LoyaltyCondition.Association>;
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* URL of the CSV file
|
|
407
|
+
*/
|
|
408
|
+
csvUrl: string | null;
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* Description of the condition
|
|
412
|
+
*/
|
|
413
|
+
description: string | null;
|
|
414
|
+
|
|
415
|
+
/**
|
|
416
|
+
* Number of times the condition must be met
|
|
417
|
+
*/
|
|
418
|
+
repeatCount: number | null;
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* Number of times the condition must be met
|
|
422
|
+
*/
|
|
423
|
+
requiredCount: number | null;
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* Type of the condition
|
|
427
|
+
*/
|
|
428
|
+
type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
export namespace LoyaltyCondition {
|
|
432
|
+
export interface Association {
|
|
433
|
+
/**
|
|
434
|
+
* Unique identifier for the association
|
|
435
|
+
*/
|
|
436
|
+
id: string;
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* Unique identifier for the loyalty badge
|
|
440
|
+
*/
|
|
441
|
+
loyaltyBadgeId: string | null;
|
|
442
|
+
|
|
443
|
+
loyaltyCurrency: Association.LoyaltyCurrency | null;
|
|
444
|
+
|
|
445
|
+
/**
|
|
446
|
+
* Unique identifier for the loyalty currency
|
|
447
|
+
*/
|
|
448
|
+
loyaltyCurrencyId: string | null;
|
|
449
|
+
|
|
450
|
+
loyaltyRule: Association.LoyaltyRule | null;
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* Unique identifier for the loyalty rule group
|
|
454
|
+
*/
|
|
455
|
+
loyaltyRuleGroupId: string | null;
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Unique identifier for the loyalty rule
|
|
459
|
+
*/
|
|
460
|
+
loyaltyRuleId: string | null;
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
export namespace Association {
|
|
464
|
+
export interface LoyaltyCurrency {
|
|
465
|
+
/**
|
|
466
|
+
* Name of the loyalty currency
|
|
467
|
+
*/
|
|
468
|
+
name: string;
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
export interface LoyaltyRule {
|
|
472
|
+
/**
|
|
473
|
+
* Name of the loyalty rule
|
|
474
|
+
*/
|
|
475
|
+
name: string;
|
|
476
|
+
}
|
|
477
|
+
}
|
|
478
|
+
}
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
export interface TransactionResetLoyaltyCurrencyResponse {
|
|
483
|
+
success: boolean;
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
export interface TransactionCreateTransactionParams {
|
|
487
|
+
/**
|
|
488
|
+
* Description of the loyalty transaction
|
|
489
|
+
*/
|
|
490
|
+
description: string;
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Array of transaction entries
|
|
494
|
+
*/
|
|
495
|
+
entries: Array<TransactionCreateTransactionParams.Entry>;
|
|
496
|
+
|
|
497
|
+
/**
|
|
498
|
+
* Unique identifier for the loyalty currency
|
|
499
|
+
*/
|
|
500
|
+
loyaltyCurrencyId?: string;
|
|
501
|
+
|
|
502
|
+
organizationId?: string;
|
|
503
|
+
|
|
504
|
+
websiteId?: string;
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
export namespace TransactionCreateTransactionParams {
|
|
508
|
+
export interface Entry {
|
|
509
|
+
/**
|
|
510
|
+
* Transaction entry amount.
|
|
511
|
+
*/
|
|
512
|
+
amount: number;
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Direction of the transaction entry for this wallet address
|
|
516
|
+
*/
|
|
517
|
+
direction?: 'credit' | 'debit';
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* Idempotency key for the transaction entry. Creation will fail if already exists
|
|
521
|
+
* for this wallet address.
|
|
522
|
+
*/
|
|
523
|
+
idempotencyKey?: string;
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* Unique identifier for the loyalty currency for the wallet. Can only use
|
|
527
|
+
* entry-level currency or transaction-level currency.
|
|
528
|
+
*/
|
|
529
|
+
loyaltyCurrencyId?: string;
|
|
530
|
+
|
|
531
|
+
/**
|
|
532
|
+
* The wallet address of the user
|
|
533
|
+
*/
|
|
534
|
+
walletAddress?: string;
|
|
535
|
+
}
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
export interface TransactionGetTransactionEntriesParams {
|
|
539
|
+
/**
|
|
540
|
+
* End date to filter by (exclusive, less than)
|
|
541
|
+
*/
|
|
542
|
+
createdAtEnd?: string;
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
* Start date to filter by (inclusive, greater than or equal to)
|
|
546
|
+
*/
|
|
547
|
+
createdAtStart?: string;
|
|
548
|
+
|
|
549
|
+
/**
|
|
550
|
+
* Key to ensure idempotency of the request
|
|
551
|
+
*/
|
|
552
|
+
idempotencyKey?: string;
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* Maximum number of records to return (max 100)
|
|
556
|
+
*/
|
|
557
|
+
limit?: number;
|
|
558
|
+
|
|
559
|
+
/**
|
|
560
|
+
* UUID of the loyalty currency IDs to filter by. Use this to exclude deleted
|
|
561
|
+
* currencies
|
|
562
|
+
*/
|
|
563
|
+
loyaltyCurrencyId?: string | Array<string>;
|
|
564
|
+
|
|
565
|
+
/**
|
|
566
|
+
* UUID of the rule group (converted to lowercase)
|
|
567
|
+
*/
|
|
568
|
+
loyaltyRuleGroupId?: string;
|
|
569
|
+
|
|
570
|
+
/**
|
|
571
|
+
* Unique identifier for the loyalty rule to filter by
|
|
572
|
+
*/
|
|
573
|
+
loyaltyRuleId?: string;
|
|
574
|
+
|
|
575
|
+
loyaltyRuleType?:
|
|
576
|
+
| 'Bonus'
|
|
577
|
+
| 'BoughtOn'
|
|
578
|
+
| 'BoughtWithRoyalties'
|
|
579
|
+
| 'DiscordMessages'
|
|
580
|
+
| 'Listing'
|
|
581
|
+
| 'Lodging'
|
|
582
|
+
| 'MintOn'
|
|
583
|
+
| 'PoapClaim'
|
|
584
|
+
| 'SnagSocialsConnected'
|
|
585
|
+
| 'SnapshotFullset'
|
|
586
|
+
| 'SnapshotHold'
|
|
587
|
+
| 'SoldOn'
|
|
588
|
+
| 'SoldWithRoyalties'
|
|
589
|
+
| 'TokenHold'
|
|
590
|
+
| 'TwitterBio'
|
|
591
|
+
| 'TwitterHashTagPost'
|
|
592
|
+
| 'Retweet'
|
|
593
|
+
| 'check_in'
|
|
594
|
+
| 'code_entry'
|
|
595
|
+
| 'connect_wallet'
|
|
596
|
+
| 'connected_discord'
|
|
597
|
+
| 'connected_email'
|
|
598
|
+
| 'connected_epic'
|
|
599
|
+
| 'connected_github'
|
|
600
|
+
| 'connected_steam'
|
|
601
|
+
| 'connected_telegram'
|
|
602
|
+
| 'connected_twitter'
|
|
603
|
+
| 'create_partner_account'
|
|
604
|
+
| 'discord_member'
|
|
605
|
+
| 'drip_x_follow'
|
|
606
|
+
| 'drip_x_new_tweet'
|
|
607
|
+
| 'drip_x_text_in_bio'
|
|
608
|
+
| 'drip_x_text_in_comment'
|
|
609
|
+
| 'drip_x_text_in_name'
|
|
610
|
+
| 'drip_x_tweet'
|
|
611
|
+
| 'external_rule'
|
|
612
|
+
| 'link_click'
|
|
613
|
+
| 'manual_upload'
|
|
614
|
+
| 'profile_completed'
|
|
615
|
+
| 'referred_user'
|
|
616
|
+
| 'smart_contract_event'
|
|
617
|
+
| 'snapshot_governance'
|
|
618
|
+
| 'telegram_join'
|
|
619
|
+
| 'telegram_messages'
|
|
620
|
+
| 'text_input'
|
|
621
|
+
| 'token_hold_erc20'
|
|
622
|
+
| 'tweet_liked_by_project'
|
|
623
|
+
| 'twitter_comment'
|
|
624
|
+
| 'twitter_follow'
|
|
625
|
+
| 'twitter_followers'
|
|
626
|
+
| 'twitter_like'
|
|
627
|
+
| 'twitter_post_hashtag'
|
|
628
|
+
| 'quiz'
|
|
629
|
+
| 'poll'
|
|
630
|
+
| 'steam_wishlist'
|
|
631
|
+
| 'liquidity_uniswap_v2'
|
|
632
|
+
| 'liquidity_uniswap_v3'
|
|
633
|
+
| 'points_airdrop'
|
|
634
|
+
| 'youtube_subscribers'
|
|
635
|
+
| 'youtube_comment'
|
|
636
|
+
| 'shopify_spend'
|
|
637
|
+
| 'swap'
|
|
638
|
+
| 'tiktok_post'
|
|
639
|
+
| 'post_impressions'
|
|
640
|
+
| 'discord_join'
|
|
641
|
+
| 'connected_youtube'
|
|
642
|
+
| 'stratus_function'
|
|
643
|
+
| 'connected_tiktok'
|
|
644
|
+
| 'tiktok_follow'
|
|
645
|
+
| 'github_repo_star'
|
|
646
|
+
| 'github_repo_fork'
|
|
647
|
+
| 'github_repo_collaborator'
|
|
648
|
+
| 'github_merge_PR'
|
|
649
|
+
| 'discord_role_grant'
|
|
650
|
+
| 'connected_reddit'
|
|
651
|
+
| 'reddit_comment'
|
|
652
|
+
| 'robinhood_token_hold'
|
|
653
|
+
| 'connected_instagram'
|
|
654
|
+
| 'instagram_post'
|
|
655
|
+
| 'instagram_follow'
|
|
656
|
+
| 'connected_phone'
|
|
657
|
+
| 'dapps_by_gas_spent'
|
|
658
|
+
| 'dapps_by_active_users'
|
|
659
|
+
| 'dapps_by_new_users'
|
|
660
|
+
| 'dapps_by_transaction_count'
|
|
661
|
+
| Array<
|
|
662
|
+
| 'Bonus'
|
|
663
|
+
| 'BoughtOn'
|
|
664
|
+
| 'BoughtWithRoyalties'
|
|
665
|
+
| 'DiscordMessages'
|
|
666
|
+
| 'Listing'
|
|
667
|
+
| 'Lodging'
|
|
668
|
+
| 'MintOn'
|
|
669
|
+
| 'PoapClaim'
|
|
670
|
+
| 'SnagSocialsConnected'
|
|
671
|
+
| 'SnapshotFullset'
|
|
672
|
+
| 'SnapshotHold'
|
|
673
|
+
| 'SoldOn'
|
|
674
|
+
| 'SoldWithRoyalties'
|
|
675
|
+
| 'TokenHold'
|
|
676
|
+
| 'TwitterBio'
|
|
677
|
+
| 'TwitterHashTagPost'
|
|
678
|
+
| 'Retweet'
|
|
679
|
+
| 'check_in'
|
|
680
|
+
| 'code_entry'
|
|
681
|
+
| 'connect_wallet'
|
|
682
|
+
| 'connected_discord'
|
|
683
|
+
| 'connected_email'
|
|
684
|
+
| 'connected_epic'
|
|
685
|
+
| 'connected_github'
|
|
686
|
+
| 'connected_steam'
|
|
687
|
+
| 'connected_telegram'
|
|
688
|
+
| 'connected_twitter'
|
|
689
|
+
| 'create_partner_account'
|
|
690
|
+
| 'discord_member'
|
|
691
|
+
| 'drip_x_follow'
|
|
692
|
+
| 'drip_x_new_tweet'
|
|
693
|
+
| 'drip_x_text_in_bio'
|
|
694
|
+
| 'drip_x_text_in_comment'
|
|
695
|
+
| 'drip_x_text_in_name'
|
|
696
|
+
| 'drip_x_tweet'
|
|
697
|
+
| 'external_rule'
|
|
698
|
+
| 'link_click'
|
|
699
|
+
| 'manual_upload'
|
|
700
|
+
| 'profile_completed'
|
|
701
|
+
| 'referred_user'
|
|
702
|
+
| 'smart_contract_event'
|
|
703
|
+
| 'snapshot_governance'
|
|
704
|
+
| 'telegram_join'
|
|
705
|
+
| 'telegram_messages'
|
|
706
|
+
| 'text_input'
|
|
707
|
+
| 'token_hold_erc20'
|
|
708
|
+
| 'tweet_liked_by_project'
|
|
709
|
+
| 'twitter_comment'
|
|
710
|
+
| 'twitter_follow'
|
|
711
|
+
| 'twitter_followers'
|
|
712
|
+
| 'twitter_like'
|
|
713
|
+
| 'twitter_post_hashtag'
|
|
714
|
+
| 'quiz'
|
|
715
|
+
| 'poll'
|
|
716
|
+
| 'steam_wishlist'
|
|
717
|
+
| 'liquidity_uniswap_v2'
|
|
718
|
+
| 'liquidity_uniswap_v3'
|
|
719
|
+
| 'points_airdrop'
|
|
720
|
+
| 'youtube_subscribers'
|
|
721
|
+
| 'youtube_comment'
|
|
722
|
+
| 'shopify_spend'
|
|
723
|
+
| 'swap'
|
|
724
|
+
| 'tiktok_post'
|
|
725
|
+
| 'post_impressions'
|
|
726
|
+
| 'discord_join'
|
|
727
|
+
| 'connected_youtube'
|
|
728
|
+
| 'stratus_function'
|
|
729
|
+
| 'connected_tiktok'
|
|
730
|
+
| 'tiktok_follow'
|
|
731
|
+
| 'github_repo_star'
|
|
732
|
+
| 'github_repo_fork'
|
|
733
|
+
| 'github_repo_collaborator'
|
|
734
|
+
| 'github_merge_PR'
|
|
735
|
+
| 'discord_role_grant'
|
|
736
|
+
| 'connected_reddit'
|
|
737
|
+
| 'reddit_comment'
|
|
738
|
+
| 'robinhood_token_hold'
|
|
739
|
+
| 'connected_instagram'
|
|
740
|
+
| 'instagram_post'
|
|
741
|
+
| 'instagram_follow'
|
|
742
|
+
| 'connected_phone'
|
|
743
|
+
| 'dapps_by_gas_spent'
|
|
744
|
+
| 'dapps_by_active_users'
|
|
745
|
+
| 'dapps_by_new_users'
|
|
746
|
+
| 'dapps_by_transaction_count'
|
|
747
|
+
>;
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* Unique identifier for the loyalty transaction to filter by
|
|
751
|
+
*/
|
|
752
|
+
loyaltyTransactionId?: string;
|
|
753
|
+
|
|
754
|
+
/**
|
|
755
|
+
* Unique identifier for the organization to filter by
|
|
756
|
+
*/
|
|
757
|
+
organizationId?: string;
|
|
758
|
+
|
|
759
|
+
/**
|
|
760
|
+
* Field to sort the results by
|
|
761
|
+
*/
|
|
762
|
+
sortBy?: 'createdAt' | 'updatedAt' | 'loyaltyAccountLockVersion';
|
|
763
|
+
|
|
764
|
+
/**
|
|
765
|
+
* Direction to sort the results by
|
|
766
|
+
*/
|
|
767
|
+
sortDir?: 'asc' | 'desc';
|
|
768
|
+
|
|
769
|
+
/**
|
|
770
|
+
* Pagination cursor to start after a specific resource ID
|
|
771
|
+
*/
|
|
772
|
+
startingAfter?: string;
|
|
773
|
+
|
|
774
|
+
/**
|
|
775
|
+
* Type of the loyalty transaction to filter by
|
|
776
|
+
*/
|
|
777
|
+
type?: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
|
|
778
|
+
|
|
779
|
+
/**
|
|
780
|
+
* When passed in return the list of fulfilled entries for loyalty rules. If a
|
|
781
|
+
* loyalty rule has a fulfilled entry this means the user cannot currently complete
|
|
782
|
+
* the rule. Must be passed in with userId or walletAddress.
|
|
783
|
+
*/
|
|
784
|
+
userCompletedLoyaltyRuleId?: string | Array<string>;
|
|
785
|
+
|
|
786
|
+
/**
|
|
787
|
+
* External identifier for the user group controlled by you.
|
|
788
|
+
*/
|
|
789
|
+
userGroupExternalIdentifier?: string;
|
|
790
|
+
|
|
791
|
+
/**
|
|
792
|
+
* Unique identifier for the user group
|
|
793
|
+
*/
|
|
794
|
+
userGroupId?: string;
|
|
795
|
+
|
|
796
|
+
/**
|
|
797
|
+
* User ID or array of User IDs to filter by
|
|
798
|
+
*/
|
|
799
|
+
userId?: string | Array<string>;
|
|
800
|
+
|
|
801
|
+
/**
|
|
802
|
+
* Wallet address or array of wallet addresses to filter by
|
|
803
|
+
*/
|
|
804
|
+
walletAddress?: string | Array<string>;
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* Identifier for the wallet group to filter by
|
|
808
|
+
*/
|
|
809
|
+
walletGroupIdentifier?: string;
|
|
810
|
+
|
|
811
|
+
/**
|
|
812
|
+
* Unique identifier for the website to filter by
|
|
813
|
+
*/
|
|
814
|
+
websiteId?: string;
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
export interface TransactionListBadgeUsersParams {
|
|
818
|
+
/**
|
|
819
|
+
* UUID of the loyalty badge (converted to lowercase)
|
|
820
|
+
*/
|
|
821
|
+
loyaltyBadgeId: string;
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* Number of badges to fetch
|
|
825
|
+
*/
|
|
826
|
+
limit?: number;
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* UUID of the organization (optional, converted to lowercase)
|
|
830
|
+
*/
|
|
831
|
+
organizationId?: string;
|
|
832
|
+
|
|
833
|
+
/**
|
|
834
|
+
* UUID of the badge to start after (converted to lowercase)
|
|
835
|
+
*/
|
|
836
|
+
startingAfter?: string;
|
|
837
|
+
|
|
838
|
+
/**
|
|
839
|
+
* Status of the badge
|
|
840
|
+
*/
|
|
841
|
+
status?: 'active' | 'inactive' | 'revoked';
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* Wallet Address of the user, or array of wallet addresses.
|
|
845
|
+
*/
|
|
846
|
+
walletAddress?: string;
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* UUID of the website (optional, converted to lowercase)
|
|
850
|
+
*/
|
|
851
|
+
websiteId?: string;
|
|
852
|
+
}
|
|
853
|
+
|
|
854
|
+
export interface TransactionListRuleChainsParams {
|
|
855
|
+
/**
|
|
856
|
+
* Unique identifier for the organization
|
|
857
|
+
*/
|
|
858
|
+
organizationId: string;
|
|
859
|
+
|
|
860
|
+
/**
|
|
861
|
+
* Unique identifier for the website
|
|
862
|
+
*/
|
|
863
|
+
websiteId: string;
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* Number of rule chains to return
|
|
867
|
+
*/
|
|
868
|
+
limit?: number;
|
|
869
|
+
|
|
870
|
+
/**
|
|
871
|
+
* Starting after the given rule chain ID
|
|
872
|
+
*/
|
|
873
|
+
startingAfter?: string;
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
export interface TransactionResetLoyaltyCurrencyParams {
|
|
877
|
+
/**
|
|
878
|
+
* UUID of the loyalty currency to reset
|
|
879
|
+
*/
|
|
880
|
+
loyaltyCurrencyId: string;
|
|
881
|
+
|
|
882
|
+
type:
|
|
883
|
+
| 'loyalty_reset_balances'
|
|
884
|
+
| 'loyalty_reset_balances_data_and_rules'
|
|
885
|
+
| 'loyalty_reset_balances_data_not_rules';
|
|
886
|
+
|
|
887
|
+
/**
|
|
888
|
+
* UUID of the organization (optional, converted to lowercase)
|
|
889
|
+
*/
|
|
890
|
+
organizationId?: string;
|
|
891
|
+
|
|
892
|
+
/**
|
|
893
|
+
* UUID of the website (optional, converted to lowercase)
|
|
894
|
+
*/
|
|
895
|
+
websiteId?: string;
|
|
896
|
+
}
|
|
897
|
+
|
|
898
|
+
Transactions.RuleStatuses = RuleStatuses;
|
|
899
|
+
Transactions.Posts = Posts;
|
|
900
|
+
|
|
901
|
+
export declare namespace Transactions {
|
|
902
|
+
export {
|
|
903
|
+
type TransactionCreateTransactionResponse as TransactionCreateTransactionResponse,
|
|
904
|
+
type TransactionGetTransactionEntriesResponse as TransactionGetTransactionEntriesResponse,
|
|
905
|
+
type TransactionListBadgeUsersResponse as TransactionListBadgeUsersResponse,
|
|
906
|
+
type TransactionListRuleChainsResponse as TransactionListRuleChainsResponse,
|
|
907
|
+
type TransactionResetLoyaltyCurrencyResponse as TransactionResetLoyaltyCurrencyResponse,
|
|
908
|
+
type TransactionCreateTransactionParams as TransactionCreateTransactionParams,
|
|
909
|
+
type TransactionGetTransactionEntriesParams as TransactionGetTransactionEntriesParams,
|
|
910
|
+
type TransactionListBadgeUsersParams as TransactionListBadgeUsersParams,
|
|
911
|
+
type TransactionListRuleChainsParams as TransactionListRuleChainsParams,
|
|
912
|
+
type TransactionResetLoyaltyCurrencyParams as TransactionResetLoyaltyCurrencyParams,
|
|
913
|
+
};
|
|
914
|
+
|
|
915
|
+
export {
|
|
916
|
+
RuleStatuses as RuleStatuses,
|
|
917
|
+
type RuleStatusUpdateResponse as RuleStatusUpdateResponse,
|
|
918
|
+
type RuleStatusListResponse as RuleStatusListResponse,
|
|
919
|
+
type RuleStatusUpdateParams as RuleStatusUpdateParams,
|
|
920
|
+
type RuleStatusListParams as RuleStatusListParams,
|
|
921
|
+
};
|
|
922
|
+
|
|
923
|
+
export {
|
|
924
|
+
Posts as Posts,
|
|
925
|
+
type PostListResponse as PostListResponse,
|
|
926
|
+
type PostRewardResponse as PostRewardResponse,
|
|
927
|
+
type PostListParams as PostListParams,
|
|
928
|
+
type PostRewardParams as PostRewardParams,
|
|
929
|
+
};
|
|
930
|
+
}
|