@snagsolutions/sdk 0.1.0-alpha.11 → 0.1.0-alpha.111
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 +978 -0
- package/README.md +24 -28
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +19 -5
- package/core.d.ts.map +1 -1
- package/core.js +35 -19
- package/core.js.map +1 -1
- package/core.mjs +36 -20
- package/core.mjs.map +1 -1
- package/index.d.mts +25 -16
- package/index.d.ts +25 -16
- package/index.d.ts.map +1 -1
- package/index.js +20 -10
- package/index.js.map +1 -1
- package/index.mjs +21 -11
- package/index.mjs.map +1 -1
- 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 +22 -8
- package/resources/assets.d.ts.map +1 -1
- package/resources/assets.js +12 -4
- package/resources/assets.js.map +1 -1
- package/resources/assets.mjs +12 -4
- package/resources/assets.mjs.map +1 -1
- package/resources/auctions/auctions.d.ts +285 -0
- package/resources/auctions/auctions.d.ts.map +1 -0
- package/resources/auctions/auctions.js +76 -0
- package/resources/auctions/auctions.js.map +1 -0
- package/resources/auctions/auctions.mjs +49 -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 +122 -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 +132 -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 +2 -0
- package/resources/auctions.d.ts.map +1 -0
- package/resources/auctions.js +19 -0
- package/resources/auctions.js.map +1 -0
- package/resources/auctions.mjs +3 -0
- package/resources/auctions.mjs.map +1 -0
- package/resources/auth.d.ts +44 -0
- package/resources/auth.d.ts.map +1 -0
- package/resources/auth.js +16 -0
- package/resources/auth.js.map +1 -0
- package/resources/auth.mjs +12 -0
- package/resources/auth.mjs.map +1 -0
- package/resources/index.d.ts +7 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +10 -6
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +6 -4
- package/resources/index.mjs.map +1 -1
- package/resources/loyalty/account-streaks.d.ts +81 -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 +62 -15
- package/resources/loyalty/accounts.d.ts.map +1 -1
- package/resources/loyalty/accounts.js +22 -1
- package/resources/loyalty/accounts.js.map +1 -1
- package/resources/loyalty/accounts.mjs +22 -1
- package/resources/loyalty/accounts.mjs.map +1 -1
- package/resources/loyalty/badges.d.ts +876 -77
- 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 +20 -1
- 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 +9 -5
- package/resources/loyalty/index.d.ts.map +1 -1
- package/resources/loyalty/index.js +11 -3
- package/resources/loyalty/index.js.map +1 -1
- package/resources/loyalty/index.mjs +6 -2
- package/resources/loyalty/index.mjs.map +1 -1
- package/resources/loyalty/loyalty.d.ts +33 -17
- package/resources/loyalty/loyalty.d.ts.map +1 -1
- package/resources/loyalty/loyalty.js +28 -12
- package/resources/loyalty/loyalty.js.map +1 -1
- package/resources/loyalty/loyalty.mjs +29 -13
- package/resources/loyalty/loyalty.mjs.map +1 -1
- package/resources/loyalty/multipliers.d.ts +97 -4
- package/resources/loyalty/multipliers.d.ts.map +1 -1
- package/resources/loyalty/multipliers.js +29 -0
- package/resources/loyalty/multipliers.js.map +1 -1
- package/resources/loyalty/multipliers.mjs +29 -0
- package/resources/loyalty/multipliers.mjs.map +1 -1
- package/resources/loyalty/questions-responses.d.ts +112 -0
- package/resources/loyalty/questions-responses.d.ts.map +1 -0
- package/resources/loyalty/questions-responses.js +31 -0
- package/resources/loyalty/questions-responses.js.map +1 -0
- package/resources/loyalty/questions-responses.mjs +27 -0
- package/resources/loyalty/questions-responses.mjs.map +1 -0
- package/resources/loyalty/questions.d.ts +183 -0
- package/resources/loyalty/questions.d.ts.map +1 -0
- package/resources/loyalty/questions.js +60 -0
- package/resources/loyalty/questions.js.map +1 -0
- package/resources/loyalty/questions.mjs +56 -0
- package/resources/loyalty/questions.mjs.map +1 -0
- package/resources/loyalty/rule-edits.d.ts +2489 -11
- package/resources/loyalty/rule-edits.d.ts.map +1 -1
- package/resources/loyalty/rule-edits.js +16 -2
- package/resources/loyalty/rule-edits.js.map +1 -1
- package/resources/loyalty/rule-edits.mjs +16 -2
- package/resources/loyalty/rule-edits.mjs.map +1 -1
- package/resources/loyalty/rule-groups.d.ts +738 -0
- package/resources/loyalty/rule-groups.d.ts.map +1 -0
- package/resources/loyalty/rule-groups.js +52 -0
- package/resources/loyalty/rule-groups.js.map +1 -0
- package/resources/loyalty/rule-groups.mjs +48 -0
- package/resources/loyalty/rule-groups.mjs.map +1 -0
- package/resources/loyalty/rules.d.ts +1735 -282
- 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 +3 -0
- package/resources/loyalty/transactions/index.d.ts.map +1 -0
- package/resources/loyalty/transactions/index.js +9 -0
- package/resources/loyalty/transactions/index.js.map +1 -0
- package/resources/loyalty/transactions/index.mjs +4 -0
- package/resources/loyalty/transactions/index.mjs.map +1 -0
- package/resources/loyalty/transactions/rule-statuses.d.ts +120 -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 +410 -0
- package/resources/loyalty/transactions/transactions.d.ts.map +1 -0
- package/resources/loyalty/transactions/transactions.js +76 -0
- package/resources/loyalty/transactions/transactions.js.map +1 -0
- package/resources/loyalty/transactions/transactions.mjs +49 -0
- package/resources/loyalty/transactions/transactions.mjs.map +1 -0
- package/resources/loyalty/transactions.d.ts +2 -0
- package/resources/loyalty/transactions.d.ts.map +1 -0
- package/resources/loyalty/transactions.js +19 -0
- package/resources/loyalty/transactions.js.map +1 -0
- package/resources/loyalty/transactions.mjs +3 -0
- package/resources/loyalty/transactions.mjs.map +1 -0
- package/resources/loyalty.d.ts +2 -0
- package/resources/loyalty.d.ts.map +1 -0
- package/resources/loyalty.js +19 -0
- package/resources/loyalty.js.map +1 -0
- package/resources/loyalty.mjs +3 -0
- package/resources/loyalty.mjs.map +1 -0
- package/resources/minting.d.ts +95 -0
- package/resources/minting.d.ts.map +1 -0
- package/resources/minting.js +15 -0
- package/resources/minting.js.map +1 -0
- package/resources/minting.mjs +11 -0
- package/resources/minting.mjs.map +1 -0
- package/resources/referral/index.d.ts +3 -0
- package/resources/referral/index.d.ts.map +1 -0
- package/resources/referral/index.js +9 -0
- package/resources/referral/index.js.map +1 -0
- package/resources/referral/index.mjs +4 -0
- package/resources/referral/index.mjs.map +1 -0
- package/resources/referral/referral.d.ts +39 -0
- package/resources/referral/referral.d.ts.map +1 -0
- package/resources/{drip/drip.js → referral/referral.js} +21 -12
- package/resources/referral/referral.js.map +1 -0
- package/resources/referral/referral.mjs +25 -0
- package/resources/referral/referral.mjs.map +1 -0
- package/resources/referral/users.d.ts +83 -0
- package/resources/referral/users.d.ts.map +1 -0
- package/resources/referral/users.js +35 -0
- package/resources/referral/users.js.map +1 -0
- package/resources/referral/users.mjs +31 -0
- package/resources/referral/users.mjs.map +1 -0
- package/resources/referral.d.ts +2 -0
- package/resources/referral.d.ts.map +1 -0
- package/resources/referral.js +19 -0
- package/resources/referral.js.map +1 -0
- package/resources/referral.mjs +3 -0
- package/resources/referral.mjs.map +1 -0
- package/resources/users/index.d.ts +2 -3
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/index.js +1 -3
- package/resources/users/index.js.map +1 -1
- package/resources/users/index.mjs +2 -3
- package/resources/users/index.mjs.map +1 -1
- package/resources/users/metadatas.d.ts +109 -9
- package/resources/users/metadatas.d.ts.map +1 -1
- package/resources/users/metadatas.js +6 -0
- package/resources/users/metadatas.js.map +1 -1
- package/resources/users/metadatas.mjs +6 -0
- package/resources/users/metadatas.mjs.map +1 -1
- package/resources/users/users.d.ts +414 -6
- package/resources/users/users.d.ts.map +1 -1
- package/resources/users/users.js +77 -4
- package/resources/users/users.js.map +1 -1
- package/resources/users/users.mjs +78 -5
- package/resources/users/users.mjs.map +1 -1
- package/resources/users.d.ts +2 -0
- package/resources/users.d.ts.map +1 -0
- package/resources/users.js +19 -0
- package/resources/users.js.map +1 -0
- package/resources/users.mjs +3 -0
- package/resources/users.mjs.map +1 -0
- package/resources/websites/index.d.ts +4 -0
- package/resources/websites/index.d.ts.map +1 -0
- package/resources/websites/index.js +11 -0
- package/resources/websites/index.js.map +1 -0
- package/resources/websites/index.mjs +5 -0
- package/resources/websites/index.mjs.map +1 -0
- package/resources/websites/website-collections.d.ts +94 -0
- package/resources/websites/website-collections.d.ts.map +1 -0
- package/resources/websites/website-collections.js +46 -0
- package/resources/websites/website-collections.js.map +1 -0
- package/resources/websites/website-collections.mjs +42 -0
- package/resources/websites/website-collections.mjs.map +1 -0
- package/resources/websites/website-user-roles.d.ts +96 -0
- package/resources/websites/website-user-roles.d.ts.map +1 -0
- package/resources/websites/website-user-roles.js +45 -0
- package/resources/websites/website-user-roles.js.map +1 -0
- package/resources/websites/website-user-roles.mjs +41 -0
- package/resources/websites/website-user-roles.mjs.map +1 -0
- package/resources/websites/websites.d.ts +223 -0
- package/resources/websites/websites.d.ts.map +1 -0
- package/resources/websites/websites.js +63 -0
- package/resources/websites/websites.js.map +1 -0
- package/resources/websites/websites.mjs +36 -0
- package/resources/websites/websites.mjs.map +1 -0
- package/resources/websites.d.ts +1 -202
- package/resources/websites.d.ts.map +1 -1
- package/resources/websites.js +15 -18
- package/resources/websites.js.map +1 -1
- package/resources/websites.mjs +1 -16
- package/resources/websites.mjs.map +1 -1
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +18 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/_shims/index.d.ts +2 -0
- package/src/_shims/index.js +5 -1
- package/src/_shims/index.mjs +5 -1
- package/src/core.ts +56 -20
- package/src/index.ts +96 -24
- package/src/resource.ts +1 -1
- package/src/resources/assets.ts +29 -8
- package/src/resources/auctions/auctions.ts +436 -0
- package/src/resources/auctions/index.ts +18 -0
- package/src/resources/auctions/website-user-attributes/index.ts +18 -0
- package/src/resources/auctions/website-user-attributes/values.ts +165 -0
- package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +207 -0
- package/src/resources/auctions/website-user-attributes.ts +3 -0
- package/src/resources/auctions.ts +3 -0
- package/src/resources/auth.ts +74 -0
- package/src/resources/index.ts +31 -5
- package/src/resources/loyalty/account-streaks.ts +110 -0
- package/src/resources/loyalty/accounts.ts +79 -16
- package/src/resources/loyalty/badges.ts +1055 -83
- package/src/resources/loyalty/currencies.ts +20 -1
- package/src/resources/loyalty/index.ts +53 -9
- package/src/resources/loyalty/loyalty.ts +160 -60
- package/src/resources/loyalty/multipliers.ts +124 -4
- package/src/resources/loyalty/questions-responses.ts +161 -0
- package/src/resources/loyalty/questions.ts +241 -0
- package/src/resources/loyalty/rule-edits.ts +3502 -63
- package/src/resources/loyalty/rule-groups.ts +1149 -0
- package/src/resources/loyalty/rules.ts +2906 -575
- package/src/resources/loyalty/transactions/index.ts +18 -0
- package/src/resources/loyalty/transactions/rule-statuses.ts +178 -0
- package/src/resources/loyalty/transactions/transactions.ts +671 -0
- package/src/resources/loyalty/transactions.ts +3 -0
- package/src/resources/loyalty.ts +3 -0
- package/src/resources/minting.ts +170 -0
- package/src/resources/referral/index.ts +10 -0
- package/src/resources/referral/referral.ts +72 -0
- package/src/resources/referral/users.ts +122 -0
- package/src/resources/referral.ts +3 -0
- package/src/resources/users/index.ts +21 -9
- package/src/resources/users/metadatas.ts +161 -8
- package/src/resources/users/users.ts +581 -17
- package/src/resources/users.ts +3 -0
- package/src/resources/websites/index.ts +22 -0
- package/src/resources/websites/website-collections.ts +182 -0
- package/src/resources/websites/website-user-roles.ts +130 -0
- package/src/resources/websites/websites.ts +311 -0
- package/src/resources/websites.ts +1 -257
- package/src/resources.ts +1 -0
- 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/auction-bids.d.ts +0 -81
- package/resources/auction-bids.d.ts.map +0 -1
- package/resources/auction-bids.js +0 -30
- package/resources/auction-bids.js.map +0 -1
- package/resources/auction-bids.mjs +0 -26
- package/resources/auction-bids.mjs.map +0 -1
- package/resources/drip/drip.d.ts +0 -14
- package/resources/drip/drip.d.ts.map +0 -1
- package/resources/drip/drip.js.map +0 -1
- package/resources/drip/drip.mjs +0 -16
- package/resources/drip/drip.mjs.map +0 -1
- package/resources/drip/index.d.ts +0 -4
- package/resources/drip/index.d.ts.map +0 -1
- package/resources/drip/index.js +0 -11
- package/resources/drip/index.js.map +0 -1
- package/resources/drip/index.mjs +0 -5
- package/resources/drip/index.mjs.map +0 -1
- package/resources/drip/quests.d.ts +0 -168
- package/resources/drip/quests.d.ts.map +0 -1
- package/resources/drip/quests.js +0 -17
- package/resources/drip/quests.js.map +0 -1
- package/resources/drip/quests.mjs +0 -13
- package/resources/drip/quests.mjs.map +0 -1
- package/resources/drip/status.d.ts +0 -26
- package/resources/drip/status.d.ts.map +0 -1
- package/resources/drip/status.js +0 -16
- package/resources/drip/status.js.map +0 -1
- package/resources/drip/status.mjs +0 -12
- package/resources/drip/status.mjs.map +0 -1
- package/resources/loyalty/transaction-entries.d.ts +0 -175
- package/resources/loyalty/transaction-entries.d.ts.map +0 -1
- package/resources/loyalty/transaction-entries.js +0 -16
- package/resources/loyalty/transaction-entries.js.map +0 -1
- package/resources/loyalty/transaction-entries.mjs +0 -12
- package/resources/loyalty/transaction-entries.mjs.map +0 -1
- package/resources/users/wallets.d.ts +0 -193
- package/resources/users/wallets.d.ts.map +0 -1
- package/resources/users/wallets.js +0 -28
- package/resources/users/wallets.js.map +0 -1
- package/resources/users/wallets.mjs +0 -24
- package/resources/users/wallets.mjs.map +0 -1
- package/src/resources/auction-bids.ts +0 -123
- package/src/resources/drip/drip.ts +0 -25
- package/src/resources/drip/index.ts +0 -5
- package/src/resources/drip/quests.ts +0 -210
- package/src/resources/drip/status.ts +0 -33
- package/src/resources/loyalty/transaction-entries.ts +0 -229
- package/src/resources/users/wallets.ts +0 -271
|
@@ -6,7 +6,18 @@ import * as Core from '../../core';
|
|
|
6
6
|
|
|
7
7
|
export class Badges extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
* This endpoint allows you to configure a new badge
|
|
9
|
+
* This endpoint allows you to configure a new badge
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const badge = await client.loyalty.badges.create({
|
|
14
|
+
* conditions: [{}],
|
|
15
|
+
* imageUrl: 'https://example.com/image.png',
|
|
16
|
+
* name: 'Example Badge',
|
|
17
|
+
* organizationId: '123e4567-e89b-12d3-a456-426614174222',
|
|
18
|
+
* websiteId: '123e4567-e89b-12d3-a456-426614174111',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
10
21
|
*/
|
|
11
22
|
create(body: BadgeCreateParams, options?: Core.RequestOptions): Core.APIPromise<BadgeCreateResponse> {
|
|
12
23
|
return this._client.post('/api/loyalty/badges', { body, ...options });
|
|
@@ -14,6 +25,13 @@ export class Badges extends APIResource {
|
|
|
14
25
|
|
|
15
26
|
/**
|
|
16
27
|
* This endpoint allows you to update an existing badge.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const badge = await client.loyalty.badges.update(
|
|
32
|
+
* '123e4567-e89b-12d3-a456-426614174333',
|
|
33
|
+
* );
|
|
34
|
+
* ```
|
|
17
35
|
*/
|
|
18
36
|
update(
|
|
19
37
|
id: string,
|
|
@@ -34,6 +52,11 @@ export class Badges extends APIResource {
|
|
|
34
52
|
|
|
35
53
|
/**
|
|
36
54
|
* This endpoint allows you to fetch badge(s) data.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* const badges = await client.loyalty.badges.list();
|
|
59
|
+
* ```
|
|
37
60
|
*/
|
|
38
61
|
list(query?: BadgeListParams, options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
|
|
39
62
|
list(options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
|
|
@@ -49,6 +72,13 @@ export class Badges extends APIResource {
|
|
|
49
72
|
|
|
50
73
|
/**
|
|
51
74
|
* This endpoint allows you to delete a badge.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const badge = await client.loyalty.badges.delete(
|
|
79
|
+
* '123e4567-e89b-12d3-a456-426614174333',
|
|
80
|
+
* );
|
|
81
|
+
* ```
|
|
52
82
|
*/
|
|
53
83
|
delete(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeDeleteResponse> {
|
|
54
84
|
return this._client.delete(`/api/loyalty/badges/${id}`, options);
|
|
@@ -56,6 +86,13 @@ export class Badges extends APIResource {
|
|
|
56
86
|
|
|
57
87
|
/**
|
|
58
88
|
* This endpoint allows you to revoke a badge from an account
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* ```ts
|
|
92
|
+
* const response = await client.loyalty.badges.revoke(
|
|
93
|
+
* '123e4567-e89b-12d3-a456-426614174333',
|
|
94
|
+
* );
|
|
95
|
+
* ```
|
|
59
96
|
*/
|
|
60
97
|
revoke(
|
|
61
98
|
id: string,
|
|
@@ -76,6 +113,13 @@ export class Badges extends APIResource {
|
|
|
76
113
|
|
|
77
114
|
/**
|
|
78
115
|
* This endpoint allows you to reward a badge for an account
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```ts
|
|
119
|
+
* const response = await client.loyalty.badges.reward(
|
|
120
|
+
* '123e4567-e89b-12d3-a456-426614174333',
|
|
121
|
+
* );
|
|
122
|
+
* ```
|
|
79
123
|
*/
|
|
80
124
|
reward(
|
|
81
125
|
id: string,
|
|
@@ -99,118 +143,1004 @@ export class Badges extends APIResource {
|
|
|
99
143
|
* Response returned upon successful creation of the badge.
|
|
100
144
|
*/
|
|
101
145
|
export interface BadgeCreateResponse {
|
|
146
|
+
/**
|
|
147
|
+
* UUID of the badge (converted to lowercase)
|
|
148
|
+
*/
|
|
102
149
|
id: string;
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* The description of the badge
|
|
153
|
+
*/
|
|
154
|
+
description: string | null;
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* The URL of the badge image
|
|
158
|
+
*/
|
|
159
|
+
imageUrl: string | null;
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Array of conditions of the badge
|
|
163
|
+
*/
|
|
164
|
+
loyaltyConditions: Array<BadgeCreateResponse.LoyaltyCondition>;
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* The name of the badge
|
|
168
|
+
*/
|
|
169
|
+
name: string;
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Array of user badges
|
|
173
|
+
*/
|
|
174
|
+
loyaltyBadgeUsers?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* Array of loyalty rules associated with the badge
|
|
178
|
+
*/
|
|
179
|
+
loyaltyRules?: Array<BadgeCreateResponse.LoyaltyRule>;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
export namespace BadgeCreateResponse {
|
|
183
|
+
/**
|
|
184
|
+
* Schema for a loyalty condition rule.
|
|
185
|
+
*/
|
|
186
|
+
export interface LoyaltyCondition {
|
|
187
|
+
/**
|
|
188
|
+
* UUID of the condition (converted to lowercase)
|
|
189
|
+
*/
|
|
190
|
+
id: string;
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The amount of the condition
|
|
194
|
+
*/
|
|
195
|
+
amount: number | null;
|
|
196
|
+
|
|
197
|
+
association: Array<LoyaltyCondition.Association>;
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* The URL of the CSV file
|
|
201
|
+
*/
|
|
202
|
+
csvUrl: string | null;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* The description of the condition
|
|
206
|
+
*/
|
|
207
|
+
description: string | null;
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* UUID of the currency (converted to lowercase)
|
|
211
|
+
*/
|
|
212
|
+
loyaltyCurrencyId: string | null;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* UUID of the rule group (converted to lowercase)
|
|
216
|
+
*/
|
|
217
|
+
loyaltyRuleGroupId: string | null;
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* The repeat count of the condition
|
|
221
|
+
*/
|
|
222
|
+
repeatCount: number | null;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* The required count of the condition
|
|
226
|
+
*/
|
|
227
|
+
requiredCount: number | null;
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* The type of the condition
|
|
231
|
+
*/
|
|
232
|
+
type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
export namespace LoyaltyCondition {
|
|
236
|
+
export interface Association {
|
|
237
|
+
loyaltyBadge: Association.LoyaltyBadge | null;
|
|
238
|
+
|
|
239
|
+
loyaltyCurrency: Association.LoyaltyCurrency | null;
|
|
240
|
+
|
|
241
|
+
loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
|
|
242
|
+
|
|
243
|
+
loyaltyRule: Association.LoyaltyRule | null;
|
|
244
|
+
|
|
245
|
+
loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
export namespace Association {
|
|
249
|
+
export interface LoyaltyBadge {
|
|
250
|
+
/**
|
|
251
|
+
* UUID of the association (converted to lowercase)
|
|
252
|
+
*/
|
|
253
|
+
id: string;
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* The name of the association
|
|
257
|
+
*/
|
|
258
|
+
name: string;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
export interface LoyaltyCurrency {
|
|
262
|
+
/**
|
|
263
|
+
* UUID of the association (converted to lowercase)
|
|
264
|
+
*/
|
|
265
|
+
id: string;
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* The name of the association
|
|
269
|
+
*/
|
|
270
|
+
name: string;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
export interface LoyaltyLeaderboardView {
|
|
274
|
+
/**
|
|
275
|
+
* UUID of the association (converted to lowercase)
|
|
276
|
+
*/
|
|
277
|
+
id: string;
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* The name of the association
|
|
281
|
+
*/
|
|
282
|
+
name: string;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
export interface LoyaltyRule {
|
|
286
|
+
/**
|
|
287
|
+
* UUID of the association (converted to lowercase)
|
|
288
|
+
*/
|
|
289
|
+
id: string;
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* The name of the association
|
|
293
|
+
*/
|
|
294
|
+
name: string;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
export interface LoyaltyRuleGroup {
|
|
298
|
+
/**
|
|
299
|
+
* UUID of the association (converted to lowercase)
|
|
300
|
+
*/
|
|
301
|
+
id: string;
|
|
302
|
+
|
|
303
|
+
/**
|
|
304
|
+
* The name of the association
|
|
305
|
+
*/
|
|
306
|
+
name: string;
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
export interface LoyaltyBadgeUser {
|
|
312
|
+
/**
|
|
313
|
+
* UUID of the user badge (converted to lowercase)
|
|
314
|
+
*/
|
|
315
|
+
id: string;
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* The date and time the user badge was created
|
|
319
|
+
*/
|
|
320
|
+
createdAt: string;
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* UUID of the badge (converted to lowercase)
|
|
324
|
+
*/
|
|
325
|
+
loyaltyBadgeId: string;
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* UUID of the organization (converted to lowercase)
|
|
329
|
+
*/
|
|
330
|
+
organizationId: string;
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* The status of the badge
|
|
334
|
+
*/
|
|
335
|
+
status: 'active' | 'inactive' | 'revoked';
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* The date and time the user badge was updated
|
|
339
|
+
*/
|
|
340
|
+
updatedAt: string;
|
|
341
|
+
|
|
342
|
+
/**
|
|
343
|
+
* UUID of the user (converted to lowercase)
|
|
344
|
+
*/
|
|
345
|
+
userId: string;
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* UUID of the website (converted to lowercase)
|
|
349
|
+
*/
|
|
350
|
+
websiteId: string;
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* Array of progress for the badge
|
|
354
|
+
*/
|
|
355
|
+
progress?: unknown;
|
|
356
|
+
|
|
357
|
+
/**
|
|
358
|
+
* User associated with the user badge
|
|
359
|
+
*/
|
|
360
|
+
user?: LoyaltyBadgeUser.User;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
export namespace LoyaltyBadgeUser {
|
|
364
|
+
/**
|
|
365
|
+
* User associated with the user badge
|
|
366
|
+
*/
|
|
367
|
+
export interface User {
|
|
368
|
+
/**
|
|
369
|
+
* UUID of the user (converted to lowercase)
|
|
370
|
+
*/
|
|
371
|
+
id: string;
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* Wallet address of the user
|
|
375
|
+
*/
|
|
376
|
+
walletAddress: string;
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
export interface LoyaltyRule {
|
|
381
|
+
/**
|
|
382
|
+
* UUID of the loyalty rule (converted to lowercase)
|
|
383
|
+
*/
|
|
384
|
+
id: string;
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* The name of the loyalty rule
|
|
388
|
+
*/
|
|
389
|
+
name: string;
|
|
390
|
+
}
|
|
103
391
|
}
|
|
104
392
|
|
|
105
393
|
/**
|
|
106
394
|
* Response returned upon successful update of the badge.
|
|
107
395
|
*/
|
|
108
396
|
export interface BadgeUpdateResponse {
|
|
397
|
+
/**
|
|
398
|
+
* UUID of the badge (converted to lowercase)
|
|
399
|
+
*/
|
|
109
400
|
id: string;
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* The description of the badge
|
|
404
|
+
*/
|
|
405
|
+
description: string | null;
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* The URL of the badge image
|
|
409
|
+
*/
|
|
410
|
+
imageUrl: string | null;
|
|
411
|
+
|
|
412
|
+
/**
|
|
413
|
+
* Array of conditions of the badge
|
|
414
|
+
*/
|
|
415
|
+
loyaltyConditions: Array<BadgeUpdateResponse.LoyaltyCondition>;
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* The name of the badge
|
|
419
|
+
*/
|
|
420
|
+
name: string;
|
|
421
|
+
|
|
422
|
+
/**
|
|
423
|
+
* Array of user badges
|
|
424
|
+
*/
|
|
425
|
+
loyaltyBadgeUsers?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
|
|
426
|
+
|
|
427
|
+
/**
|
|
428
|
+
* Array of loyalty rules associated with the badge
|
|
429
|
+
*/
|
|
430
|
+
loyaltyRules?: Array<BadgeUpdateResponse.LoyaltyRule>;
|
|
110
431
|
}
|
|
111
432
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
433
|
+
export namespace BadgeUpdateResponse {
|
|
434
|
+
/**
|
|
435
|
+
* Schema for a loyalty condition rule.
|
|
436
|
+
*/
|
|
437
|
+
export interface LoyaltyCondition {
|
|
438
|
+
/**
|
|
439
|
+
* UUID of the condition (converted to lowercase)
|
|
440
|
+
*/
|
|
441
|
+
id: string;
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
* The amount of the condition
|
|
445
|
+
*/
|
|
446
|
+
amount: number | null;
|
|
447
|
+
|
|
448
|
+
association: Array<LoyaltyCondition.Association>;
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
* The URL of the CSV file
|
|
452
|
+
*/
|
|
453
|
+
csvUrl: string | null;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* The description of the condition
|
|
457
|
+
*/
|
|
458
|
+
description: string | null;
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* UUID of the currency (converted to lowercase)
|
|
462
|
+
*/
|
|
463
|
+
loyaltyCurrencyId: string | null;
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* UUID of the rule group (converted to lowercase)
|
|
467
|
+
*/
|
|
468
|
+
loyaltyRuleGroupId: string | null;
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* The repeat count of the condition
|
|
472
|
+
*/
|
|
473
|
+
repeatCount: number | null;
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* The required count of the condition
|
|
477
|
+
*/
|
|
478
|
+
requiredCount: number | null;
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* The type of the condition
|
|
482
|
+
*/
|
|
483
|
+
type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
export namespace LoyaltyCondition {
|
|
487
|
+
export interface Association {
|
|
488
|
+
loyaltyBadge: Association.LoyaltyBadge | null;
|
|
489
|
+
|
|
490
|
+
loyaltyCurrency: Association.LoyaltyCurrency | null;
|
|
491
|
+
|
|
492
|
+
loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
|
|
493
|
+
|
|
494
|
+
loyaltyRule: Association.LoyaltyRule | null;
|
|
495
|
+
|
|
496
|
+
loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
export namespace Association {
|
|
500
|
+
export interface LoyaltyBadge {
|
|
501
|
+
/**
|
|
502
|
+
* UUID of the association (converted to lowercase)
|
|
503
|
+
*/
|
|
504
|
+
id: string;
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* The name of the association
|
|
508
|
+
*/
|
|
509
|
+
name: string;
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
export interface LoyaltyCurrency {
|
|
513
|
+
/**
|
|
514
|
+
* UUID of the association (converted to lowercase)
|
|
515
|
+
*/
|
|
516
|
+
id: string;
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* The name of the association
|
|
520
|
+
*/
|
|
521
|
+
name: string;
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
export interface LoyaltyLeaderboardView {
|
|
525
|
+
/**
|
|
526
|
+
* UUID of the association (converted to lowercase)
|
|
527
|
+
*/
|
|
528
|
+
id: string;
|
|
529
|
+
|
|
530
|
+
/**
|
|
531
|
+
* The name of the association
|
|
532
|
+
*/
|
|
533
|
+
name: string;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
export interface LoyaltyRule {
|
|
537
|
+
/**
|
|
538
|
+
* UUID of the association (converted to lowercase)
|
|
539
|
+
*/
|
|
540
|
+
id: string;
|
|
541
|
+
|
|
542
|
+
/**
|
|
543
|
+
* The name of the association
|
|
544
|
+
*/
|
|
545
|
+
name: string;
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
export interface LoyaltyRuleGroup {
|
|
549
|
+
/**
|
|
550
|
+
* UUID of the association (converted to lowercase)
|
|
551
|
+
*/
|
|
552
|
+
id: string;
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* The name of the association
|
|
556
|
+
*/
|
|
557
|
+
name: string;
|
|
558
|
+
}
|
|
559
|
+
}
|
|
560
|
+
}
|
|
561
|
+
|
|
562
|
+
export interface LoyaltyBadgeUser {
|
|
563
|
+
/**
|
|
564
|
+
* UUID of the user badge (converted to lowercase)
|
|
565
|
+
*/
|
|
566
|
+
id: string;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* The date and time the user badge was created
|
|
570
|
+
*/
|
|
571
|
+
createdAt: string;
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* UUID of the badge (converted to lowercase)
|
|
575
|
+
*/
|
|
576
|
+
loyaltyBadgeId: string;
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* UUID of the organization (converted to lowercase)
|
|
580
|
+
*/
|
|
581
|
+
organizationId: string;
|
|
582
|
+
|
|
583
|
+
/**
|
|
584
|
+
* The status of the badge
|
|
585
|
+
*/
|
|
586
|
+
status: 'active' | 'inactive' | 'revoked';
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* The date and time the user badge was updated
|
|
590
|
+
*/
|
|
591
|
+
updatedAt: string;
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* UUID of the user (converted to lowercase)
|
|
595
|
+
*/
|
|
596
|
+
userId: string;
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* UUID of the website (converted to lowercase)
|
|
600
|
+
*/
|
|
601
|
+
websiteId: string;
|
|
602
|
+
|
|
603
|
+
/**
|
|
604
|
+
* Array of progress for the badge
|
|
605
|
+
*/
|
|
606
|
+
progress?: unknown;
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* User associated with the user badge
|
|
610
|
+
*/
|
|
611
|
+
user?: LoyaltyBadgeUser.User;
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
export namespace LoyaltyBadgeUser {
|
|
615
|
+
/**
|
|
616
|
+
* User associated with the user badge
|
|
617
|
+
*/
|
|
618
|
+
export interface User {
|
|
619
|
+
/**
|
|
620
|
+
* UUID of the user (converted to lowercase)
|
|
621
|
+
*/
|
|
622
|
+
id: string;
|
|
623
|
+
|
|
624
|
+
/**
|
|
625
|
+
* Wallet address of the user
|
|
626
|
+
*/
|
|
627
|
+
walletAddress: string;
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
|
|
631
|
+
export interface LoyaltyRule {
|
|
632
|
+
/**
|
|
633
|
+
* UUID of the loyalty rule (converted to lowercase)
|
|
634
|
+
*/
|
|
635
|
+
id: string;
|
|
636
|
+
|
|
637
|
+
/**
|
|
638
|
+
* The name of the loyalty rule
|
|
639
|
+
*/
|
|
640
|
+
name: string;
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* Response returned upon successful fetching of the badges.
|
|
646
|
+
*/
|
|
647
|
+
export interface BadgeListResponse {
|
|
648
|
+
/**
|
|
649
|
+
* UUID of the badge (converted to lowercase)
|
|
650
|
+
*/
|
|
651
|
+
id: string;
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
* The description of the badge
|
|
655
|
+
*/
|
|
656
|
+
description: string | null;
|
|
657
|
+
|
|
658
|
+
/**
|
|
659
|
+
* The URL of the badge image
|
|
660
|
+
*/
|
|
661
|
+
imageUrl: string | null;
|
|
662
|
+
|
|
663
|
+
/**
|
|
664
|
+
* Array of conditions of the badge
|
|
665
|
+
*/
|
|
666
|
+
loyaltyConditions: Array<BadgeListResponse.LoyaltyCondition>;
|
|
667
|
+
|
|
668
|
+
/**
|
|
669
|
+
* The name of the badge
|
|
670
|
+
*/
|
|
671
|
+
name: string;
|
|
672
|
+
|
|
673
|
+
/**
|
|
674
|
+
* Array of user badges
|
|
675
|
+
*/
|
|
676
|
+
loyaltyBadgeUsers?: Array<BadgeListResponse.LoyaltyBadgeUser>;
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* Array of loyalty rules associated with the badge
|
|
680
|
+
*/
|
|
681
|
+
loyaltyRules?: Array<BadgeListResponse.LoyaltyRule>;
|
|
117
682
|
}
|
|
118
683
|
|
|
119
684
|
export namespace BadgeListResponse {
|
|
120
|
-
|
|
685
|
+
/**
|
|
686
|
+
* Schema for a loyalty condition rule.
|
|
687
|
+
*/
|
|
688
|
+
export interface LoyaltyCondition {
|
|
121
689
|
/**
|
|
122
|
-
* UUID of the
|
|
690
|
+
* UUID of the condition (converted to lowercase)
|
|
123
691
|
*/
|
|
124
692
|
id: string;
|
|
125
693
|
|
|
126
694
|
/**
|
|
127
|
-
*
|
|
695
|
+
* The amount of the condition
|
|
128
696
|
*/
|
|
129
|
-
|
|
697
|
+
amount: number | null;
|
|
698
|
+
|
|
699
|
+
association: Array<LoyaltyCondition.Association>;
|
|
130
700
|
|
|
131
701
|
/**
|
|
132
|
-
* The URL of the
|
|
702
|
+
* The URL of the CSV file
|
|
133
703
|
*/
|
|
134
|
-
|
|
704
|
+
csvUrl: string | null;
|
|
135
705
|
|
|
136
706
|
/**
|
|
137
|
-
*
|
|
707
|
+
* The description of the condition
|
|
138
708
|
*/
|
|
139
|
-
|
|
709
|
+
description: string | null;
|
|
140
710
|
|
|
141
711
|
/**
|
|
142
|
-
*
|
|
712
|
+
* UUID of the currency (converted to lowercase)
|
|
143
713
|
*/
|
|
144
|
-
|
|
714
|
+
loyaltyCurrencyId: string | null;
|
|
145
715
|
|
|
146
716
|
/**
|
|
147
|
-
*
|
|
717
|
+
* UUID of the rule group (converted to lowercase)
|
|
148
718
|
*/
|
|
149
|
-
|
|
150
|
-
}
|
|
719
|
+
loyaltyRuleGroupId: string | null;
|
|
151
720
|
|
|
152
|
-
export namespace Badge {
|
|
153
721
|
/**
|
|
154
|
-
*
|
|
722
|
+
* The repeat count of the condition
|
|
155
723
|
*/
|
|
156
|
-
|
|
157
|
-
/**
|
|
158
|
-
* The number of accounts with the badge
|
|
159
|
-
*/
|
|
160
|
-
LoyaltyBadgeUser: number;
|
|
724
|
+
repeatCount: number | null;
|
|
161
725
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
726
|
+
/**
|
|
727
|
+
* The required count of the condition
|
|
728
|
+
*/
|
|
729
|
+
requiredCount: number | null;
|
|
730
|
+
|
|
731
|
+
/**
|
|
732
|
+
* The type of the condition
|
|
733
|
+
*/
|
|
734
|
+
type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
export namespace LoyaltyCondition {
|
|
738
|
+
export interface Association {
|
|
739
|
+
loyaltyBadge: Association.LoyaltyBadge | null;
|
|
740
|
+
|
|
741
|
+
loyaltyCurrency: Association.LoyaltyCurrency | null;
|
|
742
|
+
|
|
743
|
+
loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
|
|
744
|
+
|
|
745
|
+
loyaltyRule: Association.LoyaltyRule | null;
|
|
746
|
+
|
|
747
|
+
loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
|
|
166
748
|
}
|
|
167
749
|
|
|
168
|
-
export
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
750
|
+
export namespace Association {
|
|
751
|
+
export interface LoyaltyBadge {
|
|
752
|
+
/**
|
|
753
|
+
* UUID of the association (converted to lowercase)
|
|
754
|
+
*/
|
|
755
|
+
id: string;
|
|
756
|
+
|
|
757
|
+
/**
|
|
758
|
+
* The name of the association
|
|
759
|
+
*/
|
|
760
|
+
name: string;
|
|
761
|
+
}
|
|
762
|
+
|
|
763
|
+
export interface LoyaltyCurrency {
|
|
764
|
+
/**
|
|
765
|
+
* UUID of the association (converted to lowercase)
|
|
766
|
+
*/
|
|
767
|
+
id: string;
|
|
768
|
+
|
|
769
|
+
/**
|
|
770
|
+
* The name of the association
|
|
771
|
+
*/
|
|
772
|
+
name: string;
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
export interface LoyaltyLeaderboardView {
|
|
776
|
+
/**
|
|
777
|
+
* UUID of the association (converted to lowercase)
|
|
778
|
+
*/
|
|
779
|
+
id: string;
|
|
780
|
+
|
|
781
|
+
/**
|
|
782
|
+
* The name of the association
|
|
783
|
+
*/
|
|
784
|
+
name: string;
|
|
785
|
+
}
|
|
786
|
+
|
|
787
|
+
export interface LoyaltyRule {
|
|
788
|
+
/**
|
|
789
|
+
* UUID of the association (converted to lowercase)
|
|
790
|
+
*/
|
|
791
|
+
id: string;
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* The name of the association
|
|
795
|
+
*/
|
|
796
|
+
name: string;
|
|
797
|
+
}
|
|
798
|
+
|
|
799
|
+
export interface LoyaltyRuleGroup {
|
|
800
|
+
/**
|
|
801
|
+
* UUID of the association (converted to lowercase)
|
|
802
|
+
*/
|
|
803
|
+
id: string;
|
|
804
|
+
|
|
805
|
+
/**
|
|
806
|
+
* The name of the association
|
|
807
|
+
*/
|
|
808
|
+
name: string;
|
|
809
|
+
}
|
|
810
|
+
}
|
|
811
|
+
}
|
|
173
812
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
813
|
+
export interface LoyaltyBadgeUser {
|
|
814
|
+
/**
|
|
815
|
+
* UUID of the user badge (converted to lowercase)
|
|
816
|
+
*/
|
|
817
|
+
id: string;
|
|
178
818
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
819
|
+
/**
|
|
820
|
+
* The date and time the user badge was created
|
|
821
|
+
*/
|
|
822
|
+
createdAt: string;
|
|
183
823
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
824
|
+
/**
|
|
825
|
+
* UUID of the badge (converted to lowercase)
|
|
826
|
+
*/
|
|
827
|
+
loyaltyBadgeId: string;
|
|
188
828
|
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
829
|
+
/**
|
|
830
|
+
* UUID of the organization (converted to lowercase)
|
|
831
|
+
*/
|
|
832
|
+
organizationId: string;
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* The status of the badge
|
|
836
|
+
*/
|
|
837
|
+
status: 'active' | 'inactive' | 'revoked';
|
|
838
|
+
|
|
839
|
+
/**
|
|
840
|
+
* The date and time the user badge was updated
|
|
841
|
+
*/
|
|
842
|
+
updatedAt: string;
|
|
843
|
+
|
|
844
|
+
/**
|
|
845
|
+
* UUID of the user (converted to lowercase)
|
|
846
|
+
*/
|
|
847
|
+
userId: string;
|
|
848
|
+
|
|
849
|
+
/**
|
|
850
|
+
* UUID of the website (converted to lowercase)
|
|
851
|
+
*/
|
|
852
|
+
websiteId: string;
|
|
193
853
|
|
|
854
|
+
/**
|
|
855
|
+
* Array of progress for the badge
|
|
856
|
+
*/
|
|
857
|
+
progress?: unknown;
|
|
858
|
+
|
|
859
|
+
/**
|
|
860
|
+
* User associated with the user badge
|
|
861
|
+
*/
|
|
862
|
+
user?: LoyaltyBadgeUser.User;
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
export namespace LoyaltyBadgeUser {
|
|
866
|
+
/**
|
|
867
|
+
* User associated with the user badge
|
|
868
|
+
*/
|
|
869
|
+
export interface User {
|
|
194
870
|
/**
|
|
195
|
-
* UUID of the
|
|
871
|
+
* UUID of the user (converted to lowercase)
|
|
196
872
|
*/
|
|
197
|
-
|
|
873
|
+
id: string;
|
|
198
874
|
|
|
199
875
|
/**
|
|
200
|
-
*
|
|
876
|
+
* Wallet address of the user
|
|
201
877
|
*/
|
|
202
|
-
|
|
878
|
+
walletAddress: string;
|
|
203
879
|
}
|
|
204
880
|
}
|
|
881
|
+
|
|
882
|
+
export interface LoyaltyRule {
|
|
883
|
+
/**
|
|
884
|
+
* UUID of the loyalty rule (converted to lowercase)
|
|
885
|
+
*/
|
|
886
|
+
id: string;
|
|
887
|
+
|
|
888
|
+
/**
|
|
889
|
+
* The name of the loyalty rule
|
|
890
|
+
*/
|
|
891
|
+
name: string;
|
|
892
|
+
}
|
|
205
893
|
}
|
|
206
894
|
|
|
207
895
|
/**
|
|
208
896
|
* Response returned upon successful deletion of the badge.
|
|
209
897
|
*/
|
|
210
898
|
export interface BadgeDeleteResponse {
|
|
899
|
+
/**
|
|
900
|
+
* UUID of the badge (converted to lowercase)
|
|
901
|
+
*/
|
|
211
902
|
id: string;
|
|
212
903
|
|
|
213
|
-
|
|
904
|
+
/**
|
|
905
|
+
* The description of the badge
|
|
906
|
+
*/
|
|
907
|
+
description: string | null;
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* The URL of the badge image
|
|
911
|
+
*/
|
|
912
|
+
imageUrl: string | null;
|
|
913
|
+
|
|
914
|
+
/**
|
|
915
|
+
* Array of conditions of the badge
|
|
916
|
+
*/
|
|
917
|
+
loyaltyConditions: Array<BadgeDeleteResponse.LoyaltyCondition>;
|
|
918
|
+
|
|
919
|
+
/**
|
|
920
|
+
* The name of the badge
|
|
921
|
+
*/
|
|
922
|
+
name: string;
|
|
923
|
+
|
|
924
|
+
/**
|
|
925
|
+
* Array of user badges
|
|
926
|
+
*/
|
|
927
|
+
loyaltyBadgeUsers?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* Array of loyalty rules associated with the badge
|
|
931
|
+
*/
|
|
932
|
+
loyaltyRules?: Array<BadgeDeleteResponse.LoyaltyRule>;
|
|
933
|
+
}
|
|
934
|
+
|
|
935
|
+
export namespace BadgeDeleteResponse {
|
|
936
|
+
/**
|
|
937
|
+
* Schema for a loyalty condition rule.
|
|
938
|
+
*/
|
|
939
|
+
export interface LoyaltyCondition {
|
|
940
|
+
/**
|
|
941
|
+
* UUID of the condition (converted to lowercase)
|
|
942
|
+
*/
|
|
943
|
+
id: string;
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* The amount of the condition
|
|
947
|
+
*/
|
|
948
|
+
amount: number | null;
|
|
949
|
+
|
|
950
|
+
association: Array<LoyaltyCondition.Association>;
|
|
951
|
+
|
|
952
|
+
/**
|
|
953
|
+
* The URL of the CSV file
|
|
954
|
+
*/
|
|
955
|
+
csvUrl: string | null;
|
|
956
|
+
|
|
957
|
+
/**
|
|
958
|
+
* The description of the condition
|
|
959
|
+
*/
|
|
960
|
+
description: string | null;
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* UUID of the currency (converted to lowercase)
|
|
964
|
+
*/
|
|
965
|
+
loyaltyCurrencyId: string | null;
|
|
966
|
+
|
|
967
|
+
/**
|
|
968
|
+
* UUID of the rule group (converted to lowercase)
|
|
969
|
+
*/
|
|
970
|
+
loyaltyRuleGroupId: string | null;
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* The repeat count of the condition
|
|
974
|
+
*/
|
|
975
|
+
repeatCount: number | null;
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* The required count of the condition
|
|
979
|
+
*/
|
|
980
|
+
requiredCount: number | null;
|
|
981
|
+
|
|
982
|
+
/**
|
|
983
|
+
* The type of the condition
|
|
984
|
+
*/
|
|
985
|
+
type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
export namespace LoyaltyCondition {
|
|
989
|
+
export interface Association {
|
|
990
|
+
loyaltyBadge: Association.LoyaltyBadge | null;
|
|
991
|
+
|
|
992
|
+
loyaltyCurrency: Association.LoyaltyCurrency | null;
|
|
993
|
+
|
|
994
|
+
loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
|
|
995
|
+
|
|
996
|
+
loyaltyRule: Association.LoyaltyRule | null;
|
|
997
|
+
|
|
998
|
+
loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
|
|
999
|
+
}
|
|
1000
|
+
|
|
1001
|
+
export namespace Association {
|
|
1002
|
+
export interface LoyaltyBadge {
|
|
1003
|
+
/**
|
|
1004
|
+
* UUID of the association (converted to lowercase)
|
|
1005
|
+
*/
|
|
1006
|
+
id: string;
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* The name of the association
|
|
1010
|
+
*/
|
|
1011
|
+
name: string;
|
|
1012
|
+
}
|
|
1013
|
+
|
|
1014
|
+
export interface LoyaltyCurrency {
|
|
1015
|
+
/**
|
|
1016
|
+
* UUID of the association (converted to lowercase)
|
|
1017
|
+
*/
|
|
1018
|
+
id: string;
|
|
1019
|
+
|
|
1020
|
+
/**
|
|
1021
|
+
* The name of the association
|
|
1022
|
+
*/
|
|
1023
|
+
name: string;
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
export interface LoyaltyLeaderboardView {
|
|
1027
|
+
/**
|
|
1028
|
+
* UUID of the association (converted to lowercase)
|
|
1029
|
+
*/
|
|
1030
|
+
id: string;
|
|
1031
|
+
|
|
1032
|
+
/**
|
|
1033
|
+
* The name of the association
|
|
1034
|
+
*/
|
|
1035
|
+
name: string;
|
|
1036
|
+
}
|
|
1037
|
+
|
|
1038
|
+
export interface LoyaltyRule {
|
|
1039
|
+
/**
|
|
1040
|
+
* UUID of the association (converted to lowercase)
|
|
1041
|
+
*/
|
|
1042
|
+
id: string;
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* The name of the association
|
|
1046
|
+
*/
|
|
1047
|
+
name: string;
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1050
|
+
export interface LoyaltyRuleGroup {
|
|
1051
|
+
/**
|
|
1052
|
+
* UUID of the association (converted to lowercase)
|
|
1053
|
+
*/
|
|
1054
|
+
id: string;
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* The name of the association
|
|
1058
|
+
*/
|
|
1059
|
+
name: string;
|
|
1060
|
+
}
|
|
1061
|
+
}
|
|
1062
|
+
}
|
|
1063
|
+
|
|
1064
|
+
export interface LoyaltyBadgeUser {
|
|
1065
|
+
/**
|
|
1066
|
+
* UUID of the user badge (converted to lowercase)
|
|
1067
|
+
*/
|
|
1068
|
+
id: string;
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* The date and time the user badge was created
|
|
1072
|
+
*/
|
|
1073
|
+
createdAt: string;
|
|
1074
|
+
|
|
1075
|
+
/**
|
|
1076
|
+
* UUID of the badge (converted to lowercase)
|
|
1077
|
+
*/
|
|
1078
|
+
loyaltyBadgeId: string;
|
|
1079
|
+
|
|
1080
|
+
/**
|
|
1081
|
+
* UUID of the organization (converted to lowercase)
|
|
1082
|
+
*/
|
|
1083
|
+
organizationId: string;
|
|
1084
|
+
|
|
1085
|
+
/**
|
|
1086
|
+
* The status of the badge
|
|
1087
|
+
*/
|
|
1088
|
+
status: 'active' | 'inactive' | 'revoked';
|
|
1089
|
+
|
|
1090
|
+
/**
|
|
1091
|
+
* The date and time the user badge was updated
|
|
1092
|
+
*/
|
|
1093
|
+
updatedAt: string;
|
|
1094
|
+
|
|
1095
|
+
/**
|
|
1096
|
+
* UUID of the user (converted to lowercase)
|
|
1097
|
+
*/
|
|
1098
|
+
userId: string;
|
|
1099
|
+
|
|
1100
|
+
/**
|
|
1101
|
+
* UUID of the website (converted to lowercase)
|
|
1102
|
+
*/
|
|
1103
|
+
websiteId: string;
|
|
1104
|
+
|
|
1105
|
+
/**
|
|
1106
|
+
* Array of progress for the badge
|
|
1107
|
+
*/
|
|
1108
|
+
progress?: unknown;
|
|
1109
|
+
|
|
1110
|
+
/**
|
|
1111
|
+
* User associated with the user badge
|
|
1112
|
+
*/
|
|
1113
|
+
user?: LoyaltyBadgeUser.User;
|
|
1114
|
+
}
|
|
1115
|
+
|
|
1116
|
+
export namespace LoyaltyBadgeUser {
|
|
1117
|
+
/**
|
|
1118
|
+
* User associated with the user badge
|
|
1119
|
+
*/
|
|
1120
|
+
export interface User {
|
|
1121
|
+
/**
|
|
1122
|
+
* UUID of the user (converted to lowercase)
|
|
1123
|
+
*/
|
|
1124
|
+
id: string;
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* Wallet address of the user
|
|
1128
|
+
*/
|
|
1129
|
+
walletAddress: string;
|
|
1130
|
+
}
|
|
1131
|
+
}
|
|
1132
|
+
|
|
1133
|
+
export interface LoyaltyRule {
|
|
1134
|
+
/**
|
|
1135
|
+
* UUID of the loyalty rule (converted to lowercase)
|
|
1136
|
+
*/
|
|
1137
|
+
id: string;
|
|
1138
|
+
|
|
1139
|
+
/**
|
|
1140
|
+
* The name of the loyalty rule
|
|
1141
|
+
*/
|
|
1142
|
+
name: string;
|
|
1143
|
+
}
|
|
214
1144
|
}
|
|
215
1145
|
|
|
216
1146
|
/**
|
|
@@ -262,6 +1192,11 @@ export namespace BadgeRewardResponse {
|
|
|
262
1192
|
}
|
|
263
1193
|
|
|
264
1194
|
export interface BadgeCreateParams {
|
|
1195
|
+
/**
|
|
1196
|
+
* Array of conditions for the badge
|
|
1197
|
+
*/
|
|
1198
|
+
conditions: Array<BadgeCreateParams.Condition>;
|
|
1199
|
+
|
|
265
1200
|
/**
|
|
266
1201
|
* The URL of the badge image
|
|
267
1202
|
*/
|
|
@@ -277,11 +1212,6 @@ export interface BadgeCreateParams {
|
|
|
277
1212
|
*/
|
|
278
1213
|
organizationId: string;
|
|
279
1214
|
|
|
280
|
-
/**
|
|
281
|
-
* Array of rules for the badge
|
|
282
|
-
*/
|
|
283
|
-
rules: Array<BadgeCreateParams.Rule>;
|
|
284
|
-
|
|
285
1215
|
/**
|
|
286
1216
|
* UUID of the website (optional, converted to lowercase)
|
|
287
1217
|
*/
|
|
@@ -294,49 +1224,66 @@ export interface BadgeCreateParams {
|
|
|
294
1224
|
}
|
|
295
1225
|
|
|
296
1226
|
export namespace BadgeCreateParams {
|
|
297
|
-
|
|
298
|
-
* Schema for a loyalty condition rule.
|
|
299
|
-
*/
|
|
300
|
-
export interface Rule {
|
|
1227
|
+
export interface Condition {
|
|
301
1228
|
/**
|
|
302
|
-
* The
|
|
1229
|
+
* The amount of the rule
|
|
303
1230
|
*/
|
|
304
|
-
|
|
1231
|
+
amount?: number | null;
|
|
305
1232
|
|
|
306
1233
|
/**
|
|
307
|
-
*
|
|
1234
|
+
* URL of the CSV file (optional)
|
|
308
1235
|
*/
|
|
309
|
-
|
|
1236
|
+
csvUrl?: string | null;
|
|
310
1237
|
|
|
311
1238
|
/**
|
|
312
1239
|
* The description of the rule
|
|
313
1240
|
*/
|
|
314
|
-
description?: string;
|
|
1241
|
+
description?: string | null;
|
|
1242
|
+
|
|
1243
|
+
/**
|
|
1244
|
+
* Array of UUIDs of the badge (optional, converted to lowercase)
|
|
1245
|
+
*/
|
|
1246
|
+
loyaltyBadgeIds?: Array<string>;
|
|
1247
|
+
|
|
1248
|
+
/**
|
|
1249
|
+
* Array of UUIDs of the currency (optional, converted to lowercase)
|
|
1250
|
+
*/
|
|
1251
|
+
loyaltyCurrencyIds?: Array<string>;
|
|
1252
|
+
|
|
1253
|
+
/**
|
|
1254
|
+
* Array of UUIDs of the Loyalty Leaderboard (optional, converted to lowercase)
|
|
1255
|
+
*/
|
|
1256
|
+
loyaltyLeaderboardViewIds?: Array<string>;
|
|
315
1257
|
|
|
316
1258
|
/**
|
|
317
|
-
* UUID of the
|
|
1259
|
+
* UUID of the loyalty rule chain (optional, converted to lowercase)
|
|
318
1260
|
*/
|
|
319
|
-
|
|
1261
|
+
loyaltyRuleChainId?: string;
|
|
320
1262
|
|
|
321
1263
|
/**
|
|
322
|
-
*
|
|
1264
|
+
* Array of UUIDs of the rule group (optional, converted to lowercase)
|
|
323
1265
|
*/
|
|
324
|
-
|
|
1266
|
+
loyaltyRuleGroupIds?: Array<string>;
|
|
325
1267
|
|
|
326
1268
|
/**
|
|
327
|
-
*
|
|
1269
|
+
* Array of UUIDs of the rules (optional, converted to lowercase)
|
|
328
1270
|
*/
|
|
329
|
-
|
|
1271
|
+
loyaltyRuleIds?: Array<string>;
|
|
330
1272
|
|
|
331
1273
|
/**
|
|
332
|
-
*
|
|
1274
|
+
* The number of times the rule should be repeated to fulfill the condition
|
|
333
1275
|
*/
|
|
334
|
-
|
|
1276
|
+
repeatCount?: number | null;
|
|
335
1277
|
|
|
336
1278
|
/**
|
|
337
|
-
*
|
|
1279
|
+
* The number of rules that need to be fulfilled to satisfy the condition
|
|
1280
|
+
*/
|
|
1281
|
+
requiredCount?: number | null;
|
|
1282
|
+
|
|
1283
|
+
/**
|
|
1284
|
+
* The type of rule
|
|
338
1285
|
*/
|
|
339
|
-
|
|
1286
|
+
type?: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
|
|
340
1287
|
}
|
|
341
1288
|
}
|
|
342
1289
|
|
|
@@ -371,7 +1318,7 @@ export interface BadgeListParams {
|
|
|
371
1318
|
/**
|
|
372
1319
|
* Number of badges to fetch
|
|
373
1320
|
*/
|
|
374
|
-
limit?: number
|
|
1321
|
+
limit?: number;
|
|
375
1322
|
|
|
376
1323
|
/**
|
|
377
1324
|
* UUID of the organization (optional, converted to lowercase)
|
|
@@ -384,9 +1331,24 @@ export interface BadgeListParams {
|
|
|
384
1331
|
startingAfter?: string;
|
|
385
1332
|
|
|
386
1333
|
/**
|
|
387
|
-
*
|
|
1334
|
+
* External identifier of the user group
|
|
388
1335
|
*/
|
|
389
|
-
|
|
1336
|
+
userGroupExternalIdentifier?: string;
|
|
1337
|
+
|
|
1338
|
+
/**
|
|
1339
|
+
* UUID of the user group
|
|
1340
|
+
*/
|
|
1341
|
+
userGroupId?: string;
|
|
1342
|
+
|
|
1343
|
+
/**
|
|
1344
|
+
* UUID of the user, or array of UUID.
|
|
1345
|
+
*/
|
|
1346
|
+
userId?: string | Array<string>;
|
|
1347
|
+
|
|
1348
|
+
/**
|
|
1349
|
+
* Wallet Address of the user, or array of wallet addresses.
|
|
1350
|
+
*/
|
|
1351
|
+
walletAddress?: string | Array<string>;
|
|
390
1352
|
|
|
391
1353
|
/**
|
|
392
1354
|
* UUID of the website (optional, converted to lowercase)
|
|
@@ -395,6 +1357,11 @@ export interface BadgeListParams {
|
|
|
395
1357
|
}
|
|
396
1358
|
|
|
397
1359
|
export interface BadgeRevokeParams {
|
|
1360
|
+
/**
|
|
1361
|
+
* Status of the badge
|
|
1362
|
+
*/
|
|
1363
|
+
status?: 'active' | 'inactive' | 'revoked';
|
|
1364
|
+
|
|
398
1365
|
/**
|
|
399
1366
|
* UUID of the user (converted to lowercase)
|
|
400
1367
|
*/
|
|
@@ -407,6 +1374,11 @@ export interface BadgeRevokeParams {
|
|
|
407
1374
|
}
|
|
408
1375
|
|
|
409
1376
|
export interface BadgeRewardParams {
|
|
1377
|
+
/**
|
|
1378
|
+
* Status of the badge
|
|
1379
|
+
*/
|
|
1380
|
+
status?: 'active' | 'inactive' | 'revoked';
|
|
1381
|
+
|
|
410
1382
|
/**
|
|
411
1383
|
* UUID of the user (converted to lowercase)
|
|
412
1384
|
*/
|