wgn

package
v4.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2024 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountInfo

type AccountInfo struct {
	// Player ID
	AccountId *int `json:"account_id,omitempty"`
	// Date when player's account was created
	CreatedAt *wgnTime.UnixTime `json:"created_at,omitempty"`
	// List of games player has played
	Games []string `json:"games,omitempty"`
	// Player name
	Nickname *string `json:"nickname,omitempty"`
	// Player's private data
	Private *struct {
		// Amount of Free Experience
		FreeXp *int `json:"free_xp,omitempty"`
		// Current gold balance
		Gold *int `json:"gold,omitempty"`
		// Premium Account expiration date
		PremiumExpiresAt *wgnTime.UnixTime `json:"premium_expires_at,omitempty"`
	} `json:"private,omitempty"`
}

type AccountInfoOptions

type AccountInfoOptions struct {
	// Access token for the private data of a user's account; can be received via the authorization method; valid within a stated time period
	AccessToken *string `json:"access_token,omitempty"`
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
}

type AccountList

type AccountList struct {
	// Player ID
	AccountId *int `json:"account_id,omitempty"`
	// Date when player's account was created
	CreatedAt *wgnTime.UnixTime `json:"created_at,omitempty"`
	// List of games player has played
	Games []string `json:"games,omitempty"`
	// Player name
	Nickname *string `json:"nickname,omitempty"`
}

type AccountListOptions

type AccountListOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to player search. If the parameter is not specified, search will be executed across known games. Maximum limit: 10. Valid values:
	//
	// "wotb" - World of Tanks Blitz
	// "wot" - World of Tanks
	// "wows" - World of Warships
	// "wowp" - World of Warplanes
	Game []string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
	// Number of returned entries (fewer can be returned, but not more than 100). If the limit sent exceeds 100, a limit of None is applied (by default).
	Limit *int `json:"limit,omitempty"`
	// Search type. Default is "startswith". Valid values:
	//
	// "startswith" - Search by initial characters of player name. Minimum length: 3 characters. Maximum length: 24 characters. (by default)
	// "exact" - Search by exact match of player name. Case insensitive. You can enter several names, separated with commas (up to 100).
	Type *string `json:"type,omitempty"`
}

type ClansGlossary

type ClansGlossary struct {
	// Available clan positions
	ClansRoles map[string]string `json:"clans_roles,omitempty"`
	// Game with clan entities
	Game *string `json:"game,omitempty"`
}

type ClansGlossaryOptions

type ClansGlossaryOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to perform the clan search in. If the parameter is not specified, search will be executed across World of Tanks. Default is "wot". Valid values:
	//
	// "wot" - World of Tanks (by default)
	// "wowp" - World of Warplanes
	Game *string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
}

type ClansInfo

type ClansInfo struct {
	// Clan can invite players
	AcceptsJoinRequests *bool `json:"accepts_join_requests,omitempty"`
	// Clan ID
	ClanId *int `json:"clan_id,omitempty"`
	// Clan color in HEX #RRGGBB
	Color *string `json:"color,omitempty"`
	// Clan creation date
	CreatedAt *wgnTime.UnixTime `json:"created_at,omitempty"`
	// Clan creator ID
	CreatorId *int `json:"creator_id,omitempty"`
	// Clan creator's name
	CreatorName *string `json:"creator_name,omitempty"`
	// Clan description
	Description *string `json:"description,omitempty"`
	// Clan description in HTML
	DescriptionHtml *string `json:"description_html,omitempty"`
	// Information on clan emblems in games and on clan portal
	Emblems *struct {
		// List of links to 195x195 px emblems
		X195 map[string]string `json:"x195,omitempty"`
		// List of links to 24x24 px emblems
		X24 map[string]string `json:"x24,omitempty"`
		// List of links to 256x256 px emblems
		X256 map[string]string `json:"x256,omitempty"`
		// List of links to 32x32 px emblems
		X32 map[string]string `json:"x32,omitempty"`
		// List of links to 64x64 px emblems
		X64 map[string]string `json:"x64,omitempty"`
	} `json:"emblems,omitempty"`
	// Game where clan was created
	Game *string `json:"game,omitempty"`
	// Clan has been deleted. The deleted clan data contains valid values for the following fields only: clan_id, is_clan_disbanded, updated_at.
	IsClanDisbanded *bool `json:"is_clan_disbanded,omitempty"`
	// Clan Commander ID
	LeaderId *int `json:"leader_id,omitempty"`
	// Commander's name
	LeaderName *string `json:"leader_name,omitempty"`
	// Information on clan members. Field format depends on members_key input parameter.
	Members *struct {
		// Player account ID
		AccountId *int `json:"account_id,omitempty"`
		// Player name
		AccountName *string `json:"account_name,omitempty"`
		// Date when player joined clan
		JoinedAt *wgnTime.UnixTime `json:"joined_at,omitempty"`
		// Technical position name
		Role *string `json:"role,omitempty"`
		// Position
		RoleI18n *string `json:"role_i18n,omitempty"`
	} `json:"members,omitempty"`
	// Number of clan members
	MembersCount *int `json:"members_count,omitempty"`
	// Clan motto
	Motto *string `json:"motto,omitempty"`
	// Clan name
	Name *string `json:"name,omitempty"`
	// Old clan name
	OldName *string `json:"old_name,omitempty"`
	// Old clan tag
	OldTag *string `json:"old_tag,omitempty"`
	// Restricted clan information
	Private *struct {
		// Clan Treasury
		ClanTreasury *struct {
			// Amount of credits in the сlan Treasury
			Credits *int `json:"credits,omitempty"`
			// Number of bonds in the сlan Treasury
			Crystal *int `json:"crystal,omitempty"`
			// Amount of gold in the сlan Treasury
			Gold *int `json:"gold,omitempty"`
		} `json:"clan_treasury,omitempty"`
		// List of clan members with an active game session in World of Tanks.
		// An extra field.
		OnlineMembers []int `json:"online_members,omitempty"`
		// Amount of gold in the сlan Treasury
		Treasury *int `json:"treasury,omitempty"`
	} `json:"private,omitempty"`
	// Time (UTC) when clan name was changed
	RenamedAt *wgnTime.UnixTime `json:"renamed_at,omitempty"`
	// Clan tag
	Tag *string `json:"tag,omitempty"`
	// Time when clan details were updated
	UpdatedAt *wgnTime.UnixTime `json:"updated_at,omitempty"`
}

type ClansInfoOptions

type ClansInfoOptions struct {
	// Access token for the private data of a user's account; can be received via the authorization method; valid within a stated time period
	AccessToken *string `json:"access_token,omitempty"`
	// Extra fields that will be added to the response. Valid values:
	//
	// "private.online_members"
	Extra []string `json:"extra,omitempty"`
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to perform the clan search in. If the parameter is not specified, search will be executed across World of Tanks. Default is "wot". Valid values:
	//
	// "wot" - World of Tanks (by default)
	// "wowp" - World of Warplanes
	Game *string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
	// This parameter changes members field type. Valid values:
	//
	// "id" - Members field will contain associative array with account_id indexing in response
	MembersKey *string `json:"members_key,omitempty"`
}

type ClansList

type ClansList struct {
	// Clan ID
	ClanId *int `json:"clan_id,omitempty"`
	// Clan color in HEX #RRGGBB
	Color *string `json:"color,omitempty"`
	// Clan creation date
	CreatedAt *wgnTime.UnixTime `json:"created_at,omitempty"`
	// Information on clan emblems in games and on clan portal
	Emblems *struct {
		// List of links to 195x195 px emblems
		X195 map[string]string `json:"x195,omitempty"`
		// List of links to 24x24 px emblems
		X24 map[string]string `json:"x24,omitempty"`
		// List of links to 256x256 px emblems
		X256 map[string]string `json:"x256,omitempty"`
		// List of links to 32x32 px emblems
		X32 map[string]string `json:"x32,omitempty"`
		// List of links to 64x64 px emblems
		X64 map[string]string `json:"x64,omitempty"`
	} `json:"emblems,omitempty"`
	// Game where clan was created
	Game *string `json:"game,omitempty"`
	// Number of clan members
	MembersCount *int `json:"members_count,omitempty"`
	// Clan name
	Name *string `json:"name,omitempty"`
	// Clan tag
	Tag *string `json:"tag,omitempty"`
}

type ClansListOptions

type ClansListOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to perform the clan search in. If the parameter is not specified, search will be executed across World of Tanks. Default is "wot". Maximum limit: 100. Valid values:
	//
	// "wot" - World of Tanks
	// "wowp" - World of Warplanes
	Game []string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
	// Number of returned entries (fewer can be returned, but not more than 100). If the limit sent exceeds 100, a limit of 100 is applied (by default).
	Limit *int `json:"limit,omitempty"`
	// Page number. Default is 1. Min value is 1.
	PageNo *int `json:"page_no,omitempty"`
	// Part of name or tag for clan search. Minimum 2 characters
	Search *string `json:"search,omitempty"`
}

type ClansMemberhistory

type ClansMemberhistory struct {
	// Player account ID
	AccountId *int `json:"account_id,omitempty"`
	// Clan ID
	ClanId *int `json:"clan_id,omitempty"`
	// Date when player joined clan
	JoinedAt *wgnTime.UnixTime `json:"joined_at,omitempty"`
	// Date when player left clan
	LeftAt *wgnTime.UnixTime `json:"left_at,omitempty"`
	// Last position in clan
	Role *string `json:"role,omitempty"`
}

type ClansMemberhistoryOptions

type ClansMemberhistoryOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to perform the clan history search in. If the parameter is not specified, search will be executed across World of Tanks. Default is "wot". Valid values:
	//
	// "wot" - World of Tanks (by default)
	// "wowp" - World of Warplanes
	Game *string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
}

type ClansMembersinfo

type ClansMembersinfo struct {
	// Player account ID
	AccountId *int `json:"account_id,omitempty"`
	// Player name
	AccountName *string `json:"account_name,omitempty"`
	// Short clan info
	Clan *struct {
		// Clan ID
		ClanId *int `json:"clan_id,omitempty"`
		// Clan color in HEX #RRGGBB
		Color *string `json:"color,omitempty"`
		// Clan creation date
		CreatedAt *wgnTime.UnixTime `json:"created_at,omitempty"`
		// Information on clan emblems in games and on clan portal
		Emblems *struct {
			// List of links to 195x195 px emblems
			X195 map[string]string `json:"x195,omitempty"`
			// List of links to 24x24 px emblems
			X24 map[string]string `json:"x24,omitempty"`
			// List of links to 256x256 px emblems
			X256 map[string]string `json:"x256,omitempty"`
			// List of links to 32x32 px emblems
			X32 map[string]string `json:"x32,omitempty"`
			// List of links to 64x64 px emblems
			X64 map[string]string `json:"x64,omitempty"`
		} `json:"emblems,omitempty"`
		// Game where clan was created
		Game *string `json:"game,omitempty"`
		// Number of clan members
		MembersCount *int `json:"members_count,omitempty"`
		// Clan name
		Name *string `json:"name,omitempty"`
		// Clan tag
		Tag *string `json:"tag,omitempty"`
	} `json:"clan,omitempty"`
	// Date when player joined clan
	JoinedAt *wgnTime.UnixTime `json:"joined_at,omitempty"`
	// Technical position name
	Role *string `json:"role,omitempty"`
	// Position
	RoleI18n *string `json:"role_i18n,omitempty"`
}

type ClansMembersinfoOptions

type ClansMembersinfoOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to perform the clan search in. If the parameter is not specified, search will be executed across World of Tanks. Default is "wot". Valid values:
	//
	// "wot" - World of Tanks (by default)
	// "wowp" - World of Warplanes
	Game *string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
}

type ClansMessageboard

type ClansMessageboard struct {
	// Message author ID
	AuthorId *int `json:"author_id,omitempty"`
	// Message creation date
	CreatedAt *wgnTime.UnixTime `json:"created_at,omitempty"`
	// ID of a player who has changed the message
	EditorId *int `json:"editor_id,omitempty"`
	// Indicates if the message has been read
	IsRead *bool `json:"is_read,omitempty"`
	// Message text
	Message *string `json:"message,omitempty"`
	// Date when message was updated
	UpdatedAt *wgnTime.UnixTime `json:"updated_at,omitempty"`
}

type ClansMessageboardOptions

type ClansMessageboardOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Name of the game to perform the clan search in. If the parameter is not specified, search will be executed across World of Tanks. Default is "wot". Valid values:
	//
	// "wot" - World of Tanks (by default)
	// "wowp" - World of Warplanes
	Game *string `json:"game,omitempty"`
}

type ServersInfo

type ServersInfo struct {
	// Number of online players
	PlayersOnline *int `json:"players_online,omitempty"`
	// Server ID
	Server *string `json:"server,omitempty"`
}

type ServersInfoOptions

type ServersInfoOptions struct {
	// Response field. The fields are separated with commas. Embedded fields are separated with dots. To exclude a field, use "-" in front of its name. In case the parameter is not defined, the method returns all fields. Maximum limit: 100.
	Fields []string `json:"fields,omitempty"`
	// Game ID. Maximum limit: 100. Valid values:
	//
	// "wotb" - World of Tanks Blitz
	// "wot" - World of Tanks
	// "wows" - World of Warships
	Game []string `json:"game,omitempty"`
	// Localization language. Default is "en". Valid values:
	//
	// "en" - English (by default)
	// "ru" - Русский
	// "pl" - Polski
	// "de" - Deutsch
	// "fr" - Français
	// "es" - Español
	// "zh-cn" - 简体中文
	// "zh-tw" - 繁體中文
	// "tr" - Türkçe
	// "cs" - Čeština
	// "th" - ไทย
	// "vi" - Tiếng Việt
	// "ko" - 한국어
	Language *string `json:"language,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL