Kotlin SDK

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:

• API version: 0.2.262
• Build package: org.openapitools.codegen.languages.KotlinClientCodegen

Requires

• Kotlin 1.3.61
• Gradle 4.9

Installation

note

Until y.at is launched publically, the dependency will not be available on public Maven repositories. You can contact the Yat team to obtain a copy of the Kotlin SDK while the project is in Alpha.

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Configuring the SDK

Base URL

You can set the base URL for the API through the static property ApiClient.baseUrl.

import com.yatlabs.yat.infrastructure.ApiClient
fun setup() {    ApiClient.baseUrl = "https://y.at/api"}

Token Storage

When you authenticate with the Yat API, you will receive a pair of tokens: an access token and a refresh token.

import com.yatlabs.yat.apis.UserAuthenticationApiimport com.yatlabs.yat.models.LoginRequest
fun main() {    val tokenPair = UserAuthenticationApi.shared.login(        LoginRequest(            email = email,            password = password        )    )    println("Access token: ${tokenPair.accessToken}")    println("Refresh token: ${tokenPair.refreshToken}")}

Yat Kotlin SDK manages the storage of your token pair and refreshes the access token when it expires. Tokens are stored in the memory by default. If you would like to override this behavior and manage the storage of the tokens yourself, override the com.yatlabs.yat.infrastructure.TokenStorage interface, and pass an instance to the ApiClient as in the Android example below.

import android.content.SharedPreferencesimport com.yatlabs.yat.infrastructure.ApiClientimport com.yatlabs.yat.infrastructure.TokenStorage
class SharedPrefsTokenStorage(prefs: SharedPreferences): TokenStorage {
    override var accessToken: String?        get() = prefs.getString("access_token", null)        set(value) = prefs.edit().run {            putString("access_token", value)            apply()        }
    override var refreshToken: String?        get() = prefs.getString("refresh_token", null)        set(value) = prefs.edit().run {            putString("refresh_token", value)            apply()        }
}
fun setup() {    ApiClient.baseUrl = "https://y.at/api"    ApiClient.tokenStorage = SharedPrefsTokenStorage(prefs = appSharedPrefs)}

Logging

You can change the logging level for the HTTP requests by setting the ApiClient.logLevel static property.

import com.yatlabs.yat.infrastructure.ApiClientimport okhttp3.logging.HttpLoggingInterceptor

fun setup() {    ApiClient.logLevel = HttpLoggingInterceptor.Level.BODY}

Logging levels are as below:

Log Level	Description
NONE	No logs.
BASIC	Logs request and response lines.
HEADERS	Logs request and response lines and their respective headers.
BODY	Logs request and response lines and their respective headers and bodies (if present).

Getting Started

Please follow the installation instruction and execute the following Kotlin code:

import com.yatlabs.yat.infrastructure.ApiClientimport com.yatlabs.yat.apis.*import com.yatlabs.yat.models.*
fun runDemo() {    println("Yat API calls will be made to ${ApiClient.baseUrl}")    ApiClient.baseUrl = "https://y.at/api"    println("Changed base path. Now Yat API calls will be made to ${ApiClient.baseUrl}");
    try {        val res = UserAuthenticationApi.shared.login(            LoginRequest(                email = "[email protected]",                password = "wrong_password"            )        )        println("Logged in (Should not see this): $res")    } catch (exception: Exception) {        println("Could not login: ${exception.message}")        try {            UsersApi.shared.getAccount() // Not logged in, should throw an error        } catch (exception: Exception) {            println("Cannot access account: ${exception.message}");        }    }
    try {        UserAuthenticationApi.shared.login(            LoginRequest(                email = "[email protected]",                password = "real_password"            )        )        println("Logged in.")        val account = UsersApi.shared.getAccount()        println("Account data: $account")    } catch (exception: Exception) {        println("Could not log in: ${exception.message}");    }}
fun main() {    runDemo()    println("Bye")}

Documentation for API Endpoints

All paths are relative to the API base URL, which is set through the ApiClient.baseUrl static property as previously described.

Class	Method	HTTP request	Description
ApiKeysApi	createApiKey	POST /api_keys	Create new api key for current user
ApiKeysApi	deleteApiKey	DELETE /api_keys/{id}	Delete provided api key
ApiKeysApi	listApiKeys	GET /api_keys	Load api keys for user
CartApi	addItems	POST /cart	Update cart items by adding new items to the cart
CartApi	applyPromoCode	POST /cart/promo_code	Apply promo code
CartApi	checkout	POST /cart/checkout	Checkout last payment cart
CartApi	checkoutOrder	POST /cart/checkout/{id}	Checkout saved cart by id
CartApi	clearCart	DELETE /cart	Remove all items from cart
CartApi	convertOrderToDraft	POST /cart/convert_to_draft	Convert pending payment cart back into Draft status
CartApi	deletePaymentMethods	DELETE /payment_methods/{id}	Delete payment method
CartApi	getItems	GET /cart	Return cart content
CartApi	listPaymentMethods	GET /payment_methods	Fetch payment methods for the user
CartApi	removeItem	DELETE /cart/cart_items/{cart_item_id}	Removes an order item from the cart
DiscountsApi	activateRandomYatCode	POST /codes/{code_id}/random_yat	Use random yat code
DiscountsApi	addPubkeyForCode	POST /codes/{code_id}/pubkeys/{pubkey}	Add pubkey for code
DiscountsApi	listCodes	GET /codes	Fetch codes
DiscountsApi	revokePubkeyForCode	DELETE /codes/{code_id}/pubkeys/{pubkey}	Revoke pubkey for code
EmojiApi	emojiList	GET /emoji	List of supported emoji characters
EmojiIDApi	editEmojiID	PATCH /emoji_id/{emoji_id}	Edit EmojiId
EmojiIDApi	emojiIDMetadata	GET /emoji_id/{emoji_id}/metadata
EmojiIDApi	generateSignature	POST /emoji_id/{emoji_id}/generate_signature	Generates a signature for the Yat allowing it to be minted
EmojiIDApi	getStats	GET /emoji_id/{eid}/stats	Get statistics for EmojiId
EmojiIDApi	linkRedirect	GET /redirect	Redirect by EmojiId link
EmojiIDApi	listEmojiIDs	GET /emoji_id	List user's Emoji Ids
EmojiIDApi	listExtended	GET /emoji_id/extended	List extended view user's Emoji Ids
EmojiIDApi	loadJson	GET /emoji_id/{eid}/json/{key}	Load value from EmojiId key value store
EmojiIDApi	loadJsonIndex	GET /emoji_id/{eid}/json	Load value from EmojiId key value store with data keyed by YatJsonStoreKeys
EmojiIDApi	lookupEmojiID	GET /emoji_id/{emoji_id}	Lookup EmojiId
EmojiIDApi	lookupEmojiIDPayment	GET /emoji_id/{emoji_id}/payment	Lookup EmojiId Payment addresses
EmojiIDApi	lookupEmojiIdTicker	GET /emoji_id/{emoji_id}/{tag}	Lookup EmojiId data based on a symbol or ticker
EmojiIDApi	metadata	GET /nft_transfers/metadata/{token_id}
EmojiIDApi	random	GET /emoji_id/random	Return random Emoji
EmojiIDApi	recent	GET /emoji_id/recent	Return list of recently purchased emoji
EmojiIDApi	rhythm	GET /emoji_id/{emoji_id}/rhythm	Calculate EmojiId rhythm score
EmojiIDApi	searchEmojiID	GET /emoji_id/search	Search for EmojiID
EmojiIDApi	storeJson	POST /emoji_id/{eid}/json/{key}	Store value under EmojiId key
KeyManagementApi	addPubkey	POST /pubkeys/{pubkey}	Add pubkey for current user
KeyManagementApi	addPubkeyForUser	POST /users/{user_id}/pubkeys/{pubkey}	Add pubkey for user by user_id
KeyManagementApi	createWallet	POST /pubkeys	Generate custodial wallet
KeyManagementApi	getPubkeys	GET /pubkeys	Retrieve pubkeys
KeyManagementApi	getPubkeysForUser	GET /users/{user_id}/pubkeys	Retrieve pubkeys by user_id
LootBoxTypeApi	createType	POST /lootbox_type	Create a new lootbox category
LootBoxTypeApi	generateLootBoxes	POST /lootbox_type/generate	Generates a set of loot boxes
LootBoxTypeApi	getTypes	GET /lootbox_type	List all loot box categories
LootBoxesApi	createLootbox	POST /lootboxes	Create a new lootbox
LootBoxesApi	deleteLootbox	DELETE /lootboxes/{id}	Delete a lootbox
LootBoxesApi	listLootboxes	GET /lootboxes	Fetch lootboxes
LootBoxesApi	openLootbox	POST /lootboxes/{id}/open	Open lootbox
LootBoxesApi	showLootbox	GET /lootboxes/{id}	Show information about lootbox
LootBoxesApi	updateLootbox	PATCH /lootboxes/{id}	Update a lootbox
OrganizationApi	getBranding	GET /organizations/{id}/branding	Load organization branding paramters
OrganizationApi	setBranding	PUT /organizations/{id}/branding	Set organization branding parameters
ProxyApi	callProxy	POST /proxy	Calls a pre-defined proxy service with the provided data
TransferApi	deleteTransfer	DELETE /transfers/{transfer_id}	Mark transfer request as deleted
TransferApi	listFiltered	GET /transfers	List outgoing transfer requests for current or specified user If limit is omitted will display top 50 transfer requests
TransferApi	listIncoming	GET /transfers/incoming	List transfer requests assigned to user
TransferApi	receiverAcceptTransfer	POST /transfers/{transfer_id}/receiver_accept	As a receiver, accept transfer request by id.
TransferApi	requestTransfer	POST /transfers	Transfer eid to either the pubkey or email address supplied in the PUT data
TransferApi	resendCode	POST /transfers/{transfer_id}/resend_code	Resend a new transfer OTP code for the current user, if the transfer allows it.
TransferApi	senderAcceptTransfer	POST /transfers/{transfer_id}/sender_accept	As a sender, confirm the transfer request by transfer id.
UserAuthenticationApi	login	POST /auth/token	Login via password
UserAuthenticationApi	logout	POST /logout	Invalidates all user's access tokens
UserAuthenticationApi	magicLinkLogin	POST /auth/magic_link	Generate magic link for login
UserAuthenticationApi	refreshToken	POST /auth/token/refresh	Refresh access token
UserAuthenticationApi	twoFactorAuthentication	POST /auth/2fa	Two factor authentication
UserFeatureApi	readFeatures	GET /user_features	List users features
UserInterestApi	deleteUserInterest	DELETE /user_interests/{emoji_id}	Destroys the user interest preventing this Emoji ID's notification emails from being sent for this user
UserInterestApi	getInterestedUsers	GET /user_interests	Returns a paginated list of user interest records associated with the user
UserInterestApi	getUserInterestForYat	GET /user_interests/{emoji_id}	Given an EmojiId returns information about the user interest if a record exists for this user
UserInterestApi	registerInterest	POST /user_interests	Create new interest in emoji to be notified when available
UsersApi	backupDisable2FA	POST /account/2fa/backup_disable	Disable choosen 2FA provider or disable completely using backup code and user primary ID
UsersApi	confirm2FA	POST /account/2fa/confirm	Confirm two factor authentication update
UsersApi	createUser	POST /users	Register a User
UsersApi	deleteUser	DELETE /users/{id}	Delete a user
UsersApi	disable2FA	POST /account/2fa/disable	Disable choosen 2FA provider or disable completely
UsersApi	enable2FA	POST /account/2fa/enable	Enables two factor authentication method
UsersApi	getAccount	GET /account	Current user account
UsersApi	getAllUsers	GET /users	List users
UsersApi	load	GET /account/load	Load user data for a session
UsersApi	send2FASms	POST /account/2fa/sms_code	Send SMS 2FA code
UsersApi	showUser	GET /users/{id}	Show users
UsersApi	updateAccount	PATCH /account	Update the currently logged in user
UsersApi	updateUserByAdmin	PATCH /users/{id}	Update a user as an admin
WalletsApi	listWallets	GET /wallets	Fetch associated wallet addresses for the user
WalletsApi	syncWallet	POST /wallets	Associate new wallet address with user

Documentation for Models

AcceptTransfer

Properties

Name	Type	Description	Notes
code	kotlin.String	Confirmation OTP of either the sender or receiver of the transfer

AddItemsCartRequest

Properties

Name	Type	Description	Notes
items	kotlin.collections.List<AddItemsCartRequestItems>	New items to add to cart
trackingData	kotlin.Any	Tracking data	[optional]

AddItemsCartRequestItems

Properties

Name	Type	Description	Notes
emojiId	kotlin.String	EmojiID to buy

AdminNewLootBoxBody

Properties

Name	Type	Description	Notes
status	inline
Status lootbox will be created in If status is `Used` lootbox with be automatically opened
yats	kotlin.collections.List<kotlin.String>	LootBox emoji IDs
ownerEmail	kotlin.String	Assign lootbox an owner with matching email Should not be set if owner_id is set	[optional]
ownerId	java.util.UUID	Lootbox owner_id, required for Owned and Used lootboxes	[optional]

Enum: status

Name	Value
status	Draft, Available, Owned, Used

AdminNewLootBoxType

Properties

Name	Type	Description	Notes
config	AdminNewLootBoxTypeConfig
description	kotlin.String	A description for the loot box type
name	kotlin.String	the name of the loot box type

AdminNewLootBoxTypeConfig

Properties

Name	Type	Description	Notes
guarantees	kotlin.collections.List<AdminNewLootBoxTypeConfigGuarantees>	A set of guaranteed drops in this loot box type
maxBaseScore	kotlin.Long	The upper bound (inclusive) rhythm score for standard yats in the loot box
maxLength	kotlin.Long	Maximum yat length
minBaseScore	kotlin.Long	The lower bound (inclusive) rhythm score for standard yats in the loot box
minLength	kotlin.Long	Minimum yat length
size	kotlin.Long	The number of yats in the loot box
weights	kotlin.collections.List<AdminNewLootBoxTypeConfigWeights>	A set of probability weightings for chance-based drops

AdminNewLootBoxTypeConfigGuarantees

Properties

Name	Type	Description	Notes
count	kotlin.Long	The number of guaranteed drops of this type in the loot box
maxScore	kotlin.Long	The highest (inclusive) rhythm score range for guaranteed drop
minScore	kotlin.Long	The lowest (inclusive) rhythm score range for guaranteed drop

AdminNewLootBoxTypeConfigWeights

Properties

Name	Type	Description	Notes
ipr	kotlin.Double	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%
maxScore	kotlin.Long	The highest (inclusive) rhythm score range for inclusion when the probability spec hits
minScore	kotlin.Long	The lowest (inclusive) rhythm score range for inclusion when the probability spec hits

AdminUpdateLootBoxBody

Properties

Name	Type	Description	Notes
ownerEmail	kotlin.String	Assign lootbox an owner with matching email Should not be set if owner_id is set	[optional]
ownerId	java.util.UUID	Assign lootbox an owner, if set requires status `Owned`	[optional]
status	inline
Update status If status is `Used` lootbox with be automatically opened	[optional]
yats	kotlin.collections.List<kotlin.String>	LootBox emoji IDs	[optional]

Enum: status

Name	Value
status	Draft, Available, Owned, Used

AdminUpdateUserParameters

Properties

Name	Type	Description	Notes
activationSource	kotlin.String	Optional: Source of activation	[optional]
currentPassword	kotlin.String	Optional: Current password, must be provided if one exists	[optional]
email	kotlin.String	Optional: Email	[optional]
firstName	kotlin.String	Optional: First name	[optional]
freeLimit	kotlin.Int	Optional: Free limit for how many yats the user may purchase	[optional]
lastName	kotlin.String	Optional: Last name	[optional]
password	kotlin.String	Optional: User password	[optional]
role	inline
Optional: Update the user role	[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

ApplyPromoCodeRequest

Properties

Name	Type	Description	Notes
code	kotlin.String	Code to apply

BackupDisableBody

Properties

Name	Type	Description	Notes
backupCode	kotlin.String	Backup code
alternateId	kotlin.String	Alternate identifier	[optional]
disableAll	kotlin.Boolean	Make this method default	[optional]
email	kotlin.String	Email	[optional]
provider	inline
Two factor authentication backend	[optional]

Enum: provider

Name	Value
provider	GoogleAuthenticator, SMS

CheckoutCartRequest

Properties

Name	Type	Description	Notes
method	inline
Payment method type
amount	kotlin.Long	Amount paid in cash. Applicable and required only for `Cash` payment option for Admin.	[optional]
cancelUrl	kotlin.String	URL user will be redirected if payment cancelled Required for Stripe Checkout	[optional]
externalReference	kotlin.String	External reference for cash payment. Applicable and required only for `Cash` payment option for Admin.	[optional]
pubkey	kotlin.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]
successUrl	kotlin.String	URL user will be redirected after successful payment Required for Stripe Checkout	[optional]
trackingData	kotlin.Any	Optional: tracking data	[optional]

Enum: method

Name	Value
method	Free, CoinbaseCommerce, Stripe, Cash, PayPal

Confirm2Fa

Properties

Name	Type	Description	Notes
code	kotlin.String	Two factor authentication code
refreshToken	kotlin.String	Refresh token obtained from login request

Confirm2FaUpdate

Properties

Name	Type	Description	Notes
code	kotlin.String	Auth code of new 2FA provider

CreateApiKeyBody

Properties

Name	Type	Description	Notes
name	kotlin.String
expiresAt	java.time.OffsetDateTime		[optional]
scopes	inline
	[optional]

Enum: scopes

Name

Value

scopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

CurrentUser

Properties

Name	Type	Description	Notes
features	kotlin.collections.List<CurrentUserFeatures>	Enabled features for the user
globalScopes	inline
A list of fine-grained permissions the user may perform.
organizationRoles	[inline](#kotlin.collections.Map<kotlin.String, InnerEnum>)
The role this user has in each organisation. Organisations are currently not used, but are reserved for future operations.
organizationScopes	[inline](#kotlin.collections.Map<kotlin.String, kotlin.collections.List<kotlin.String>>)
The scopes that are granted to this user for each organisation. Organisations are currently not used, but are reserved for future operations.
pendingTransfers	kotlin.collections.List<kotlin.String>	List of transfers pending acceptance on current user side
pubkeys	kotlin.collections.List<kotlin.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	inline
The role assigned to this user. Roles grant authority to user accounts to perform certain actions.
user	CurrentUserUser
everflowTransactionId	kotlin.String	transaction id indicating if the user signed up from a partner via everflow redirect	[optional]

Enum: global_scopes

Name

Value

globalScopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

Enum: organization_roles

Name	Value
organizationRoles	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: organization_scopes

Name

Value

organizationScopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

CurrentUserFeatures

Properties

Name	Type	Description	Notes
code	kotlin.String
id	java.util.UUID

CurrentUserUser

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
freeLimit	kotlin.Int
id	java.util.UUID
pubkeys	kotlin.collections.List<kotlin.String>
remainingFreeEmoji	kotlin.Int
role	inline
twoFactorShouldPrompt	kotlin.Boolean
updatedAt	java.time.OffsetDateTime
alternateId	kotlin.String		[optional]
deactivatedAt	java.time.OffsetDateTime		[optional]
email	kotlin.String		[optional]
emailVerifiedAt	java.time.OffsetDateTime		[optional]
firstName	kotlin.String		[optional]
lastName	kotlin.String		[optional]
source	kotlin.String		[optional]
twoFactorAuth	inline
	[optional]
twoFactorLastPromptedAt	java.time.OffsetDateTime		[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: two_factor_auth

Name	Value
twoFactorAuth	GoogleAuthenticator, SMS

Disable2FABody

Properties

Name	Type	Description	Notes
disableAll	kotlin.Boolean	Make this method default
provider	inline
Two factor authentication backend	[optional]

Enum: provider

Name	Value
provider	GoogleAuthenticator, SMS

DisplayApiKey

Properties

Name	Type	Description	Notes
apiKey	kotlin.String
createdAt	java.time.OffsetDateTime
name	kotlin.String
scopes	inline
expiresAt	java.time.OffsetDateTime		[optional]

Enum: scopes

Name

Value

scopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

DisplayFeature

Properties

Name	Type	Description	Notes
code	kotlin.String
id	java.util.UUID

DisplayOrder

Properties

Name	Type	Description	Notes
amountOverpaidInCents	kotlin.Long	Amount overpaid in cents
createdAt	java.time.OffsetDateTime	A UTC timestamp for when this order was initially created.
eligibleForRefund	kotlin.Boolean	Whether an order is eligible for a refund via an admin.
id	java.util.UUID	The unique identifier for this order
miscRefundedTotalInCents	kotlin.Long	The total of miscellaneous refund amounts retirned to the order.
orderItems	kotlin.collections.List<DisplayOrderOrderItems>	The list of individual line items making up this order.
orderNumber	kotlin.String	The order number is the last 8 characters of the order's ID for user display purposes.
refundedTotalInCents	kotlin.Long	The total of refund amounts for the order.
remainingDueInCents	kotlin.Long	Remaining due in cents to mark the cart as Paid
status	inline
The order of the status. Orders start in 'Draft' status, then move to 'PendingPayment' and finally, 'Paid', unless they are 'Cancelled'.
totalInCents	kotlin.Long	The sum of all the items in this order, plus fees, in USD cents.
updatedAt	java.time.OffsetDateTime	A UTC timestamp for the last time any field in this order was modified.
user	DisplayOrderUser
userId	java.util.UUID	The identifier of the user placing this order
expiresAt	java.time.OffsetDateTime	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]
organizationId	java.util.UUID	The organization id of the user, if applicable. This will generally be null, unless the purchase is coming via a referral programme.	[optional]
paidAt	java.time.OffsetDateTime	A UTC timestamp for when payment for this order was received. Will be null if no payment has been made yet.	[optional]
paymentMethodData	DisplayOrderPaymentMethodData		[optional]
secondsUntilExpiry	kotlin.Int	A convenience field indicating how long before `expires_at` is reached.	[optional]

Enum: status

Name	Value
status	Cancelled, Draft, Paid, PendingPayment

DisplayOrderOrderItems

Properties

Name	Type	Description	Notes
clientFeeInCents	kotlin.Int	The fee attributable to the referral partner, in addition to the nominal unit price, in USD cents.
companyFeeInCents	kotlin.Int	The fee attributable to the service host or company, in addition to the nominal unit price, in USD cents.
createdAt	java.time.OffsetDateTime	A UTC timestamp for when this order item was created.
id	java.util.UUID	A unique identifier for this order item
itemType	inline
The type of order. Current enumerations are EmojiId and Discount
orderId	java.util.UUID	The id of the order this order item
quantity	kotlin.Int	The number of items in the line order. For emoji id sales, this should always be one.
refundedQuantity	kotlin.Int	The number of items refunded. For emoji id sales, this should always at most be one.
unitPriceInCents	kotlin.Int	The nominal, non-discounted price of the item, in USD cents.
updatedAt	java.time.OffsetDateTime	A UTC timestamp for when any field in the order item was modified.
codeId	java.util.UUID	The code associated with this order item for providing a discount.	[optional]
emojiId	kotlin.Any	The emoji id that is being purchased	[optional]
mainId	java.util.UUID	Main item ID	[optional]
mainTable	kotlin.Any	Main item table	[optional]
markedInvalidAt	java.time.OffsetDateTime	A UTC timestamp for when this order item was marked as invalid.	[optional]
markedInvalidAtReason	inline
Marked invalid at reason Taken / PendingPurchase	[optional]
parentId	java.util.UUID	Parent order item's ID, set for discounts and fees	[optional]
rhythmScore	kotlin.Int	The rhythm score belonging to this order item, only set for order items containing EmojiIds.	[optional]

Enum: item_type

Name	Value
itemType	Discount, LootBox, EmojiId

Enum: marked_invalid_at_reason

Name	Value
markedInvalidAtReason	Taken, PendingPurchase

DisplayOrderPaymentMethodData

Properties

Name	Type	Description	Notes
clientSecret	kotlin.String	Client Secret for the `Stripe` method for Elements and Checkout
method	inline
Payment method
methods	kotlin.collections.List<DisplayOrderPaymentMethodDataMethods>	Metadata for `CoinbaseCommerce` payment method
paymentIntentId	kotlin.String	Payment method ID for `Stripe` method
cancelUrl	kotlin.String	Cancel url for `Stripe` method when using Checkout	[optional]
invoiceId	kotlin.String	Invoice ID for the `Stripe` method for Elements	[optional]
sessionId	kotlin.String	Invoice ID for the `Stripe` method for Checkout	[optional]
successUrl	kotlin.String	Success url for `Stripe` method when using Checkout	[optional]

Enum: method

Name	Value
method	CoinbaseCommerce, Stripe

DisplayOrderPaymentMethodDataMethods

Properties

Name	Type	Description	Notes
address	kotlin.String
amount	kotlin.Double
currency	kotlin.String
title	kotlin.String

DisplayOrderUser

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
freeLimit	kotlin.Int
id	java.util.UUID
pubkeys	kotlin.collections.List<kotlin.String>
remainingFreeEmoji	kotlin.Int
role	inline
twoFactorShouldPrompt	kotlin.Boolean
updatedAt	java.time.OffsetDateTime
alternateId	kotlin.String		[optional]
deactivatedAt	java.time.OffsetDateTime		[optional]
email	kotlin.String		[optional]
emailVerifiedAt	java.time.OffsetDateTime		[optional]
firstName	kotlin.String		[optional]
lastName	kotlin.String		[optional]
source	kotlin.String		[optional]
twoFactorAuth	inline
	[optional]
twoFactorLastPromptedAt	java.time.OffsetDateTime		[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: two_factor_auth

Name	Value
twoFactorAuth	GoogleAuthenticator, SMS

DisplayTransferRequest

Properties

Name	Type	Description	Notes
clearOnTransfer	kotlin.Boolean
createdAt	java.time.OffsetDateTime
eid	kotlin.String
email	kotlin.String
id	java.util.UUID
recipientId	java.util.UUID
acceptedAt	java.time.OffsetDateTime		[optional]
deletedAt	java.time.OffsetDateTime		[optional]
message	kotlin.String		[optional]
senderCodeAcceptedAt	java.time.OffsetDateTime		[optional]

DisplayUser

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
freeLimit	kotlin.Int
id	java.util.UUID
pubkeys	kotlin.collections.List<kotlin.String>
remainingFreeEmoji	kotlin.Int
role	inline
twoFactorShouldPrompt	kotlin.Boolean
updatedAt	java.time.OffsetDateTime
alternateId	kotlin.String		[optional]
deactivatedAt	java.time.OffsetDateTime		[optional]
email	kotlin.String		[optional]
emailVerifiedAt	java.time.OffsetDateTime		[optional]
firstName	kotlin.String		[optional]
lastName	kotlin.String		[optional]
source	kotlin.String		[optional]
twoFactorAuth	inline
	[optional]
twoFactorLastPromptedAt	java.time.OffsetDateTime		[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: two_factor_auth

Name	Value
twoFactorAuth	GoogleAuthenticator, SMS

DisplayUserExtended

Properties

Name	Type	Description	Notes
emojiIds	kotlin.collections.List<kotlin.String>
alternateId	kotlin.String		[optional]
createdAt	java.time.OffsetDateTime		[optional]
deactivatedAt	java.time.OffsetDateTime		[optional]
email	kotlin.String		[optional]
emailVerifiedAt	java.time.OffsetDateTime		[optional]
firstName	kotlin.String		[optional]
freeLimit	kotlin.Int		[optional]
id	java.util.UUID		[optional]
lastName	kotlin.String		[optional]
pubkeys	kotlin.collections.List<kotlin.String>		[optional]
remainingFreeEmoji	kotlin.Int		[optional]
role	inline
	[optional]
source	kotlin.String		[optional]
twoFactorAuth	inline
	[optional]
twoFactorLastPromptedAt	java.time.OffsetDateTime		[optional]
twoFactorShouldPrompt	kotlin.Boolean		[optional]
updatedAt	java.time.OffsetDateTime		[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: two_factor_auth

Name	Value
twoFactorAuth	GoogleAuthenticator, SMS

EditRequest

Properties

Name	Type	Description	Notes
bypassSingleRestrictions	kotlin.Boolean	Optional: Allow many addresses per Tag	[optional]
delete	kotlin.collections.List<kotlin.String>	Optional: hashes of records to delete	[optional]
insert	kotlin.collections.List<EditRequestInsert>	Optional: list of records to add	[optional]
merkleRoot	kotlin.String	Optional: merkle root (use WASM to generate)	[optional]
signature	kotlin.String	Optional: signature (use WASM to generate)	[optional]

EditRequestInsert

Properties

Name	Type	Description	Notes
data	kotlin.String	Category data in text format
tag	kotlin.String	Category ID as a hex number

EidResponse

Properties

Name	Type	Description	Notes
status	kotlin.Boolean	Response status. If true, the requested data will be in the result field, null otherwise
error	EidResponseError		[optional]
result	kotlin.collections.List<EidResponseResult>	Records associated with EmojiID	[optional]

EidResponseError

Properties

Name	Type	Description	Notes
code	kotlin.String	Error code
reason	kotlin.String

EidResponseResult

Properties

Name	Type	Description	Notes
data	kotlin.String	Category data in text or hex encoded formats
hash	kotlin.String	Hash identifies record, can be used to delete records
tag	kotlin.String	Category as a hex string number

EmojiListItem

Properties

Name	Type	Description	Notes
canonicalFormat	kotlin.String
chainFormat	kotlin.String
displayFormat	kotlin.String
flippableEmoji	kotlin.collections.List<kotlin.Boolean>
generation	kotlin.Int
minted	kotlin.Boolean
rhythmScore	kotlin.Int
shape	EmojiListItemShape
shortname	kotlin.String
blockedUntil	java.time.OffsetDateTime		[optional]
tokenId	kotlin.Long		[optional]

EmojiListItemShape

Properties

Name	Type	Description	Notes
pattern	kotlin.Any		[optional]
shape	inline
	[optional]

Enum: shape

Name	Value
shape	Repeaters, Eye Heart, Bookends, Adoptables

EmojiStatsResponse

Properties

Name	Type	Description	Notes
emojiId	kotlin.String
metrics	kotlin.collections.List<EmojiStatsResponseMetrics>

EmojiStatsResponseMetrics

Properties

Name	Type	Description	Notes
description	kotlin.String
finishDate	java.time.OffsetDateTime
key	kotlin.String	Counter object
metric	kotlin.String	Counter type
startDate	java.time.OffsetDateTime
value	kotlin.Long	Counter value

Enable2FABody

Properties

Name	Type	Description	Notes
default	kotlin.Boolean	Make this method default
provider	inline
Two factor authentication backend
phone	kotlin.String	Phone number required for `SMS` provider	[optional]

Enum: provider

Name	Value
provider	GoogleAuthenticator, SMS

Enable2FAResponse

Properties

Name	Type	Description	Notes
backupCodes	kotlin.collections.List<kotlin.String>	One time backup codes to login	[optional]
gaQrCodeSvg	kotlin.String	GA secret as QR code in svg image	[optional]
gaSecret	kotlin.String	GA base32 encoded secret, will be null when code is disabled	[optional]
phoneLastDigits	kotlin.String	Phone last digits	[optional]

ListOfCodeAvailability

Properties

Name	Type	Description	Notes
data	kotlin.collections.List<ListOfCodeAvailabilityData>		[optional]
paging	ListOfCodeAvailabilityPaging		[optional]

ListOfCodeAvailabilityData

Properties

Name	Type	Description	Notes
totalUses	kotlin.Long
activator	inline
	[optional]
available	kotlin.Long		[optional]
codeType	inline
	[optional]
createdAt	java.time.OffsetDateTime		[optional]
deletedAt	java.time.OffsetDateTime		[optional]
discountAsPercentage	kotlin.Int		[optional]
discountInCents	kotlin.Int		[optional]
endDate	java.time.OffsetDateTime		[optional]
id	java.util.UUID		[optional]
maxEmojisPerUser	kotlin.Int		[optional]
maxUses	kotlin.Int		[optional]
name	kotlin.String		[optional]
organizationId	java.util.UUID		[optional]
pattern	kotlin.Any		[optional]
redemptionCode	kotlin.String		[optional]
startDate	java.time.OffsetDateTime		[optional]
updatedAt	java.time.OffsetDateTime		[optional]

Enum: activator

Name	Value
activator	RedemptionCode, SecretKey

Enum: code_type

Name	Value
codeType	Discount, RandomYat

ListOfCodeAvailabilityPaging

Properties

Name	Type	Description	Notes
dir	inline
limit	kotlin.Int
page	kotlin.Int
sort	kotlin.String
tags	kotlin.collections.Map<kotlin.String, kotlin.Any>
total	kotlin.Long

Enum: dir

Name	Value
dir	Asc, Desc

ListOfDisplayTransferRequest

Properties

Name	Type	Description	Notes
data	kotlin.collections.List<ListOfDisplayTransferRequestData>		[optional]
paging	ListOfCodeAvailabilityPaging		[optional]

ListOfDisplayTransferRequestData

Properties

Name	Type	Description	Notes
clearOnTransfer	kotlin.Boolean
createdAt	java.time.OffsetDateTime
eid	kotlin.String
email	kotlin.String
id	java.util.UUID
recipientId	java.util.UUID
acceptedAt	java.time.OffsetDateTime		[optional]
deletedAt	java.time.OffsetDateTime		[optional]
message	kotlin.String		[optional]
senderCodeAcceptedAt	java.time.OffsetDateTime		[optional]

ListOfDisplayUserExtended

Properties

Name	Type	Description	Notes
data	kotlin.collections.List<ListOfDisplayUserExtendedData>		[optional]
paging	ListOfCodeAvailabilityPaging		[optional]

ListOfDisplayUserExtendedData

Properties

Name	Type	Description	Notes
emojiIds	kotlin.collections.List<kotlin.String>
alternateId	kotlin.String		[optional]
createdAt	java.time.OffsetDateTime		[optional]
deactivatedAt	java.time.OffsetDateTime		[optional]
email	kotlin.String		[optional]
emailVerifiedAt	java.time.OffsetDateTime		[optional]
firstName	kotlin.String		[optional]
freeLimit	kotlin.Int		[optional]
id	java.util.UUID		[optional]
lastName	kotlin.String		[optional]
pubkeys	kotlin.collections.List<kotlin.String>		[optional]
remainingFreeEmoji	kotlin.Int		[optional]
role	inline
	[optional]
source	kotlin.String		[optional]
twoFactorAuth	inline
	[optional]
twoFactorLastPromptedAt	java.time.OffsetDateTime		[optional]
twoFactorShouldPrompt	kotlin.Boolean		[optional]
updatedAt	java.time.OffsetDateTime		[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: two_factor_auth

Name	Value
twoFactorAuth	GoogleAuthenticator, SMS

ListOfPublicLootBox

Properties

Name	Type	Description	Notes
data	kotlin.collections.List<ListOfPublicLootBoxData>		[optional]
paging	ListOfCodeAvailabilityPaging		[optional]

ListOfPublicLootBoxData

Properties

Name	Type	Description	Notes
averageRhythmScore	kotlin.Double	Average score of emoji IDs in loot box
createdAt	java.time.OffsetDateTime
id	java.util.UUID
prices	kotlin.collections.List<kotlin.Int>	The prices of the yats in the box, in cents
scores	kotlin.collections.List<kotlin.Long>	The rhythm scores of the yats in the box
status	inline
Status loot box will be created in
totalValue	kotlin.Double	Total value of EmojiIDs in the Loot Box
yats	kotlin.collections.List<kotlin.String>	Loot box yats
lootboxType	ListOfPublicLootBoxLootboxType		[optional]
lootboxTypeId	java.util.UUID	For Admin: The type of loot box, if applicable	[optional]
owner	ListOfPublicLootBoxOwner		[optional]
ownerId	java.util.UUID	Loot box owner_id, required for Owned and Used loot boxes	[optional]

Enum: status

Name	Value
status	Draft, Available, Owned, Used

ListOfPublicLootBoxLootboxType

Properties

Name	Type	Description	Notes
config	ListOfPublicLootBoxLootboxTypeConfig
createdAt	java.time.OffsetDateTime	The timestamp for when this loot box type was created
description	kotlin.String	A more detailed description of the loot box type
id	java.util.UUID	The loot box type id
name	kotlin.String	The name of this loot box type

ListOfPublicLootBoxLootboxTypeConfig

Properties

Name	Type	Description	Notes
guarantees	kotlin.collections.List<AdminNewLootBoxTypeConfigGuarantees>	A set of guaranteed drops in this loot box type
maxBaseScore	kotlin.Long	The upper bound (inclusive) rhythm score for standard yats in the loot box
maxLength	kotlin.Long	Maximum yat length
minBaseScore	kotlin.Long	The lower bound (inclusive) rhythm score for standard yats in the loot box
minLength	kotlin.Long	Minimum yat length
size	kotlin.Long	The number of yats in the loot box
weights	kotlin.collections.List<AdminNewLootBoxTypeConfigWeights>	A set of probability weightings for chance-based drops

ListOfPublicLootBoxOwner

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
freeLimit	kotlin.Int
id	java.util.UUID
pubkeys	kotlin.collections.List<kotlin.String>
remainingFreeEmoji	kotlin.Int
role	inline
twoFactorShouldPrompt	kotlin.Boolean
updatedAt	java.time.OffsetDateTime
alternateId	kotlin.String		[optional]
deactivatedAt	java.time.OffsetDateTime		[optional]
email	kotlin.String		[optional]
emailVerifiedAt	java.time.OffsetDateTime		[optional]
firstName	kotlin.String		[optional]
lastName	kotlin.String		[optional]
source	kotlin.String		[optional]
twoFactorAuth	inline
	[optional]
twoFactorLastPromptedAt	java.time.OffsetDateTime		[optional]

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: two_factor_auth

Name	Value
twoFactorAuth	GoogleAuthenticator, SMS

ListOfUserInterest

Properties

Name	Type	Description	Notes
data	kotlin.collections.List<ListOfUserInterestData>		[optional]
paging	ListOfCodeAvailabilityPaging		[optional]

ListOfUserInterestData

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
emojiId	kotlin.String
id	java.util.UUID
updatedAt	java.time.OffsetDateTime
userId	java.util.UUID

LoadJsonResponse

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime	Created at time for the record
data	kotlin.Any	Data value stored by key and EmojiID If there is no value for the key an empty object `{}` is returned
isLocked	kotlin.Boolean	Data is locked
updatedAt	java.time.OffsetDateTime	Updated at time for the record
lockedFutureWritesAt	java.time.OffsetDateTime	Time the record was locked from future writes	[optional]

LoadUser

Properties

Name	Type	Description	Notes
currentUser	LoadUserCurrentUser
editions	kotlin.collections.List<kotlin.Long>
extendedList	kotlin.collections.List<LoadUserExtendedList>
incomingTransfers	kotlin.collections.List<ListOfDisplayTransferRequestData>
outgoingTransfers	LoadUserOutgoingTransfers
wallets	kotlin.collections.List<LoadUserWallets>
everflowTransactionId	kotlin.String		[optional]
sidebar	kotlin.Any		[optional]

LoadUserCurrentUser

Properties

Name	Type	Description	Notes
features	kotlin.collections.List<CurrentUserFeatures>	Enabled features for the user
globalScopes	inline
A list of fine-grained permissions the user may perform.
organizationRoles	[inline](#kotlin.collections.Map<kotlin.String, InnerEnum>)
The role this user has in each organisation. Organisations are currently not used, but are reserved for future operations.
organizationScopes	[inline](#kotlin.collections.Map<kotlin.String, kotlin.collections.List<kotlin.String>>)
The scopes that are granted to this user for each organisation. Organisations are currently not used, but are reserved for future operations.
pendingTransfers	kotlin.collections.List<kotlin.String>	List of transfers pending acceptance on current user side
pubkeys	kotlin.collections.List<kotlin.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	inline
The role assigned to this user. Roles grant authority to user accounts to perform certain actions.
user	CurrentUserUser
everflowTransactionId	kotlin.String	transaction id indicating if the user signed up from a partner via everflow redirect	[optional]

Enum: global_scopes

Name

Value

globalScopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

Enum: organization_roles

Name	Value
organizationRoles	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: organization_scopes

Name

Value

organizationScopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

LoadUserExtendedList

Properties

Name	Type	Description	Notes
canonicalFormat	kotlin.String
chainFormat	kotlin.String
displayFormat	kotlin.String
flippableEmoji	kotlin.collections.List<kotlin.Boolean>
generation	kotlin.Int
minted	kotlin.Boolean
rhythmScore	kotlin.Int
shape	EmojiListItemShape
shortname	kotlin.String
blockedUntil	java.time.OffsetDateTime		[optional]
tokenId	kotlin.Long		[optional]

LoadUserOutgoingTransfers

Properties

Name	Type	Description	Notes
data	kotlin.collections.List<ListOfDisplayTransferRequestData>		[optional]
paging	ListOfCodeAvailabilityPaging		[optional]

LoadUserWallets

Properties

Name	Type	Description	Notes
ethAddress	kotlin.String
userId	java.util.UUID

LoginRequest

Properties

Name	Type	Description	Notes
password	kotlin.String	Required: Password
alternateId	kotlin.String	Alternate identifier	[optional]
email	kotlin.String	Email	[optional]
gRecaptchaResponse	kotlin.String	Response from google Recaptcha	[optional]

LookupResponse

Properties

Name	Type	Description	Notes
stats	kotlin.collections.List<EmojiStatsResponseMetrics>	Number of times emoji viewed during past month
error	EidResponseError		[optional]
result	kotlin.collections.List<EidResponseResult>	Records associated with EmojiID	[optional]
status	kotlin.Boolean	Response status. If true, the requested data will be in the result field, null otherwise	[optional]

LootBoxGenerationRequest

Properties

Name	Type	Description	Notes
lootBoxTypeId	java.util.UUID	The id of the loot box type to generate
numBoxes	kotlin.Long	The number of loot boxes to generate in this sample

LootBoxSet

Properties

Name	Type	Description	Notes
lootBoxes	kotlin.collections.List<ListOfPublicLootBoxData>	The set of loot boxes generated. The length of this array may be less than `num_requested`
numRequested	kotlin.Long	The number of loot boxes requested

MagicLinkLoginRequest

Properties

Name	Type	Description	Notes
email	kotlin.String	Email	[optional]
gRecaptchaResponse	kotlin.String	Response from google Recaptcha	[optional]
redirect	kotlin.String	Redirect path	[optional]
userId	java.util.UUID	User ID	[optional]

MagicLinkLoginResponse

Properties

Name	Type	Description	Notes
message	kotlin.String	Message
status	inline
Status of requested user after completing the login request

Enum: status

Name	Value
status	Active, RegisteredInactive, RegisteredActive, Inactive

Metadata

Properties

Name	Type	Description	Notes
animationUrl	kotlin.String
attributes	kotlin.collections.List<MetadataAttributes>
description	kotlin.String
externalLink	kotlin.String
image	kotlin.String
name	kotlin.String

MetadataAttributes

Properties

Name	Type	Description	Notes
traitType	kotlin.String
value	kotlin.Any

NewUserInterestParameters

Properties

Name	Type	Description	Notes
emojiId	kotlin.String	Emoji ID to express interest in

OrganizationBranding

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
currencies	kotlin.collections.List<kotlin.String>
name	kotlin.String
organizationId	java.util.UUID
requiresEmail	kotlin.Boolean
returnLink	kotlin.String
updatedAt	java.time.OffsetDateTime
logo	kotlin.String		[optional]
logoSmall	kotlin.String		[optional]
logoThumbnail	kotlin.String		[optional]

PaymentAddressResponse

Properties

Name	Type	Description	Notes
status	kotlin.Boolean
error	EidResponseError		[optional]
result	kotlin.collections.Map<kotlin.String, PaymentAddressResponseResult>		[optional]

PaymentAddressResponseResult

Properties

Name	Type	Description	Notes
address	kotlin.String	The payment address
category	kotlin.String	The category of this address
default	kotlin.Boolean	Optional: Is this address the default address for the category
description	kotlin.String	Optional: Description of the address	[optional]
longName	kotlin.String	Optional: CryptoToken long name is a defined name for the ERC20 token	[optional]
settlementNetwork	kotlin.String	Optional: CryptoToken settlement network for the ERC20 token	[optional]
shortName	kotlin.String	Optional: CryptoToken short name to identify an ERC20 token	[optional]
signature	kotlin.String	Optional: Proof of ownership signature for the address	[optional]

PaymentMethod

Properties

Name	Type	Description	Notes
id	kotlin.String
paymentType	kotlin.String
brand	kotlin.String		[optional]
country	kotlin.String		[optional]
expMonth	kotlin.Int		[optional]
expYear	kotlin.Int		[optional]
last4	kotlin.String		[optional]

ProxyCallParameters

Properties

Name	Type	Description	Notes
service	inline
`ProxyService` type
data	kotlin.String	The data to pass through to the proxied service	[optional]

Enum: service

Name	Value
service	Echo, Scraper

ProxyResult

Properties

Name	Type	Description	Notes
json	kotlin.Any	The response from the proxied service as a Json object
value	kotlin.String	The response from the proxied service as a String

PublicLootBox

Properties

Name	Type	Description	Notes
averageRhythmScore	kotlin.Double	Average score of emoji IDs in loot box
createdAt	java.time.OffsetDateTime
id	java.util.UUID
prices	kotlin.collections.List<kotlin.Int>	The prices of the yats in the box, in cents
scores	kotlin.collections.List<kotlin.Long>	The rhythm scores of the yats in the box
status	inline
Status loot box will be created in
totalValue	kotlin.Double	Total value of EmojiIDs in the Loot Box
yats	kotlin.collections.List<kotlin.String>	Loot box yats
lootboxType	ListOfPublicLootBoxLootboxType		[optional]
lootboxTypeId	java.util.UUID	For Admin: The type of loot box, if applicable	[optional]
owner	ListOfPublicLootBoxOwner		[optional]
ownerId	java.util.UUID	Loot box owner_id, required for Owned and Used loot boxes	[optional]

Enum: status

Name	Value
status	Draft, Available, Owned, Used

PublicLootBoxType

Properties

Name	Type	Description	Notes
config	ListOfPublicLootBoxLootboxTypeConfig
createdAt	java.time.OffsetDateTime	The timestamp for when this loot box type was created
description	kotlin.String	A more detailed description of the loot box type
id	java.util.UUID	The loot box type id
name	kotlin.String	The name of this loot box type

RandomResult

Properties

Name	Type	Description	Notes
result	kotlin.collections.List<RandomResultResult>	Random Emoji IDs

RandomResultResult

Properties

Name	Type	Description	Notes
availability	inline
The availability state of this emoji
available	kotlin.Boolean	Whether the Emoji ID is available for purchase
emojiId	kotlin.String	Emoji ID in canonical form
flippableEmoji	kotlin.collections.List<kotlin.Boolean>	Which emoji are flippable
length	kotlin.Long	Canonical EmojiID length in emojis
minted	kotlin.Boolean	If this Emoji is minted
rhythmScore	kotlin.Long	EmojiID rhythm score
shape	EmojiListItemShape
shortNames	kotlin.collections.List<kotlin.String>	Emoji key words
stats	kotlin.collections.List<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	kotlin.Any	EmojiID copy text	[optional]
generation	kotlin.Int	The generation of the Yat, if it has been purchased.	[optional]
origin	kotlin.String	The origin of the Yat if it was from a Prism Case	[optional]
price	kotlin.Int	Pricing in US cents, e.g. 1024 is 10.24 USD. Price is 0 if the emoji is not available	[optional]

Enum: availability

Name	Value
availability	Available, Taken, InCart, ComingSoon, NoPrice

RandomYatActivateBody

Properties

Name	Type	Description	Notes
nonce	kotlin.String	Schnorr signature nonce as a hex string
pubkey	kotlin.String	Public key to authorize usage of a code
signature	kotlin.String	Schnorr signature as a hex with alternate_id as a challenge
trackingData	kotlin.Any	Custom tracking data to be associated with a purchase	[optional]

RecentlyPurchasedResult

Properties

Name	Type	Description	Notes
result	kotlin.collections.List<RandomResultResult>	Recently purchased emoji

RefreshRequest

Properties

Name	Type	Description	Notes
refreshToken	kotlin.String	Refresh token obtained from login request

RegisterUserParameters

Properties

Name	Type	Description	Notes
activate	kotlin.Boolean	Optional: Whether to force activation during creation (requires UserActivate scope)	[optional]
activationSource	kotlin.String	Optional: Source of activation (requires UserActivate scope)	[optional]
alternateId	kotlin.String	Alternate identifier	[optional]
email	kotlin.String	Email address	[optional]
firstName	kotlin.String	Optional: first name	[optional]
gRecaptchaResponse	kotlin.String	Response from google Recaptcha	[optional]
lastName	kotlin.String	Optional: last name	[optional]
partnerConversionId	kotlin.String	Parameter to pass everflow click id	[optional]
password	kotlin.String	Optional: password	[optional]
source	kotlin.String	Required when registering with `alternate_id`, source for non custodial user	[optional]

RhythmResponse

Properties

Name	Type	Description	Notes
rhythm	kotlin.Long	The yat rhythm score, a number between 1 (least prestigious) and 100 (most prestigious)

SearchResult

Properties

Name	Type	Description	Notes
alternates	kotlin.collections.List<RandomResultResult>	Alternative Emoji IDs
result	SearchResultResult

SearchResultResult

Properties

Name	Type	Description	Notes
availability	inline
The availability state of this emoji
available	kotlin.Boolean	Whether the Emoji ID is available for purchase
emojiId	kotlin.String	Emoji ID in canonical form
flippableEmoji	kotlin.collections.List<kotlin.Boolean>	Which emoji are flippable
length	kotlin.Long	Canonical EmojiID length in emojis
minted	kotlin.Boolean	If this Emoji is minted
rhythmScore	kotlin.Long	EmojiID rhythm score
shape	EmojiListItemShape
shortNames	kotlin.collections.List<kotlin.String>	Emoji key words
stats	kotlin.collections.List<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	kotlin.Any	EmojiID copy text	[optional]
generation	kotlin.Int	The generation of the Yat, if it has been purchased.	[optional]
origin	kotlin.String	The origin of the Yat if it was from a Prism Case	[optional]
price	kotlin.Int	Pricing in US cents, e.g. 1024 is 10.24 USD. Price is 0 if the emoji is not available	[optional]

Enum: availability

Name	Value
availability	Available, Taken, InCart, ComingSoon, NoPrice

ShapeMatch

Properties

Name	Type	Description	Notes
pattern	kotlin.Any		[optional]
shape	inline
	[optional]

Enum: shape

Name	Value
shape	Repeaters, Eye Heart, Bookends, Adoptables

SignatureRequest

Properties

Name	Type	Description	Notes
account	kotlin.String
expiry	kotlin.Long		[optional]

SignatureResponse

Properties

Name	Type	Description	Notes
account	kotlin.String
expiry	kotlin.Long
signature	kotlin.String
token	kotlin.String

StoreJsonBody

Properties

Name	Type	Description	Notes
data	kotlin.Any	Data value allows to store any Json value, limited by 250Kb
linkedTags	kotlin.collections.List<EditRequestInsert>	Link tag items as part of the transaction All previously linked tags not present in new request will be deleted	[optional]

SuccessResponse

Properties

Name	Type	Description	Notes
message	kotlin.String

SuccessResponse2FA

Properties

Name	Type	Description	Notes
message	kotlin.String
phoneLastDigits	kotlin.String		[optional]

TokenResponse

Properties

Name	Type	Description	Notes
accessToken	kotlin.String	Access token
hasPassword	kotlin.Boolean	Has a password set
refreshToken	kotlin.String	Refresh token, only required for 2FA (???)
requires2fa	inline
Whether has 2FA enabled or not	[optional]

Enum: requires_2fa

Name	Value
requires2fa	GoogleAuthenticator, SMS

TransferRequest

Properties

Name	Type	Description	Notes
clearOnTransfer	kotlin.Boolean	Clear emoji data when emoji transferred to destination
eid	kotlin.String
email	kotlin.String	Transfer to specified email, would register new user account if not existent
forceTransfer	kotlin.Boolean	Admin can force transfer, for regular user it has no effect
message	kotlin.String	Message displayed to recipient and included in the invitiation email	[optional]

UpdateAccountResponse

Properties

Name	Type	Description	Notes
everflowTransactionId	kotlin.String	transaction id indicating if the user signed up from a partner via everflow redirect	[optional]
features	kotlin.collections.List<CurrentUserFeatures>	Enabled features for the user	[optional]
globalScopes	inline
A list of fine-grained permissions the user may perform.	[optional]
organizationRoles	[inline](#kotlin.collections.Map<kotlin.String, InnerEnum>)
The role this user has in each organisation. Organisations are currently not used, but are reserved for future operations.	[optional]
organizationScopes	[inline](#kotlin.collections.Map<kotlin.String, kotlin.collections.List<kotlin.String>>)
The scopes that are granted to this user for each organisation. Organisations are currently not used, but are reserved for future operations.	[optional]
pendingTransfers	kotlin.collections.List<kotlin.String>	List of transfers pending acceptance on current user side	[optional]
pubkeys	kotlin.collections.List<kotlin.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	inline
The role assigned to this user. Roles grant authority to user accounts to perform certain actions.	[optional]
tokenResponse	UpdateAccountResponseTokenResponse		[optional]
user	CurrentUserUser		[optional]

Enum: global_scopes

Name

Value

globalScopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

Enum: organization_roles

Name	Value
organizationRoles	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

Enum: organization_scopes

Name

Value

organizationScopes

adminCart:update, adminEmoji:destroy, adminEmoji:load, adminEmoji:register, adminEmoji:transfer, adminEmoji:updateFeatures, adminEmoji:updateSecureData, adminEmoji:write, adminFeatureUser:read, adminInvites:write, adminInvites:list, adminLootbox:read, adminLootbox:write, adminNotifications:write, adminUser:bypass2fa, adminUser:load, adminUser:loginAs, adminUser:twoFactorAuthDestroy, adminUser:roleUpdate, cart:show, cart:update, code:delete, code:read, code:write, user:createApiKey, domainAction:read, domainEvent:read, edition:delete, edition:read, edition:write, emojiGroups:delete, emojiGroups:read, emojiGroups:write, emoji::transfer, feature::delete, feature::read, feature::write, lootbox:use, order:paymentOverride, order:read, order:readSelf, order:refund, order:refundOverride, order:resendConfirmation, organization:admin, organizationCode:admin, organizationEmoji:list, organizationEmoji:write, organizationList:read, organization:read, organizationUser:admin, organizationUser:read, organization:write, nftSignature:write, nftToken:destroy, nftTransfer:read, paymentMethod:destroy, paymentMethod:read, paymentMethod:setDefault, adminPriceParameters:read, adminPriceParameters:write, refund:read, token:refresh, auth:twoFactor, user:activate, userData:update, user:delete, user:deleteSelf, userEmail:verify, userEmoji:list, userInterest:delete, userInterest:read, userInterest:write, user:list, userPubkeys:list, userPubkeys:write, user:show, user:write, user:writeSelf

Enum: role

Name	Value
role	Admin, OrgController, OrgMember, OrgOwner, Bot, Super, User

UpdateAccountResponseTokenResponse

Properties

Name	Type	Description	Notes
accessToken	kotlin.String	Access token
hasPassword	kotlin.Boolean	Has a password set
refreshToken	kotlin.String	Refresh token, only required for 2FA (???)
requires2fa	inline
Whether has 2FA enabled or not	[optional]

Enum: requires_2fa

Name	Value
requires2fa	GoogleAuthenticator, SMS

UpdateOrganizationBranding

Properties

Name	Type	Description	Notes
currencies	kotlin.collections.List<kotlin.String>
returnLink	kotlin.String
logo	kotlin.String		[optional]
logoSmall	kotlin.String		[optional]
logoThumbnail	kotlin.String		[optional]
requiresEmail	kotlin.Boolean		[optional]

UpdateUserParameters

Properties

Name	Type	Description	Notes
currentPassword	kotlin.String	Optional: Current password, must be provided if one exists	[optional]
email	kotlin.String	Optional: Email	[optional]
firstName	kotlin.String	Optional: First name	[optional]
lastName	kotlin.String	Optional: Last name	[optional]
password	kotlin.String	Optional: User password	[optional]

UserInterest

Properties

Name	Type	Description	Notes
createdAt	java.time.OffsetDateTime
emojiId	kotlin.String
id	java.util.UUID
updatedAt	java.time.OffsetDateTime
userId	java.util.UUID

Wallet

Properties

Name	Type	Description	Notes
ethAddress	kotlin.String
userId	java.util.UUID

WalletSyncRequest

Properties

Name	Type	Description	Notes
signature	kotlin.String
source	inline

Enum: source

Name	Value
source	Mint, Dashboard

Documentation for Authorization

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

apiKey

• Type: API key
• API key parameter name: Authorization,X-Api-Key
• Location: HTTP header

two_factor

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header