:::caution The SDK code and documentation are in ALPHA state and are under heavy development. As a result, the apis are still in flux, and the documentation may be out of date with the code. :::
Emoji ID is a directory service that associates almost any type of structured data with a short, memorable identifier the emoji id.
This SDK is automatically generated by the OpenAPI Generator project:
:::note Until y.at is launched publically, the NPM package will not be available. You can contact the Yat team to obtain a copy of the javascript SDK while the project is in Alpha. :::
npm install yatjs --save
Finally, you need to build the module:
npm run build
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module". In this case you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
const yat = require('yatjs');
const api = new yat.YatJs();
async function runDemo() {
console.log(`Yat API calls will be made to ${api.basePath}`);
api.basePath = 'https://y.at/api;
console.log(`Changed base path. Now Yat API calls will be made to ${api.basePath}`);
try {
let res = await api.login("bob@example.com", "wrong_password");
console.log("Logged in (Should not see this): ", res);
} catch (res) {
console.log(`Could not log in: ${res.error}`);
try {
await api.users().getAccount(); // Not logged in, should throw an error
} catch (res) {
console.log(`Cannot access account: ${res.error}`);
}
}
try {
await api.login("test@yatlabs.com", "real_password");
console.log("Logged in.");
let account = await api.users().getAccount();
console.log("Account data:", account);
} catch (res) {
console.log(`Could not log in: ${res.error}`);
}
}
runDemo()
.then(() => console.log("Bye"))
.catch(console.error);
Once you have a YatJs instance, all the sub-APIs are accessed through getters, for example, the cart api is available as
yat.cart(). A full list of sub-APIs and their methods is:
| API accessor | Method | Description |
|---|---|---|
| apiKeys() | createApiKey | Create new api key for current user |
| apiKeys() | deleteApiKey | Delete provided api key |
| apiKeys() | listApiKeys | Load api keys for user |
| cart() | addItems | Update cart items by adding new items to the cart |
| cart() | applyPromoCode | Apply promo code |
| cart() | checkout | Checkout last payment cart |
| cart() | checkoutOrder | Checkout saved cart by id |
| cart() | clearCart | Remove all items from cart |
| cart() | convertOrderToDraft | Convert pending payment cart back into Draft status |
| cart() | deletePaymentMethods | Delete payment method |
| cart() | getItems | Return cart content |
| cart() | listPaymentMethods | Fetch payment methods for the user |
| cart() | removeItem | Removes an order item from the cart |
| discounts() | activateRandomYatCode | Use random yat code |
| discounts() | addPubkeyForCode | Add pubkey for code |
| discounts() | listCodes | Fetch codes |
| discounts() | revokePubkeyForCode | Revoke pubkey for code |
| emoji() | emojiList | List of supported emoji characters |
| emojiID() | editEmojiID | Edit EmojiId |
| emojiID() | emojiIDMetadata | |
| emojiID() | generateSignature | Generates a signature for the Yat allowing it to be minted |
| emojiID() | getStats | Get statistics for EmojiId |
| emojiID() | linkRedirect | Redirect by EmojiId link |
| emojiID() | listEmojiIDs | List user's Emoji Ids |
| emojiID() | listExtended | List extended view user's Emoji Ids |
| emojiID() | loadJson | Load value from EmojiId key value store |
| emojiID() | loadJsonIndex | Load value from EmojiId key value store with data keyed by YatJsonStoreKeys |
| emojiID() | lookupEmojiID | Lookup EmojiId |
| emojiID() | lookupEmojiIdTicker | Lookup EmojiId data based on a symbol or ticker |
| emojiID() | metadata | |
| emojiID() | random | Return random Emoji |
| emojiID() | recent | Return list of recently purchased emoji |
| emojiID() | rhythm | Calculate EmojiId rhythm score |
| emojiID() | searchEmojiID | Search for EmojiID |
| emojiID() | storeJson | Store value under EmojiId key |
| keyManagement() | addPubkey | Add pubkey for current user |
| keyManagement() | addPubkeyForUser | Add pubkey for user by user_id |
| keyManagement() | createWallet | Generate custodial wallet |
| keyManagement() | getPubkeys | Retrieve pubkeys |
| keyManagement() | getPubkeysForUser | Retrieve pubkeys by user_id |
| lootBoxType() | createType | Create a new lootbox category |
| lootBoxType() | generateLootBoxes | Generates a set of loot boxes |
| lootBoxType() | getTypes | List all loot box categories |
| lootBoxes() | createLootbox | Create a new lootbox |
| lootBoxes() | deleteLootbox | Delete a lootbox |
| lootBoxes() | listLootboxes | Fetch lootboxes |
| lootBoxes() | openLootbox | Open lootbox |
| lootBoxes() | showLootbox | Show information about lootbox |
| lootBoxes() | updateLootbox | Update a lootbox |
| organization() | getBranding | Load organization branding paramters |
| organization() | setBranding | Set organization branding parameters |
| proxy() | callProxy | Calls a pre-defined proxy service with the provided data |
| transfer() | deleteTransfer | Mark transfer request as deleted |
| transfer() | listFiltered | List outgoing transfer requests for current or specified user If limit is omitted will display top 50 transfer requests |
| transfer() | listIncoming | List transfer requests assigned to user |
| transfer() | receiverAcceptTransfer | As a receiver, accept transfer request by id. |
| transfer() | requestTransfer | Transfer eid to either the pubkey or email address supplied in the PUT data |
| transfer() | resendCode | Resend a new transfer OTP code for the current user, if the transfer allows it. |
| transfer() | senderAcceptTransfer | As a sender, confirm the transfer request by transfer id. |
| userAuthentication() | login | Login via password |
| userAuthentication() | logout | Invalidates all user's access tokens |
| userAuthentication() | magicLinkLogin | Generate magic link for login |
| userAuthentication() | refreshToken | Refresh access token |
| userAuthentication() | twoFactorAuthentication | Two factor authentication |
| userFeature() | readFeatures | List users features |
| userInterest() | deleteUserInterest | Destroys the user interest preventing this Emoji ID's notification emails from being sent for this user |
| userInterest() | getInterestedUsers | Returns a paginated list of user interest records associated with the user |
| userInterest() | getUserInterestForYat | Given an EmojiId returns information about the user interest if a record exists for this user |
| userInterest() | registerInterest | Create new interest in emoji to be notified when available |
| users() | backupDisable2FA | Disable choosen 2FA provider or disable completely using backup code and user primary ID |
| users() | confirm2FA | Confirm two factor authentication update |
| users() | createUser | Register a User |
| users() | deleteUser | Delete a user |
| users() | disable2FA | Disable choosen 2FA provider or disable completely |
| users() | enable2FA | Enables two factor authentication method |
| users() | getAccount | Current user account |
| users() | getAllUsers | List users |
| users() | load | Load user data for a session |
| users() | send2FASms | Send SMS 2FA code |
| users() | showUser | Show users |
| users() | updateAccount | Update the currently logged in user |
| users() | updateUserByAdmin | Update a user as an admin |
| wallets() | listWallets | Fetch associated wallet addresses for the user |
| wallets() | syncWallet | Associate new wallet address with user |
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | Confirmation OTP of either the sender or receiver of the transfer |
| Name | Type | Description | Notes |
|---|---|---|---|
| items | [AddItemsCartRequestItems] | New items to add to cart | |
| tracking_data | Object | Tracking data | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| emoji_id | String | EmojiID to buy |
| Name | Type | Description | Notes |
|---|---|---|---|
| status | String | Status lootbox will be created in If status is `Used` lootbox with be automatically opened | |
| yats | [String] | LootBox emoji IDs | |
| owner_email | String | Assign lootbox an owner with matching email Should not be set if owner_id is set | [optional] |
| owner_id | String | Lootbox owner_id, required for Owned and Used lootboxes | [optional] |
Draft (value: "Draft")
Available (value: "Available")
Owned (value: "Owned")
Used (value: "Used")
| Name | Type | Description | Notes |
|---|---|---|---|
| config | AdminNewLootBoxTypeConfig | ||
| description | String | A description for the loot box type | |
| name | String | the name of the loot box type |
| Name | Type | Description | Notes |
|---|---|---|---|
| guarantees | [AdminNewLootBoxTypeConfigGuarantees] | A set of guaranteed drops in this loot box type | |
| max_base_score | Number | The upper bound (inclusive) rhythm score for standard yats in the loot box | |
| max_length | Number | Maximum yat length | |
| min_base_score | Number | The lower bound (inclusive) rhythm score for standard yats in the loot box | |
| min_length | Number | Minimum yat length | |
| size | Number | The number of yats in the loot box | |
| weights | [AdminNewLootBoxTypeConfigWeights] | A set of probability weightings for chance-based drops |
| Name | Type | Description | Notes |
|---|---|---|---|
| count | Number | The number of guaranteed drops of this type in the loot box | |
| max_score | Number | The highest (inclusive) rhythm score range for guaranteed drop | |
| min_score | Number | The lowest (inclusive) rhythm score range for guaranteed drop |
| Name | Type | Description | Notes |
|---|---|---|---|
| ipr | Number | The inverse probability ratio. This is a 1:n value. i.e. an ipr of 5 means a 1 in 5 chance of occurring, or 20% | |
| max_score | Number | The highest (inclusive) rhythm score range for inclusion when the probability spec hits | |
| min_score | Number | The lowest (inclusive) rhythm score range for inclusion when the probability spec hits |
| Name | Type | Description | Notes |
|---|---|---|---|
| owner_email | String | Assign lootbox an owner with matching email Should not be set if owner_id is set | [optional] |
| owner_id | String | Assign lootbox an owner, if set requires status `Owned` | [optional] |
| status | String | Update status If status is `Used` lootbox with be automatically opened | [optional] |
| yats | [String] | LootBox emoji IDs | [optional] |
Draft (value: "Draft")
Available (value: "Available")
Owned (value: "Owned")
Used (value: "Used")
| Name | Type | Description | Notes |
|---|---|---|---|
| activation_source | String | Optional: Source of activation | [optional] |
| current_password | String | Optional: Current password, must be provided if one exists | [optional] |
| String | Optional: Email | [optional] | |
| first_name | String | Optional: First name | [optional] |
| free_limit | Number | Optional: Free limit for how many yats the user may purchase | [optional] |
| last_name | String | Optional: Last name | [optional] |
| password | String | Optional: User password | [optional] |
| role | String | Optional: Update the user role | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | Code to apply |
| Name | Type | Description | Notes |
|---|---|---|---|
| backup_code | String | Backup code | |
| alternate_id | String | Alternate identifier | [optional] |
| disable_all | Boolean | Make this method default | [optional] |
| String | [optional] | ||
| provider | String | Two factor authentication backend | [optional] |
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| method | String | Payment method type | |
| amount | Number | Amount paid in cash. Applicable and required only for `Cash` payment option for Admin. | [optional] |
| cancel_url | String | URL user will be redirected if payment cancelled Required for Stripe Checkout | [optional] |
| external_reference | String | External reference for cash payment. Applicable and required only for `Cash` payment option for Admin. | [optional] |
| pubkey | String | Optional: The user's public key to associate with this emoji id. If provided will use this pubkey otherwise will default to the first pubkey returned for the user. | [optional] |
| success_url | String | URL user will be redirected after successful payment Required for Stripe Checkout | [optional] |
| tracking_data | Object | Optional: tracking data | [optional] |
Free (value: "Free")
CoinbaseCommerce (value: "CoinbaseCommerce")
Stripe (value: "Stripe")
Cash (value: "Cash")
PayPal (value: "PayPal")
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | Two factor authentication code | |
| refresh_token | String | Refresh token obtained from login request |
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | Auth code of new 2FA provider |
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | ||
| expires_at | Date | [optional] | |
| scopes | [String] | [optional] |
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
| Name | Type | Description | Notes |
|---|---|---|---|
| features | [CurrentUserFeatures] | Enabled features for the user | |
| global_scopes | [String] | A list of fine-grained permissions the user may perform. | |
| organization_roles | {String: String} | The role this user has in each organisation. Organisations are currently not used, but are reserved for future operations. | |
| organization_scopes | {String: [String]} | The scopes that are granted to this user for each organisation. Organisations are currently not used, but are reserved for future operations. | |
| pending_transfers | [String] | List of transfers pending acceptance on current user side | |
| pubkeys | [String] | A list of this user's public keys. When yats are deployed to the blockchain, users prove ownership of their Yats with digital signatures, proving knowledge of the private keys that "own" the yat. In the centralised implementation of Yat, the server will custody the users' wallets and private keys, but in other respects the ownership model is the same. | |
| role | String | The role assigned to this user. Roles grant authority to user accounts to perform certain actions. | |
| user | CurrentUserUser | ||
| everflow_transaction_id | String | transaction id indicating if the user signed up from a partner via everflow redirect | [optional] |
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | ||
| id | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| free_limit | Number | ||
| id | String | ||
| pubkeys | [String] | ||
| remaining_free_emoji | Number | ||
| role | String | ||
| two_factor_should_prompt | Boolean | ||
| updated_at | Date | ||
| alternate_id | String | [optional] | |
| deactivated_at | Date | [optional] | |
| String | [optional] | ||
| email_verified_at | Date | [optional] | |
| first_name | String | [optional] | |
| last_name | String | [optional] | |
| source | String | [optional] | |
| two_factor_auth | [String] | [optional] | |
| two_factor_last_prompted_at | Date | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| disable_all | Boolean | Make this method default | |
| provider | String | Two factor authentication backend | [optional] |
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| api_key | String | ||
| created_at | Date | ||
| name | String | ||
| scopes | [String] | ||
| expires_at | Date | [optional] |
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | ||
| id | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| amount_overpaid_in_cents | Number | Amount overpaid in cents | |
| created_at | Date | A UTC timestamp for when this order was initially created. | |
| eligible_for_refund | Boolean | Whether an order is eligible for a refund via an admin. | |
| id | String | The unique identifier for this order | |
| misc_refunded_total_in_cents | Number | The total of miscellaneous refund amounts retirned to the order. | |
| order_items | [DisplayOrderOrderItems] | The list of individual line items making up this order. | |
| order_number | String | The order number is the last 8 characters of the order's ID for user display purposes. | |
| refunded_total_in_cents | Number | The total of refund amounts for the order. | |
| remaining_due_in_cents | Number | Remaining due in cents to mark the cart as Paid | |
| status | String | The order of the status. Orders start in 'Draft' status, then move to 'PendingPayment' and finally, 'Paid', unless they are 'Cancelled'. | |
| total_in_cents | Number | The sum of all the items in this order, plus fees, in USD cents. | |
| updated_at | Date | A UTC timestamp for the last time any field in this order was modified. | |
| user | DisplayOrderUser | ||
| user_id | String | The identifier of the user placing this order | |
| expires_at | Date | Checkout carts have a limited time before they expire. This prevents users from blocking inventory from being sold to other customers. The expiry time is configurable on the server and is typically 5 minutes. | [optional] |
| organization_id | String | The organization id of the user, if applicable. This will generally be null, unless the purchase is coming via a referral programme. | [optional] |
| paid_at | Date | A UTC timestamp for when payment for this order was received. Will be null if no payment has been made yet. | [optional] |
| payment_method_data | DisplayOrderPaymentMethodData | [optional] | |
| seconds_until_expiry | Number | A convenience field indicating how long before `expires_at` is reached. | [optional] |
Cancelled (value: "Cancelled")
Draft (value: "Draft")
Paid (value: "Paid")
PendingPayment (value: "PendingPayment")
| Name | Type | Description | Notes |
|---|---|---|---|
| client_fee_in_cents | Number | The fee attributable to the referral partner, in addition to the nominal unit price, in USD cents. | |
| company_fee_in_cents | Number | The fee attributable to the service host or company, in addition to the nominal unit price, in USD cents. | |
| created_at | Date | A UTC timestamp for when this order item was created. | |
| id | String | A unique identifier for this order item | |
| item_type | String | The type of order. Current enumerations are EmojiId and Discount | |
| order_id | String | The id of the order this order item | |
| quantity | Number | The number of items in the line order. For emoji id sales, this should always be one. | |
| refunded_quantity | Number | The number of items refunded. For emoji id sales, this should always at most be one. | |
| unit_price_in_cents | Number | The nominal, non-discounted price of the item, in USD cents. | |
| updated_at | Date | A UTC timestamp for when any field in the order item was modified. | |
| code_id | String | The code associated with this order item for providing a discount. | [optional] |
| emoji_id | Object | The emoji id that is being purchased | [optional] |
| main_id | String | Main item ID | [optional] |
| main_table | Object | Main item table | [optional] |
| marked_invalid_at | Date | A UTC timestamp for when this order item was marked as invalid. | [optional] |
| marked_invalid_at_reason | String | Marked invalid at reason Taken / PendingPurchase | [optional] |
| parent_id | String | Parent order item's ID, set for discounts and fees | [optional] |
| rhythm_score | Number | The rhythm score belonging to this order item, only set for order items containing EmojiIds. | [optional] |
Discount (value: "Discount")
LootBox (value: "LootBox")
EmojiId (value: "EmojiId")
Taken (value: "Taken")
PendingPurchase (value: "PendingPurchase")
| Name | Type | Description | Notes |
|---|---|---|---|
| client_secret | String | Client Secret for the `Stripe` method for Elements and Checkout | |
| method | String | Payment method | |
| methods | [DisplayOrderPaymentMethodDataMethods] | Metadata for `CoinbaseCommerce` payment method | |
| payment_intent_id | String | Payment method ID for `Stripe` method | |
| cancel_url | String | Cancel url for `Stripe` method when using Checkout | [optional] |
| invoice_id | String | Invoice ID for the `Stripe` method for Elements | [optional] |
| session_id | String | Invoice ID for the `Stripe` method for Checkout | [optional] |
| success_url | String | Success url for `Stripe` method when using Checkout | [optional] |
CoinbaseCommerce (value: "CoinbaseCommerce")
Stripe (value: "Stripe")
| Name | Type | Description | Notes |
|---|---|---|---|
| address | String | ||
| amount | Number | ||
| currency | String | ||
| title | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| free_limit | Number | ||
| id | String | ||
| pubkeys | [String] | ||
| remaining_free_emoji | Number | ||
| role | String | ||
| two_factor_should_prompt | Boolean | ||
| updated_at | Date | ||
| alternate_id | String | [optional] | |
| deactivated_at | Date | [optional] | |
| String | [optional] | ||
| email_verified_at | Date | [optional] | |
| first_name | String | [optional] | |
| last_name | String | [optional] | |
| source | String | [optional] | |
| two_factor_auth | [String] | [optional] | |
| two_factor_last_prompted_at | Date | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| clear_on_transfer | Boolean | ||
| created_at | Date | ||
| eid | String | ||
| String | |||
| id | String | ||
| recipient_id | String | ||
| accepted_at | Date | [optional] | |
| deleted_at | Date | [optional] | |
| message | String | [optional] | |
| sender_code_accepted_at | Date | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| free_limit | Number | ||
| id | String | ||
| pubkeys | [String] | ||
| remaining_free_emoji | Number | ||
| role | String | ||
| two_factor_should_prompt | Boolean | ||
| updated_at | Date | ||
| alternate_id | String | [optional] | |
| deactivated_at | Date | [optional] | |
| String | [optional] | ||
| email_verified_at | Date | [optional] | |
| first_name | String | [optional] | |
| last_name | String | [optional] | |
| source | String | [optional] | |
| two_factor_auth | [String] | [optional] | |
| two_factor_last_prompted_at | Date | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| emoji_ids | [String] | ||
| alternate_id | String | [optional] | |
| created_at | Date | [optional] | |
| deactivated_at | Date | [optional] | |
| String | [optional] | ||
| email_verified_at | Date | [optional] | |
| first_name | String | [optional] | |
| free_limit | Number | [optional] | |
| id | String | [optional] | |
| last_name | String | [optional] | |
| pubkeys | [String] | [optional] | |
| remaining_free_emoji | Number | [optional] | |
| role | String | [optional] | |
| source | String | [optional] | |
| two_factor_auth | [String] | [optional] | |
| two_factor_last_prompted_at | Date | [optional] | |
| two_factor_should_prompt | Boolean | [optional] | |
| updated_at | Date | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| delete | [String] | Optional: hashes of records to delete | [optional] |
| insert | [EditRequestInsert] | Optional: list of records to add | [optional] |
| merkle_root | String | Optional: merkle root (use WASM to generate) | [optional] |
| signature | String | Optional: signature (use WASM to generate) | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| data | String | Category data in text format | |
| tag | String | Category ID as a hex number |
| Name | Type | Description | Notes |
|---|---|---|---|
| status | Boolean | Response status. If true, the requested data will be in the result field, null otherwise | |
| error | EidResponseError | [optional] | |
| result | [EidResponseResult] | Records associated with EmojiID | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | Error code | |
| reason | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| data | String | Category data in text or hex encoded formats | |
| hash | String | Hash identifies record, can be used to delete records | |
| tag | String | Category as a hex string number |
| Name | Type | Description | Notes |
|---|---|---|---|
| canonical_format | String | ||
| chain_format | String | ||
| display_format | String | ||
| flippable_emoji | [Boolean] | ||
| generation | Number | ||
| minted | Boolean | ||
| rhythm_score | Number | ||
| shape | EmojiListItemShape | ||
| shortname | String | ||
| blocked_until | Date | [optional] | |
| token_id | Number | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| pattern | Object | [optional] | |
| shape | String | [optional] |
Repeaters (value: "Repeaters")
Eye Heart (value: "Eye Heart")
Bookends (value: "Bookends")
Adoptables (value: "Adoptables")
| Name | Type | Description | Notes |
|---|---|---|---|
| emoji_id | String | ||
| metrics | [EmojiStatsResponseMetrics] |
| Name | Type | Description | Notes |
|---|---|---|---|
| description | String | ||
| finish_date | Date | ||
| key | String | Counter object | |
| metric | String | Counter type | |
| start_date | Date | ||
| value | Number | Counter value |
| Name | Type | Description | Notes |
|---|---|---|---|
| default | Boolean | Make this method default | |
| provider | String | Two factor authentication backend | |
| phone | String | Phone number required for `SMS` provider | [optional] |
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| backup_codes | [String] | One time backup codes to login | [optional] |
| ga_qr_code_svg | String | GA secret as QR code in svg image | [optional] |
| ga_secret | String | GA base32 encoded secret, will be null when code is disabled | [optional] |
| phone_last_digits | String | Phone last digits | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| data | [ListOfCodeAvailabilityData] | [optional] | |
| paging | ListOfCodeAvailabilityPaging | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| total_uses | Number | ||
| activator | String | [optional] | |
| available | Number | [optional] | |
| code_type | String | [optional] | |
| created_at | Date | [optional] | |
| deleted_at | Date | [optional] | |
| discount_as_percentage | Number | [optional] | |
| discount_in_cents | Number | [optional] | |
| end_date | Date | [optional] | |
| id | String | [optional] | |
| max_emojis_per_user | Number | [optional] | |
| max_uses | Number | [optional] | |
| name | String | [optional] | |
| organization_id | String | [optional] | |
| pattern | Object | [optional] | |
| redemption_code | String | [optional] | |
| start_date | Date | [optional] | |
| updated_at | Date | [optional] |
RedemptionCode (value: "RedemptionCode")
SecretKey (value: "SecretKey")
Discount (value: "Discount")
RandomYat (value: "RandomYat")
| Name | Type | Description | Notes |
|---|---|---|---|
| dir | String | ||
| limit | Number | ||
| page | Number | ||
| sort | String | ||
| tags | {String: Object} | ||
| total | Number |
Asc (value: "Asc")
Desc (value: "Desc")
| Name | Type | Description | Notes |
|---|---|---|---|
| data | [ListOfDisplayTransferRequestData] | [optional] | |
| paging | ListOfCodeAvailabilityPaging | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| clear_on_transfer | Boolean | ||
| created_at | Date | ||
| eid | String | ||
| String | |||
| id | String | ||
| recipient_id | String | ||
| accepted_at | Date | [optional] | |
| deleted_at | Date | [optional] | |
| message | String | [optional] | |
| sender_code_accepted_at | Date | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| data | [ListOfDisplayUserExtendedData] | [optional] | |
| paging | ListOfCodeAvailabilityPaging | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| emoji_ids | [String] | ||
| alternate_id | String | [optional] | |
| created_at | Date | [optional] | |
| deactivated_at | Date | [optional] | |
| String | [optional] | ||
| email_verified_at | Date | [optional] | |
| first_name | String | [optional] | |
| free_limit | Number | [optional] | |
| id | String | [optional] | |
| last_name | String | [optional] | |
| pubkeys | [String] | [optional] | |
| remaining_free_emoji | Number | [optional] | |
| role | String | [optional] | |
| source | String | [optional] | |
| two_factor_auth | [String] | [optional] | |
| two_factor_last_prompted_at | Date | [optional] | |
| two_factor_should_prompt | Boolean | [optional] | |
| updated_at | Date | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| data | [ListOfPublicLootBoxData] | [optional] | |
| paging | ListOfCodeAvailabilityPaging | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| average_rhythm_score | Number | Average score of emoji IDs in loot box | |
| created_at | Date | ||
| id | String | ||
| prices | [Number] | The prices of the yats in the box, in cents | |
| scores | [Number] | The rhythm scores of the yats in the box | |
| status | String | Status loot box will be created in | |
| total_value | Number | Total value of EmojiIDs in the Loot Box | |
| yats | [String] | Loot box yats | |
| lootbox_type | ListOfPublicLootBoxLootboxType | [optional] | |
| lootbox_type_id | String | For Admin: The type of loot box, if applicable | [optional] |
| owner | ListOfPublicLootBoxOwner | [optional] | |
| owner_id | String | Loot box owner_id, required for Owned and Used loot boxes | [optional] |
Draft (value: "Draft")
Available (value: "Available")
Owned (value: "Owned")
Used (value: "Used")
| Name | Type | Description | Notes |
|---|---|---|---|
| config | ListOfPublicLootBoxLootboxTypeConfig | ||
| created_at | Date | The timestamp for when this loot box type was created | |
| description | String | A more detailed description of the loot box type | |
| id | String | The loot box type id | |
| name | String | The name of this loot box type |
| Name | Type | Description | Notes |
|---|---|---|---|
| guarantees | [AdminNewLootBoxTypeConfigGuarantees] | A set of guaranteed drops in this loot box type | |
| max_base_score | Number | The upper bound (inclusive) rhythm score for standard yats in the loot box | |
| max_length | Number | Maximum yat length | |
| min_base_score | Number | The lower bound (inclusive) rhythm score for standard yats in the loot box | |
| min_length | Number | Minimum yat length | |
| size | Number | The number of yats in the loot box | |
| weights | [AdminNewLootBoxTypeConfigWeights] | A set of probability weightings for chance-based drops |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| free_limit | Number | ||
| id | String | ||
| pubkeys | [String] | ||
| remaining_free_emoji | Number | ||
| role | String | ||
| two_factor_should_prompt | Boolean | ||
| updated_at | Date | ||
| alternate_id | String | [optional] | |
| deactivated_at | Date | [optional] | |
| String | [optional] | ||
| email_verified_at | Date | [optional] | |
| first_name | String | [optional] | |
| last_name | String | [optional] | |
| source | String | [optional] | |
| two_factor_auth | [String] | [optional] | |
| two_factor_last_prompted_at | Date | [optional] |
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| data | [ListOfUserInterestData] | [optional] | |
| paging | ListOfCodeAvailabilityPaging | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| emoji_id | String | ||
| id | String | ||
| updated_at | Date | ||
| user_id | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | Created at time for the record | |
| data | Object | Data value stored by key and EmojiID If there is no value for the key an empty object `{}` is returned | |
| is_locked | Boolean | Data is locked | |
| updated_at | Date | Updated at time for the record | |
| locked_future_writes_at | Date | Time the record was locked from future writes | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| current_user | LoadUserCurrentUser | ||
| editions | [Number] | ||
| extended_list | [LoadUserExtendedList] | ||
| incoming_transfers | [ListOfDisplayTransferRequestData] | ||
| outgoing_transfers | LoadUserOutgoingTransfers | ||
| wallets | [LoadUserWallets] | ||
| everflow_transaction_id | String | [optional] | |
| sidebar | Object | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| features | [CurrentUserFeatures] | Enabled features for the user | |
| global_scopes | [String] | A list of fine-grained permissions the user may perform. | |
| organization_roles | {String: String} | The role this user has in each organisation. Organisations are currently not used, but are reserved for future operations. | |
| organization_scopes | {String: [String]} | The scopes that are granted to this user for each organisation. Organisations are currently not used, but are reserved for future operations. | |
| pending_transfers | [String] | List of transfers pending acceptance on current user side | |
| pubkeys | [String] | A list of this user's public keys. When yats are deployed to the blockchain, users prove ownership of their Yats with digital signatures, proving knowledge of the private keys that "own" the yat. In the centralised implementation of Yat, the server will custody the users' wallets and private keys, but in other respects the ownership model is the same. | |
| role | String | The role assigned to this user. Roles grant authority to user accounts to perform certain actions. | |
| user | CurrentUserUser | ||
| everflow_transaction_id | String | transaction id indicating if the user signed up from a partner via everflow redirect | [optional] |
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
| Name | Type | Description | Notes |
|---|---|---|---|
| canonical_format | String | ||
| chain_format | String | ||
| display_format | String | ||
| flippable_emoji | [Boolean] | ||
| generation | Number | ||
| minted | Boolean | ||
| rhythm_score | Number | ||
| shape | EmojiListItemShape | ||
| shortname | String | ||
| blocked_until | Date | [optional] | |
| token_id | Number | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| data | [ListOfDisplayTransferRequestData] | [optional] | |
| paging | ListOfCodeAvailabilityPaging | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| eth_address | String | ||
| user_id | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| password | String | Required: Password | |
| alternate_id | String | Alternate identifier | [optional] |
| String | [optional] | ||
| g_recaptcha_response | String | Response from google Recaptcha | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| stats | [EmojiStatsResponseMetrics] | Number of times emoji viewed during past month | |
| error | EidResponseError | [optional] | |
| result | [EidResponseResult] | Records associated with EmojiID | [optional] |
| status | Boolean | Response status. If true, the requested data will be in the result field, null otherwise | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| loot_box_type_id | String | The id of the loot box type to generate | |
| num_boxes | Number | The number of loot boxes to generate in this sample |
| Name | Type | Description | Notes |
|---|---|---|---|
| loot_boxes | [ListOfPublicLootBoxData] | The set of loot boxes generated. The length of this array may be less than `num_requested` | |
| num_requested | Number | The number of loot boxes requested |
| Name | Type | Description | Notes |
|---|---|---|---|
| String | [optional] | ||
| g_recaptcha_response | String | Response from google Recaptcha | [optional] |
| redirect | String | Redirect path | [optional] |
| user_id | String | User ID | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| message | String | Message | |
| status | String | Status of requested user after completing the login request |
Active (value: "Active")
RegisteredInactive (value: "RegisteredInactive")
RegisteredActive (value: "RegisteredActive")
Inactive (value: "Inactive")
| Name | Type | Description | Notes |
|---|---|---|---|
| animation_url | String | ||
| attributes | [MetadataAttributes] | ||
| description | String | ||
| external_link | String | ||
| image | String | ||
| name | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| trait_type | String | ||
| value | Object |
| Name | Type | Description | Notes |
|---|---|---|---|
| emoji_id | String | Emoji ID to express interest in |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| currencies | [String] | ||
| name | String | ||
| organization_id | String | ||
| requires_email | Boolean | ||
| return_link | String | ||
| updated_at | Date | ||
| logo | String | [optional] | |
| logo_small | String | [optional] | |
| logo_thumbnail | String | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | ||
| payment_type | String | ||
| brand | String | [optional] | |
| country | String | [optional] | |
| exp_month | Number | [optional] | |
| exp_year | Number | [optional] | |
| last4 | String | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| service | String | `ProxyService` type | |
| data | String | The data to pass through to the proxied service | [optional] |
Echo (value: "Echo")
Scraper (value: "Scraper")
| Name | Type | Description | Notes |
|---|---|---|---|
| json | Object | The response from the proxied service as a Json object | |
| value | String | The response from the proxied service as a String |
| Name | Type | Description | Notes |
|---|---|---|---|
| average_rhythm_score | Number | Average score of emoji IDs in loot box | |
| created_at | Date | ||
| id | String | ||
| prices | [Number] | The prices of the yats in the box, in cents | |
| scores | [Number] | The rhythm scores of the yats in the box | |
| status | String | Status loot box will be created in | |
| total_value | Number | Total value of EmojiIDs in the Loot Box | |
| yats | [String] | Loot box yats | |
| lootbox_type | ListOfPublicLootBoxLootboxType | [optional] | |
| lootbox_type_id | String | For Admin: The type of loot box, if applicable | [optional] |
| owner | ListOfPublicLootBoxOwner | [optional] | |
| owner_id | String | Loot box owner_id, required for Owned and Used loot boxes | [optional] |
Draft (value: "Draft")
Available (value: "Available")
Owned (value: "Owned")
Used (value: "Used")
| Name | Type | Description | Notes |
|---|---|---|---|
| config | ListOfPublicLootBoxLootboxTypeConfig | ||
| created_at | Date | The timestamp for when this loot box type was created | |
| description | String | A more detailed description of the loot box type | |
| id | String | The loot box type id | |
| name | String | The name of this loot box type |
| Name | Type | Description | Notes |
|---|---|---|---|
| result | [RandomResultResult] | Random Emoji IDs |
| Name | Type | Description | Notes |
|---|---|---|---|
| availability | String | The availability state of this emoji | |
| available | Boolean | Whether the Emoji ID is available for purchase | |
| emoji_id | String | Emoji ID in canonical form | |
| flippable_emoji | [Boolean] | Which emoji are flippable | |
| length | Number | Canonical EmojiID length in emojis | |
| minted | Boolean | If this Emoji is minted | |
| rhythm_score | Number | EmojiID rhythm score | |
| shape | EmojiListItemShape | ||
| short_names | [String] | Emoji key words | |
| stats | [EmojiStatsResponseMetrics] | Total lookups using this API, if someone is viewing this Emoji ID using their own self hosted node, it will not be counted here | |
| copy | Object | EmojiID copy text | [optional] |
| generation | Number | The generation of the Yat, if it has been purchased. | [optional] |
| origin | String | The origin of the Yat if it was from a Prism Case | [optional] |
| price | Number | Pricing in US cents, e.g. 1024 is 10.24 USD. Price is 0 if the emoji is not available | [optional] |
Available (value: "Available")
Taken (value: "Taken")
InCart (value: "InCart")
ComingSoon (value: "ComingSoon")
NoPrice (value: "NoPrice")
| Name | Type | Description | Notes |
|---|---|---|---|
| nonce | String | Schnorr signature nonce as a hex string | |
| pubkey | String | Public key to authorize usage of a code | |
| signature | String | Schnorr signature as a hex with alternate_id as a challenge | |
| tracking_data | Object | Custom tracking data to be associated with a purchase | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| result | [RandomResultResult] | Recently purchased emoji |
| Name | Type | Description | Notes |
|---|---|---|---|
| refresh_token | String | Refresh token obtained from login request |
| Name | Type | Description | Notes |
|---|---|---|---|
| activate | Boolean | Optional: Whether to force activation during creation (requires UserActivate scope) | [optional] |
| activation_source | String | Optional: Source of activation (requires UserActivate scope) | [optional] |
| alternate_id | String | Alternate identifier | [optional] |
| String | Email address | [optional] | |
| first_name | String | Optional: first name | [optional] |
| g_recaptcha_response | String | Response from google Recaptcha | [optional] |
| last_name | String | Optional: last name | [optional] |
| partner_conversion_id | String | Parameter to pass everflow click id | [optional] |
| password | String | Optional: password | [optional] |
| source | String | Required when registering with `alternate_id`, source for non custodial user | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| rhythm | Number | The yat rhythm score, a number between 1 (least prestigious) and 100 (most prestigious) |
| Name | Type | Description | Notes |
|---|---|---|---|
| alternates | [RandomResultResult] | Alternative Emoji IDs | |
| result | SearchResultResult |
| Name | Type | Description | Notes |
|---|---|---|---|
| availability | String | The availability state of this emoji | |
| available | Boolean | Whether the Emoji ID is available for purchase | |
| emoji_id | String | Emoji ID in canonical form | |
| flippable_emoji | [Boolean] | Which emoji are flippable | |
| length | Number | Canonical EmojiID length in emojis | |
| minted | Boolean | If this Emoji is minted | |
| rhythm_score | Number | EmojiID rhythm score | |
| shape | EmojiListItemShape | ||
| short_names | [String] | Emoji key words | |
| stats | [EmojiStatsResponseMetrics] | Total lookups using this API, if someone is viewing this Emoji ID using their own self hosted node, it will not be counted here | |
| copy | Object | EmojiID copy text | [optional] |
| generation | Number | The generation of the Yat, if it has been purchased. | [optional] |
| origin | String | The origin of the Yat if it was from a Prism Case | [optional] |
| price | Number | Pricing in US cents, e.g. 1024 is 10.24 USD. Price is 0 if the emoji is not available | [optional] |
Available (value: "Available")
Taken (value: "Taken")
InCart (value: "InCart")
ComingSoon (value: "ComingSoon")
NoPrice (value: "NoPrice")
| Name | Type | Description | Notes |
|---|---|---|---|
| pattern | Object | [optional] | |
| shape | String | [optional] |
Repeaters (value: "Repeaters")
Eye Heart (value: "Eye Heart")
Bookends (value: "Bookends")
Adoptables (value: "Adoptables")
| Name | Type | Description | Notes |
|---|---|---|---|
| account | String | ||
| expiry | Number | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| account | String | ||
| expiry | Number | ||
| signature | String | ||
| token | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| data | Object | Data value allows to store any Json value, limited by 250Kb | |
| linked_tags | [EditRequestInsert] | Link tag items as part of the transaction All previously linked tags not present in new request will be deleted | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| message | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| message | String | ||
| phone_last_digits | String | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| access_token | String | Access token | |
| has_password | Boolean | Has a password set | |
| refresh_token | String | Refresh token, only required for 2FA (???) | |
| requires_2fa | String | Whether has 2FA enabled or not | [optional] |
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| clear_on_transfer | Boolean | Clear emoji data when emoji transferred to destination | |
| eid | String | ||
| String | Transfer to specified email, would register new user account if not existent | ||
| force_transfer | Boolean | Admin can force transfer, for regular user it has no effect | |
| message | String | Message displayed to recipient and included in the invitiation email | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| everflow_transaction_id | String | transaction id indicating if the user signed up from a partner via everflow redirect | [optional] |
| features | [CurrentUserFeatures] | Enabled features for the user | [optional] |
| global_scopes | [String] | A list of fine-grained permissions the user may perform. | [optional] |
| organization_roles | {String: String} | The role this user has in each organisation. Organisations are currently not used, but are reserved for future operations. | [optional] |
| organization_scopes | {String: [String]} | The scopes that are granted to this user for each organisation. Organisations are currently not used, but are reserved for future operations. | [optional] |
| pending_transfers | [String] | List of transfers pending acceptance on current user side | [optional] |
| pubkeys | [String] | A list of this user's public keys. When yats are deployed to the blockchain, users prove ownership of their Yats with digital signatures, proving knowledge of the private keys that "own" the yat. In the centralised implementation of Yat, the server will custody the users' wallets and private keys, but in other respects the ownership model is the same. | [optional] |
| role | String | The role assigned to this user. Roles grant authority to user accounts to perform certain actions. | [optional] |
| token_response | UpdateAccountResponseTokenResponse | [optional] | |
| user | CurrentUserUser | [optional] |
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
adminCart:update (value: "adminCart:update")
adminEmoji:destroy (value: "adminEmoji:destroy")
adminEmoji:load (value: "adminEmoji:load")
adminEmoji:register (value: "adminEmoji:register")
adminEmoji:transfer (value: "adminEmoji:transfer")
adminEmoji:updateFeatures (value: "adminEmoji:updateFeatures")
adminEmoji:updateSecureData (value: "adminEmoji:updateSecureData")
adminEmoji:write (value: "adminEmoji:write")
adminFeatureUser:read (value: "adminFeatureUser:read")
adminInvites:write (value: "adminInvites:write")
adminInvites:list (value: "adminInvites:list")
adminLootbox:read (value: "adminLootbox:read")
adminLootbox:write (value: "adminLootbox:write")
adminNotifications:write (value: "adminNotifications:write")
adminUser:bypass2fa (value: "adminUser:bypass2fa")
adminUser:load (value: "adminUser:load")
adminUser:loginAs (value: "adminUser:loginAs")
adminUser:twoFactorAuthDestroy (value: "adminUser:twoFactorAuthDestroy")
adminUser:roleUpdate (value: "adminUser:roleUpdate")
cart:show (value: "cart:show")
cart:update (value: "cart:update")
code:delete (value: "code:delete")
code:read (value: "code:read")
code:write (value: "code:write")
user:createApiKey (value: "user:createApiKey")
domainAction:read (value: "domainAction:read")
domainEvent:read (value: "domainEvent:read")
edition:delete (value: "edition:delete")
edition:read (value: "edition:read")
edition:write (value: "edition:write")
emojiGroups:delete (value: "emojiGroups:delete")
emojiGroups:read (value: "emojiGroups:read")
emojiGroups:write (value: "emojiGroups:write")
emoji::transfer (value: "emoji::transfer")
feature::delete (value: "feature::delete")
feature::read (value: "feature::read")
feature::write (value: "feature::write")
lootbox:use (value: "lootbox:use")
order:paymentOverride (value: "order:paymentOverride")
order:read (value: "order:read")
order:readSelf (value: "order:readSelf")
order:refund (value: "order:refund")
order:refundOverride (value: "order:refundOverride")
order:resendConfirmation (value: "order:resendConfirmation")
organization:admin (value: "organization:admin")
organizationCode:admin (value: "organizationCode:admin")
organizationEmoji:list (value: "organizationEmoji:list")
organizationEmoji:write (value: "organizationEmoji:write")
organizationList:read (value: "organizationList:read")
organization:read (value: "organization:read")
organizationUser:admin (value: "organizationUser:admin")
organizationUser:read (value: "organizationUser:read")
organization:write (value: "organization:write")
nftSignature:write (value: "nftSignature:write")
nftToken:destroy (value: "nftToken:destroy")
nftTransfer:read (value: "nftTransfer:read")
paymentMethod:destroy (value: "paymentMethod:destroy")
paymentMethod:read (value: "paymentMethod:read")
paymentMethod:setDefault (value: "paymentMethod:setDefault")
adminPriceParameters:read (value: "adminPriceParameters:read")
adminPriceParameters:write (value: "adminPriceParameters:write")
refund:read (value: "refund:read")
token:refresh (value: "token:refresh")
auth:twoFactor (value: "auth:twoFactor")
user:activate (value: "user:activate")
userData:update (value: "userData:update")
user:delete (value: "user:delete")
user:deleteSelf (value: "user:deleteSelf")
userEmail:verify (value: "userEmail:verify")
userEmoji:list (value: "userEmoji:list")
userInterest:delete (value: "userInterest:delete")
userInterest:read (value: "userInterest:read")
userInterest:write (value: "userInterest:write")
user:list (value: "user:list")
userPubkeys:list (value: "userPubkeys:list")
userPubkeys:write (value: "userPubkeys:write")
user:show (value: "user:show")
user:write (value: "user:write")
user:writeSelf (value: "user:writeSelf")
Admin (value: "Admin")
OrgController (value: "OrgController")
OrgMember (value: "OrgMember")
OrgOwner (value: "OrgOwner")
Bot (value: "Bot")
Super (value: "Super")
User (value: "User")
| Name | Type | Description | Notes |
|---|---|---|---|
| access_token | String | Access token | |
| has_password | Boolean | Has a password set | |
| refresh_token | String | Refresh token, only required for 2FA (???) | |
| requires_2fa | String | Whether has 2FA enabled or not | [optional] |
GoogleAuthenticator (value: "GoogleAuthenticator")
SMS (value: "SMS")
| Name | Type | Description | Notes |
|---|---|---|---|
| currencies | [String] | ||
| return_link | String | ||
| logo | String | [optional] | |
| logo_small | String | [optional] | |
| logo_thumbnail | String | [optional] | |
| requires_email | Boolean | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| current_password | String | Optional: Current password, must be provided if one exists | [optional] |
| String | Optional: Email | [optional] | |
| first_name | String | Optional: First name | [optional] |
| last_name | String | Optional: Last name | [optional] |
| password | String | Optional: User password | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | Date | ||
| emoji_id | String | ||
| id | String | ||
| updated_at | Date | ||
| user_id | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| eth_address | String | ||
| user_id | String |
| Name | Type | Description | Notes |
|---|---|---|---|
| signature | String | ||
| source | String |
Mint (value: "Mint")
Dashboard (value: "Dashboard")
FAQs
Bindings for the Yat API for javascript
We found that yatjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.