@snagsolutions/sdk 0.1.0-alpha.15 → 0.1.0-alpha.150
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 +1243 -45
- package/README.md +17 -29
- 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 +26 -17
- package/core.js.map +1 -1
- package/core.mjs +27 -18
- package/core.mjs.map +1 -1
- package/index.d.mts +30 -6
- package/index.d.ts +30 -6
- package/index.d.ts.map +1 -1
- package/index.js +36 -11
- package/index.js.map +1 -1
- package/index.mjs +36 -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 +64 -0
- package/resources/assets.d.ts.map +1 -0
- package/resources/assets.js +25 -0
- package/resources/assets.js.map +1 -0
- package/resources/assets.mjs +21 -0
- package/resources/assets.mjs.map +1 -0
- 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/{api.js → auctions.js} +2 -2
- package/resources/auctions.js.map +1 -0
- package/resources/{api.mjs → auctions.mjs} +2 -2
- package/resources/auctions.mjs.map +1 -0
- package/resources/auth.d.ts +48 -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 +8 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +17 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +8 -1
- 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/{api/loyalty → loyalty}/accounts.d.ts +36 -27
- package/resources/loyalty/accounts.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/accounts.js +17 -4
- package/resources/loyalty/accounts.js.map +1 -0
- package/resources/loyalty/accounts.mjs +33 -0
- package/resources/loyalty/accounts.mjs.map +1 -0
- package/resources/{api/loyalty → loyalty}/badges.d.ts +474 -24
- package/resources/loyalty/badges.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/badges.js +21 -3
- package/resources/loyalty/badges.js.map +1 -0
- package/resources/{api/loyalty → loyalty}/badges.mjs +21 -3
- package/resources/loyalty/badges.mjs.map +1 -0
- package/resources/{api/loyalty → loyalty}/currencies.d.ts +27 -2
- package/resources/loyalty/currencies.d.ts.map +1 -0
- package/resources/loyalty/currencies.js +40 -0
- package/resources/loyalty/currencies.js.map +1 -0
- package/resources/loyalty/currencies.mjs +36 -0
- package/resources/loyalty/currencies.mjs.map +1 -0
- package/resources/{api/loyalty → loyalty}/index.d.ts +6 -3
- package/resources/loyalty/index.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/index.js +7 -1
- package/resources/loyalty/index.js.map +1 -0
- package/resources/{api/loyalty → loyalty}/index.mjs +4 -1
- package/resources/loyalty/index.mjs.map +1 -0
- package/resources/loyalty/loyalty.d.ts +50 -0
- package/resources/loyalty/loyalty.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/loyalty.js +13 -20
- package/resources/loyalty/loyalty.js.map +1 -0
- package/resources/{api/loyalty → loyalty}/loyalty.mjs +13 -20
- package/resources/loyalty/loyalty.mjs.map +1 -0
- package/resources/{api/loyalty → loyalty}/multipliers.d.ts +65 -4
- package/resources/loyalty/multipliers.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/multipliers.js +25 -2
- package/resources/loyalty/multipliers.js.map +1 -0
- package/resources/{api/loyalty → loyalty}/multipliers.mjs +25 -2
- package/resources/loyalty/multipliers.mjs.map +1 -0
- package/resources/{api/loyalty → loyalty}/questions-responses.d.ts +41 -2
- package/resources/loyalty/questions-responses.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/questions-responses.js +11 -2
- package/resources/loyalty/questions-responses.js.map +1 -0
- package/resources/{api/loyalty → loyalty}/questions-responses.mjs +11 -2
- package/resources/loyalty/questions-responses.mjs.map +1 -0
- package/resources/{api/loyalty → loyalty}/questions.d.ts +39 -4
- package/resources/loyalty/questions.d.ts.map +1 -0
- package/resources/loyalty/questions.js +58 -0
- package/resources/loyalty/questions.js.map +1 -0
- package/resources/loyalty/questions.mjs +54 -0
- package/resources/loyalty/questions.mjs.map +1 -0
- package/resources/loyalty/rule-edits.d.ts +2904 -0
- package/resources/loyalty/rule-edits.d.ts.map +1 -0
- package/resources/{api/loyalty → loyalty}/rule-edits.js +15 -1
- package/resources/loyalty/rule-edits.js.map +1 -0
- package/resources/{api/loyalty → loyalty}/rule-edits.mjs +15 -1
- package/resources/loyalty/rule-edits.mjs.map +1 -0
- package/resources/{api/loyalty/loyalty.d.ts → loyalty/rule-groups.d.ts} +275 -320
- 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/{api/loyalty → loyalty}/rules.d.ts +1743 -224
- package/resources/loyalty/rules.d.ts.map +1 -0
- package/resources/loyalty/rules.js +77 -0
- package/resources/loyalty/rules.js.map +1 -0
- package/resources/loyalty/rules.mjs +73 -0
- package/resources/loyalty/rules.mjs.map +1 -0
- 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.map +1 -0
- package/resources/loyalty.js.map +1 -0
- package/resources/loyalty.mjs.map +1 -0
- package/resources/{api/minting.d.ts → minting.d.ts} +7 -7
- package/resources/minting.d.ts.map +1 -0
- package/resources/{api/minting.js → minting.js} +1 -1
- package/resources/minting.js.map +1 -0
- package/resources/{api/minting.mjs → minting.mjs} +1 -1
- package/resources/minting.mjs.map +1 -0
- package/resources/referral/index.d.ts.map +1 -0
- package/resources/referral/index.js.map +1 -0
- package/resources/referral/index.mjs.map +1 -0
- package/resources/{api/referral → referral}/referral.d.ts +13 -5
- package/resources/referral/referral.d.ts.map +1 -0
- package/resources/{api/referral → referral}/referral.js +12 -6
- package/resources/referral/referral.js.map +1 -0
- package/resources/{api/referral → referral}/referral.mjs +12 -6
- package/resources/referral/referral.mjs.map +1 -0
- package/resources/{api/referral → referral}/users.d.ts +30 -3
- package/resources/referral/users.d.ts.map +1 -0
- package/resources/{api/referral → referral}/users.js +15 -1
- package/resources/referral/users.js.map +1 -0
- package/resources/{api/referral → referral}/users.mjs +15 -1
- package/resources/referral/users.mjs.map +1 -0
- package/resources/referral.d.ts.map +1 -0
- package/resources/referral.js.map +1 -0
- package/resources/referral.mjs.map +1 -0
- package/resources/users/index.d.ts +3 -0
- package/resources/users/index.d.ts.map +1 -0
- package/resources/users/index.js.map +1 -0
- package/resources/users/index.mjs.map +1 -0
- package/resources/{api/users → users}/metadatas.d.ts +34 -2
- package/resources/users/metadatas.d.ts.map +1 -0
- package/resources/{api/users → users}/metadatas.js +2 -2
- package/resources/users/metadatas.js.map +1 -0
- package/resources/{api/users → users}/metadatas.mjs +2 -2
- package/resources/users/metadatas.mjs.map +1 -0
- package/resources/users/users.d.ts +422 -0
- package/resources/users/users.d.ts.map +1 -0
- package/resources/{api/users → users}/users.js +61 -2
- package/resources/users/users.js.map +1 -0
- package/resources/users/users.mjs +89 -0
- package/resources/users/users.mjs.map +1 -0
- package/resources/users.d.ts.map +1 -0
- package/resources/users.js.map +1 -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/{api → websites}/index.mjs +0 -5
- package/resources/websites/index.mjs.map +1 -0
- package/resources/{api → websites}/website-collections.d.ts +22 -1
- package/resources/websites/website-collections.d.ts.map +1 -0
- package/resources/{api → websites}/website-collections.js +21 -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/{api → websites}/website-user-roles.d.ts +23 -0
- package/resources/websites/website-user-roles.d.ts.map +1 -0
- package/resources/{api → websites}/website-user-roles.js +23 -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/{api → websites}/websites.d.ts +20 -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 +2 -0
- package/resources/websites.d.ts.map +1 -0
- package/resources/websites.js +19 -0
- package/resources/websites.js.map +1 -0
- package/resources/websites.mjs +3 -0
- package/resources/websites.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 +45 -17
- package/src/index.ts +126 -24
- package/src/resource.ts +1 -1
- package/src/resources/assets.ts +93 -0
- 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/{api.ts → auctions.ts} +1 -1
- package/src/resources/auth.ts +79 -0
- package/src/resources/index.ts +37 -8
- package/src/resources/loyalty/account-streaks.ts +110 -0
- package/src/resources/{api/loyalty → loyalty}/accounts.ts +41 -35
- package/src/resources/{api/loyalty → loyalty}/badges.ts +570 -27
- package/src/resources/{api/loyalty → loyalty}/currencies.ts +27 -2
- package/src/resources/{api/loyalty → loyalty}/index.ts +28 -11
- package/src/resources/loyalty/loyalty.ts +259 -0
- package/src/resources/{api/loyalty → loyalty}/multipliers.ts +70 -7
- package/src/resources/{api/loyalty → loyalty}/questions-responses.ts +48 -3
- package/src/resources/{api/loyalty → loyalty}/questions.ts +40 -4
- package/src/resources/loyalty/rule-edits.ts +3988 -0
- package/src/resources/{api/loyalty/loyalty.ts → loyalty/rule-groups.ts} +437 -550
- package/src/resources/{api/loyalty → loyalty}/rules.ts +2906 -530
- 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 +677 -0
- package/src/resources/loyalty/transactions.ts +3 -0
- package/src/resources/{api/minting.ts → minting.ts} +37 -23
- package/src/resources/{api/referral → referral}/referral.ts +15 -13
- package/src/resources/{api/referral → referral}/users.ts +35 -4
- package/src/resources/{api/users → users}/index.ts +6 -0
- package/src/resources/{api/users → users}/metadatas.ts +62 -3
- package/src/resources/users/users.ts +603 -0
- package/src/resources/websites/index.ts +22 -0
- package/src/resources/{api → websites}/website-collections.ts +52 -17
- package/src/resources/{api → websites}/website-user-roles.ts +23 -0
- package/src/resources/{api → websites}/websites.ts +52 -0
- package/src/resources/websites.ts +3 -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/api/api.d.ts +0 -365
- package/resources/api/api.d.ts.map +0 -1
- package/resources/api/api.js +0 -94
- package/resources/api/api.js.map +0 -1
- package/resources/api/api.mjs +0 -67
- package/resources/api/api.mjs.map +0 -1
- package/resources/api/index.d.ts +0 -9
- package/resources/api/index.d.ts.map +0 -1
- package/resources/api/index.js +0 -21
- package/resources/api/index.js.map +0 -1
- package/resources/api/index.mjs.map +0 -1
- package/resources/api/loyalty/accounts.d.ts.map +0 -1
- package/resources/api/loyalty/accounts.js.map +0 -1
- package/resources/api/loyalty/accounts.mjs +0 -20
- package/resources/api/loyalty/accounts.mjs.map +0 -1
- package/resources/api/loyalty/badges.d.ts.map +0 -1
- package/resources/api/loyalty/badges.js.map +0 -1
- package/resources/api/loyalty/badges.mjs.map +0 -1
- package/resources/api/loyalty/currencies.d.ts.map +0 -1
- package/resources/api/loyalty/currencies.js +0 -21
- package/resources/api/loyalty/currencies.js.map +0 -1
- package/resources/api/loyalty/currencies.mjs +0 -17
- package/resources/api/loyalty/currencies.mjs.map +0 -1
- package/resources/api/loyalty/index.d.ts.map +0 -1
- package/resources/api/loyalty/index.js.map +0 -1
- package/resources/api/loyalty/index.mjs.map +0 -1
- package/resources/api/loyalty/loyalty.d.ts.map +0 -1
- package/resources/api/loyalty/loyalty.js.map +0 -1
- package/resources/api/loyalty/loyalty.mjs.map +0 -1
- package/resources/api/loyalty/multipliers.d.ts.map +0 -1
- package/resources/api/loyalty/multipliers.js.map +0 -1
- package/resources/api/loyalty/multipliers.mjs.map +0 -1
- package/resources/api/loyalty/questions-responses.d.ts.map +0 -1
- package/resources/api/loyalty/questions-responses.js.map +0 -1
- package/resources/api/loyalty/questions-responses.mjs.map +0 -1
- package/resources/api/loyalty/questions.d.ts.map +0 -1
- package/resources/api/loyalty/questions.js +0 -27
- package/resources/api/loyalty/questions.js.map +0 -1
- package/resources/api/loyalty/questions.mjs +0 -23
- package/resources/api/loyalty/questions.mjs.map +0 -1
- package/resources/api/loyalty/rule-edits.d.ts +0 -330
- package/resources/api/loyalty/rule-edits.d.ts.map +0 -1
- package/resources/api/loyalty/rule-edits.js.map +0 -1
- package/resources/api/loyalty/rule-edits.mjs.map +0 -1
- package/resources/api/loyalty/rules.d.ts.map +0 -1
- package/resources/api/loyalty/rules.js +0 -46
- package/resources/api/loyalty/rules.js.map +0 -1
- package/resources/api/loyalty/rules.mjs +0 -42
- package/resources/api/loyalty/rules.mjs.map +0 -1
- package/resources/api/loyalty.d.ts.map +0 -1
- package/resources/api/loyalty.js.map +0 -1
- package/resources/api/loyalty.mjs.map +0 -1
- package/resources/api/minting.d.ts.map +0 -1
- package/resources/api/minting.js.map +0 -1
- package/resources/api/minting.mjs.map +0 -1
- package/resources/api/referral/index.d.ts.map +0 -1
- package/resources/api/referral/index.js.map +0 -1
- package/resources/api/referral/index.mjs.map +0 -1
- package/resources/api/referral/referral.d.ts.map +0 -1
- package/resources/api/referral/referral.js.map +0 -1
- package/resources/api/referral/referral.mjs.map +0 -1
- package/resources/api/referral/users.d.ts.map +0 -1
- package/resources/api/referral/users.js.map +0 -1
- package/resources/api/referral/users.mjs.map +0 -1
- package/resources/api/referral.d.ts.map +0 -1
- package/resources/api/referral.js.map +0 -1
- package/resources/api/referral.mjs.map +0 -1
- package/resources/api/users/index.d.ts +0 -3
- package/resources/api/users/index.d.ts.map +0 -1
- package/resources/api/users/index.js.map +0 -1
- package/resources/api/users/index.mjs.map +0 -1
- package/resources/api/users/metadatas.d.ts.map +0 -1
- package/resources/api/users/metadatas.js.map +0 -1
- package/resources/api/users/metadatas.mjs.map +0 -1
- package/resources/api/users/users.d.ts +0 -133
- package/resources/api/users/users.d.ts.map +0 -1
- package/resources/api/users/users.js.map +0 -1
- package/resources/api/users/users.mjs +0 -30
- package/resources/api/users/users.mjs.map +0 -1
- package/resources/api/users.d.ts.map +0 -1
- package/resources/api/users.js.map +0 -1
- package/resources/api/users.mjs.map +0 -1
- package/resources/api/website-collections.d.ts.map +0 -1
- package/resources/api/website-collections.js.map +0 -1
- package/resources/api/website-collections.mjs +0 -21
- package/resources/api/website-collections.mjs.map +0 -1
- package/resources/api/website-user-roles.d.ts.map +0 -1
- package/resources/api/website-user-roles.js.map +0 -1
- package/resources/api/website-user-roles.mjs +0 -18
- package/resources/api/website-user-roles.mjs.map +0 -1
- package/resources/api/websites.d.ts.map +0 -1
- package/resources/api/websites.js +0 -22
- package/resources/api/websites.js.map +0 -1
- package/resources/api/websites.mjs +0 -18
- package/resources/api/websites.mjs.map +0 -1
- package/resources/api.d.ts +0 -2
- package/resources/api.d.ts.map +0 -1
- package/resources/api.js.map +0 -1
- package/resources/api.mjs.map +0 -1
- package/src/resources/api/api.ts +0 -629
- package/src/resources/api/index.ts +0 -51
- package/src/resources/api/loyalty/rule-edits.ts +0 -418
- package/src/resources/api/users/users.ts +0 -203
- /package/resources/{api/loyalty.d.ts → loyalty.d.ts} +0 -0
- /package/resources/{api/loyalty.js → loyalty.js} +0 -0
- /package/resources/{api/loyalty.mjs → loyalty.mjs} +0 -0
- /package/resources/{api/referral → referral}/index.d.ts +0 -0
- /package/resources/{api/referral → referral}/index.js +0 -0
- /package/resources/{api/referral → referral}/index.mjs +0 -0
- /package/resources/{api/referral.d.ts → referral.d.ts} +0 -0
- /package/resources/{api/referral.js → referral.js} +0 -0
- /package/resources/{api/referral.mjs → referral.mjs} +0 -0
- /package/resources/{api/users → users}/index.js +0 -0
- /package/resources/{api/users → users}/index.mjs +0 -0
- /package/resources/{api/users.d.ts → users.d.ts} +0 -0
- /package/resources/{api/users.js → users.js} +0 -0
- /package/resources/{api/users.mjs → users.mjs} +0 -0
- /package/src/resources/{api/loyalty.ts → loyalty.ts} +0 -0
- /package/src/resources/{api/referral → referral}/index.ts +0 -0
- /package/src/resources/{api/referral.ts → referral.ts} +0 -0
- /package/src/resources/{api/users.ts → users.ts} +0 -0
|
@@ -1,128 +1,63 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
-
import { APIResource } from '
|
|
4
|
-
import { isRequestOptions } from '
|
|
5
|
-
import * as Core from '
|
|
6
|
-
import * as AccountsAPI from './accounts';
|
|
7
|
-
import {
|
|
8
|
-
AccountGetRankParams,
|
|
9
|
-
AccountGetRankResponse,
|
|
10
|
-
AccountListParams,
|
|
11
|
-
AccountListResponse,
|
|
12
|
-
Accounts,
|
|
13
|
-
} from './accounts';
|
|
14
|
-
import * as BadgesAPI from './badges';
|
|
15
|
-
import {
|
|
16
|
-
BadgeCreateParams,
|
|
17
|
-
BadgeCreateResponse,
|
|
18
|
-
BadgeDeleteResponse,
|
|
19
|
-
BadgeListParams,
|
|
20
|
-
BadgeListResponse,
|
|
21
|
-
BadgeRevokeParams,
|
|
22
|
-
BadgeRevokeResponse,
|
|
23
|
-
BadgeRewardParams,
|
|
24
|
-
BadgeRewardResponse,
|
|
25
|
-
BadgeUpdateParams,
|
|
26
|
-
BadgeUpdateResponse,
|
|
27
|
-
Badges,
|
|
28
|
-
} from './badges';
|
|
29
|
-
import * as CurrenciesAPI from './currencies';
|
|
30
|
-
import {
|
|
31
|
-
Currencies,
|
|
32
|
-
CurrencyCreateParams,
|
|
33
|
-
CurrencyCreateResponse,
|
|
34
|
-
CurrencyListParams,
|
|
35
|
-
CurrencyListResponse,
|
|
36
|
-
} from './currencies';
|
|
37
|
-
import * as MultipliersAPI from './multipliers';
|
|
38
|
-
import {
|
|
39
|
-
MultiplierCreateParams,
|
|
40
|
-
MultiplierCreateResponse,
|
|
41
|
-
MultiplierDeleteByExternalIDParams,
|
|
42
|
-
MultiplierDeleteByExternalIDResponse,
|
|
43
|
-
MultiplierDeleteResponse,
|
|
44
|
-
MultiplierListParams,
|
|
45
|
-
MultiplierListResponse,
|
|
46
|
-
MultiplierUpdateParams,
|
|
47
|
-
MultiplierUpdateResponse,
|
|
48
|
-
Multipliers,
|
|
49
|
-
} from './multipliers';
|
|
50
|
-
import * as QuestionsAPI from './questions';
|
|
51
|
-
import {
|
|
52
|
-
QuestionCreateParams,
|
|
53
|
-
QuestionCreateResponse,
|
|
54
|
-
QuestionListParams,
|
|
55
|
-
QuestionListResponse,
|
|
56
|
-
QuestionUpdateParams,
|
|
57
|
-
QuestionUpdateResponse,
|
|
58
|
-
Questions,
|
|
59
|
-
} from './questions';
|
|
60
|
-
import * as QuestionsResponsesAPI from './questions-responses';
|
|
61
|
-
import {
|
|
62
|
-
QuestionsResponseListParams,
|
|
63
|
-
QuestionsResponseListResponse,
|
|
64
|
-
QuestionsResponseSubmitParams,
|
|
65
|
-
QuestionsResponseSubmitResponse,
|
|
66
|
-
QuestionsResponses,
|
|
67
|
-
} from './questions-responses';
|
|
68
|
-
import * as RuleEditsAPI from './rule-edits';
|
|
69
|
-
import {
|
|
70
|
-
RuleEditListParams,
|
|
71
|
-
RuleEditListResponse,
|
|
72
|
-
RuleEditRestoreParams,
|
|
73
|
-
RuleEditRestoreResponse,
|
|
74
|
-
RuleEdits,
|
|
75
|
-
} from './rule-edits';
|
|
76
|
-
import * as RulesAPI from './rules';
|
|
77
|
-
import {
|
|
78
|
-
RuleCompleteParams,
|
|
79
|
-
RuleCompleteResponse,
|
|
80
|
-
RuleCreateParams,
|
|
81
|
-
RuleCreateResponse,
|
|
82
|
-
RuleDeleteResponse,
|
|
83
|
-
RuleGetStatusParams,
|
|
84
|
-
RuleGetStatusResponse,
|
|
85
|
-
RuleListParams,
|
|
86
|
-
RuleListResponse,
|
|
87
|
-
RuleUpdateParams,
|
|
88
|
-
RuleUpdateResponse,
|
|
89
|
-
Rules,
|
|
90
|
-
} from './rules';
|
|
91
|
-
|
|
92
|
-
export class Loyalty extends APIResource {
|
|
93
|
-
accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
|
|
94
|
-
badges: BadgesAPI.Badges = new BadgesAPI.Badges(this._client);
|
|
95
|
-
currencies: CurrenciesAPI.Currencies = new CurrenciesAPI.Currencies(this._client);
|
|
96
|
-
multipliers: MultipliersAPI.Multipliers = new MultipliersAPI.Multipliers(this._client);
|
|
97
|
-
ruleEdits: RuleEditsAPI.RuleEdits = new RuleEditsAPI.RuleEdits(this._client);
|
|
98
|
-
rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
|
|
99
|
-
questions: QuestionsAPI.Questions = new QuestionsAPI.Questions(this._client);
|
|
100
|
-
questionsResponses: QuestionsResponsesAPI.QuestionsResponses = new QuestionsResponsesAPI.QuestionsResponses(
|
|
101
|
-
this._client,
|
|
102
|
-
);
|
|
3
|
+
import { APIResource } from '../../resource';
|
|
4
|
+
import { isRequestOptions } from '../../core';
|
|
5
|
+
import * as Core from '../../core';
|
|
103
6
|
|
|
7
|
+
export class RuleGroups extends APIResource {
|
|
104
8
|
/**
|
|
105
|
-
* Create a loyalty
|
|
9
|
+
* Create a new loyalty rule groups
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const response =
|
|
14
|
+
* await client.loyalty.ruleGroups.createRuleGroup({
|
|
15
|
+
* name: 'name',
|
|
16
|
+
* organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
17
|
+
* websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
106
20
|
*/
|
|
107
|
-
|
|
108
|
-
body:
|
|
21
|
+
createRuleGroup(
|
|
22
|
+
body: RuleGroupCreateRuleGroupParams,
|
|
109
23
|
options?: Core.RequestOptions,
|
|
110
|
-
): Core.APIPromise<
|
|
111
|
-
return this._client.post('/api/loyalty/
|
|
24
|
+
): Core.APIPromise<RuleGroupCreateRuleGroupResponse> {
|
|
25
|
+
return this._client.post('/api/loyalty/rule_groups/create', { body, ...options });
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Delete loyalty rule group by ID
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const response =
|
|
34
|
+
* await client.loyalty.ruleGroups.deleteRuleGroup(
|
|
35
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
deleteRuleGroup(id: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
|
|
40
|
+
return this._client.delete(`/api/loyalty/rule_groups/${id}`, options);
|
|
112
41
|
}
|
|
113
42
|
|
|
114
43
|
/**
|
|
115
44
|
* Retrieve configured loyalty rule groups
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const response =
|
|
49
|
+
* await client.loyalty.ruleGroups.getRuleGroups();
|
|
50
|
+
* ```
|
|
116
51
|
*/
|
|
117
52
|
getRuleGroups(
|
|
118
|
-
query?:
|
|
53
|
+
query?: RuleGroupGetRuleGroupsParams,
|
|
119
54
|
options?: Core.RequestOptions,
|
|
120
|
-
): Core.APIPromise<
|
|
121
|
-
getRuleGroups(options?: Core.RequestOptions): Core.APIPromise<
|
|
55
|
+
): Core.APIPromise<RuleGroupGetRuleGroupsResponse>;
|
|
56
|
+
getRuleGroups(options?: Core.RequestOptions): Core.APIPromise<RuleGroupGetRuleGroupsResponse>;
|
|
122
57
|
getRuleGroups(
|
|
123
|
-
query:
|
|
58
|
+
query: RuleGroupGetRuleGroupsParams | Core.RequestOptions = {},
|
|
124
59
|
options?: Core.RequestOptions,
|
|
125
|
-
): Core.APIPromise<
|
|
60
|
+
): Core.APIPromise<RuleGroupGetRuleGroupsResponse> {
|
|
126
61
|
if (isRequestOptions(query)) {
|
|
127
62
|
return this.getRuleGroups({}, query);
|
|
128
63
|
}
|
|
@@ -130,61 +65,71 @@ export class Loyalty extends APIResource {
|
|
|
130
65
|
}
|
|
131
66
|
|
|
132
67
|
/**
|
|
133
|
-
*
|
|
134
|
-
*
|
|
68
|
+
* Update loyalty rule group by ID
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const response =
|
|
73
|
+
* await client.loyalty.ruleGroups.updateRuleGroup(
|
|
74
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
75
|
+
* );
|
|
76
|
+
* ```
|
|
135
77
|
*/
|
|
136
|
-
|
|
137
|
-
|
|
78
|
+
updateRuleGroup(
|
|
79
|
+
id: string,
|
|
80
|
+
body?: RuleGroupUpdateRuleGroupParams,
|
|
138
81
|
options?: Core.RequestOptions,
|
|
139
|
-
): Core.APIPromise<
|
|
140
|
-
|
|
82
|
+
): Core.APIPromise<RuleGroupUpdateRuleGroupResponse>;
|
|
83
|
+
updateRuleGroup(
|
|
84
|
+
id: string,
|
|
141
85
|
options?: Core.RequestOptions,
|
|
142
|
-
): Core.APIPromise<
|
|
143
|
-
|
|
144
|
-
|
|
86
|
+
): Core.APIPromise<RuleGroupUpdateRuleGroupResponse>;
|
|
87
|
+
updateRuleGroup(
|
|
88
|
+
id: string,
|
|
89
|
+
body: RuleGroupUpdateRuleGroupParams | Core.RequestOptions = {},
|
|
145
90
|
options?: Core.RequestOptions,
|
|
146
|
-
): Core.APIPromise<
|
|
147
|
-
if (isRequestOptions(
|
|
148
|
-
return this.
|
|
91
|
+
): Core.APIPromise<RuleGroupUpdateRuleGroupResponse> {
|
|
92
|
+
if (isRequestOptions(body)) {
|
|
93
|
+
return this.updateRuleGroup(id, {}, body);
|
|
149
94
|
}
|
|
150
|
-
return this._client.
|
|
95
|
+
return this._client.post(`/api/loyalty/rule_groups/${id}`, { body, ...options });
|
|
151
96
|
}
|
|
152
97
|
}
|
|
153
98
|
|
|
154
|
-
export interface
|
|
99
|
+
export interface RuleGroupCreateRuleGroupResponse {
|
|
155
100
|
id: string;
|
|
156
101
|
|
|
157
102
|
createdAt: string;
|
|
158
103
|
|
|
159
|
-
|
|
104
|
+
isCollapsible: boolean;
|
|
160
105
|
|
|
161
|
-
|
|
106
|
+
isRequired: boolean;
|
|
162
107
|
|
|
163
|
-
|
|
164
|
-
}
|
|
108
|
+
name: string;
|
|
165
109
|
|
|
166
|
-
|
|
167
|
-
export interface Entry {
|
|
168
|
-
amount: number;
|
|
110
|
+
organizationId: string;
|
|
169
111
|
|
|
170
|
-
|
|
171
|
-
* Direction of the transaction entry
|
|
172
|
-
*/
|
|
173
|
-
direction: 'credit' | 'debit';
|
|
112
|
+
sortId: number;
|
|
174
113
|
|
|
175
|
-
|
|
114
|
+
subTitle: string | null;
|
|
176
115
|
|
|
177
|
-
|
|
178
|
-
|
|
116
|
+
updatedAt: string;
|
|
117
|
+
|
|
118
|
+
websiteId: string;
|
|
179
119
|
}
|
|
180
120
|
|
|
181
|
-
export
|
|
182
|
-
|
|
121
|
+
export type RuleGroupDeleteRuleGroupResponse = unknown;
|
|
122
|
+
|
|
123
|
+
export interface RuleGroupGetRuleGroupsResponse {
|
|
124
|
+
data: Array<RuleGroupGetRuleGroupsResponse.Data>;
|
|
183
125
|
|
|
184
126
|
hasNextPage: boolean;
|
|
185
127
|
}
|
|
186
128
|
|
|
187
|
-
export namespace
|
|
129
|
+
export namespace RuleGroupGetRuleGroupsResponse {
|
|
130
|
+
/**
|
|
131
|
+
* Schema for a get loyalty rule groups response
|
|
132
|
+
*/
|
|
188
133
|
export interface Data {
|
|
189
134
|
id: string;
|
|
190
135
|
|
|
@@ -228,13 +173,17 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
228
173
|
|
|
229
174
|
isRequired: boolean;
|
|
230
175
|
|
|
176
|
+
loyaltyBadge: LoyaltyRule.LoyaltyBadge;
|
|
177
|
+
|
|
231
178
|
loyaltyCurrencyId: string;
|
|
232
179
|
|
|
180
|
+
mediaUrl: string | null;
|
|
181
|
+
|
|
233
182
|
metadata: LoyaltyRule.Metadata;
|
|
234
183
|
|
|
235
184
|
name: string;
|
|
236
185
|
|
|
237
|
-
rewardType: 'points' | 'multiplier';
|
|
186
|
+
rewardType: 'points' | 'multiplier' | 'badge';
|
|
238
187
|
|
|
239
188
|
startTime: string | null;
|
|
240
189
|
|
|
@@ -291,11 +240,38 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
291
240
|
| 'twitter_like'
|
|
292
241
|
| 'twitter_post_hashtag'
|
|
293
242
|
| 'quiz'
|
|
294
|
-
| 'poll'
|
|
243
|
+
| 'poll'
|
|
244
|
+
| 'steam_wishlist'
|
|
245
|
+
| 'liquidity_uniswap_v2'
|
|
246
|
+
| 'liquidity_uniswap_v3'
|
|
247
|
+
| 'points_airdrop'
|
|
248
|
+
| 'youtube_subscribers'
|
|
249
|
+
| 'youtube_comment'
|
|
250
|
+
| 'shopify_spend'
|
|
251
|
+
| 'swap'
|
|
252
|
+
| 'tiktok_post'
|
|
253
|
+
| 'post_impressions'
|
|
254
|
+
| 'discord_join'
|
|
255
|
+
| 'connected_youtube';
|
|
295
256
|
}
|
|
296
257
|
|
|
297
258
|
export namespace LoyaltyRule {
|
|
259
|
+
export interface LoyaltyBadge {
|
|
260
|
+
id: string;
|
|
261
|
+
|
|
262
|
+
description: string | null;
|
|
263
|
+
|
|
264
|
+
imageUrl: string | null;
|
|
265
|
+
|
|
266
|
+
name: string;
|
|
267
|
+
}
|
|
268
|
+
|
|
298
269
|
export interface Metadata {
|
|
270
|
+
/**
|
|
271
|
+
* Number of tokens per batch.
|
|
272
|
+
*/
|
|
273
|
+
batchSize?: number | null;
|
|
274
|
+
|
|
299
275
|
/**
|
|
300
276
|
* Text displayed on the action button.
|
|
301
277
|
*/
|
|
@@ -326,6 +302,16 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
326
302
|
*/
|
|
327
303
|
collection?: Array<Metadata.Collection>;
|
|
328
304
|
|
|
305
|
+
/**
|
|
306
|
+
* Conditions for completing the profile.
|
|
307
|
+
*/
|
|
308
|
+
completeProfileConditions?: { [key: string]: boolean } | null;
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Description of the external rule condition (only for external rules)
|
|
312
|
+
*/
|
|
313
|
+
conditionDescription?: string;
|
|
314
|
+
|
|
329
315
|
/**
|
|
330
316
|
* Object containing details for the call-to-action.
|
|
331
317
|
*/
|
|
@@ -336,6 +322,11 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
336
322
|
*/
|
|
337
323
|
customRewardsApiKey?: string;
|
|
338
324
|
|
|
325
|
+
/**
|
|
326
|
+
* Flag indicating if the rule should use direct RPC to get the balance of tokens.
|
|
327
|
+
*/
|
|
328
|
+
directRpc?: boolean;
|
|
329
|
+
|
|
339
330
|
/**
|
|
340
331
|
* Array of Discord servers, channels, and roles to join.
|
|
341
332
|
*/
|
|
@@ -361,11 +352,21 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
361
352
|
*/
|
|
362
353
|
enableVerifiedMultiplier?: boolean;
|
|
363
354
|
|
|
355
|
+
/**
|
|
356
|
+
* Fill source of the order for the token sale
|
|
357
|
+
*/
|
|
358
|
+
fillSource?: string;
|
|
359
|
+
|
|
364
360
|
/**
|
|
365
361
|
* Percentage reward given to a user for their first referral.
|
|
366
362
|
*/
|
|
367
363
|
firstReferralReward?: number | null;
|
|
368
364
|
|
|
365
|
+
/**
|
|
366
|
+
* Flag indicating whether the fill source is included.
|
|
367
|
+
*/
|
|
368
|
+
hasFillSource?: boolean;
|
|
369
|
+
|
|
369
370
|
/**
|
|
370
371
|
* Indicates if the item has never been sold.
|
|
371
372
|
*/
|
|
@@ -391,11 +392,21 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
391
392
|
*/
|
|
392
393
|
imageUrl?: string | null;
|
|
393
394
|
|
|
395
|
+
/**
|
|
396
|
+
* If enabled, the first transaction done on the platform will complete this rule
|
|
397
|
+
*/
|
|
398
|
+
isCheckInOnEveryTxn?: boolean;
|
|
399
|
+
|
|
394
400
|
/**
|
|
395
401
|
* Indicates if the multiplier has been applied to rewards.
|
|
396
402
|
*/
|
|
397
403
|
isMultiplierApplied?: boolean;
|
|
398
404
|
|
|
405
|
+
/**
|
|
406
|
+
* Flag indicating if the rule is restricted to new users.
|
|
407
|
+
*/
|
|
408
|
+
isRestrictedToNewUsers?: boolean;
|
|
409
|
+
|
|
399
410
|
/**
|
|
400
411
|
* Flag indicating if rewards are applied retroactively.
|
|
401
412
|
*/
|
|
@@ -411,6 +422,11 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
411
422
|
*/
|
|
412
423
|
link?: string | null;
|
|
413
424
|
|
|
425
|
+
/**
|
|
426
|
+
* Liquidity pool details.
|
|
427
|
+
*/
|
|
428
|
+
liquidity?: Metadata.Liquidity;
|
|
429
|
+
|
|
414
430
|
/**
|
|
415
431
|
* Maximum quantity constraint for token holding.
|
|
416
432
|
*/
|
|
@@ -456,6 +472,21 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
456
472
|
*/
|
|
457
473
|
promoCode?: string;
|
|
458
474
|
|
|
475
|
+
/**
|
|
476
|
+
* URL of the CSV file containing promo codes.
|
|
477
|
+
*/
|
|
478
|
+
promoCodeCsvUrl?: string;
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* Numbers of the promotional code to be generated.
|
|
482
|
+
*/
|
|
483
|
+
promoCodeLength?: number | null;
|
|
484
|
+
|
|
485
|
+
/**
|
|
486
|
+
* Type of the promotional code.
|
|
487
|
+
*/
|
|
488
|
+
promoCodeType?: 'code' | 'csv' | 'generate';
|
|
489
|
+
|
|
459
490
|
/**
|
|
460
491
|
* Array defining ranges and corresponding rewards.
|
|
461
492
|
*/
|
|
@@ -471,11 +502,52 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
471
502
|
*/
|
|
472
503
|
referrerReward?: number | null;
|
|
473
504
|
|
|
505
|
+
/**
|
|
506
|
+
* Loyalty currency ID of the referrer reward.
|
|
507
|
+
*/
|
|
508
|
+
referrerRewardLoyaltyCurrencyId?: string | null;
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
* Flag indicating if the post link is required.
|
|
512
|
+
*/
|
|
513
|
+
requirePostLink?: boolean | null;
|
|
514
|
+
|
|
515
|
+
/**
|
|
516
|
+
* Flag indicating if the rule can also reward badges per range.
|
|
517
|
+
*/
|
|
518
|
+
rewardBadgePerRange?: boolean;
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* Flag indicating if the reward is rewarded by batch.
|
|
522
|
+
*/
|
|
523
|
+
rewardByBatch?: boolean | null;
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* Flag indicating if the reward is rewarded per action.
|
|
527
|
+
*/
|
|
528
|
+
rewardPerAction?: boolean | null;
|
|
529
|
+
|
|
474
530
|
/**
|
|
475
531
|
* Flag indicating if rewards are given per impression.
|
|
476
532
|
*/
|
|
477
533
|
rewardPerImpression?: boolean | null;
|
|
478
534
|
|
|
535
|
+
/**
|
|
536
|
+
* Flag indicating if the rule should reward based on value of traded tokens
|
|
537
|
+
* instead of count.
|
|
538
|
+
*/
|
|
539
|
+
rewardPerValue?: boolean;
|
|
540
|
+
|
|
541
|
+
/**
|
|
542
|
+
* Wallet address of the user can only be used if userId is not provided
|
|
543
|
+
*/
|
|
544
|
+
royaltyAddress?: string;
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* Royalty percentage of the item.
|
|
548
|
+
*/
|
|
549
|
+
royaltyPercentage?: number;
|
|
550
|
+
|
|
479
551
|
/**
|
|
480
552
|
* Currency associated with sales.
|
|
481
553
|
*/
|
|
@@ -515,6 +587,7 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
515
587
|
| 'Twitch'
|
|
516
588
|
| 'X(Twitter)'
|
|
517
589
|
| 'YouTube'
|
|
590
|
+
| 'Google'
|
|
518
591
|
| null;
|
|
519
592
|
|
|
520
593
|
/**
|
|
@@ -527,11 +600,21 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
527
600
|
*/
|
|
528
601
|
socialPlatformName?: string | null;
|
|
529
602
|
|
|
603
|
+
/**
|
|
604
|
+
* ID of the Steam app.
|
|
605
|
+
*/
|
|
606
|
+
steamAppId?: string | null;
|
|
607
|
+
|
|
530
608
|
/**
|
|
531
609
|
* Array of streak milestones and corresponding rewards.
|
|
532
610
|
*/
|
|
533
611
|
streakArray?: Array<Metadata.StreakArray> | null;
|
|
534
612
|
|
|
613
|
+
/**
|
|
614
|
+
* Metadata for swap loyalty rules
|
|
615
|
+
*/
|
|
616
|
+
swap?: Metadata.Swap;
|
|
617
|
+
|
|
535
618
|
/**
|
|
536
619
|
* ID of the Telegram channel.
|
|
537
620
|
*/
|
|
@@ -547,6 +630,12 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
547
630
|
*/
|
|
548
631
|
trackAllContracts?: boolean | null;
|
|
549
632
|
|
|
633
|
+
/**
|
|
634
|
+
* Flag indicating if the progress is tracked. If enabled, the rule can only be
|
|
635
|
+
* completed once the progress is 100%.
|
|
636
|
+
*/
|
|
637
|
+
trackProgress?: boolean | null;
|
|
638
|
+
|
|
550
639
|
/**
|
|
551
640
|
* URL of the associated Twitter account.
|
|
552
641
|
*/
|
|
@@ -590,7 +679,17 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
590
679
|
/**
|
|
591
680
|
* Type of wallet associated with the rule.
|
|
592
681
|
*/
|
|
593
|
-
walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
|
|
682
|
+
walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
|
|
683
|
+
|
|
684
|
+
/**
|
|
685
|
+
* ID of the Youtube channel.
|
|
686
|
+
*/
|
|
687
|
+
youtubeChannelId?: string | null;
|
|
688
|
+
|
|
689
|
+
/**
|
|
690
|
+
* ID of the Youtube video.
|
|
691
|
+
*/
|
|
692
|
+
youtubeVideoId?: string | null;
|
|
594
693
|
}
|
|
595
694
|
|
|
596
695
|
export namespace Metadata {
|
|
@@ -609,39 +708,53 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
609
708
|
* Blockchain network of the collection.
|
|
610
709
|
*/
|
|
611
710
|
network?:
|
|
612
|
-
| '
|
|
613
|
-
| '
|
|
614
|
-
| '
|
|
615
|
-
| 'optimism'
|
|
711
|
+
| 'abstract'
|
|
712
|
+
| 'abstractTestnet'
|
|
713
|
+
| 'apechain'
|
|
616
714
|
| 'arbitrum'
|
|
617
|
-
| 'binance'
|
|
618
|
-
| 'bscTestnet'
|
|
619
715
|
| 'avalanche'
|
|
620
716
|
| 'avalancheFuji'
|
|
621
|
-
| 'zksync'
|
|
622
|
-
| 'fantom'
|
|
623
|
-
| 'fantomTestnet'
|
|
624
717
|
| 'base'
|
|
625
718
|
| 'baseSepolia'
|
|
626
|
-
| '
|
|
627
|
-
| 'xai'
|
|
719
|
+
| 'berachain'
|
|
628
720
|
| 'berachainArtio'
|
|
629
|
-
| '
|
|
630
|
-
| '
|
|
631
|
-
| '
|
|
721
|
+
| 'berachainBepolia'
|
|
722
|
+
| 'binance'
|
|
723
|
+
| 'bscTestnet'
|
|
632
724
|
| 'campTestnet'
|
|
725
|
+
| 'fantom'
|
|
726
|
+
| 'fantomTestnet'
|
|
727
|
+
| 'flowMainnet'
|
|
728
|
+
| 'mainnet'
|
|
729
|
+
| 'nexusTestnet'
|
|
730
|
+
| 'optimism'
|
|
731
|
+
| 'polygon'
|
|
732
|
+
| 'polygon_mumbai'
|
|
733
|
+
| 'skaleNebula'
|
|
734
|
+
| 'solana'
|
|
735
|
+
| 'sophon'
|
|
736
|
+
| 'sophonTestnet'
|
|
633
737
|
| 'sui'
|
|
634
|
-
| 'vanar'
|
|
635
738
|
| 'superseed'
|
|
636
739
|
| 'superseedSepolia'
|
|
740
|
+
| 'vanar'
|
|
741
|
+
| 'xai'
|
|
742
|
+
| 'zksync'
|
|
743
|
+
| 'coti'
|
|
744
|
+
| 'cotiTestnet'
|
|
745
|
+
| 'morph'
|
|
746
|
+
| 'morphTestnet'
|
|
747
|
+
| 'morphHolesky'
|
|
748
|
+
| 'ultra'
|
|
749
|
+
| 'ultraTestnet'
|
|
750
|
+
| 'nitrograph'
|
|
637
751
|
| 'sepolia'
|
|
638
752
|
| 'optimism_sepolia'
|
|
639
753
|
| 'arbitrumSepolia'
|
|
640
754
|
| 'goerli'
|
|
641
755
|
| 'optimism_goerli'
|
|
642
756
|
| 'arbitrumGoerli'
|
|
643
|
-
| 'basecamp'
|
|
644
|
-
| 'abstract';
|
|
757
|
+
| 'basecamp';
|
|
645
758
|
}
|
|
646
759
|
|
|
647
760
|
/**
|
|
@@ -718,6 +831,104 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
718
831
|
id: string;
|
|
719
832
|
}
|
|
720
833
|
|
|
834
|
+
/**
|
|
835
|
+
* Liquidity pool details.
|
|
836
|
+
*/
|
|
837
|
+
export interface Liquidity {
|
|
838
|
+
/**
|
|
839
|
+
* Calculation type of the liquidity pool.
|
|
840
|
+
*/
|
|
841
|
+
calculationType?: 'fixed' | 'custom';
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* Custom function to calculate the the reward amount based on the liquidity
|
|
845
|
+
* provided per day. X is the reward amount, Y is the liquidity provided per day in
|
|
846
|
+
* USD.
|
|
847
|
+
*/
|
|
848
|
+
customFunction?: string;
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
* Liquidity provided per day in USD
|
|
852
|
+
*/
|
|
853
|
+
liquidityPerDay?: number;
|
|
854
|
+
|
|
855
|
+
/**
|
|
856
|
+
* Blockchain network of the liquidity pool.
|
|
857
|
+
*/
|
|
858
|
+
network?:
|
|
859
|
+
| 'abstract'
|
|
860
|
+
| 'abstractTestnet'
|
|
861
|
+
| 'apechain'
|
|
862
|
+
| 'arbitrum'
|
|
863
|
+
| 'avalanche'
|
|
864
|
+
| 'avalancheFuji'
|
|
865
|
+
| 'base'
|
|
866
|
+
| 'baseSepolia'
|
|
867
|
+
| 'berachain'
|
|
868
|
+
| 'berachainArtio'
|
|
869
|
+
| 'berachainBepolia'
|
|
870
|
+
| 'binance'
|
|
871
|
+
| 'bscTestnet'
|
|
872
|
+
| 'campTestnet'
|
|
873
|
+
| 'fantom'
|
|
874
|
+
| 'fantomTestnet'
|
|
875
|
+
| 'flowMainnet'
|
|
876
|
+
| 'mainnet'
|
|
877
|
+
| 'nexusTestnet'
|
|
878
|
+
| 'optimism'
|
|
879
|
+
| 'polygon'
|
|
880
|
+
| 'polygon_mumbai'
|
|
881
|
+
| 'skaleNebula'
|
|
882
|
+
| 'solana'
|
|
883
|
+
| 'sophon'
|
|
884
|
+
| 'sophonTestnet'
|
|
885
|
+
| 'sui'
|
|
886
|
+
| 'superseed'
|
|
887
|
+
| 'superseedSepolia'
|
|
888
|
+
| 'vanar'
|
|
889
|
+
| 'xai'
|
|
890
|
+
| 'zksync'
|
|
891
|
+
| 'coti'
|
|
892
|
+
| 'cotiTestnet'
|
|
893
|
+
| 'morph'
|
|
894
|
+
| 'morphTestnet'
|
|
895
|
+
| 'morphHolesky'
|
|
896
|
+
| 'ultra'
|
|
897
|
+
| 'ultraTestnet'
|
|
898
|
+
| 'nitrograph'
|
|
899
|
+
| 'sepolia'
|
|
900
|
+
| 'optimism_sepolia'
|
|
901
|
+
| 'arbitrumSepolia'
|
|
902
|
+
| 'goerli'
|
|
903
|
+
| 'optimism_goerli'
|
|
904
|
+
| 'arbitrumGoerli'
|
|
905
|
+
| 'basecamp';
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* Indicates if only in-range liquidity is rewarded.
|
|
909
|
+
*/
|
|
910
|
+
onlyRewardInRangeLiquidity?: boolean;
|
|
911
|
+
|
|
912
|
+
/**
|
|
913
|
+
* Array of liquidity pools associated with the rule.
|
|
914
|
+
*/
|
|
915
|
+
pools?: Array<Liquidity.Pool>;
|
|
916
|
+
|
|
917
|
+
/**
|
|
918
|
+
* Protocol of the liquidity pool.
|
|
919
|
+
*/
|
|
920
|
+
protocol?: string;
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
export namespace Liquidity {
|
|
924
|
+
export interface Pool {
|
|
925
|
+
/**
|
|
926
|
+
* Unique identifier of the liquidity pool.
|
|
927
|
+
*/
|
|
928
|
+
id: string;
|
|
929
|
+
}
|
|
930
|
+
}
|
|
931
|
+
|
|
721
932
|
export interface Range {
|
|
722
933
|
/**
|
|
723
934
|
* Reward amount for this range.
|
|
@@ -733,6 +944,16 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
733
944
|
* Start value of the range.
|
|
734
945
|
*/
|
|
735
946
|
startRange: number;
|
|
947
|
+
|
|
948
|
+
/**
|
|
949
|
+
* ID of the loyalty badge for this range.
|
|
950
|
+
*/
|
|
951
|
+
loyaltyBadgeId?: string;
|
|
952
|
+
|
|
953
|
+
/**
|
|
954
|
+
* Amount of the loyalty multiplier for this range.
|
|
955
|
+
*/
|
|
956
|
+
loyaltyMultiplierAmount?: number;
|
|
736
957
|
}
|
|
737
958
|
|
|
738
959
|
/**
|
|
@@ -785,20 +1006,15 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
785
1006
|
* Object containing details of the associated smart contract.
|
|
786
1007
|
*/
|
|
787
1008
|
export interface SmartContract {
|
|
788
|
-
/**
|
|
789
|
-
* ABI of the smart contract.
|
|
790
|
-
*/
|
|
791
|
-
abi?: string | null;
|
|
792
|
-
|
|
793
1009
|
/**
|
|
794
1010
|
* Mapping of addresses for the smart contract.
|
|
795
1011
|
*/
|
|
796
1012
|
addressMapping?: string | null;
|
|
797
1013
|
|
|
798
1014
|
/**
|
|
799
|
-
*
|
|
1015
|
+
* Object containing details of the amount multiplier from the event.
|
|
800
1016
|
*/
|
|
801
|
-
|
|
1017
|
+
amountMultiplier?: SmartContract.AmountMultiplier | null;
|
|
802
1018
|
|
|
803
1019
|
/**
|
|
804
1020
|
* ID of the smart contract.
|
|
@@ -810,68 +1026,31 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
810
1026
|
*/
|
|
811
1027
|
criteria?: 'everyEvent' | 'byParameter' | null;
|
|
812
1028
|
|
|
813
|
-
/**
|
|
814
|
-
* Time range applied to the rule.
|
|
815
|
-
*/
|
|
816
|
-
customRange?: SmartContract.CustomRange | null;
|
|
817
|
-
|
|
818
1029
|
/**
|
|
819
1030
|
* Event emitted by the smart contract.
|
|
820
1031
|
*/
|
|
821
1032
|
event?: string | null;
|
|
822
1033
|
|
|
823
|
-
/**
|
|
824
|
-
* Maximum value allowed for the parameter.
|
|
825
|
-
*/
|
|
826
|
-
max?: number | null;
|
|
827
|
-
|
|
828
1034
|
/**
|
|
829
1035
|
* Array of parameters for the smart contract.
|
|
830
1036
|
*/
|
|
831
1037
|
params?: Array<SmartContract.Param> | null;
|
|
832
1038
|
|
|
833
1039
|
/**
|
|
834
|
-
*
|
|
835
|
-
*/
|
|
836
|
-
withBonus?: boolean | null;
|
|
837
|
-
|
|
838
|
-
/**
|
|
839
|
-
* Flag indicating if a custom range is applied.
|
|
840
|
-
*/
|
|
841
|
-
withCustomRange?: boolean | null;
|
|
842
|
-
|
|
843
|
-
/**
|
|
844
|
-
* Flag indicating if a maximum limit is applied.
|
|
1040
|
+
* Type of the smart contract interaction.
|
|
845
1041
|
*/
|
|
846
|
-
|
|
1042
|
+
type?: 'function' | 'event' | null;
|
|
847
1043
|
}
|
|
848
1044
|
|
|
849
1045
|
export namespace SmartContract {
|
|
850
|
-
export interface Bonus {
|
|
851
|
-
/**
|
|
852
|
-
* Amount of the bonus.
|
|
853
|
-
*/
|
|
854
|
-
amount?: number | null;
|
|
855
|
-
|
|
856
|
-
/**
|
|
857
|
-
* Number of times the bonus is applied.
|
|
858
|
-
*/
|
|
859
|
-
count?: number | null;
|
|
860
|
-
}
|
|
861
|
-
|
|
862
1046
|
/**
|
|
863
|
-
*
|
|
1047
|
+
* Object containing details of the amount multiplier from the event.
|
|
864
1048
|
*/
|
|
865
|
-
export interface
|
|
1049
|
+
export interface AmountMultiplier {
|
|
866
1050
|
/**
|
|
867
|
-
*
|
|
1051
|
+
* Mapping of the value for the smart contract.
|
|
868
1052
|
*/
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
/**
|
|
872
|
-
* Start time of the custom range.
|
|
873
|
-
*/
|
|
874
|
-
startsAt?: string | null;
|
|
1053
|
+
valueMapping?: string | null;
|
|
875
1054
|
}
|
|
876
1055
|
|
|
877
1056
|
export interface Param {
|
|
@@ -915,383 +1094,91 @@ export namespace LoyaltyGetRuleGroupsResponse {
|
|
|
915
1094
|
*/
|
|
916
1095
|
streakMilestone: number;
|
|
917
1096
|
}
|
|
918
|
-
}
|
|
919
|
-
}
|
|
920
|
-
}
|
|
921
|
-
}
|
|
922
|
-
}
|
|
923
1097
|
|
|
924
|
-
|
|
925
|
-
|
|
1098
|
+
/**
|
|
1099
|
+
* Metadata for swap loyalty rules
|
|
1100
|
+
*/
|
|
1101
|
+
export interface Swap {
|
|
1102
|
+
provider?: 'any' | 'relay' | 'lifi';
|
|
926
1103
|
|
|
927
|
-
|
|
928
|
-
}
|
|
1104
|
+
relayReferrerId?: string;
|
|
929
1105
|
|
|
930
|
-
|
|
931
|
-
/**
|
|
932
|
-
* Schema for a loyalty transaction entry
|
|
933
|
-
*/
|
|
934
|
-
export interface Data {
|
|
935
|
-
/**
|
|
936
|
-
* Unique identifier for the transaction entry
|
|
937
|
-
*/
|
|
938
|
-
id: string;
|
|
1106
|
+
requireCrossChainSwap?: boolean;
|
|
939
1107
|
|
|
940
|
-
|
|
941
|
-
* Amount involved in the transaction
|
|
942
|
-
*/
|
|
943
|
-
amount: number;
|
|
944
|
-
|
|
945
|
-
/**
|
|
946
|
-
* Timestamp when the transaction entry was created
|
|
947
|
-
*/
|
|
948
|
-
createdAt: string;
|
|
949
|
-
|
|
950
|
-
/**
|
|
951
|
-
* Direction of the transaction entry
|
|
952
|
-
*/
|
|
953
|
-
direction: 'credit' | 'debit';
|
|
954
|
-
|
|
955
|
-
/**
|
|
956
|
-
* Unique identifier for the loyalty account
|
|
957
|
-
*/
|
|
958
|
-
loyaltyAccountId: string;
|
|
959
|
-
|
|
960
|
-
/**
|
|
961
|
-
* Details of the loyalty transaction
|
|
962
|
-
*/
|
|
963
|
-
loyaltyTransaction: Data.LoyaltyTransaction;
|
|
964
|
-
|
|
965
|
-
/**
|
|
966
|
-
* Unique identifier for the organization
|
|
967
|
-
*/
|
|
968
|
-
organizationId: string;
|
|
969
|
-
|
|
970
|
-
/**
|
|
971
|
-
* Type of the loyalty transaction
|
|
972
|
-
*/
|
|
973
|
-
type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
|
|
974
|
-
|
|
975
|
-
/**
|
|
976
|
-
* Timestamp when the transaction entry was last updated
|
|
977
|
-
*/
|
|
978
|
-
updatedAt: string;
|
|
979
|
-
|
|
980
|
-
/**
|
|
981
|
-
* Unique identifier for the website
|
|
982
|
-
*/
|
|
983
|
-
websiteId: string;
|
|
984
|
-
|
|
985
|
-
/**
|
|
986
|
-
* Optional metadata for the transaction entry
|
|
987
|
-
*/
|
|
988
|
-
metadata?: Record<string, unknown>;
|
|
989
|
-
}
|
|
1108
|
+
swappedToChain?: 'any' | number | string;
|
|
990
1109
|
|
|
991
|
-
|
|
992
|
-
/**
|
|
993
|
-
* Details of the loyalty transaction
|
|
994
|
-
*/
|
|
995
|
-
export interface LoyaltyTransaction {
|
|
996
|
-
/**
|
|
997
|
-
* Unique identifier for the loyalty transaction
|
|
998
|
-
*/
|
|
999
|
-
id: string;
|
|
1110
|
+
swappedToTokens?: Array<Swap.SwappedToToken>;
|
|
1000
1111
|
|
|
1001
|
-
|
|
1002
|
-
* Type of the loyalty transaction
|
|
1003
|
-
*/
|
|
1004
|
-
type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
|
|
1112
|
+
tokenMode?: 'any' | 'specific';
|
|
1005
1113
|
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
*/
|
|
1009
|
-
loyaltyRule?: LoyaltyTransaction.LoyaltyRule;
|
|
1010
|
-
}
|
|
1114
|
+
trackTokenAmount?: boolean;
|
|
1115
|
+
}
|
|
1011
1116
|
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
*/
|
|
1016
|
-
export interface LoyaltyRule {
|
|
1017
|
-
/**
|
|
1018
|
-
* Unique identifier for the loyalty rule
|
|
1019
|
-
*/
|
|
1020
|
-
id: string;
|
|
1117
|
+
export namespace Swap {
|
|
1118
|
+
export interface SwappedToToken {
|
|
1119
|
+
address: string;
|
|
1021
1120
|
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
/**
|
|
1028
|
-
* Description of the loyalty rule
|
|
1029
|
-
*/
|
|
1030
|
-
description?: string;
|
|
1031
|
-
|
|
1032
|
-
/**
|
|
1033
|
-
* Optional metadata for the loyalty rule
|
|
1034
|
-
*/
|
|
1035
|
-
metadata?: Record<string, unknown>;
|
|
1036
|
-
|
|
1037
|
-
/**
|
|
1038
|
-
* Name of the loyalty rule
|
|
1039
|
-
*/
|
|
1040
|
-
name?: string;
|
|
1121
|
+
chainId: string;
|
|
1122
|
+
}
|
|
1123
|
+
}
|
|
1124
|
+
}
|
|
1041
1125
|
}
|
|
1042
1126
|
}
|
|
1043
1127
|
}
|
|
1044
1128
|
}
|
|
1045
1129
|
|
|
1046
|
-
export interface
|
|
1047
|
-
|
|
1048
|
-
* Description of the loyalty transaction
|
|
1049
|
-
*/
|
|
1050
|
-
description: string;
|
|
1051
|
-
|
|
1052
|
-
/**
|
|
1053
|
-
* Array of transaction entries
|
|
1054
|
-
*/
|
|
1055
|
-
entries: Array<LoyaltyCreateTransactionParams.Entry>;
|
|
1130
|
+
export interface RuleGroupUpdateRuleGroupResponse {
|
|
1131
|
+
isCollapsible?: boolean;
|
|
1056
1132
|
|
|
1057
|
-
|
|
1058
|
-
* Unique identifier for the loyalty currency
|
|
1059
|
-
*/
|
|
1060
|
-
loyaltyCurrencyId?: string;
|
|
1061
|
-
}
|
|
1133
|
+
name?: string;
|
|
1062
1134
|
|
|
1063
|
-
|
|
1064
|
-
export interface Entry {
|
|
1065
|
-
/**
|
|
1066
|
-
* Transaction entry amount.
|
|
1067
|
-
*/
|
|
1068
|
-
amount: number;
|
|
1069
|
-
|
|
1070
|
-
/**
|
|
1071
|
-
* Direction of the transaction entry for this wallet address
|
|
1072
|
-
*/
|
|
1073
|
-
direction?: 'credit' | 'debit';
|
|
1074
|
-
|
|
1075
|
-
/**
|
|
1076
|
-
* Idempotency key for the transaction entry. Creation will fail if already exists
|
|
1077
|
-
* for this wallet address.
|
|
1078
|
-
*/
|
|
1079
|
-
idempotencyKey?: string;
|
|
1080
|
-
|
|
1081
|
-
/**
|
|
1082
|
-
* The wallet address of the user
|
|
1083
|
-
*/
|
|
1084
|
-
walletAddress?: string;
|
|
1085
|
-
}
|
|
1135
|
+
subTitle?: string;
|
|
1086
1136
|
}
|
|
1087
1137
|
|
|
1088
|
-
export interface
|
|
1089
|
-
|
|
1138
|
+
export interface RuleGroupCreateRuleGroupParams {
|
|
1139
|
+
name: string;
|
|
1090
1140
|
|
|
1091
|
-
|
|
1141
|
+
organizationId: string;
|
|
1092
1142
|
|
|
1093
|
-
|
|
1143
|
+
websiteId: string;
|
|
1094
1144
|
|
|
1095
|
-
|
|
1145
|
+
isCollapsible?: boolean;
|
|
1096
1146
|
|
|
1097
|
-
|
|
1098
|
-
}
|
|
1147
|
+
isRequired?: boolean;
|
|
1099
1148
|
|
|
1100
|
-
|
|
1101
|
-
/**
|
|
1102
|
-
* End date to filter by (exclusive, less than)
|
|
1103
|
-
*/
|
|
1104
|
-
createdAtEnd?: string;
|
|
1149
|
+
sortId?: number;
|
|
1105
1150
|
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
*/
|
|
1109
|
-
createdAtStart?: string;
|
|
1110
|
-
|
|
1111
|
-
/**
|
|
1112
|
-
* Direction of the transaction entry to filter by
|
|
1113
|
-
*/
|
|
1114
|
-
direction?: 'credit' | 'debit';
|
|
1151
|
+
subTitle?: string;
|
|
1152
|
+
}
|
|
1115
1153
|
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
*/
|
|
1119
|
-
idempotencyKey?: string;
|
|
1154
|
+
export interface RuleGroupGetRuleGroupsParams {
|
|
1155
|
+
excludeHidden?: string;
|
|
1120
1156
|
|
|
1121
|
-
/**
|
|
1122
|
-
* Maximum number of records to return (max 1000)
|
|
1123
|
-
*/
|
|
1124
1157
|
limit?: number;
|
|
1125
1158
|
|
|
1126
|
-
/**
|
|
1127
|
-
* Unique identifier for the loyalty rule to filter by
|
|
1128
|
-
*/
|
|
1129
|
-
loyaltyRuleId?: string;
|
|
1130
|
-
|
|
1131
|
-
/**
|
|
1132
|
-
* Unique identifier for the loyalty transaction to filter by
|
|
1133
|
-
*/
|
|
1134
|
-
loyaltyTransactionId?: string;
|
|
1135
|
-
|
|
1136
|
-
/**
|
|
1137
|
-
* Field to order the results by
|
|
1138
|
-
*/
|
|
1139
|
-
orderBy?: 'createdAt' | 'updatedAt' | 'loyaltyAccountLockVersion';
|
|
1140
|
-
|
|
1141
|
-
/**
|
|
1142
|
-
* Unique identifier for the organization to filter by
|
|
1143
|
-
*/
|
|
1144
1159
|
organizationId?: string;
|
|
1145
1160
|
|
|
1146
|
-
/**
|
|
1147
|
-
* Pagination cursor to start after a specific resource ID
|
|
1148
|
-
*/
|
|
1149
1161
|
startingAfter?: string;
|
|
1150
1162
|
|
|
1151
|
-
/**
|
|
1152
|
-
* Type of the loyalty transaction to filter by
|
|
1153
|
-
*/
|
|
1154
|
-
type?: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
|
|
1155
|
-
|
|
1156
|
-
/**
|
|
1157
|
-
* When passed in return the list of fulfilled entries for loyalty rules. If a
|
|
1158
|
-
* loyalty rule has a fulfilled entry this means the user cannot currently complete
|
|
1159
|
-
* the rule. Must be passed in with userId or walletAddress.
|
|
1160
|
-
*/
|
|
1161
|
-
userCompletedLoyaltyRuleId?: string | Array<string>;
|
|
1162
|
-
|
|
1163
|
-
/**
|
|
1164
|
-
* External identifier for the user group controlled by you
|
|
1165
|
-
*/
|
|
1166
|
-
userGroupExternalIdentifier?: string;
|
|
1167
|
-
|
|
1168
|
-
/**
|
|
1169
|
-
* Unique identifier for the user group
|
|
1170
|
-
*/
|
|
1171
|
-
userGroupId?: string;
|
|
1172
|
-
|
|
1173
|
-
/**
|
|
1174
|
-
* User ID or array of User IDs to filter by
|
|
1175
|
-
*/
|
|
1176
|
-
userId?: string | Array<string>;
|
|
1177
|
-
|
|
1178
|
-
/**
|
|
1179
|
-
* Wallet address or array of wallet addresses to filter by
|
|
1180
|
-
*/
|
|
1181
|
-
walletAddress?: string | Array<string>;
|
|
1182
|
-
|
|
1183
|
-
/**
|
|
1184
|
-
* Identifier for the wallet group to filter by
|
|
1185
|
-
*/
|
|
1186
|
-
walletGroupIdentifier?: string;
|
|
1187
|
-
|
|
1188
|
-
/**
|
|
1189
|
-
* Unique identifier for the website to filter by
|
|
1190
|
-
*/
|
|
1191
1163
|
websiteId?: string;
|
|
1192
1164
|
}
|
|
1193
1165
|
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
Loyalty.Currencies = Currencies;
|
|
1197
|
-
Loyalty.Multipliers = Multipliers;
|
|
1198
|
-
Loyalty.RuleEdits = RuleEdits;
|
|
1199
|
-
Loyalty.Rules = Rules;
|
|
1200
|
-
Loyalty.Questions = Questions;
|
|
1201
|
-
Loyalty.QuestionsResponses = QuestionsResponses;
|
|
1166
|
+
export interface RuleGroupUpdateRuleGroupParams {
|
|
1167
|
+
isCollapsible?: boolean;
|
|
1202
1168
|
|
|
1203
|
-
|
|
1204
|
-
export {
|
|
1205
|
-
type LoyaltyCreateTransactionResponse as LoyaltyCreateTransactionResponse,
|
|
1206
|
-
type LoyaltyGetRuleGroupsResponse as LoyaltyGetRuleGroupsResponse,
|
|
1207
|
-
type LoyaltyListTransactionEntriesResponse as LoyaltyListTransactionEntriesResponse,
|
|
1208
|
-
type LoyaltyCreateTransactionParams as LoyaltyCreateTransactionParams,
|
|
1209
|
-
type LoyaltyGetRuleGroupsParams as LoyaltyGetRuleGroupsParams,
|
|
1210
|
-
type LoyaltyListTransactionEntriesParams as LoyaltyListTransactionEntriesParams,
|
|
1211
|
-
};
|
|
1169
|
+
name?: string | null;
|
|
1212
1170
|
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
type AccountListResponse as AccountListResponse,
|
|
1216
|
-
type AccountGetRankResponse as AccountGetRankResponse,
|
|
1217
|
-
type AccountListParams as AccountListParams,
|
|
1218
|
-
type AccountGetRankParams as AccountGetRankParams,
|
|
1219
|
-
};
|
|
1220
|
-
|
|
1221
|
-
export {
|
|
1222
|
-
Badges as Badges,
|
|
1223
|
-
type BadgeCreateResponse as BadgeCreateResponse,
|
|
1224
|
-
type BadgeUpdateResponse as BadgeUpdateResponse,
|
|
1225
|
-
type BadgeListResponse as BadgeListResponse,
|
|
1226
|
-
type BadgeDeleteResponse as BadgeDeleteResponse,
|
|
1227
|
-
type BadgeRevokeResponse as BadgeRevokeResponse,
|
|
1228
|
-
type BadgeRewardResponse as BadgeRewardResponse,
|
|
1229
|
-
type BadgeCreateParams as BadgeCreateParams,
|
|
1230
|
-
type BadgeUpdateParams as BadgeUpdateParams,
|
|
1231
|
-
type BadgeListParams as BadgeListParams,
|
|
1232
|
-
type BadgeRevokeParams as BadgeRevokeParams,
|
|
1233
|
-
type BadgeRewardParams as BadgeRewardParams,
|
|
1234
|
-
};
|
|
1235
|
-
|
|
1236
|
-
export {
|
|
1237
|
-
Currencies as Currencies,
|
|
1238
|
-
type CurrencyCreateResponse as CurrencyCreateResponse,
|
|
1239
|
-
type CurrencyListResponse as CurrencyListResponse,
|
|
1240
|
-
type CurrencyCreateParams as CurrencyCreateParams,
|
|
1241
|
-
type CurrencyListParams as CurrencyListParams,
|
|
1242
|
-
};
|
|
1243
|
-
|
|
1244
|
-
export {
|
|
1245
|
-
Multipliers as Multipliers,
|
|
1246
|
-
type MultiplierCreateResponse as MultiplierCreateResponse,
|
|
1247
|
-
type MultiplierUpdateResponse as MultiplierUpdateResponse,
|
|
1248
|
-
type MultiplierListResponse as MultiplierListResponse,
|
|
1249
|
-
type MultiplierDeleteResponse as MultiplierDeleteResponse,
|
|
1250
|
-
type MultiplierDeleteByExternalIDResponse as MultiplierDeleteByExternalIDResponse,
|
|
1251
|
-
type MultiplierCreateParams as MultiplierCreateParams,
|
|
1252
|
-
type MultiplierUpdateParams as MultiplierUpdateParams,
|
|
1253
|
-
type MultiplierListParams as MultiplierListParams,
|
|
1254
|
-
type MultiplierDeleteByExternalIDParams as MultiplierDeleteByExternalIDParams,
|
|
1255
|
-
};
|
|
1256
|
-
|
|
1257
|
-
export {
|
|
1258
|
-
RuleEdits as RuleEdits,
|
|
1259
|
-
type RuleEditListResponse as RuleEditListResponse,
|
|
1260
|
-
type RuleEditRestoreResponse as RuleEditRestoreResponse,
|
|
1261
|
-
type RuleEditListParams as RuleEditListParams,
|
|
1262
|
-
type RuleEditRestoreParams as RuleEditRestoreParams,
|
|
1263
|
-
};
|
|
1264
|
-
|
|
1265
|
-
export {
|
|
1266
|
-
Rules as Rules,
|
|
1267
|
-
type RuleCreateResponse as RuleCreateResponse,
|
|
1268
|
-
type RuleUpdateResponse as RuleUpdateResponse,
|
|
1269
|
-
type RuleListResponse as RuleListResponse,
|
|
1270
|
-
type RuleDeleteResponse as RuleDeleteResponse,
|
|
1271
|
-
type RuleCompleteResponse as RuleCompleteResponse,
|
|
1272
|
-
type RuleGetStatusResponse as RuleGetStatusResponse,
|
|
1273
|
-
type RuleCreateParams as RuleCreateParams,
|
|
1274
|
-
type RuleUpdateParams as RuleUpdateParams,
|
|
1275
|
-
type RuleListParams as RuleListParams,
|
|
1276
|
-
type RuleCompleteParams as RuleCompleteParams,
|
|
1277
|
-
type RuleGetStatusParams as RuleGetStatusParams,
|
|
1278
|
-
};
|
|
1279
|
-
|
|
1280
|
-
export {
|
|
1281
|
-
Questions as Questions,
|
|
1282
|
-
type QuestionCreateResponse as QuestionCreateResponse,
|
|
1283
|
-
type QuestionUpdateResponse as QuestionUpdateResponse,
|
|
1284
|
-
type QuestionListResponse as QuestionListResponse,
|
|
1285
|
-
type QuestionCreateParams as QuestionCreateParams,
|
|
1286
|
-
type QuestionUpdateParams as QuestionUpdateParams,
|
|
1287
|
-
type QuestionListParams as QuestionListParams,
|
|
1288
|
-
};
|
|
1171
|
+
subtitle?: string | null;
|
|
1172
|
+
}
|
|
1289
1173
|
|
|
1174
|
+
export declare namespace RuleGroups {
|
|
1290
1175
|
export {
|
|
1291
|
-
|
|
1292
|
-
type
|
|
1293
|
-
type
|
|
1294
|
-
type
|
|
1295
|
-
type
|
|
1176
|
+
type RuleGroupCreateRuleGroupResponse as RuleGroupCreateRuleGroupResponse,
|
|
1177
|
+
type RuleGroupDeleteRuleGroupResponse as RuleGroupDeleteRuleGroupResponse,
|
|
1178
|
+
type RuleGroupGetRuleGroupsResponse as RuleGroupGetRuleGroupsResponse,
|
|
1179
|
+
type RuleGroupUpdateRuleGroupResponse as RuleGroupUpdateRuleGroupResponse,
|
|
1180
|
+
type RuleGroupCreateRuleGroupParams as RuleGroupCreateRuleGroupParams,
|
|
1181
|
+
type RuleGroupGetRuleGroupsParams as RuleGroupGetRuleGroupsParams,
|
|
1182
|
+
type RuleGroupUpdateRuleGroupParams as RuleGroupUpdateRuleGroupParams,
|
|
1296
1183
|
};
|
|
1297
1184
|
}
|