dto

Documentation

Overview

TODO: deal with this mess

Index

• type Activities
• type Activity
• type Asset2d
• type Asset2dMeta
• type Asset2dOptions
• type Asset3d
• type Asset3dMeta
• type Asset3dOptions
• type Asset3dType
  • func (v Asset3dType) MarshalMUS(buf []byte) int
  • func (v Asset3dType) SizeMUS() int
  • func (v *Asset3dType) UnmarshalMUS(buf []byte) (int, error)
• type Assets3dMeta
• type Assets3dOptions
• type Broadcast
• type BroadcastStatusType
• type Emoji
• type Event
• type EventForm
• type ExploreOption
• type ExploreOptions
• type Favorite
• type FlyToMeType
• type GoogleDrive
• type HashResponse
• type JWTToken
• type KusamaMetaData
• type Magic
• type MagicType
• type Member
• type Miro
• type NFTAttributes
• type Object
• type ObjectAncestor
• type ObjectAttributeValues
• type ObjectAttributes
• type ObjectInfo
• type ObjectMember
• type ObjectOptions
• type ObjectSubAttributes
• type ObjectSubOptions
• type ObjectType
• type OwnedWorld
• type PermanentType
• type Plugin
• type PluginMeta
• type PluginOptions
• type Plugins
• type PluginsMeta
• type PluginsOptions
• type Profile
• type RecentUser
• type RecentWorld
• type SearchOptions
• type StageModeRequestType
• type StageModeStatusType
• type StageModeUser
• type Stake
• type StakedWorld
• type Tile
• type TileContent
• type TileType
• type Token
• type TokenInfo
• type TokenNetworkType
• type TokenRule
• type TokenRuleReviewStatusType
• type TokenType
• type TopStaker
• type User
• type UserSearchResult
• type UserSearchResults
• type UserStatusType
• type UserSubAttributes
• type Validator
• type VibeAmount
• type WalletInfo
• type WorldDetails
• type WorldNFTMeta
• type WorldStaker

Types

type Activities

type Activities map[umid.UMID]Activity

type Activity

type Activity struct {
	ActivityID      umid.UMID           `json:"activity_id"`
	UserID          umid.UMID           `json:"user_id"`
	ObjectID        umid.UMID           `json:"object_id"`
	Type            *entry.ActivityType `json:"type"`
	Data            *entry.ActivityData `json:"data"`
	AvatarHash      *string             `json:"avatar_hash"`
	WorldName       string              `json:"world_name"`
	WorldAvatarHash *string             `json:"world_avatar_hash"`
	UserName        *string             `json:"user_name"`
	CreatedAt       time.Time           `json:"created_at"`
}

type Asset2d

type Asset2d struct {
	Meta    Asset2dMeta    `json:"meta"`
	Options Asset2dOptions `json:"options"`
}

type Asset2dMeta

type Asset2dMeta entry.Asset2dMeta

type Asset2dOptions

type Asset2dOptions *entry.Asset2dOptions

type Asset3d

type Asset3d struct {
	ID        string      `json:"id"`
	UserID    string      `json:"user_id"`
	Name      string      `json:"name,omitempty"`
	Meta      Asset3dMeta `json:"meta,omitempty"`
	Private   bool        `json:"is_private"`
	CreatedAt string      `json:"createdAt,omitempty"`
	UpdatedAt string      `json:"updatedAt,omitempty"`
}

type Asset3dMeta

type Asset3dMeta *entry.Asset3dMeta

type Asset3dOptions

type Asset3dOptions *entry.Asset3dOptions

type Asset3dType

type Asset3dType int8

const (
	AddressableAssetType Asset3dType = iota
	GLTFAsset3dType
	BasicAsset3dType
)

func (Asset3dType) MarshalMUS

func (v Asset3dType) MarshalMUS(buf []byte) int

MarshalMUS fills buf with the MUS encoding of v.

func (Asset3dType) SizeMUS

func (v Asset3dType) SizeMUS() int

SizeMUS returns the size of the MUS-encoded v.

func (*Asset3dType) UnmarshalMUS

func (v *Asset3dType) UnmarshalMUS(buf []byte) (int, error)

UnmarshalMUS parses the MUS-encoded buf, and sets the result to *v.

type Assets3dMeta

type Assets3dMeta map[umid.UMID]Asset3dMeta

type Assets3dOptions

type Assets3dOptions map[umid.UMID]Asset3dOptions

type Broadcast

type Broadcast struct {
	URL             string              `json:"url"`
	YoutubeURL      string              `json:"youtubeUrl"`
	BroadcastStatus BroadcastStatusType `json:"broadcastStatus"`
}

type BroadcastStatusType

type BroadcastStatusType string

const (
	UnknownBroadcastStatusType    BroadcastStatusType = ""
	ForceSmallBroadcastStatusType BroadcastStatusType = "force_small"
	PlaySmallBroadcastStatusType  BroadcastStatusType = "play_small"
	ForceLargeBroadcastStatusType BroadcastStatusType = "force_large"
	PlayLargeBroadcastStatusType  BroadcastStatusType = "play_large"
	PlayBroadcastStatusType       BroadcastStatusType = "play"
	StopBroadcastStatusType       BroadcastStatusType = "stop"
)

type Emoji

type Emoji struct {
	ID       string `json:"id"`
	Code     string `json:"code"`
	Hash     string `json:"hash"`
	Name     string `json:"name"`
	ObjectID string `json:"objectId"`
	Order    int    `json:"order"`
}

type Event

type Event struct {
	ID          string  `json:"id"`
	Title       string  `json:"title"`
	Description string  `json:"description"`
	HostedBy    string  `json:"hosted_by"`
	ImageHash   *string `json:"image_hash,omitempty"`
	WebLink     *string `json:"web_link,omitempty"`
	ObjectID    string  `json:"objectId"`
	ObjectName  string  `json:"objectName"`
	Start       string  `json:"start"`
	End         string  `json:"end"`
	Created     string  `json:"created"`
	Modified    string  `json:"modified"`
	Attendees   []User  `json:"attendees"`
}

type EventForm

type EventForm struct {
	Start       string  `json:"start"`
	End         string  `json:"end"`
	Title       string  `json:"title"`
	HostedBy    string  `json:"hosted_by"`
	WebLink     *string `json:"web_link"`
	Description string  `json:"description"`
}

type ExploreOption

type ExploreOption struct {
	ID          umid.UMID `json:"id"`
	Name        *string   `json:"name"`
	Description *string   `json:"description"`
}

type ExploreOptions

type ExploreOptions []ExploreOption

type Favorite

type Favorite struct {
	ObjectID string `json:"objectId"`
	Name     string `json:"name"`
}

type FlyToMeType

type FlyToMeType string

const (
	FlyToMeTrigger FlyToMeType = "fly-to-me"
)

type GoogleDrive

type GoogleDrive struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	URL  string `json:"url"`
}

type HashResponse

type HashResponse struct {
	Hash string `json:"hash"`
}

type JWTToken

type JWTToken struct {
	Subject      *string `json:"subject,omitempty"`
	Issuer       *string `json:"issuer,omitempty"`
	ExpiresAt    *string `json:"expiresAt,omitempty"`
	IssuedAt     *string `json:"issuedAt,omitempty"`
	SignedString *string `json:"signedString,omitempty"`
}

type KusamaMetaData

type KusamaMetaData struct {
	ValidatorID     string `json:"validator_id"`
	ValidatorReward int    `json:"validator_reward"`
	ValidatorInfo   struct {
		AccountID string `json:"account_id"`
		Entity    struct {
			Name      string `json:"name"`
			AccountID string `json:"accountId"`
		} `json:"entity"`
		Commission              any    `json:"commission"` // QUESTION: originally here is "string | number", really?
		OwnStake                any    `json:"ownStake"`   // QUESTION: originally here is "string | number", really?
		Status                  string `json:"status"`
		TotalStake              string `json:"totalStake"`
		ValidatorAccountDetails struct {
			Name string `json:"name"`
		} `json:"validatorAccountDetails"`
	} `json:"validator_info"`
}

type Magic

type Magic struct {
	ID   string    `json:"id"`
	Key  string    `json:"key"`
	Type MagicType `json:"type"`
	Data struct {
		ID       string  `json:"id"`
		EventID  *string `json:"eventId,omitempty"`
		Position *any    `json:"position,omitempty"`
	} `json:"data"`
	Expired  string `json:"expired"`
	UpdateAt string `json:"update_at"`
	CratedAt string `json:"cratedAt"`
}

type MagicType

type MagicType string

const (
	UnknownMagicType     MagicType = ""
	OpenObjectMagicType  MagicType = "open_object"
	JoinMeetingMagicType MagicType = "join_meeting"
	FlyMagicType         MagicType = "fly"
	EventMagicType       MagicType = "event"
)

type Member

type Member struct {
	ObjectID   *umid.UMID `json:"object_id"`
	UserID     *umid.UMID `json:"user_id"`
	Name       *string    `json:"name"`
	AvatarHash *string    `json:"avatar_hash"`
	Role       *string    `json:"role"`
}

type Miro

type Miro struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	ViewLink    string `json:"viewLink"`
	AccessLink  string `json:"accessLink"`
}

type NFTAttributes

type NFTAttributes struct {
	TraitType string `json:"trait_type"`
	Value     string `json:"value"`
}

type Object

type Object struct {
	OwnerID      string          `json:"owner_id"`
	ParentID     string          `json:"parent_id"`
	ObjectTypeID string          `json:"object_type_id"`
	Asset2dID    string          `json:"asset_2d_id"`
	Asset3dID    string          `json:"asset_3d_id"`
	Transform    cmath.Transform `json:"transform"`
}

type ObjectAncestor

type ObjectAncestor struct {
	ObjectID   string `json:"objectId"`
	ObjectName string `json:"objectName"`
}

type ObjectAttributeValues

type ObjectAttributeValues map[umid.UMID]*entry.AttributeValue

type ObjectAttributes

type ObjectAttributes map[umid.UMID]*entry.ObjectAttribute

type ObjectInfo

type ObjectInfo struct {
	ID          string     `json:"id"`
	ParentID    *string    `json:"parentId,omitempty"`
	ObjectType  ObjectType `json:"objectType"`
	Name        string     `json:"name"`
	Description string     `json:"description"`
	OwnerID     string     `json:"ownerId"`
	OwnerName   string     `json:"ownerName"`
	CreateAt    string     `json:"createAt"`
	UpdatedAt   string     `json:"updatedAt"`
	IsPrivate   bool       `json:"isPrivate"`
	IsAdmin     bool       `json:"isAdmin"`
}

type ObjectMember

type ObjectMember struct {
	UserID   string `json:"userId"`
	UserName string `json:"userName"`
	IsAdmin  bool   `json:"isAdmin"`
}

type ObjectOptions

type ObjectOptions *entry.ObjectOptions

type ObjectSubAttributes

type ObjectSubAttributes map[string]any

type ObjectSubOptions

type ObjectSubOptions map[string]any

type ObjectType

type ObjectType string

const (
	UnknownObjectType    ObjectType = ""
	WorldObjectType      ObjectType = "world"
	ProgramObjectType    ObjectType = "program"
	ChallengeObjectType  ObjectType = "challenge"
	ProjectObjectType    ObjectType = "project"
	GrabATableObjectType ObjectType = "grab-a-table"
)

type OwnedWorld

type OwnedWorld struct {
	ID          umid.UMID `json:"id"`
	OwnerID     umid.UMID `json:"owner_id"`
	OwnerName   *string   `json:"owner_name"`
	Name        *string   `json:"name,omitempty"`
	Description *string   `json:"description"`
	WebsiteLink *string   `json:"website_link"`
	AvatarHash  *string   `json:"avatarHash"`
}

type PermanentType

type PermanentType string

const (
	UnknownPermanentType        PermanentType = ""
	NonePermanentType           PermanentType = "none"
	PosterPermanentType         PermanentType = "poster"
	MemePermanentType           PermanentType = "meme"
	LogoPermanentType           PermanentType = "logo"
	DescriptionPermanentType    PermanentType = "description"
	VideoPermanentPermanentType PermanentType = "video"
	NamePermanentType           PermanentType = "name"
	ProblemPermanentType        PermanentType = "problem"
	SolutionPermanentType       PermanentType = "solution"
	ThirdPermanentType          PermanentType = "third"
)

type Plugin

type Plugin struct {
	Name      string  `json:"name"`
	Title     string  `json:"title"`
	SubTitle  *string `json:"subTitle,omitempty"`
	ScriptURL string  `json:"scriptUrl"`
	IconName  *string `json:"iconName,omitempty"`
}

type PluginMeta

type PluginMeta entry.PluginMeta

type PluginOptions

type PluginOptions *entry.PluginOptions

type Plugins

type Plugins map[umid.UMID]string

type PluginsMeta

type PluginsMeta map[umid.UMID]PluginMeta

type PluginsOptions

type PluginsOptions map[umid.UMID]PluginOptions

type Profile

type Profile struct {
	Bio         *string `json:"bio,omitempty"`
	Location    *string `json:"location,omitempty"`
	AvatarHash  *string `json:"avatarHash,omitempty"`
	ProfileLink *string `json:"profileLink,omitempty"`
}

type RecentUser

type RecentUser struct {
	ID      umid.UMID `json:"id"`
	Name    *string   `json:"name,omitempty"`
	Wallet  *string   `json:"wallet,omitempty"`
	Profile Profile   `json:"profile,omitempty"`
}

type RecentWorld

type RecentWorld struct {
	ID          umid.UMID `json:"id"`
	OwnerID     umid.UMID `json:"owner_id"`
	OwnerName   *string   `json:"owner_name"`
	Description *string   `json:"description"`
	StakeTotal  *string   `json:"stake_total,omitempty"`
	Name        *string   `json:"name"`
	WebsiteLink *string   `json:"website_link"`
	AvatarHash  *string   `json:"avatarHash"`
}

type SearchOptions

type SearchOptions []ExploreOption

type StageModeRequestType

type StageModeRequestType string

const (
	UnknownStageModeRequestType StageModeRequestType = ""
	RequestStageModeRequestType StageModeRequestType = "request"
	InviteStageModeRequestType  StageModeRequestType = "invite"
	AcceptStageModeRequestType  StageModeRequestType = "accept"
	DeclineStageModeRequestType StageModeRequestType = "decline"
)

type StageModeStatusType

type StageModeStatusType string

const (
	UnknownStageModeStatusType   StageModeStatusType = ""
	InitiatedStageModeStatusType StageModeStatusType = "initiated"
	StoppedStageModeStatusType   StageModeStatusType = "stopped"
)

type StageModeUser

type StageModeUser struct {
	UserID string `json:"userId"`
	Flag   int    `json:"flag"`
}

type Stake

type Stake struct {
	ObjectID     umid.UMID `json:"object_id"`
	Name         string    `json:"name"`
	WalletID     string    `json:"wallet_id"`
	BlockchainID umid.UMID `json:"blockchain_id"`
	Amount       string    `json:"amount,omitempty"`
	Reward       string    `json:"reward"`
	LastComment  string    `json:"last_comment"`
	AvatarHash   string    `json:"avatar_hash"`
	UpdatedAt    time.Time `json:"updated_at"`
	Kind         int       `json:"kind"`
}

type StakedWorld

type StakedWorld struct {
	ID          umid.UMID `json:"id"`
	OwnerID     umid.UMID `json:"owner_id"`
	Name        *string   `json:"name,omitempty"`
	Description *string   `json:"description"`
	WebsiteLink *string   `json:"website_link"`
	AvatarHash  *string   `json:"avatarHash"`
}

type Tile

type Tile struct {
	ID            string        `json:"id"`
	Hash          string        `json:"hash"`
	ObjectID      string        `json:"objectId"`
	UITypeID      string        `json:"uiTypeId"`
	OwnerID       string        `json:"owner_id"`
	UpdatedAt     string        `json:"updatedAt"`
	PermanentType PermanentType `json:"permanentType"`
	Edited        int           `json:"edited"`
	Render        uint8         `json:"render"`
	Column        int           `json:"column"`
	Row           int           `json:"row"`
	Type          TileType      `json:"type"`
	Content       TileContent   `json:"content"`
}

type TileContent

type TileContent struct {
	Text  *string `json:"text"`
	Title *string `json:"title"`
	Type  *string `json:"type"`
	URL   *string `json:"url"`
}

type TileType

type TileType string

const (
	UnknownTileType TileType = ""
	TextTileType    TileType = "TILE_TYPE_TEXT"
	MediaTileType   TileType = "TILE_TYPE_MEDIA"
	VideoTileType   TileType = "TILE_TYPE_VIDEO"
)

type Token

type Token struct {
	ID              string                     `json:"id"`
	Name            string                     `json:"name"`
	ContractAddress *string                    `json:"contractAddress,omitempty"`
	TokenType       *TokenType                 `json:"tokenType,omitempty"`
	CreatedAt       *string                    `json:"createdAt,omitempty"`
	UpdatedAt       *string                    `json:"updatedAt,omitempty"`
	Status          *TokenRuleReviewStatusType `json:"status,omitempty"`
	WorldID         *string                    `json:"worldId,omitempty"`
	ObjectID        *string                    `json:"objectId,omitempty"`
}

type TokenInfo

type TokenInfo struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type TokenNetworkType

type TokenNetworkType string

const (
	UnknownTokenNetworkType  TokenNetworkType = ""
	MoonbeamTokenNetworkType TokenNetworkType = "moonbeam"
	EthereumTokenNetworkType TokenNetworkType = "eth_mainnet"
)

type TokenRule

type TokenRule struct {
	ID               string                    `json:"id"`
	Status           TokenRuleReviewStatusType `json:"status"`
	CreatedAt        *string                   `json:"createdAt,omitempty"`
	TokenGroupUserID *string                   `json:"tokenGroupUserId,omitempty"`
	Name             string                    `json:"name"`
	UpdatedAt        *string                   `json:"updatedAt,omitempty"`
	MinBalance       int                       `json:"minBalance"`
	Network          TokenNetworkType          `json:"network"`
	ContractAddress  string                    `json:"contractAddress"`
	TokenType        TokenType                 `json:"tokenType"`
	UserName         *string                   `json:"userName,omitempty"`
	UserID           *string                   `json:"userId,omitempty"`
	ObjectName       *string                   `json:"objectName,omitempty"`
}

type TokenRuleReviewStatusType

type TokenRuleReviewStatusType string

const (
	UnknownTokenRuleReviewStatusType  TokenRuleReviewStatusType = ""
	ApprovedTokenRuleReviewStatusType TokenRuleReviewStatusType = "approved"
	DeniedTokenRuleReviewStatusType   TokenRuleReviewStatusType = "denied"
)

type TokenType

type TokenType string

const (
	UnknownTokenType TokenType = ""
	ERC20TokenType   TokenType = "ERC20"
	ERC721TokenType  TokenType = "ERC721"
	ERC1155TokenType TokenType = "ERC1155"
)

type TopStaker

type TopStaker struct {
	UserID     umid.UMID `json:"user_id"`
	Name       *string   `json:"name"`
	TotalStake *big.Int  `json:"total_stake,omitempty"`
	StakeCount *uint8    `json:"stake_count,omitempty"`
	AvatarHash *string   `json:"avatarHash"`
}

type User

type User struct {
	ID         umid.UMID `json:"id"`
	UserTypeID umid.UMID `json:"userTypeId"`
	Name       string    `json:"name"`
	Wallet     *string   `json:"wallet,omitempty"`
	Profile    Profile   `json:"profile"`
	JWTToken   *string   `json:"token,omitempty"`
	CreatedAt  string    `json:"createdAt"`
	UpdatedAt  string    `json:"updatedAt,omitempty"`
	IsGuest    bool      `json:"isGuest"`
}

type UserSearchResult

type UserSearchResult struct {
	ID      umid.UMID `json:"id"`
	Name    *string   `json:"name,omitempty"`
	Wallet  *string   `json:"wallet,omitempty"`
	Profile Profile   `json:"profile,omitempty"`
}

type UserSearchResults

type UserSearchResults []UserSearchResult

type UserStatusType

type UserStatusType string

const (
	UnknownUserStatusType      UserStatusType = ""
	OnlineUserStatusType       UserStatusType = "online"
	DoNotDisturbUserStatusType UserStatusType = "dnd"
	AwayUserStatusType         UserStatusType = "away"
	InvisibleUserStatusType    UserStatusType = "invisible"
)

type UserSubAttributes

type UserSubAttributes map[string]any

type Validator

type Validator struct {
	ID                 string  `json:"id"`
	ParentID           string  `json:"parentId"`
	ObjectTypeID       string  `json:"objectTypeId"`
	OperatorObjectID   *string `json:"operatorObjectId,omitempty"`
	UITypeID           string  `json:"uiTypeId"`
	OperatorObjectName string  `json:"operatorObjectName"`
	Name               string  `json:"name"`
	IsFavorited        bool    `json:"isFavorited"`
	Metadata           struct {
		KusamaMetadata KusamaMetaData `json:"kusama_metadata"`
	} `json:"metadata"`
}

type VibeAmount

type VibeAmount struct {
	ObjectID string `json:"objectId"`
	Amount   int    `json:"amount"`
}

type WalletInfo

type WalletInfo struct {
	WalletID       string    `json:"wallet_id"`
	ContractID     string    `json:"contract_id"`
	Balance        string    `json:"balance"`
	BlockchainName string    `json:"blockchain_name"`
	UpdatedAt      time.Time `json:"updated_at"`
	Reward         string    `json:"reward"`
	Transferable   string    `json:"transferable"`
	Staked         string    `json:"staked"`
	Unbonding      string    `json:"unbonding"`
}

type WorldDetails

type WorldDetails struct {
	ID                 umid.UMID     `json:"id"`
	OwnerID            umid.UMID     `json:"owner_id"`
	OwnerName          *string       `json:"owner_name"`
	Description        *string       `json:"description"`
	StakeTotal         *string       `json:"stake_total,omitempty"`
	Name               *string       `json:"name"`
	CreatedAt          string        `json:"createdAt,omitempty"`
	UpdatedAt          string        `json:"updatedAt,omitempty"`
	AvatarHash         *string       `json:"avatarHash"`
	WebsiteLink        *string       `json:"website_link"`
	WorldStakers       []WorldStaker `json:"stakers"`
	LastStakingComment *string       `json:"last_staking_comment"`
	IsAdmin            *bool         `json:"is_admin"`
}

type WorldNFTMeta

type WorldNFTMeta struct {
	Name        string          `json:"name" binding:"required"`
	Description string          `json:"description"`
	Image       string          `json:"image"`
	ExternalURL string          `json:"external_url"`
	Attributes  []NFTAttributes `json:"attributes"`
}

type WorldStaker

type WorldStaker struct {
	UserID     umid.UMID `json:"user_id"`
	Name       *string   `json:"name"`
	Stake      *string   `json:"stake,omitempty"`
	AvatarHash *string   `json:"avatarHash"`
}