geyser

package module
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Dec 15, 2019 License: MIT Imports: 14 Imported by: 1

README

geyser GoDoc

Steam Web API client for Go.

Interface methods are auto-generated by the apigen package.

Documentation

Overview

Package geyser implements an HTTP client for the Steam Web API.

API interfaces and methods are generated automatically by sub-package "apigen" and are structured as a tree.

NOTE: A non-partner api key is used to fetch the API schema, so only non-partner interfaces are generated.

Structure

Interfaces are grouped by their base name, with the leading "I" and the AppID removed. For example: all "IGCVersion_<ID>" interfaces are grouped into a single interface struct named "GCVersion" that is instantiated by passing the AppID as parameter ("GCVersion(version)").

Interfaces that don't have an AppID do not require an AppID parameter (e.g.: "ISteamApps" -> "SteamApps()"). Interfaces that have a single AppID still require an AppID parameter.

The same grouping is done for interface methods. All methods with the same name but different versions are grouped by name and the version is parameterized ("Method(version)").

Methods that have a single version do not require a version parameter ("Method()").

The workflow for requesting an interface method is:

Client
|-> Interface([appID])
    |-> Method([version])
        |-> Request
            |-> Configure Request (optional)
            |-> Request execution
                |-> HTTP response
                    |-> Check HTTP response status
                    |-> Parse response body or use the configured result value

Client is the root element. Interfaces are instantiated with methods in the Client struct (possibly requiring an AppID parameter). Interface methods are struct methods of the interface struct (possibly requiring a version parameter).

Parameters to the request must be set in the Request configuration step (see Request.SetOptions). Parameters are validated automatically conforming the interface method schema and the request execution will return an error if the validation failed.

Results of requests can be obtained in two ways: parsing the response body manually, or configuring the result object in the Request before executing.

Requests are always sent using "format=json", so response bodies (seem to) always be in JSON format. For manual parsing, checking "Content-Type" response header is recommended. When setting the result object in the Request (see Request.SetResult), a "JSON-unmarshable" object is expected.

All requests created by generated methods are pre-configured with a corresponding result struct.

Result structs are also (initially) automatically generated, they are named by concatenating the interface struct name and the method name (e.g.: "ISteamApps/GetAppList" -> "SteamAppsGetAppList").

Given that each response has a specific format and cannot be automatically generated, most of these result structs are empty (so they are useless, but response bodies are still available for manual parsing). When a response format is known, the result struct will be updated and won't be automatically (re)generated.

Look for non-empty result structs for each interface method to see if there's any available at the time. Contributions to implement proper result structs are welcome!

NOTE: Since not all similarly named interfaces with different AppIDs are necessarily identical, this grouping can result in generated interface struct methods that are not present in a given interface. For example, given an API schema of:

{
  IFace_1[GetValue(v1), GetValue(v2)],
  IFace_2[GetValue(v1), GetValue(v2), GetSpecificAppID2Value(v1)]
}

where IFace_2 is a superset of IFace_1, the resulting structure would be:

{
  Face(appID)[GetValue(version), GetSpecificAppID2Value()]
}

GetValue and GetSpecificAppID2Value are generated struct methods of Face, regardless of AppID and version.

Accessing Face(1).GetValue(1) is valid, so is accessing Face(1).GetValue(2). But accessing Face(1).GetSpecificAppID2Value() returns an error.

Schema

API schema is defined by "Schema*" types that compose the tree-like structure of the generated API and provide basic methods for navigating and manipulation of the schema.

A schema starts with a root Schema node that contains API information and a SchemaInterfaces collection of interfaces.

SchemaInterfaces is a collection of SchemaInterface interfaces. It also provides helper methods to group interfaces by name, extract AppIDs and so on.

SchemaInterface holds the specificiation of the interface and a SchemaMethods collection of methods.

SchemaMethods is a collection of SchemaMethod and provides helpers methods to group methods by name, extract versions and so on.

SchemaMethod represents the specification of an interface method. It also contains a collection of parameters SchemaMethodParams.

SchemaMethodParams is a collection of SchemaMethodParam. It also provides helpers for parameter validation.

SchemaMethodParam holds the specification of an interface method parameter.

The specification for each interface is exposed through "Schema<InterfaceName>" public variables. These can also be used direcly by users for any other purpose, including instantiating individual interface structs directly.

All of the collection types provide JSON encoding methods that help in serialization/deserialization to/from JSON format. These types can be used directly when deserializing a JSON schema.

Official Documentation

Steam Web API documentation can be found at:

https://partner.steamgames.com/doc/webapi_overview

https://developer.valvesoftware.com/wiki/Steam_Web_API

https://wiki.teamfortress.com/wiki/WebAPI

Undocumented API

There are several interfaces and methods not present in the official API schema (returned by "ISteamWebAPIUtil/GetSupportedAPIList"), including game-specific schemas.

These undocumented interfaces are fetched from third-party sources and are also generated along with the official one.

Specifications of undocumented methods don't define any parameters, so no validation is performed or any documentation is generated. More importantly, they also don't define the HTTP method to be used. For now, these methods default to GET HTTP method.

When an interface or method originates from an undocumented source, they'll have a comment indicating it.

A comprehensive list of interfaces and methods, documented and undocumented, can be found at https://steamapi.xpaw.me

Other APIs

APIs that are available on different hosts and have different schemas are generated under sub-packages.

These sub-packages will contain their own "Client" struct that are thin wrappers around the base Client.

Schema structure and code generation rules are the same as for the main package.

Currently, only Dota 2 is known to geyser and is implemented in sub-package "dota2".

Example (Basic)
package main

import (
	"fmt"
	"log"
	"net/url"

	"github.com/13k/geyser"
)

func main() {
	client, err := geyser.New(
		geyser.WithDebug(),
		geyser.WithKey("<steam_api_key>"),
		geyser.WithLanguage("en_US"),
	)

	if err != nil {
		log.Fatal(err)
	}

	dota2match, err := client.DOTA2Match(570)

	if err != nil {
		log.Fatal(err)
	}

	req, err := dota2match.GetTeamInfoByTeamID()

	if err != nil {
		log.Fatal(err)
	}

	result := make(map[string]interface{})

	req.SetResult(result)
	req.SetOptions(geyser.RequestOptions{
		Params: url.Values{"teams_requested": []string{"3"}},
	})

	resp, err := req.Execute()

	if err != nil {
		log.Fatal(err)
	}

	if !resp.IsSuccess() {
		log.Fatalf("HTTP error: %s", resp.Status())
	}

	fmt.Printf("%#v\n", result)
}
Output:

Index

Examples

Constants

View Source
const (
	HostURL = "https://api.steampowered.com"
)

Variables

View Source
var (
	// ErrEmptyInterfaces is returned when trying to manipulate an empty
	// SchemaInterfaces.
	ErrEmptyInterfaces = errors.New("empty interfaces collection")
	// ErrMixedInterfaces is returned when trying to use group helpers on a
	// SchemaInterfaces collection containing mixed interface names.
	ErrMixedInterfaces = errors.New("mixed interfaces collection")
	// ErrMixedMethods is returned when trying to use group helpers on a
	// SchemaMethods collection containing mixed method names.
	ErrMixedMethods = errors.New("mixed methods collection")
)
View Source
var SchemaAccountLinkingService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetLinkedAccountInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IAccountLinkingService",
		Undocumented: true,
	},
)

SchemaAccountLinkingService stores the SchemaInterfaces for interface IAccountLinkingService.

View Source
var SchemaBroadcastService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "PostGameDataFrameRTMP",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID of the game being broadcasted",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Broadcasters SteamID",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Valid RTMP token for the Broadcaster",
						Name:        "rtmp_token",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "game data frame expressing current state of game (string, zipped, whatever)",
						Name:        "frame_data",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "PostChatMessage",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "MuteBroadcastChatUser",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RemoveUserChatText",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetRTMPInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetRTMPInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "UpdateChatMessageFlair",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastUploadStats",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastViewerStats",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "StartBuildClip",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBuildClipStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetClipDetails",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IBroadcastService",
		Undocumented: false,
	},
)

SchemaBroadcastService stores the SchemaInterfaces for interface IBroadcastService.

View Source
var SchemaCSGOPlayers = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetNextMatchSharingCode",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The SteamID of the user",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Authentication obtained from the SteamID",
						Name:        "steamidkey",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Previously known match sharing code obtained from the SteamID",
						Name:        "knowncode",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ICSGOPlayers_730",
		Undocumented: false,
	},
)

SchemaCSGOPlayers stores the SchemaInterfaces for interface ICSGOPlayers.

View Source
var SchemaCSGOServers = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetGameMapsPlaytime",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "What recent interval is requested, possible values: day, week, month",
						Name:        "interval",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "What game mode is requested, possible values: competitive, casual",
						Name:        "gamemode",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "What maps are requested, possible values: operation",
						Name:        "mapgroup",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetGameServersStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ICSGOServers_730",
		Undocumented: false,
	},
)

SchemaCSGOServers stores the SchemaInterfaces for interface ICSGOServers.

View Source
var SchemaCSGOTournaments = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentFantasyLineup",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The event ID",
						Name:        "event",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the user inventory",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Authentication obtained from the SteamID",
						Name:        "steamidkey",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The event ID",
						Name:        "event",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the user inventory",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Authentication obtained from the SteamID",
						Name:        "steamidkey",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentLayout",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The event ID",
						Name:        "event",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPredictions",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The event ID",
						Name:        "event",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the user inventory",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Authentication obtained from the SteamID",
						Name:        "steamidkey",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "UploadTournamentFantasyLineup",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The event ID",
						Name:        "event",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the user inventory",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Authentication obtained from the SteamID",
						Name:        "steamidkey",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Event section id",
						Name:        "sectionid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "PickID to select for the slot",
						Name:        "pickid0",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "ItemID to lock in for the pick",
						Name:        "itemid0",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "PickID to select for the slot",
						Name:        "pickid1",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "ItemID to lock in for the pick",
						Name:        "itemid1",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "PickID to select for the slot",
						Name:        "pickid2",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "ItemID to lock in for the pick",
						Name:        "itemid2",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "PickID to select for the slot",
						Name:        "pickid3",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "ItemID to lock in for the pick",
						Name:        "itemid3",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "PickID to select for the slot",
						Name:        "pickid4",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "ItemID to lock in for the pick",
						Name:        "itemid4",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "UploadTournamentPredictions",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The event ID",
						Name:        "event",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the user inventory",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Authentication obtained from the SteamID",
						Name:        "steamidkey",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Event section id",
						Name:        "sectionid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Event group id",
						Name:        "groupid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Index in group",
						Name:        "index",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Pick ID to select",
						Name:        "pickid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "ItemID to lock in for the pick",
						Name:        "itemid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ICSGOTournaments_730",
		Undocumented: false,
	},
)

SchemaCSGOTournaments stores the SchemaInterfaces for interface ICSGOTournaments.

View Source
var SchemaCheatReportingService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "ReportCheatData",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "steamid of the user running and reporting the cheat.",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The appid.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "path and file name of the cheat executable.",
						Name:        "pathandfilename",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "web url where the cheat was found and downloaded.",
						Name:        "webcheaturl",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "local system time now.",
						Name:        "time_now",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "local system time when cheat process started. ( 0 if not yet run )",
						Name:        "time_started",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "local system time when cheat process stopped. ( 0 if still running )",
						Name:        "time_stopped",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "descriptive name for the cheat.",
						Name:        "cheatname",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "process ID of the running game.",
						Name:        "game_process_id",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "process ID of the cheat process that ran",
						Name:        "cheat_process_id",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "cheat param 1",
						Name:        "cheat_param_1",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "cheat param 2",
						Name:        "cheat_param_2",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "data collection in json format",
						Name:        "cheat_data_dump",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ICheatReportingService",
		Undocumented: false,
	},
)

SchemaCheatReportingService stores the SchemaInterfaces for interface ICheatReportingService.

View Source
var SchemaClientStats = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodPost,
				Name:         "ReportEvent",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IClientStats_1046930",
		Undocumented: false,
	},
)

SchemaClientStats stores the SchemaInterfaces for interface IClientStats.

View Source
var SchemaCloudService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetUploadServerInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "BeginHTTPUpload",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "CommitHTTPUpload",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetFileDetails",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "EnumerateUserFiles",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Delete",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ICloudService",
		Undocumented: true,
	},
)

SchemaCloudService stores the SchemaInterfaces for interface ICloudService.

View Source
var SchemaCommunityService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetApps",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetUserPartnerEventNews",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBestEventsForUser",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ICommunityService",
		Undocumented: true,
	},
)

SchemaCommunityService stores the SchemaInterfaces for interface ICommunityService.

View Source
var SchemaContentServerConfigService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetSteamCacheClientFilters",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Unique ID number",
						Name:        "cache_id",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid current cache API key",
						Name:        "cache_key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Notes",
						Name:        "change_notes",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "comma-separated list of allowed IP address blocks in CIDR format - blank to clear unfilter",
						Name:        "allowed_ip_blocks",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSteamCacheNodeParams",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Unique ID number",
						Name:        "cache_id",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid current cache API key",
						Name:        "cache_key",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetSteamCachePerformanceStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Unique ID number",
						Name:        "cache_id",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid current cache API key",
						Name:        "cache_key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Outgoing network traffic in Mbps",
						Name:        "mbps_sent",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Incoming network traffic in Mbps",
						Name:        "mbps_recv",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Percent CPU load",
						Name:        "cpu_percent",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Percent cache hits",
						Name:        "cache_hit_percent",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Number of unique connected IP addresses",
						Name:        "num_connected_ips",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "What is the percent utilization of the busiest datacenter egress link?",
						Name:        "upstream_egress_utilization",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IContentServerConfigService",
		Undocumented: false,
	},
)

SchemaContentServerConfigService stores the SchemaInterfaces for interface IContentServerConfigService.

View Source
var SchemaContentServerDirectoryService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetServersForSteamPipe",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "client Cell ID",
						Name:        "cell_id",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "max servers in response list",
						Name:        "max_servers",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "client IP address",
						Name:        "ip_override",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "launcher type",
						Name:        "launcher_type",
						Optional:    true,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetDepotPatchInfo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "depotid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "source_manifestid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "target_manifestid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IContentServerDirectoryService",
		Undocumented: false,
	},
)

SchemaContentServerDirectoryService stores the SchemaInterfaces for interface IContentServerDirectoryService.

View Source
var SchemaCredentialsService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "ValidateEmailAddress",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SteamGuardPhishingReport",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ICredentialsService",
		Undocumented: true,
	},
)

SchemaCredentialsService stores the SchemaInterfaces for interface ICredentialsService.

View Source
var SchemaDOTA2Fantasy = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetFantasyPlayerStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The fantasy league ID",
						Name:        "FantasyLeagueID",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "An optional filter for minimum timestamp",
						Name:        "StartTime",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "An optional filter for maximum timestamp",
						Name:        "EndTime",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "An optional filter for a specific match",
						Name:        "MatchID",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "An optional filter for a specific series",
						Name:        "SeriesID",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "An optional filter for a specific player",
						Name:        "PlayerAccountID",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerOfficialInfo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The account ID to look up",
						Name:        "accountid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetProPlayerList",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2Fantasy_205790",
		Undocumented: false,
	},
)

SchemaDOTA2Fantasy stores the SchemaInterfaces for interface IDOTA2Fantasy.

View Source
var SchemaDOTA2Match = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetLiveLeagueGames",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Only show matches of the specified league id",
						Name:        "league_id",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Only show matches of the specified match id",
						Name:        "match_id",
						Optional:    true,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetMatchDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Match id",
						Name:        "match_id",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Include persona names as part of the response",
						Name:        "include_persona_names",
						Optional:    true,
						Type:        "bool",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetMatchHistory",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The ID of the hero that must be in the matches being queried",
						Name:        "hero_id",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Which game mode to return matches for",
						Name:        "game_mode",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The average skill range of the match, these can be [1-3] with lower numbers being lower skill. Ignored if an account ID is specified",
						Name:        "skill",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Minimum number of human players that must be in a match for it to be returned",
						Name:        "min_players",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "An account ID to get matches from. This will fail if the user has their match history hidden",
						Name:        "account_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The league ID to return games from",
						Name:        "league_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The minimum match ID to start from",
						Name:        "start_at_match_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The number of requested matches to return",
						Name:        "matches_requested",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetMatchHistoryBySequenceNum",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "start_at_match_seq_num",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "matches_requested",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTeamInfoByTeamID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "start_at_team_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "teams_requested",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTopLiveEventGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Which partner's games to use.",
						Name:        "partner",
						Optional:    false,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTopLiveGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Which partner's games to use.",
						Name:        "partner",
						Optional:    false,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTopWeekendTourneyGames",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Which partner's games to use.",
						Name:        "partner",
						Optional:    false,
						Type:        "int32",
					},
					&SchemaMethodParam{
						Description: "Prefer matches from this division.",
						Name:        "home_division",
						Optional:    true,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPlayerStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "account_id",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "league_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "hero_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "time_frame",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "match_id",
						Optional:    true,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPlayerStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "account_id",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "league_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "hero_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "time_frame",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "match_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "phase_id",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      2,
			},
		),
		Name:         "IDOTA2Match_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetLeagueListing",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetLiveLeagueGames",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Only show matches of the specified league id",
						Name:        "league_id",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Only show matches of the specified match id",
						Name:        "match_id",
						Optional:    true,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetMatchDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Match id",
						Name:        "match_id",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetMatchHistory",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The ID of the hero that must be in the matches being queried",
						Name:        "hero_id",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Which game mode to return matches for",
						Name:        "game_mode",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The average skill range of the match, these can be [1-3] with lower numbers being lower skill. Ignored if an account ID is specified",
						Name:        "skill",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Minimum number of human players that must be in a match for it to be returned",
						Name:        "min_players",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "An account ID to get matches from. This will fail if the user has their match history hidden",
						Name:        "account_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The league ID to return games from",
						Name:        "league_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The minimum match ID to start from",
						Name:        "start_at_match_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The number of requested matches to return",
						Name:        "matches_requested",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetMatchHistoryBySequenceNum",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "start_at_match_seq_num",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "matches_requested",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTeamInfoByTeamID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "start_at_team_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "teams_requested",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTopLiveEventGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Which partner's games to use.",
						Name:        "partner",
						Optional:    false,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTopLiveGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Which partner's games to use.",
						Name:        "partner",
						Optional:    false,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTopWeekendTourneyGames",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Which partner's games to use.",
						Name:        "partner",
						Optional:    false,
						Type:        "int32",
					},
					&SchemaMethodParam{
						Description: "Prefer matches from this division.",
						Name:        "home_division",
						Optional:    true,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPlayerStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "account_id",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "league_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "hero_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "time_frame",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "match_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "phase_id",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPlayerStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "account_id",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "league_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "hero_id",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "time_frame",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "match_id",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "phase_id",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      2,
			},
		),
		Name:         "IDOTA2Match_205790",
		Undocumented: false,
	},
)

SchemaDOTA2Match stores the SchemaInterfaces for interface IDOTA2Match.

View Source
var SchemaDOTA2MatchStats = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetRealtimeStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "server_steam_id",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2MatchStats_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetRealtimeStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "server_steam_id",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2MatchStats_205790",
		Undocumented: false,
	},
)

SchemaDOTA2MatchStats stores the SchemaInterfaces for interface IDOTA2MatchStats.

View Source
var SchemaDOTA2StreamSystem = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetBroadcasterInfo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "64-bit Steam ID of the broadcaster",
						Name:        "broadcaster_steam_id",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "LeagueID to use if we aren't in a lobby",
						Name:        "league_id",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2StreamSystem_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetBroadcasterInfo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "64-bit Steam ID of the broadcaster",
						Name:        "broadcaster_steam_id",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "LeagueID to use if we aren't in a lobby",
						Name:        "league_id",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2StreamSystem_205790",
		Undocumented: false,
	},
)

SchemaDOTA2StreamSystem stores the SchemaInterfaces for interface IDOTA2StreamSystem.

View Source
var SchemaDOTA2Ticket = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "ClaimBadgeReward",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Badge ID",
						Name:        "BadgeID",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 1",
						Name:        "ValidBadgeType1",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 2",
						Name:        "ValidBadgeType2",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 3",
						Name:        "ValidBadgeType3",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSteamIDForBadgeID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The badge ID",
						Name:        "BadgeID",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetSteamAccountPurchased",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The 64-bit Steam ID",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Badge Type",
						Name:        "BadgeType",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "SteamAccountValidForBadgeType",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The 64-bit Steam ID",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 1",
						Name:        "ValidBadgeType1",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 2",
						Name:        "ValidBadgeType2",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 3",
						Name:        "ValidBadgeType3",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2Ticket_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "ClaimBadgeReward",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Badge ID",
						Name:        "BadgeID",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 1",
						Name:        "ValidBadgeType1",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 2",
						Name:        "ValidBadgeType2",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 3",
						Name:        "ValidBadgeType3",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSteamIDForBadgeID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The badge ID",
						Name:        "BadgeID",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetSteamAccountPurchased",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The 64-bit Steam ID",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Badge Type",
						Name:        "BadgeType",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "SteamAccountValidForBadgeType",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The 64-bit Steam ID",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 1",
						Name:        "ValidBadgeType1",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 2",
						Name:        "ValidBadgeType2",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Valid Badge Type 3",
						Name:        "ValidBadgeType3",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IDOTA2Ticket_205790",
		Undocumented: false,
	},
)

SchemaDOTA2Ticket stores the SchemaInterfaces for interface IDOTA2Ticket.

View Source
var SchemaEconDOTA2 = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetEventStatsForAccount",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The League ID of the compendium you're looking for.",
						Name:        "eventid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The account ID to look up.",
						Name:        "accountid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The language to provide hero names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetGameItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to provide item names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetHeroes",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to provide hero names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Return a list of itemized heroes only.",
						Name:        "itemizedonly",
						Optional:    true,
						Type:        "bool",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetItemCreators",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The item definition to get creator information for.",
						Name:        "itemdef",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetRarities",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to provide rarity names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPrizePool",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The ID of the league to get the prize pool of",
						Name:        "leagueid",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconDOTA2_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetEventStatsForAccount",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The League ID of the compendium you're looking for.",
						Name:        "eventid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The account ID to look up.",
						Name:        "accountid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The language to provide hero names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetGameItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to provide item names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetHeroes",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to provide hero names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Return a list of itemized heroes only.",
						Name:        "itemizedonly",
						Optional:    true,
						Type:        "bool",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetItemIconPath",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The item icon name to get the CDN path of",
						Name:        "iconname",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The type of image you want. 0 = normal, 1 = large, 2 = ingame",
						Name:        "icontype",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetRarities",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to provide rarity names in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTournamentPrizePool",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The ID of the league to get the prize pool of",
						Name:        "leagueid",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconDOTA2_205790",
		Undocumented: false,
	},
)

SchemaEconDOTA2 stores the SchemaInterfaces for interface IEconDOTA2.

View Source
var SchemaEconItems = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchema",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to return the names in. Defaults to returning string keys.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchemaItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to return the names in. Defaults to returning string keys.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The first item id to return. Defaults to 0. Response will indicate next value to query if applicable.",
						Name:        "start",
						Optional:    true,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchemaOverview",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to return the names in. Defaults to returning string keys.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSchemaURL",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetStoreMetaData",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to results in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetStoreStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_440",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetEquippedPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Return items equipped for this class id",
						Name:        "class_id",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSchemaURL",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetStoreMetaData",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to results in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchema",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to return the names in. Defaults to returning string keys.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_620",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchema",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to return the names in. Defaults to returning string keys.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      2,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSchemaURL",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      2,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetStoreMetaData",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to results in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_730",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetEquippedPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Return items equipped for this class id",
						Name:        "class_id",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSchemaURL",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetStoreMetaData",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The language to results in.",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_205790",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_221540",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_238460",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetEquippedPlayerItems",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Return items equipped for this class id",
						Name:        "class_id",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconItems_583950",
		Undocumented: false,
	},
)

SchemaEconItems stores the SchemaInterfaces for interface IEconItems.

View Source
var SchemaEconService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTradeHistory",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The number of trades to return information for",
						Name:        "max_trades",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The time of the last trade shown on the previous page of results, or the time of the first trade if navigating back",
						Name:        "start_after_time",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The tradeid shown on the previous page of results, or the ID of the first trade if navigating back",
						Name:        "start_after_tradeid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The user wants the previous page of results, so return the previous max_trades trades before the start time and ID",
						Name:        "navigating_back",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If set, the item display data for the items included in the returned trades will also be returned",
						Name:        "get_descriptions",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "The language to use when loading item display data",
						Name:        "language",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "include_failed",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If set, the total number of trades the account has participated in will be included in the response",
						Name:        "include_total",
						Optional:    false,
						Type:        "bool",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTradeStatus",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "tradeid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "If set, the item display data for the items included in the returned trades will also be returned",
						Name:        "get_descriptions",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "The language to use when loading item display data",
						Name:        "language",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTradeOffers",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Request the list of sent offers.",
						Name:        "get_sent_offers",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Request the list of received offers.",
						Name:        "get_received_offers",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.",
						Name:        "get_descriptions",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "The language to use when loading item display data.",
						Name:        "language",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Indicates we should only return offers which are still active, or offers that have changed in state since the time_historical_cutoff",
						Name:        "active_only",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Indicates we should only return offers which are not active.",
						Name:        "historical_only",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "When active_only is set, offers updated since this time will also be returned",
						Name:        "time_historical_cutoff",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTradeOffer",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "tradeofferid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "language",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.",
						Name:        "get_descriptions",
						Optional:    false,
						Type:        "bool",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTradeOffersSummary",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The time the user last visited.  If not passed, will use the time the user last visited the trade offer page.",
						Name:        "time_last_visit",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "DeclineTradeOffer",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "tradeofferid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "CancelTradeOffer",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "tradeofferid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTradeHoldDurations",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "User you are trading with",
						Name:        "steamid_target",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "A special token that allows for trade offers from non-friends.",
						Name:        "trade_offer_access_token",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IEconService",
		Undocumented: false,
	},
)

SchemaEconService stores the SchemaInterfaces for interface IEconService.

View Source
var SchemaFriendMessagesService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetActiveMessageSessions",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetRecentMessages",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "MarkOfflineMessagesRead",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IFriendMessagesService",
		Undocumented: true,
	},
)

SchemaFriendMessagesService stores the SchemaInterfaces for interface IFriendMessagesService.

View Source
var SchemaGCVersion = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetClientVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGCVersion_440",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetClientVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGCVersion_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGCVersion_730",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetClientVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGCVersion_205790",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetClientVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGCVersion_583950",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetClientVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerVersion",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGCVersion_1046930",
		Undocumented: false,
	},
)

SchemaGCVersion stores the SchemaInterfaces for interface IGCVersion.

View Source
var SchemaGameCoordinator = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetMessages",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "PostMessages",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IGameCoordinator",
		Undocumented: true,
	},
)

SchemaGameCoordinator stores the SchemaInterfaces for interface IGameCoordinator.

View Source
var SchemaGameInventory = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetItemDefArchive",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IGameInventory",
		Undocumented: true,
	},
)

SchemaGameInventory stores the SchemaInterfaces for interface IGameInventory.

View Source
var SchemaGameNotificationsService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "UserCreateSession",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The appid to create the session for.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Game-specified context value the game can used to associate the session with some object on their backend.",
						Name:        "context",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The title of the session to be displayed within each user's list of sessions.",
						Name:        "title",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "The initial state of all users in the session.",
						Name:        "users",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "UserUpdateSession",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The sessionid to update.",
						Name:        "sessionid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The appid of the session to update.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "(Optional) The new title of the session.  If not specified, the title will not be changed.",
						Name:        "title",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it.",
						Name:        "users",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "UserDeleteSession",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The sessionid to delete.",
						Name:        "sessionid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The appid of the session to delete.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IGameNotificationsService",
		Undocumented: false,
	},
)

SchemaGameNotificationsService stores the SchemaInterfaces for interface IGameNotificationsService.

View Source
var SchemaGameServersService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetAccountList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "CreateAccount",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The app to use the account for",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The memo to set on the new account",
						Name:        "memo",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetMemo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the game server to set the memo on",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The memo to set on the new account",
						Name:        "memo",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "ResetLoginToken",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the game server to reset the login token of",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "DeleteAccount",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the game server account to delete",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetAccountPublicInfo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The SteamID of the game server to get info on",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "QueryLoginToken",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Login token to query",
						Name:        "login_token",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetServerSteamIDsByIP",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "server_ips",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetServerIPsBySteamID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "server_steamids",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerList",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IGameServersService",
		Undocumented: false,
	},
)

SchemaGameServersService stores the SchemaInterfaces for interface IGameServersService.

View Source
var SchemaInventoryService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SplitItemStack",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "itemid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "quantity",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "CombineItemStacks",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "fromitemid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "destitemid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "quantity",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPriceSheet",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "ecurrency",
						Optional:    false,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetInventory",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "ExchangeItem",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "AddPromoItem",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetItemDefs",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetItemDefMeta",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "ConsumeItem",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IInventoryService",
		Undocumented: false,
	},
)

SchemaInventoryService stores the SchemaInterfaces for interface IInventoryService.

View Source
var SchemaMobileAuthService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetWGToken",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IMobileAuthService",
		Undocumented: true,
	},
)

SchemaMobileAuthService stores the SchemaInterfaces for interface IMobileAuthService.

View Source
var SchemaMobileNotificationService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetUserNotificationCounts",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SwitchSessionToPush",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IMobileNotificationService",
		Undocumented: true,
	},
)

SchemaMobileNotificationService stores the SchemaInterfaces for interface IMobileNotificationService.

View Source
var SchemaPlayerService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "RecordOfflinePlaytime",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "ticket",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "play_sessions",
						Optional:    false,
						Type:        "{message}",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetRecentlyPlayedGames",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The player we're asking about",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The number of games to return (0/unset: all)",
						Name:        "count",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetOwnedGames",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The player we're asking about",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "true if we want additional details (name, icon) about each game",
						Name:        "include_appinfo",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Free games are excluded by default.  If this is set, free games the user has played will be returned.",
						Name:        "include_played_free_games",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "if set, restricts result set to the passed in apps",
						Name:        "appids_filter",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSteamLevel",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The player we're asking about",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetBadges",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The player we're asking about",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetCommunityBadgeProgress",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The player we're asking about",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The badge we're asking about",
						Name:        "badgeid",
						Optional:    false,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "IsPlayingSharedGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The player we're asking about",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The game player is currently playing",
						Name:        "appid_playing",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSteamLevelDistribution",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetNicknameList",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "AddFriend",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RemoveFriend",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "IgnoreFriend",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IPlayerService",
		Undocumented: false,
	},
)

SchemaPlayerService stores the SchemaInterfaces for interface IPlayerService.

View Source
var SchemaPortal2Leaderboards = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetBucketizedData",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The leaderboard name to fetch data for.",
						Name:        "leaderboardName",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IPortal2Leaderboards_620",
		Undocumented: false,
	},
)

SchemaPortal2Leaderboards stores the SchemaInterfaces for interface IPortal2Leaderboards.

View Source
var SchemaPublishedFileService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "QueryFiles",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "enumeration EPublishedFileQueryType in clientenums.h",
						Name:        "query_type",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Current page",
						Name:        "page",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Cursor to paginate through the results (set to '*' for the first request).  Prefer this over using the page parameter, as it will allow you to do deep pagination.  When used, the page parameter will be ignored.",
						Name:        "cursor",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "(Optional) The number of results, per page to return.",
						Name:        "numperpage",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "App that created the files",
						Name:        "creator_appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "App that consumes the files",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Tags to match on. See match_all_tags parameter below",
						Name:        "requiredtags",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "(Optional) Tags that must NOT be present on a published file to satisfy the query.",
						Name:        "excludedtags",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "If true, then items must have all the tags specified, otherwise they must have at least one of the tags.",
						Name:        "match_all_tags",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Required flags that must be set on any returned items",
						Name:        "required_flags",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Flags that must not be set on any returned items",
						Name:        "omitted_flags",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Text to match in the item's title or description",
						Name:        "search_text",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "EPublishedFileInfoMatchingFileType",
						Name:        "filetype",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Find all items that reference the given item.",
						Name:        "child_publishedfileid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].",
						Name:        "days",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given",
						Name:        "include_recent_votes_only",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Allow stale data to be returned for the specified number of seconds.",
						Name:        "cache_max_age_seconds",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Language to search in and also what gets returned. Defaults to English.",
						Name:        "language",
						Optional:    true,
						Type:        "int32",
					},
					&SchemaMethodParam{
						Description: "Required key-value tags to match on.",
						Name:        "required_kv_tags",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) At least one of the tags must be present on a published file to satisfy the query.",
						Name:        "taggroups",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) If true, only return the total number of files that satisfy this query.",
						Name:        "totalonly",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "(Optional) If true, only return the published file ids of files that satisfy this query.",
						Name:        "ids_only",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return vote data",
						Name:        "return_vote_data",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return tags in the file details",
						Name:        "return_tags",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return key-value tags in the file details",
						Name:        "return_kv_tags",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return preview image and video details in the file details",
						Name:        "return_previews",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return child item ids in the file details",
						Name:        "return_children",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Populate the short_description field instead of file_description",
						Name:        "return_short_description",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return pricing information, if applicable",
						Name:        "return_for_sale_data",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Populate the metadata",
						Name:        "return_metadata",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return playtime stats for the specified number of days before today.",
						Name:        "return_playtime_stats",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details.",
						Name:        "return_details",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Strips BBCode from descriptions.",
						Name:        "strip_description_bbcode",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return the data for the specified revision.",
						Name:        "desired_revision",
						Optional:    true,
						Type:        "{enum}",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Set of published file Ids to retrieve details for.",
						Name:        "publishedfileids",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "If true, return tag information in the returned details.",
						Name:        "includetags",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, return preview information in the returned details.",
						Name:        "includeadditionalpreviews",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, return children in the returned details.",
						Name:        "includechildren",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, return key value tags in the returned details.",
						Name:        "includekvtags",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, return vote data in the returned details.",
						Name:        "includevotes",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, return a short description instead of the full description.",
						Name:        "short_description",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, return pricing data, if applicable.",
						Name:        "includeforsaledata",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "If true, populate the metadata field.",
						Name:        "includemetadata",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Specifies the localized text to return. Defaults to English.",
						Name:        "language",
						Optional:    true,
						Type:        "int32",
					},
					&SchemaMethodParam{
						Description: "Return playtime stats for the specified number of days before today.",
						Name:        "return_playtime_stats",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Strips BBCode from descriptions.",
						Name:        "strip_description_bbcode",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return the data for the specified revision.",
						Name:        "desired_revision",
						Optional:    true,
						Type:        "{enum}",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetUserFiles",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Steam ID of the user whose files are being requested.",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "App Id of the app that the files were published to.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "(Optional) Starting page for results.",
						Name:        "page",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "(Optional) The number of results, per page to return.",
						Name:        "numperpage",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "(Optional) Type of files to be returned.",
						Name:        "type",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "(Optional) Sorting method to use on returned values.",
						Name:        "sortmethod",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "(optional) Filter by privacy settings.",
						Name:        "privacy",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "(Optional) Tags that must be present on a published file to satisfy the query.",
						Name:        "requiredtags",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "(Optional) Tags that must NOT be present on a published file to satisfy the query.",
						Name:        "excludedtags",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Required key-value tags to match on.",
						Name:        "required_kv_tags",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) File type to match files to.",
						Name:        "filetype",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "App Id of the app that published the files, only matched if specified.",
						Name:        "creator_appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Match this cloud filename if specified.",
						Name:        "match_cloud_filename",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Allow stale data to be returned for the specified number of seconds.",
						Name:        "cache_max_age_seconds",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Specifies the localized text to return. Defaults to English.",
						Name:        "language",
						Optional:    true,
						Type:        "int32",
					},
					&SchemaMethodParam{
						Description: "(Optional) At least one of the tags must be present on a published file to satisfy the query.",
						Name:        "taggroups",
						Optional:    false,
						Type:        "{message}",
					},
					&SchemaMethodParam{
						Description: "(Optional) If true, only return the total number of files that satisfy this query.",
						Name:        "totalonly",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "(Optional) If true, only return the published file ids of files that satisfy this query.",
						Name:        "ids_only",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return vote data",
						Name:        "return_vote_data",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return tags in the file details",
						Name:        "return_tags",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return key-value tags in the file details",
						Name:        "return_kv_tags",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return preview image and video details in the file details",
						Name:        "return_previews",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return child item ids in the file details",
						Name:        "return_children",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Populate the short_description field instead of file_description",
						Name:        "return_short_description",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return pricing information, if applicable",
						Name:        "return_for_sale_data",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Populate the metadata field",
						Name:        "return_metadata",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return playtime stats for the specified number of days before today.",
						Name:        "return_playtime_stats",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Strips BBCode from descriptions.",
						Name:        "strip_description_bbcode",
						Optional:    false,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Return the data for the specified revision.",
						Name:        "desired_revision",
						Optional:    true,
						Type:        "{enum}",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Subscribe",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Unsubscribe",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "CanSubscribe",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Publish",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Update",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RefreshVotingQueue",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetDeveloperMetadata",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "UpdateTags",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IPublishedFileService",
		Undocumented: false,
	},
)

SchemaPublishedFileService stores the SchemaInterfaces for interface IPublishedFileService.

View Source
var SchemaQuestService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetCommunityItemDefinitions",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IQuestService",
		Undocumented: true,
	},
)

SchemaQuestService stores the SchemaInterfaces for interface IQuestService.

View Source
var SchemaRemoteClientService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "NotifyRemotePacket",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "NotifyRegisterStatusUpdate",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "NotifyUnregisterStatusUpdate",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IRemoteClientService",
		Undocumented: true,
	},
)

SchemaRemoteClientService stores the SchemaInterfaces for interface IRemoteClientService.

View Source
var SchemaSteamApps = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetAppList",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetAppList",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      2,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSDRConfig",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Partner type",
						Name:        "partner",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetServersAtAddress",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "IP or IP:queryport to list",
						Name:        "addr",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "UpToDateCheck",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The installed version of the game",
						Name:        "version",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamApps",
		Undocumented: false,
	},
)

SchemaSteamApps stores the SchemaInterfaces for interface ISteamApps.

View Source
var SchemaSteamBitPay = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "BitPayPaymentNotification",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamBitPay",
		Undocumented: true,
	},
)

SchemaSteamBitPay stores the SchemaInterfaces for interface ISteamBitPay.

View Source
var SchemaSteamBoaCompra = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "BoaCompraCheckTransactionStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamBoaCompra",
		Undocumented: true,
	},
)

SchemaSteamBoaCompra stores the SchemaInterfaces for interface ISteamBoaCompra.

View Source
var SchemaSteamBroadcast = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "ViewerHeartbeat",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Steam ID of the broadcaster",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Broadcast Session ID",
						Name:        "sessionid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Viewer token",
						Name:        "token",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "video stream representation watching",
						Name:        "stream",
						Optional:    true,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamBroadcast",
		Undocumented: false,
	},
)

SchemaSteamBroadcast stores the SchemaInterfaces for interface ISteamBroadcast.

View Source
var SchemaSteamCDN = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetClientFilters",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Steam name of CDN property",
						Name:        "cdnname",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "comma-separated list of allowed IP address blocks in CIDR format - blank for not used",
						Name:        "allowedipblocks",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "comma-separated list of allowed client network AS numbers - blank for not used",
						Name:        "allowedasns",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "comma-separated list of allowed client IP country codes in ISO 3166-1 format - blank for not used",
						Name:        "allowedipcountries",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "SetPerformanceStats",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Steam name of CDN property",
						Name:        "cdnname",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Outgoing network traffic in Mbps",
						Name:        "mbps_sent",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Incoming network traffic in Mbps",
						Name:        "mbps_recv",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Percent CPU load",
						Name:        "cpu_percent",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Percent cache hits",
						Name:        "cache_hit_percent",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamCDN",
		Undocumented: false,
	},
)

SchemaSteamCDN stores the SchemaInterfaces for interface ISteamCDN.

View Source
var SchemaSteamDirectory = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetCMList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Client's Steam cell ID",
						Name:        "cellid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Max number of servers to return",
						Name:        "maxcount",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetCSList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Client's Steam cell ID",
						Name:        "cellid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Max number of servers to return",
						Name:        "maxcount",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSteamPipeDomains",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamDirectory",
		Undocumented: false,
	},
)

SchemaSteamDirectory stores the SchemaInterfaces for interface ISteamDirectory.

View Source
var SchemaSteamEconomy = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetAssetClassInfo",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Must be a steam economy app.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The user's local language",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Number of classes requested. Must be at least one.",
						Name:        "class_count",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Class ID of the nth class.",
						Name:        "classid0",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Instance ID of the nth class.",
						Name:        "instanceid0",
						Optional:    true,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetAssetPrices",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Must be a steam economy app.",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "The currency to filter for",
						Name:        "currency",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The user's local language",
						Name:        "language",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamEconomy",
		Undocumented: false,
	},
)

SchemaSteamEconomy stores the SchemaInterfaces for interface ISteamEconomy.

View Source
var SchemaSteamGameOAuth = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetAppInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetPackageInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamGameOAuth",
		Undocumented: true,
	},
)

SchemaSteamGameOAuth stores the SchemaInterfaces for interface ISteamGameOAuth.

View Source
var SchemaSteamNews = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetNewsForApp",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID to retrieve news for",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.",
						Name:        "maxlength",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Retrieve posts earlier than this date (unix epoch timestamp)",
						Name:        "enddate",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "# of posts to retrieve (default 20)",
						Name:        "count",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Comma-separated list of tags to filter by (e.g. 'patchnodes')",
						Name:        "tags",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetNewsForApp",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID to retrieve news for",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.",
						Name:        "maxlength",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Retrieve posts earlier than this date (unix epoch timestamp)",
						Name:        "enddate",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "# of posts to retrieve (default 20)",
						Name:        "count",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Comma-separated list of feed names to return news for",
						Name:        "feeds",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Comma-separated list of tags to filter by (e.g. 'patchnodes')",
						Name:        "tags",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      2,
			},
		),
		Name:         "ISteamNews",
		Undocumented: false,
	},
)

SchemaSteamNews stores the SchemaInterfaces for interface ISteamNews.

View Source
var SchemaSteamNodwin = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "NodwinPaymentNotification",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamNodwin",
		Undocumented: true,
	},
)

SchemaSteamNodwin stores the SchemaInterfaces for interface ISteamNodwin.

View Source
var SchemaSteamPayPalPaymentsHub = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "PayPalPaymentsHubPaymentNotification",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamPayPalPaymentsHub",
		Undocumented: true,
	},
)

SchemaSteamPayPalPaymentsHub stores the SchemaInterfaces for interface ISteamPayPalPaymentsHub.

View Source
var SchemaSteamRemoteStorage = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "GetCollectionDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Number of collections being requested",
						Name:        "collectioncount",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "collection ids to get the details for",
						Name:        "publishedfileids[0]",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "GetPublishedFileDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Number of items being requested",
						Name:        "itemcount",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "published file id to look up",
						Name:        "publishedfileids[0]",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetUGCFileDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "If specified, only returns details if the file is owned by the SteamID specified",
						Name:        "steamid",
						Optional:    true,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "ID of UGC file to get info for",
						Name:        "ugcid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "appID of product",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamRemoteStorage",
		Undocumented: false,
	},
)

SchemaSteamRemoteStorage stores the SchemaInterfaces for interface ISteamRemoteStorage.

View Source
var SchemaSteamTVService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "CreateBroadcastChannel",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelID",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetBroadcastChannelProfile",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelProfile",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetBroadcastChannelImage",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelImages",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetBroadcastChannelLinkRegions",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelLinks",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelBroadcasters",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetFollowedChannels",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSubscribedChannels",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "FollowBroadcastChannel",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SubscribeBroadcastChannel",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "ReportBroadcastChannel",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelInteraction",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetGames",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetFeatured",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "AddChatBan",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetChatBans",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "AddChatModerator",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetChatModerators",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "AddWordBan",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetWordBans",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "JoinChat",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Search",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetSteamTVUserSettings",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetSteamTVUserSettings",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetMyBroadcastChannels",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetBroadcastChannelClips",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetChannels",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetHomePageContents",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamTVService",
		Undocumented: true,
	},
)

SchemaSteamTVService stores the SchemaInterfaces for interface ISteamTVService.

View Source
var SchemaSteamUser = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetFriendList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "SteamID of user",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "relationship type (ex: friend)",
						Name:        "relationship",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerBans",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Comma-delimited list of SteamIDs",
						Name:        "steamids",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerSummaries",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Comma-delimited list of SteamIDs",
						Name:        "steamids",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerSummaries",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Comma-delimited list of SteamIDs (max: 100)",
						Name:        "steamids",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      2,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetUserGroupList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "SteamID of user",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "ResolveVanityURL",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The vanity URL to get a SteamID for",
						Name:        "vanityurl",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group",
						Name:        "url_type",
						Optional:    true,
						Type:        "int32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamUser",
		Undocumented: false,
	},
)

SchemaSteamUser stores the SchemaInterfaces for interface ISteamUser.

View Source
var SchemaSteamUserAuth = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "AuthenticateUser",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Should be the users steamid, unencrypted.",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Should be a 32 byte random blob of data, which is then encrypted with RSA using the Steam system's public key.  Randomness is important here for security.",
						Name:        "sessionkey",
						Optional:    false,
						Type:        "rawbinary",
					},
					&SchemaMethodParam{
						Description: "Should be the users hashed loginkey, AES encrypted with the sessionkey.",
						Name:        "encrypted_loginkey",
						Optional:    false,
						Type:        "rawbinary",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "AuthenticateUserTicket",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "appid of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Ticket from GetAuthSessionTicket.",
						Name:        "ticket",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamUserAuth",
		Undocumented: false,
	},
)

SchemaSteamUserAuth stores the SchemaInterfaces for interface ISteamUserAuth.

View Source
var SchemaSteamUserOAuth = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetTokenDetails",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "OAuth2 token for which to return details",
						Name:        "access_token",
						Optional:    false,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetUserSummaries",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetGroupSummaries",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetGroupList",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetFriendList",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Search",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamUserOAuth",
		Undocumented: false,
	},
)

SchemaSteamUserOAuth stores the SchemaInterfaces for interface ISteamUserOAuth.

View Source
var SchemaSteamUserStats = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetGlobalAchievementPercentagesForApp",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "GameID to retrieve the achievement percentages for",
						Name:        "gameid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetGlobalAchievementPercentagesForApp",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "GameID to retrieve the achievement percentages for",
						Name:        "gameid",
						Optional:    false,
						Type:        "uint64",
					},
				),
				Undocumented: false,
				Version:      2,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetGlobalStatsForGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID that we're getting global stats for",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Number of stats get data for",
						Name:        "count",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Names of stat to get data for",
						Name:        "name[0]",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Start date for daily totals (unix epoch timestamp)",
						Name:        "startdate",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "End date for daily totals (unix epoch timestamp)",
						Name:        "enddate",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetNumberOfCurrentPlayers",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "AppID that we're getting user count for",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetPlayerAchievements",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "SteamID of user",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "AppID to get achievements for",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Language to return strings for",
						Name:        "l",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchemaForGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "appid of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "localized langauge to return (english, french, etc.)",
						Name:        "l",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSchemaForGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "appid of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "localized language to return (english, french, etc.)",
						Name:        "l",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      2,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetUserStatsForGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "SteamID of user",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "appid of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetUserStatsForGame",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "SteamID of user",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "appid of game",
						Name:        "appid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      2,
			},
		),
		Name:         "ISteamUserStats",
		Undocumented: false,
	},
)

SchemaSteamUserStats stores the SchemaInterfaces for interface ISteamUserStats.

View Source
var SchemaSteamWebAPIUtil = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetServerInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetSupportedAPIList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "access key",
						Name:        "key",
						Optional:    true,
						Type:        "string",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ISteamWebAPIUtil",
		Undocumented: false,
	},
)

SchemaSteamWebAPIUtil stores the SchemaInterfaces for interface ISteamWebAPIUtil.

View Source
var SchemaSteamWebUserPresenceOAuth = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "PollStatus",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Steam ID of the user",
						Name:        "steamid",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "UMQ Session ID",
						Name:        "umqid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "Message that was last known to the user",
						Name:        "message",
						Optional:    false,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Caller-specific poll id",
						Name:        "pollid",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Long-poll timeout in seconds",
						Name:        "sectimeout",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "How many seconds is client considering itself idle, e.g. screen is off",
						Name:        "secidletime",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Boolean, 0 (default): return steamid_from in output, 1: return accountid_from",
						Name:        "use_accountids",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Logon",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Logoff",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Message",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "DeviceInfo",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "Poll",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ISteamWebUserPresenceOAuth",
		Undocumented: false,
	},
)

SchemaSteamWebUserPresenceOAuth stores the SchemaInterfaces for interface ISteamWebUserPresenceOAuth.

View Source
var SchemaStoreService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetAppList",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "Access key",
						Name:        "key",
						Optional:    false,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Return only items that have been modified since this date.",
						Name:        "if_modified_since",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Return only items that have a description in this language.",
						Name:        "have_description_language",
						Optional:    true,
						Type:        "string",
					},
					&SchemaMethodParam{
						Description: "Include games (defaults to enabled)",
						Name:        "include_games",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Include DLC",
						Name:        "include_dlc",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Include software items",
						Name:        "include_software",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Include videos and series",
						Name:        "include_videos",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "Include hardware",
						Name:        "include_hardware",
						Optional:    true,
						Type:        "bool",
					},
					&SchemaMethodParam{
						Description: "For continuations, this is the last appid returned from the previous call.",
						Name:        "last_appid",
						Optional:    true,
						Type:        "uint32",
					},
					&SchemaMethodParam{
						Description: "Number of results to return at a time.  Default 10k, max 50k.",
						Name:        "max_results",
						Optional:    true,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "IStoreService",
		Undocumented: false,
	},
)

SchemaStoreService stores the SchemaInterfaces for interface IStoreService.

View Source
var SchemaTFItems = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetGoldenWrenches",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetGoldenWrenches",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      2,
			},
		),
		Name:         "ITFItems_440",
		Undocumented: false,
	},
)

SchemaTFItems stores the SchemaInterfaces for interface ITFItems.

View Source
var SchemaTFPromos = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetItemID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "promoid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "GrantItem",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "promoid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ITFPromos_440",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetItemID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "promoid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "GrantItem",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "promoid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ITFPromos_570",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetItemID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "PromoID",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "GrantItem",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "PromoID",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ITFPromos_620",
		Undocumented: false,
	},
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod: http.MethodGet,
				Name:       "GetItemID",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "promoid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod: http.MethodPost,
				Name:       "GrantItem",
				Params: NewSchemaMethodParams(
					&SchemaMethodParam{
						Description: "The Steam ID to fetch items for",
						Name:        "steamid",
						Optional:    false,
						Type:        "uint64",
					},
					&SchemaMethodParam{
						Description: "The promo ID to grant an item for",
						Name:        "promoid",
						Optional:    false,
						Type:        "uint32",
					},
				),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ITFPromos_205790",
		Undocumented: false,
	},
)

SchemaTFPromos stores the SchemaInterfaces for interface ITFPromos.

View Source
var SchemaTFSystem = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetWorldStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: false,
				Version:      1,
			},
		),
		Name:         "ITFSystem_440",
		Undocumented: false,
	},
)

SchemaTFSystem stores the SchemaInterfaces for interface ITFSystem.

View Source
var SchemaTwoFactorService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "AddAuthenticator",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RecoverAuthenticatorCommit",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RecoverAuthenticatorContinue",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RemoveAuthenticator",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RemoveAuthenticatorViaChallengeStart",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "RemoveAuthenticatorViaChallengeContinue",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "FinalizeAddAuthenticator",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "QueryStatus",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "QueryTime",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "QuerySecrets",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SendEmail",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "ValidateToken",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "CreateEmergencyCodes",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "DestroyEmergencyCodes",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "ITwoFactorService",
		Undocumented: true,
	},
)

SchemaTwoFactorService stores the SchemaInterfaces for interface ITwoFactorService.

View Source
var SchemaVideoService = MustNewSchemaInterfaces(
	&SchemaInterface{
		Methods: MustNewSchemaMethods(
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "SetVideoBookmark",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
			&SchemaMethod{
				HTTPMethod:   http.MethodGet,
				Name:         "GetVideoBookmarks",
				Params:       NewSchemaMethodParams(),
				Undocumented: true,
				Version:      1,
			},
		),
		Name:         "IVideoService",
		Undocumented: true,
	},
)

SchemaVideoService stores the SchemaInterfaces for interface IVideoService.

Functions

func SteamRemoteStorageGetCollectionDetailsFormData

func SteamRemoteStorageGetCollectionDetailsFormData(collectionIDs []uint64) url.Values

func SteamRemoteStorageGetPublishedFileDetailsFormData

func SteamRemoteStorageGetPublishedFileDetailsFormData(fileIDs []uint64) url.Values

func SteamUserAuthAuthenticateUserFormData

func SteamUserAuthAuthenticateUserFormData(steamID uint64, loginKey string) (url.Values, error)

Types

type AccountLinkingService added in v0.2.0

type AccountLinkingService struct {
	Client    *Client
	Interface *SchemaInterface
}

AccountLinkingService represents interface IAccountLinkingService.

This is an undocumented interface.

func NewAccountLinkingService added in v0.2.0

func NewAccountLinkingService(c *Client) (*AccountLinkingService, error)

NewAccountLinkingService creates a new AccountLinkingService interface.

func (*AccountLinkingService) GetLinkedAccountInfo added in v0.2.0

func (i *AccountLinkingService) GetLinkedAccountInfo() (*Request, error)

GetLinkedAccountInfo creates a Request for interface method GetLinkedAccountInfo.

This is an undocumented method.

type AccountLinkingServiceGetLinkedAccountInfo added in v0.2.0

type AccountLinkingServiceGetLinkedAccountInfo struct{}

AccountLinkingServiceGetLinkedAccountInfo holds the result of the method IAccountLinkingService/GetLinkedAccountInfo.

type BroadcastService

type BroadcastService struct {
	Client    *Client
	Interface *SchemaInterface
}

BroadcastService represents interface IBroadcastService.

func NewBroadcastService

func NewBroadcastService(c *Client) (*BroadcastService, error)

NewBroadcastService creates a new BroadcastService interface.

func (*BroadcastService) GetBroadcastUploadStats added in v0.2.0

func (i *BroadcastService) GetBroadcastUploadStats() (*Request, error)

GetBroadcastUploadStats creates a Request for interface method GetBroadcastUploadStats.

This is an undocumented method.

func (*BroadcastService) GetBroadcastViewerStats added in v0.2.0

func (i *BroadcastService) GetBroadcastViewerStats() (*Request, error)

GetBroadcastViewerStats creates a Request for interface method GetBroadcastViewerStats.

This is an undocumented method.

func (*BroadcastService) GetBuildClipStatus added in v0.2.0

func (i *BroadcastService) GetBuildClipStatus() (*Request, error)

GetBuildClipStatus creates a Request for interface method GetBuildClipStatus.

This is an undocumented method.

func (*BroadcastService) GetClipDetails added in v0.2.0

func (i *BroadcastService) GetClipDetails() (*Request, error)

GetClipDetails creates a Request for interface method GetClipDetails.

This is an undocumented method.

func (*BroadcastService) GetRTMPInfo added in v0.2.0

func (i *BroadcastService) GetRTMPInfo() (*Request, error)

GetRTMPInfo creates a Request for interface method GetRTMPInfo.

This is an undocumented method.

func (*BroadcastService) MuteBroadcastChatUser added in v0.2.0

func (i *BroadcastService) MuteBroadcastChatUser() (*Request, error)

MuteBroadcastChatUser creates a Request for interface method MuteBroadcastChatUser.

This is an undocumented method.

func (*BroadcastService) PostChatMessage added in v0.2.0

func (i *BroadcastService) PostChatMessage() (*Request, error)

PostChatMessage creates a Request for interface method PostChatMessage.

This is an undocumented method.

func (*BroadcastService) PostGameDataFrameRTMP

func (i *BroadcastService) PostGameDataFrameRTMP() (*Request, error)

PostGameDataFrameRTMP creates a Request for interface method PostGameDataFrameRTMP.

Parameters

  • appid [uint32] (required): AppID of the game being broadcasted
  • steamid [uint64] (required): Broadcasters SteamID
  • rtmp_token [string] (required): Valid RTMP token for the Broadcaster
  • frame_data [string] (required): game data frame expressing current state of game (string, zipped, whatever)

func (*BroadcastService) RemoveUserChatText added in v0.2.0

func (i *BroadcastService) RemoveUserChatText() (*Request, error)

RemoveUserChatText creates a Request for interface method RemoveUserChatText.

This is an undocumented method.

func (*BroadcastService) SetRTMPInfo added in v0.2.0

func (i *BroadcastService) SetRTMPInfo() (*Request, error)

SetRTMPInfo creates a Request for interface method SetRTMPInfo.

This is an undocumented method.

func (*BroadcastService) StartBuildClip added in v0.2.0

func (i *BroadcastService) StartBuildClip() (*Request, error)

StartBuildClip creates a Request for interface method StartBuildClip.

This is an undocumented method.

func (*BroadcastService) UpdateChatMessageFlair added in v0.2.0

func (i *BroadcastService) UpdateChatMessageFlair() (*Request, error)

UpdateChatMessageFlair creates a Request for interface method UpdateChatMessageFlair.

This is an undocumented method.

type BroadcastServiceGetBroadcastUploadStats added in v0.2.0

type BroadcastServiceGetBroadcastUploadStats struct{}

BroadcastServiceGetBroadcastUploadStats holds the result of the method IBroadcastService/GetBroadcastUploadStats.

type BroadcastServiceGetBroadcastViewerStats added in v0.2.0

type BroadcastServiceGetBroadcastViewerStats struct{}

BroadcastServiceGetBroadcastViewerStats holds the result of the method IBroadcastService/GetBroadcastViewerStats.

type BroadcastServiceGetBuildClipStatus added in v0.2.0

type BroadcastServiceGetBuildClipStatus struct{}

BroadcastServiceGetBuildClipStatus holds the result of the method IBroadcastService/GetBuildClipStatus.

type BroadcastServiceGetClipDetails added in v0.2.0

type BroadcastServiceGetClipDetails struct{}

BroadcastServiceGetClipDetails holds the result of the method IBroadcastService/GetClipDetails.

type BroadcastServiceGetRTMPInfo added in v0.2.0

type BroadcastServiceGetRTMPInfo struct{}

BroadcastServiceGetRTMPInfo holds the result of the method IBroadcastService/GetRTMPInfo.

type BroadcastServiceMuteBroadcastChatUser added in v0.2.0

type BroadcastServiceMuteBroadcastChatUser struct{}

BroadcastServiceMuteBroadcastChatUser holds the result of the method IBroadcastService/MuteBroadcastChatUser.

type BroadcastServicePostChatMessage added in v0.2.0

type BroadcastServicePostChatMessage struct{}

BroadcastServicePostChatMessage holds the result of the method IBroadcastService/PostChatMessage.

type BroadcastServicePostGameDataFrameRTMP

type BroadcastServicePostGameDataFrameRTMP struct{}

BroadcastServicePostGameDataFrameRTMP holds the result of the method IBroadcastService/PostGameDataFrameRTMP.

type BroadcastServiceRemoveUserChatText added in v0.2.0

type BroadcastServiceRemoveUserChatText struct{}

BroadcastServiceRemoveUserChatText holds the result of the method IBroadcastService/RemoveUserChatText.

type BroadcastServiceSetRTMPInfo added in v0.2.0

type BroadcastServiceSetRTMPInfo struct{}

BroadcastServiceSetRTMPInfo holds the result of the method IBroadcastService/SetRTMPInfo.

type BroadcastServiceStartBuildClip added in v0.2.0

type BroadcastServiceStartBuildClip struct{}

BroadcastServiceStartBuildClip holds the result of the method IBroadcastService/StartBuildClip.

type BroadcastServiceUpdateChatMessageFlair added in v0.2.0

type BroadcastServiceUpdateChatMessageFlair struct{}

BroadcastServiceUpdateChatMessageFlair holds the result of the method IBroadcastService/UpdateChatMessageFlair.

type CSGOPlayers

type CSGOPlayers struct {
	Client    *Client
	Interface *SchemaInterface
}

CSGOPlayers represents interface ICSGOPlayers.

Supported AppIDs: 730.

func NewCSGOPlayers

func NewCSGOPlayers(c *Client, appID uint32) (*CSGOPlayers, error)

NewCSGOPlayers creates a new CSGOPlayers interface.

Supported AppIDs: 730.

func (*CSGOPlayers) GetNextMatchSharingCode

func (i *CSGOPlayers) GetNextMatchSharingCode() (*Request, error)

GetNextMatchSharingCode creates a Request for interface method GetNextMatchSharingCode.

Parameters

  • steamid [uint64] (required): The SteamID of the user
  • steamidkey [string] (required): Authentication obtained from the SteamID
  • knowncode [string] (required): Previously known match sharing code obtained from the SteamID

type CSGOPlayersGetNextMatchSharingCode

type CSGOPlayersGetNextMatchSharingCode struct{}

CSGOPlayersGetNextMatchSharingCode holds the result of the method ICSGOPlayers/GetNextMatchSharingCode.

type CSGOServers

type CSGOServers struct {
	Client    *Client
	Interface *SchemaInterface
}

CSGOServers represents interface ICSGOServers.

Supported AppIDs: 730.

func NewCSGOServers

func NewCSGOServers(c *Client, appID uint32) (*CSGOServers, error)

NewCSGOServers creates a new CSGOServers interface.

Supported AppIDs: 730.

func (*CSGOServers) GetGameMapsPlaytime

func (i *CSGOServers) GetGameMapsPlaytime() (*Request, error)

GetGameMapsPlaytime creates a Request for interface method GetGameMapsPlaytime.

Parameters

  • interval [string] (required): What recent interval is requested, possible values: day, week, month
  • gamemode [string] (required): What game mode is requested, possible values: competitive, casual
  • mapgroup [string] (required): What maps are requested, possible values: operation

func (*CSGOServers) GetGameServersStatus

func (i *CSGOServers) GetGameServersStatus() (*Request, error)

GetGameServersStatus creates a Request for interface method GetGameServersStatus.

type CSGOServersGetGameMapsPlaytime

type CSGOServersGetGameMapsPlaytime struct{}

CSGOServersGetGameMapsPlaytime holds the result of the method ICSGOServers/GetGameMapsPlaytime.

type CSGOServersGetGameServersStatus

type CSGOServersGetGameServersStatus struct{}

CSGOServersGetGameServersStatus holds the result of the method ICSGOServers/GetGameServersStatus.

type CSGOTournaments

type CSGOTournaments struct {
	Client    *Client
	Interface *SchemaInterface
}

CSGOTournaments represents interface ICSGOTournaments.

Supported AppIDs: 730.

func NewCSGOTournaments

func NewCSGOTournaments(c *Client, appID uint32) (*CSGOTournaments, error)

NewCSGOTournaments creates a new CSGOTournaments interface.

Supported AppIDs: 730.

func (*CSGOTournaments) GetTournamentFantasyLineup

func (i *CSGOTournaments) GetTournamentFantasyLineup() (*Request, error)

GetTournamentFantasyLineup creates a Request for interface method GetTournamentFantasyLineup.

Parameters

  • event [uint32] (required): The event ID
  • steamid [uint64] (required): The SteamID of the user inventory
  • steamidkey [string] (required): Authentication obtained from the SteamID

func (*CSGOTournaments) GetTournamentItems

func (i *CSGOTournaments) GetTournamentItems() (*Request, error)

GetTournamentItems creates a Request for interface method GetTournamentItems.

Parameters

  • event [uint32] (required): The event ID
  • steamid [uint64] (required): The SteamID of the user inventory
  • steamidkey [string] (required): Authentication obtained from the SteamID

func (*CSGOTournaments) GetTournamentLayout

func (i *CSGOTournaments) GetTournamentLayout() (*Request, error)

GetTournamentLayout creates a Request for interface method GetTournamentLayout.

Parameters

  • event [uint32] (required): The event ID

func (*CSGOTournaments) GetTournamentPredictions

func (i *CSGOTournaments) GetTournamentPredictions() (*Request, error)

GetTournamentPredictions creates a Request for interface method GetTournamentPredictions.

Parameters

  • event [uint32] (required): The event ID
  • steamid [uint64] (required): The SteamID of the user inventory
  • steamidkey [string] (required): Authentication obtained from the SteamID

func (*CSGOTournaments) UploadTournamentFantasyLineup

func (i *CSGOTournaments) UploadTournamentFantasyLineup() (*Request, error)

UploadTournamentFantasyLineup creates a Request for interface method UploadTournamentFantasyLineup.

Parameters

  • event [uint32] (required): The event ID
  • steamid [uint64] (required): The SteamID of the user inventory
  • steamidkey [string] (required): Authentication obtained from the SteamID
  • sectionid [uint32] (required): Event section id
  • pickid0 [uint32] (required): PickID to select for the slot
  • itemid0 [uint64] (required): ItemID to lock in for the pick
  • pickid1 [uint32] (required): PickID to select for the slot
  • itemid1 [uint64] (required): ItemID to lock in for the pick
  • pickid2 [uint32] (required): PickID to select for the slot
  • itemid2 [uint64] (required): ItemID to lock in for the pick
  • pickid3 [uint32] (required): PickID to select for the slot
  • itemid3 [uint64] (required): ItemID to lock in for the pick
  • pickid4 [uint32] (required): PickID to select for the slot
  • itemid4 [uint64] (required): ItemID to lock in for the pick

func (*CSGOTournaments) UploadTournamentPredictions

func (i *CSGOTournaments) UploadTournamentPredictions() (*Request, error)

UploadTournamentPredictions creates a Request for interface method UploadTournamentPredictions.

Parameters

  • event [uint32] (required): The event ID
  • steamid [uint64] (required): The SteamID of the user inventory
  • steamidkey [string] (required): Authentication obtained from the SteamID
  • sectionid [uint32] (required): Event section id
  • groupid [uint32] (required): Event group id
  • index [uint32] (required): Index in group
  • pickid [uint32] (required): Pick ID to select
  • itemid [uint64] (required): ItemID to lock in for the pick

type CSGOTournamentsGetTournamentFantasyLineup

type CSGOTournamentsGetTournamentFantasyLineup struct{}

CSGOTournamentsGetTournamentFantasyLineup holds the result of the method ICSGOTournaments/GetTournamentFantasyLineup.

type CSGOTournamentsGetTournamentItems

type CSGOTournamentsGetTournamentItems struct{}

CSGOTournamentsGetTournamentItems holds the result of the method ICSGOTournaments/GetTournamentItems.

type CSGOTournamentsGetTournamentLayout

type CSGOTournamentsGetTournamentLayout struct{}

CSGOTournamentsGetTournamentLayout holds the result of the method ICSGOTournaments/GetTournamentLayout.

type CSGOTournamentsGetTournamentPredictions

type CSGOTournamentsGetTournamentPredictions struct{}

CSGOTournamentsGetTournamentPredictions holds the result of the method ICSGOTournaments/GetTournamentPredictions.

type CSGOTournamentsUploadTournamentFantasyLineup

type CSGOTournamentsUploadTournamentFantasyLineup struct{}

CSGOTournamentsUploadTournamentFantasyLineup holds the result of the method ICSGOTournaments/UploadTournamentFantasyLineup.

type CSGOTournamentsUploadTournamentPredictions

type CSGOTournamentsUploadTournamentPredictions struct{}

CSGOTournamentsUploadTournamentPredictions holds the result of the method ICSGOTournaments/UploadTournamentPredictions.

type CheatReportingService

type CheatReportingService struct {
	Client    *Client
	Interface *SchemaInterface
}

CheatReportingService represents interface ICheatReportingService.

func NewCheatReportingService

func NewCheatReportingService(c *Client) (*CheatReportingService, error)

NewCheatReportingService creates a new CheatReportingService interface.

func (*CheatReportingService) ReportCheatData

func (i *CheatReportingService) ReportCheatData() (*Request, error)

ReportCheatData creates a Request for interface method ReportCheatData.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): steamid of the user running and reporting the cheat.
  • appid [uint32] (required): The appid.
  • pathandfilename [string] (required): path and file name of the cheat executable.
  • webcheaturl [string] (required): web url where the cheat was found and downloaded.
  • time_now [uint64] (required): local system time now.
  • time_started [uint64] (required): local system time when cheat process started. ( 0 if not yet run )
  • time_stopped [uint64] (required): local system time when cheat process stopped. ( 0 if still running )
  • cheatname [string] (required): descriptive name for the cheat.
  • game_process_id [uint32] (required): process ID of the running game.
  • cheat_process_id [uint32] (required): process ID of the cheat process that ran
  • cheat_param_1 [uint64] (required): cheat param 1
  • cheat_param_2 [uint64] (required): cheat param 2
  • cheat_data_dump [string] (required): data collection in json format

type CheatReportingServiceReportCheatData

type CheatReportingServiceReportCheatData struct{}

CheatReportingServiceReportCheatData holds the result of the method ICheatReportingService/ReportCheatData.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is the API entry-point.

func New

func New(options ...ClientOption) (*Client, error)

New creates a new client.

Example (Conditional)
package main

import (
	"os"

	"github.com/13k/geyser"
)

func main() {
	// Conditional options
	options := []geyser.ClientOption{
		geyser.WithKey("<api_key>"),
	}

	if os.Getenv("DEBUG") != "" {
		options = append(options, geyser.WithDebug())
	}

	_, _ = geyser.New(options...)
}
Output:

Example (Inline)
package main

import (
	"time"

	"github.com/13k/geyser"
)

func main() {
	// Inline options
	_, _ = geyser.New(
		geyser.WithUserAgent("mylib 1.2.3"),
		geyser.WithKey("<api_key>"),
		geyser.WithTimeout(3*time.Second),
		geyser.WithRetryCount(5),
	)
}
Output:

func (*Client) AccountLinkingService added in v0.2.0

func (c *Client) AccountLinkingService() (*AccountLinkingService, error)

AccountLinkingService creates a new AccountLinkingService interface.

func (*Client) BroadcastService

func (c *Client) BroadcastService() (*BroadcastService, error)

BroadcastService creates a new BroadcastService interface.

func (*Client) CSGOPlayers

func (c *Client) CSGOPlayers(appID uint32) (*CSGOPlayers, error)

CSGOPlayers creates a new CSGOPlayers interface.

Supported AppIDs: 730.

func (*Client) CSGOServers

func (c *Client) CSGOServers(appID uint32) (*CSGOServers, error)

CSGOServers creates a new CSGOServers interface.

Supported AppIDs: 730.

func (*Client) CSGOTournaments

func (c *Client) CSGOTournaments(appID uint32) (*CSGOTournaments, error)

CSGOTournaments creates a new CSGOTournaments interface.

Supported AppIDs: 730.

func (*Client) CheatReportingService

func (c *Client) CheatReportingService() (*CheatReportingService, error)

CheatReportingService creates a new CheatReportingService interface.

func (*Client) ClientStats

func (c *Client) ClientStats(appID uint32) (*ClientStats, error)

ClientStats creates a new ClientStats interface.

Supported AppIDs: 1046930.

func (*Client) CloudService added in v0.2.0

func (c *Client) CloudService() (*CloudService, error)

CloudService creates a new CloudService interface.

func (*Client) CommunityService added in v0.2.0

func (c *Client) CommunityService() (*CommunityService, error)

CommunityService creates a new CommunityService interface.

func (*Client) ContentServerConfigService

func (c *Client) ContentServerConfigService() (*ContentServerConfigService, error)

ContentServerConfigService creates a new ContentServerConfigService interface.

func (*Client) ContentServerDirectoryService

func (c *Client) ContentServerDirectoryService() (*ContentServerDirectoryService, error)

ContentServerDirectoryService creates a new ContentServerDirectoryService interface.

func (*Client) CredentialsService added in v0.2.0

func (c *Client) CredentialsService() (*CredentialsService, error)

CredentialsService creates a new CredentialsService interface.

func (*Client) DOTA2Fantasy

func (c *Client) DOTA2Fantasy(appID uint32) (*DOTA2Fantasy, error)

DOTA2Fantasy creates a new DOTA2Fantasy interface.

Supported AppIDs: 205790.

func (*Client) DOTA2Match

func (c *Client) DOTA2Match(appID uint32) (*DOTA2Match, error)

DOTA2Match creates a new DOTA2Match interface.

Supported AppIDs: 570, 205790.

func (*Client) DOTA2MatchStats

func (c *Client) DOTA2MatchStats(appID uint32) (*DOTA2MatchStats, error)

DOTA2MatchStats creates a new DOTA2MatchStats interface.

Supported AppIDs: 570, 205790.

func (*Client) DOTA2StreamSystem

func (c *Client) DOTA2StreamSystem(appID uint32) (*DOTA2StreamSystem, error)

DOTA2StreamSystem creates a new DOTA2StreamSystem interface.

Supported AppIDs: 570, 205790.

func (*Client) DOTA2Ticket

func (c *Client) DOTA2Ticket(appID uint32) (*DOTA2Ticket, error)

DOTA2Ticket creates a new DOTA2Ticket interface.

Supported AppIDs: 570, 205790.

func (*Client) EconDOTA2

func (c *Client) EconDOTA2(appID uint32) (*EconDOTA2, error)

EconDOTA2 creates a new EconDOTA2 interface.

Supported AppIDs: 570, 205790.

func (*Client) EconItems

func (c *Client) EconItems(appID uint32) (*EconItems, error)

EconItems creates a new EconItems interface.

Supported AppIDs: 440, 570, 620, 730, 205790, 221540, 238460, 583950.

func (*Client) EconService

func (c *Client) EconService() (*EconService, error)

EconService creates a new EconService interface.

func (*Client) FriendMessagesService added in v0.2.0

func (c *Client) FriendMessagesService() (*FriendMessagesService, error)

FriendMessagesService creates a new FriendMessagesService interface.

func (*Client) GCVersion

func (c *Client) GCVersion(appID uint32) (*GCVersion, error)

GCVersion creates a new GCVersion interface.

Supported AppIDs: 440, 570, 730, 205790, 583950, 1046930.

func (*Client) GameCoordinator added in v0.2.0

func (c *Client) GameCoordinator() (*GameCoordinator, error)

GameCoordinator creates a new GameCoordinator interface.

func (*Client) GameInventory added in v0.2.0

func (c *Client) GameInventory() (*GameInventory, error)

GameInventory creates a new GameInventory interface.

func (*Client) GameNotificationsService

func (c *Client) GameNotificationsService() (*GameNotificationsService, error)

GameNotificationsService creates a new GameNotificationsService interface.

func (*Client) GameServersService

func (c *Client) GameServersService() (*GameServersService, error)

GameServersService creates a new GameServersService interface.

func (*Client) InventoryService

func (c *Client) InventoryService() (*InventoryService, error)

InventoryService creates a new InventoryService interface.

func (*Client) MobileAuthService added in v0.2.0

func (c *Client) MobileAuthService() (*MobileAuthService, error)

MobileAuthService creates a new MobileAuthService interface.

func (*Client) MobileNotificationService added in v0.2.0

func (c *Client) MobileNotificationService() (*MobileNotificationService, error)

MobileNotificationService creates a new MobileNotificationService interface.

func (*Client) PlayerService

func (c *Client) PlayerService() (*PlayerService, error)

PlayerService creates a new PlayerService interface.

func (*Client) Portal2Leaderboards

func (c *Client) Portal2Leaderboards(appID uint32) (*Portal2Leaderboards, error)

Portal2Leaderboards creates a new Portal2Leaderboards interface.

Supported AppIDs: 620.

func (*Client) PublishedFileService

func (c *Client) PublishedFileService() (*PublishedFileService, error)

PublishedFileService creates a new PublishedFileService interface.

func (*Client) QuestService added in v0.2.0

func (c *Client) QuestService() (*QuestService, error)

QuestService creates a new QuestService interface.

func (*Client) RemoteClientService added in v0.2.0

func (c *Client) RemoteClientService() (*RemoteClientService, error)

RemoteClientService creates a new RemoteClientService interface.

func (*Client) Request

func (c *Client) Request(creq ClientRequest) (*resty.Response, error)

Request performs an API request to the given interface and method with given options and stores the result in the given result.

func (*Client) SteamApps

func (c *Client) SteamApps() (*SteamApps, error)

SteamApps creates a new SteamApps interface.

func (*Client) SteamBitPay added in v0.2.0

func (c *Client) SteamBitPay() (*SteamBitPay, error)

SteamBitPay creates a new SteamBitPay interface.

func (*Client) SteamBoaCompra added in v0.2.0

func (c *Client) SteamBoaCompra() (*SteamBoaCompra, error)

SteamBoaCompra creates a new SteamBoaCompra interface.

func (*Client) SteamBroadcast

func (c *Client) SteamBroadcast() (*SteamBroadcast, error)

SteamBroadcast creates a new SteamBroadcast interface.

func (*Client) SteamCDN

func (c *Client) SteamCDN() (*SteamCDN, error)

SteamCDN creates a new SteamCDN interface.

func (*Client) SteamDirectory

func (c *Client) SteamDirectory() (*SteamDirectory, error)

SteamDirectory creates a new SteamDirectory interface.

func (*Client) SteamEconomy

func (c *Client) SteamEconomy() (*SteamEconomy, error)

SteamEconomy creates a new SteamEconomy interface.

func (*Client) SteamGameOAuth added in v0.2.0

func (c *Client) SteamGameOAuth() (*SteamGameOAuth, error)

SteamGameOAuth creates a new SteamGameOAuth interface.

func (*Client) SteamNews

func (c *Client) SteamNews() (*SteamNews, error)

SteamNews creates a new SteamNews interface.

func (*Client) SteamNodwin added in v0.2.0

func (c *Client) SteamNodwin() (*SteamNodwin, error)

SteamNodwin creates a new SteamNodwin interface.

func (*Client) SteamPayPalPaymentsHub added in v0.2.0

func (c *Client) SteamPayPalPaymentsHub() (*SteamPayPalPaymentsHub, error)

SteamPayPalPaymentsHub creates a new SteamPayPalPaymentsHub interface.

func (*Client) SteamRemoteStorage

func (c *Client) SteamRemoteStorage() (*SteamRemoteStorage, error)

SteamRemoteStorage creates a new SteamRemoteStorage interface.

func (*Client) SteamTVService added in v0.2.0

func (c *Client) SteamTVService() (*SteamTVService, error)

SteamTVService creates a new SteamTVService interface.

func (*Client) SteamUser

func (c *Client) SteamUser() (*SteamUser, error)

SteamUser creates a new SteamUser interface.

func (*Client) SteamUserAuth

func (c *Client) SteamUserAuth() (*SteamUserAuth, error)

SteamUserAuth creates a new SteamUserAuth interface.

func (*Client) SteamUserOAuth

func (c *Client) SteamUserOAuth() (*SteamUserOAuth, error)

SteamUserOAuth creates a new SteamUserOAuth interface.

func (*Client) SteamUserStats

func (c *Client) SteamUserStats() (*SteamUserStats, error)

SteamUserStats creates a new SteamUserStats interface.

func (*Client) SteamWebAPIUtil

func (c *Client) SteamWebAPIUtil() (*SteamWebAPIUtil, error)

SteamWebAPIUtil creates a new SteamWebAPIUtil interface.

func (*Client) SteamWebUserPresenceOAuth

func (c *Client) SteamWebUserPresenceOAuth() (*SteamWebUserPresenceOAuth, error)

SteamWebUserPresenceOAuth creates a new SteamWebUserPresenceOAuth interface.

func (*Client) StoreService

func (c *Client) StoreService() (*StoreService, error)

StoreService creates a new StoreService interface.

func (*Client) TFItems

func (c *Client) TFItems(appID uint32) (*TFItems, error)

TFItems creates a new TFItems interface.

Supported AppIDs: 440.

func (*Client) TFPromos

func (c *Client) TFPromos(appID uint32) (*TFPromos, error)

TFPromos creates a new TFPromos interface.

Supported AppIDs: 440, 570, 620, 205790.

func (*Client) TFSystem

func (c *Client) TFSystem(appID uint32) (*TFSystem, error)

TFSystem creates a new TFSystem interface.

Supported AppIDs: 440.

func (*Client) TwoFactorService added in v0.2.0

func (c *Client) TwoFactorService() (*TwoFactorService, error)

TwoFactorService creates a new TwoFactorService interface.

func (*Client) VideoService added in v0.2.0

func (c *Client) VideoService() (*VideoService, error)

VideoService creates a new VideoService interface.

type ClientOption

type ClientOption func(*Client) error

ClientOption functions set options in `Client`.

func WithBaseURL added in v0.2.0

func WithBaseURL(baseURL string) ClientOption

WithBaseURL sets the base URL for all outgoing requests.

func WithDebug

func WithDebug() ClientOption

WithDebug enables debug logging.

func WithKey

func WithKey(key string) ClientOption

WithKey sets the Steam API key ("key" parameter) for all requests.

func WithLanguage

func WithLanguage(lang string) ClientOption

WithLanguage sets the language ("language" parameter) for all requests.

func WithLogger

func WithLogger(logger Logger) ClientOption

WithLogger sets the logger.

func WithProxy

func WithProxy(proxy string) ClientOption

WithProxy sets the proxy.

func WithRetryCount

func WithRetryCount(retryCount int) ClientOption

WithRetryCount enables request retrying and allows to set the number of tries, using a backoff mechanism.

Setting to 0 disables retrying.

func WithRetryMaxWaitTime

func WithRetryMaxWaitTime(retryMaxWaitTime time.Duration) ClientOption

WithRetryMaxWaitTime sets the max wait time to sleep before retrying request.

Default is 2s.

func WithRetryWaitTime

func WithRetryWaitTime(retryWaitTime time.Duration) ClientOption

WithRetryWaitTime sets the default wait time to sleep before retrying request.

Default is 100ms.

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

WithTimeout sets the timeout duration for each request.

func WithTransport

func WithTransport(transport http.RoundTripper) ClientOption

WithTransport sets the HTTP transport.

func WithUserAgent

func WithUserAgent(userAgent string) ClientOption

WithUserAgent sets the "User-Agent" HTTP header for all outgoing requests.

type ClientRequest

type ClientRequest struct {
	Interface *SchemaInterface
	Method    *SchemaMethod
	Options   RequestOptions
	Result    interface{}
}

ClientRequest wraps request arguments.

type ClientStats

type ClientStats struct {
	Client    *Client
	Interface *SchemaInterface
}

ClientStats represents interface IClientStats.

Supported AppIDs: 1046930.

func NewClientStats

func NewClientStats(c *Client, appID uint32) (*ClientStats, error)

NewClientStats creates a new ClientStats interface.

Supported AppIDs: 1046930.

func (*ClientStats) ReportEvent

func (i *ClientStats) ReportEvent() (*Request, error)

ReportEvent creates a Request for interface method ReportEvent.

type ClientStatsReportEvent

type ClientStatsReportEvent struct{}

ClientStatsReportEvent holds the result of the method IClientStats/ReportEvent.

type CloudService added in v0.2.0

type CloudService struct {
	Client    *Client
	Interface *SchemaInterface
}

CloudService represents interface ICloudService.

This is an undocumented interface.

func NewCloudService added in v0.2.0

func NewCloudService(c *Client) (*CloudService, error)

NewCloudService creates a new CloudService interface.

func (*CloudService) BeginHTTPUpload added in v0.2.0

func (i *CloudService) BeginHTTPUpload() (*Request, error)

BeginHTTPUpload creates a Request for interface method BeginHTTPUpload.

This is an undocumented method.

func (*CloudService) CommitHTTPUpload added in v0.2.0

func (i *CloudService) CommitHTTPUpload() (*Request, error)

CommitHTTPUpload creates a Request for interface method CommitHTTPUpload.

This is an undocumented method.

func (*CloudService) Delete added in v0.2.0

func (i *CloudService) Delete() (*Request, error)

Delete creates a Request for interface method Delete.

This is an undocumented method.

func (*CloudService) EnumerateUserFiles added in v0.2.0

func (i *CloudService) EnumerateUserFiles() (*Request, error)

EnumerateUserFiles creates a Request for interface method EnumerateUserFiles.

This is an undocumented method.

func (*CloudService) GetFileDetails added in v0.2.0

func (i *CloudService) GetFileDetails() (*Request, error)

GetFileDetails creates a Request for interface method GetFileDetails.

This is an undocumented method.

func (*CloudService) GetUploadServerInfo added in v0.2.0

func (i *CloudService) GetUploadServerInfo() (*Request, error)

GetUploadServerInfo creates a Request for interface method GetUploadServerInfo.

This is an undocumented method.

type CloudServiceBeginHTTPUpload added in v0.2.0

type CloudServiceBeginHTTPUpload struct{}

CloudServiceBeginHTTPUpload holds the result of the method ICloudService/BeginHTTPUpload.

type CloudServiceCommitHTTPUpload added in v0.2.0

type CloudServiceCommitHTTPUpload struct{}

CloudServiceCommitHTTPUpload holds the result of the method ICloudService/CommitHTTPUpload.

type CloudServiceDelete added in v0.2.0

type CloudServiceDelete struct{}

CloudServiceDelete holds the result of the method ICloudService/Delete.

type CloudServiceEnumerateUserFiles added in v0.2.0

type CloudServiceEnumerateUserFiles struct{}

CloudServiceEnumerateUserFiles holds the result of the method ICloudService/EnumerateUserFiles.

type CloudServiceGetFileDetails added in v0.2.0

type CloudServiceGetFileDetails struct{}

CloudServiceGetFileDetails holds the result of the method ICloudService/GetFileDetails.

type CloudServiceGetUploadServerInfo added in v0.2.0

type CloudServiceGetUploadServerInfo struct{}

CloudServiceGetUploadServerInfo holds the result of the method ICloudService/GetUploadServerInfo.

type CommunityService added in v0.2.0

type CommunityService struct {
	Client    *Client
	Interface *SchemaInterface
}

CommunityService represents interface ICommunityService.

This is an undocumented interface.

func NewCommunityService added in v0.2.0

func NewCommunityService(c *Client) (*CommunityService, error)

NewCommunityService creates a new CommunityService interface.

func (*CommunityService) GetApps added in v0.2.0

func (i *CommunityService) GetApps() (*Request, error)

GetApps creates a Request for interface method GetApps.

This is an undocumented method.

func (*CommunityService) GetBestEventsForUser added in v0.2.0

func (i *CommunityService) GetBestEventsForUser() (*Request, error)

GetBestEventsForUser creates a Request for interface method GetBestEventsForUser.

This is an undocumented method.

func (*CommunityService) GetUserPartnerEventNews added in v0.2.0

func (i *CommunityService) GetUserPartnerEventNews() (*Request, error)

GetUserPartnerEventNews creates a Request for interface method GetUserPartnerEventNews.

This is an undocumented method.

type CommunityServiceGetApps added in v0.2.0

type CommunityServiceGetApps struct{}

CommunityServiceGetApps holds the result of the method ICommunityService/GetApps.

type CommunityServiceGetBestEventsForUser added in v0.2.0

type CommunityServiceGetBestEventsForUser struct{}

CommunityServiceGetBestEventsForUser holds the result of the method ICommunityService/GetBestEventsForUser.

type CommunityServiceGetUserPartnerEventNews added in v0.2.0

type CommunityServiceGetUserPartnerEventNews struct{}

CommunityServiceGetUserPartnerEventNews holds the result of the method ICommunityService/GetUserPartnerEventNews.

type ContentServerConfigService

type ContentServerConfigService struct {
	Client    *Client
	Interface *SchemaInterface
}

ContentServerConfigService represents interface IContentServerConfigService.

func NewContentServerConfigService

func NewContentServerConfigService(c *Client) (*ContentServerConfigService, error)

NewContentServerConfigService creates a new ContentServerConfigService interface.

func (*ContentServerConfigService) GetSteamCacheNodeParams

func (i *ContentServerConfigService) GetSteamCacheNodeParams() (*Request, error)

GetSteamCacheNodeParams creates a Request for interface method GetSteamCacheNodeParams.

Parameters

  • key [string] (required): Access key
  • cache_id [uint32] (required): Unique ID number
  • cache_key [string] (required): Valid current cache API key

func (*ContentServerConfigService) SetSteamCacheClientFilters

func (i *ContentServerConfigService) SetSteamCacheClientFilters() (*Request, error)

SetSteamCacheClientFilters creates a Request for interface method SetSteamCacheClientFilters.

Parameters

  • key [string] (required): Access key
  • cache_id [uint32] (required): Unique ID number
  • cache_key [string] (required): Valid current cache API key
  • change_notes [string] (required): Notes
  • allowed_ip_blocks [string] (required): comma-separated list of allowed IP address blocks in CIDR format - blank to clear unfilter

func (*ContentServerConfigService) SetSteamCachePerformanceStats

func (i *ContentServerConfigService) SetSteamCachePerformanceStats() (*Request, error)

SetSteamCachePerformanceStats creates a Request for interface method SetSteamCachePerformanceStats.

Parameters

  • key [string] (required): Access key
  • cache_id [uint32] (required): Unique ID number
  • cache_key [string] (required): Valid current cache API key
  • mbps_sent [uint32] (required): Outgoing network traffic in Mbps
  • mbps_recv [uint32] (required): Incoming network traffic in Mbps
  • cpu_percent [uint32] (required): Percent CPU load
  • cache_hit_percent [uint32] (required): Percent cache hits
  • num_connected_ips [uint32] (required): Number of unique connected IP addresses
  • upstream_egress_utilization [uint32] (required): What is the percent utilization of the busiest datacenter egress link?

type ContentServerConfigServiceGetSteamCacheNodeParams

type ContentServerConfigServiceGetSteamCacheNodeParams struct{}

ContentServerConfigServiceGetSteamCacheNodeParams holds the result of the method IContentServerConfigService/GetSteamCacheNodeParams.

type ContentServerConfigServiceSetSteamCacheClientFilters

type ContentServerConfigServiceSetSteamCacheClientFilters struct{}

ContentServerConfigServiceSetSteamCacheClientFilters holds the result of the method IContentServerConfigService/SetSteamCacheClientFilters.

type ContentServerConfigServiceSetSteamCachePerformanceStats

type ContentServerConfigServiceSetSteamCachePerformanceStats struct{}

ContentServerConfigServiceSetSteamCachePerformanceStats holds the result of the method IContentServerConfigService/SetSteamCachePerformanceStats.

type ContentServerDirectoryService

type ContentServerDirectoryService struct {
	Client    *Client
	Interface *SchemaInterface
}

ContentServerDirectoryService represents interface IContentServerDirectoryService.

func NewContentServerDirectoryService

func NewContentServerDirectoryService(c *Client) (*ContentServerDirectoryService, error)

NewContentServerDirectoryService creates a new ContentServerDirectoryService interface.

func (*ContentServerDirectoryService) GetDepotPatchInfo

func (i *ContentServerDirectoryService) GetDepotPatchInfo() (*Request, error)

GetDepotPatchInfo creates a Request for interface method GetDepotPatchInfo.

Parameters

  • appid [uint32] (required)
  • depotid [uint32] (required)
  • source_manifestid [uint64] (required)
  • target_manifestid [uint64] (required)

func (*ContentServerDirectoryService) GetServersForSteamPipe

func (i *ContentServerDirectoryService) GetServersForSteamPipe() (*Request, error)

GetServersForSteamPipe creates a Request for interface method GetServersForSteamPipe.

Parameters

  • cell_id [uint32] (required): client Cell ID
  • max_servers [uint32]: max servers in response list
  • ip_override [string]: client IP address
  • launcher_type [int32]: launcher type

type ContentServerDirectoryServiceGetDepotPatchInfo

type ContentServerDirectoryServiceGetDepotPatchInfo struct{}

ContentServerDirectoryServiceGetDepotPatchInfo holds the result of the method IContentServerDirectoryService/GetDepotPatchInfo.

type ContentServerDirectoryServiceGetServersForSteamPipe

type ContentServerDirectoryServiceGetServersForSteamPipe struct{}

ContentServerDirectoryServiceGetServersForSteamPipe holds the result of the method IContentServerDirectoryService/GetServersForSteamPipe.

type CredentialsService added in v0.2.0

type CredentialsService struct {
	Client    *Client
	Interface *SchemaInterface
}

CredentialsService represents interface ICredentialsService.

This is an undocumented interface.

func NewCredentialsService added in v0.2.0

func NewCredentialsService(c *Client) (*CredentialsService, error)

NewCredentialsService creates a new CredentialsService interface.

func (*CredentialsService) SteamGuardPhishingReport added in v0.2.0

func (i *CredentialsService) SteamGuardPhishingReport() (*Request, error)

SteamGuardPhishingReport creates a Request for interface method SteamGuardPhishingReport.

This is an undocumented method.

func (*CredentialsService) ValidateEmailAddress added in v0.2.0

func (i *CredentialsService) ValidateEmailAddress() (*Request, error)

ValidateEmailAddress creates a Request for interface method ValidateEmailAddress.

This is an undocumented method.

type CredentialsServiceSteamGuardPhishingReport added in v0.2.0

type CredentialsServiceSteamGuardPhishingReport struct{}

CredentialsServiceSteamGuardPhishingReport holds the result of the method ICredentialsService/SteamGuardPhishingReport.

type CredentialsServiceValidateEmailAddress added in v0.2.0

type CredentialsServiceValidateEmailAddress struct{}

CredentialsServiceValidateEmailAddress holds the result of the method ICredentialsService/ValidateEmailAddress.

type DOTA2Fantasy

type DOTA2Fantasy struct {
	Client    *Client
	Interface *SchemaInterface
}

DOTA2Fantasy represents interface IDOTA2Fantasy.

Supported AppIDs: 205790.

func NewDOTA2Fantasy

func NewDOTA2Fantasy(c *Client, appID uint32) (*DOTA2Fantasy, error)

NewDOTA2Fantasy creates a new DOTA2Fantasy interface.

Supported AppIDs: 205790.

func (*DOTA2Fantasy) GetFantasyPlayerStats

func (i *DOTA2Fantasy) GetFantasyPlayerStats() (*Request, error)

GetFantasyPlayerStats creates a Request for interface method GetFantasyPlayerStats.

Parameters

  • FantasyLeagueID [uint32] (required): The fantasy league ID
  • StartTime [uint32]: An optional filter for minimum timestamp
  • EndTime [uint32]: An optional filter for maximum timestamp
  • MatchID [uint64]: An optional filter for a specific match
  • SeriesID [uint32]: An optional filter for a specific series
  • PlayerAccountID [uint32]: An optional filter for a specific player

func (*DOTA2Fantasy) GetPlayerOfficialInfo

func (i *DOTA2Fantasy) GetPlayerOfficialInfo() (*Request, error)

GetPlayerOfficialInfo creates a Request for interface method GetPlayerOfficialInfo.

Parameters

  • accountid [uint32] (required): The account ID to look up

func (*DOTA2Fantasy) GetProPlayerList

func (i *DOTA2Fantasy) GetProPlayerList() (*Request, error)

GetProPlayerList creates a Request for interface method GetProPlayerList.

type DOTA2FantasyGetFantasyPlayerStats

type DOTA2FantasyGetFantasyPlayerStats struct{}

DOTA2FantasyGetFantasyPlayerStats holds the result of the method IDOTA2Fantasy/GetFantasyPlayerStats.

type DOTA2FantasyGetPlayerOfficialInfo

type DOTA2FantasyGetPlayerOfficialInfo struct{}

DOTA2FantasyGetPlayerOfficialInfo holds the result of the method IDOTA2Fantasy/GetPlayerOfficialInfo.

type DOTA2FantasyGetProPlayerList

type DOTA2FantasyGetProPlayerList struct{}

DOTA2FantasyGetProPlayerList holds the result of the method IDOTA2Fantasy/GetProPlayerList.

type DOTA2Match

type DOTA2Match struct {
	Client    *Client
	Interface *SchemaInterface
}

DOTA2Match represents interface IDOTA2Match.

Supported AppIDs: 570, 205790.

func NewDOTA2Match

func NewDOTA2Match(c *Client, appID uint32) (*DOTA2Match, error)

NewDOTA2Match creates a new DOTA2Match interface.

Supported AppIDs: 570, 205790.

func (*DOTA2Match) GetLeagueListing

func (i *DOTA2Match) GetLeagueListing() (*Request, error)

GetLeagueListing creates a Request for interface method GetLeagueListing.

func (*DOTA2Match) GetLiveLeagueGames

func (i *DOTA2Match) GetLiveLeagueGames() (*Request, error)

GetLiveLeagueGames creates a Request for interface method GetLiveLeagueGames.

Parameters

  • league_id [uint32]: Only show matches of the specified league id
  • match_id [uint64]: Only show matches of the specified match id

func (*DOTA2Match) GetMatchDetails

func (i *DOTA2Match) GetMatchDetails() (*Request, error)

GetMatchDetails creates a Request for interface method GetMatchDetails.

Parameters

  • match_id [uint64] (required): Match id

func (*DOTA2Match) GetMatchHistory

func (i *DOTA2Match) GetMatchHistory() (*Request, error)

GetMatchHistory creates a Request for interface method GetMatchHistory.

Parameters

  • hero_id [uint32]: The ID of the hero that must be in the matches being queried
  • game_mode [uint32]: Which game mode to return matches for
  • skill [uint32]: The average skill range of the match, these can be [1-3] with lower numbers being lower skill. Ignored if an account ID is specified
  • min_players [string]: Minimum number of human players that must be in a match for it to be returned
  • account_id [string]: An account ID to get matches from. This will fail if the user has their match history hidden
  • league_id [string]: The league ID to return games from
  • start_at_match_id [uint64]: The minimum match ID to start from
  • matches_requested [string]: The number of requested matches to return

func (*DOTA2Match) GetMatchHistoryBySequenceNum

func (i *DOTA2Match) GetMatchHistoryBySequenceNum() (*Request, error)

GetMatchHistoryBySequenceNum creates a Request for interface method GetMatchHistoryBySequenceNum.

Parameters

  • start_at_match_seq_num [uint64]
  • matches_requested [uint32]

func (*DOTA2Match) GetTeamInfoByTeamID

func (i *DOTA2Match) GetTeamInfoByTeamID() (*Request, error)

GetTeamInfoByTeamID creates a Request for interface method GetTeamInfoByTeamID.

Parameters

  • start_at_team_id [uint64]
  • teams_requested [uint32]

func (*DOTA2Match) GetTopLiveEventGame

func (i *DOTA2Match) GetTopLiveEventGame() (*Request, error)

GetTopLiveEventGame creates a Request for interface method GetTopLiveEventGame.

Parameters

  • partner [int32] (required): Which partner's games to use.

func (*DOTA2Match) GetTopLiveGame

func (i *DOTA2Match) GetTopLiveGame() (*Request, error)

GetTopLiveGame creates a Request for interface method GetTopLiveGame.

Parameters

  • partner [int32] (required): Which partner's games to use.

func (*DOTA2Match) GetTopWeekendTourneyGames

func (i *DOTA2Match) GetTopWeekendTourneyGames() (*Request, error)

GetTopWeekendTourneyGames creates a Request for interface method GetTopWeekendTourneyGames.

Parameters

  • partner [int32] (required): Which partner's games to use.
  • home_division [int32]: Prefer matches from this division.

func (*DOTA2Match) GetTournamentPlayerStats

func (i *DOTA2Match) GetTournamentPlayerStats(version int) (*Request, error)

GetTournamentPlayerStats creates a Request for interface method GetTournamentPlayerStats.

Supported versions: 1, 2.

Parameters (v1)

  • account_id [string] (required)
  • league_id [string]
  • hero_id [string]
  • time_frame [string]
  • match_id [uint64]
  • phase_id [uint32]

Parameters (v2)

  • account_id [string] (required)
  • league_id [string]
  • hero_id [string]
  • time_frame [string]
  • match_id [uint64]
  • phase_id [uint32]

type DOTA2MatchGetLeagueListing

type DOTA2MatchGetLeagueListing struct{}

DOTA2MatchGetLeagueListing holds the result of the method IDOTA2Match/GetLeagueListing.

type DOTA2MatchGetLiveLeagueGames

type DOTA2MatchGetLiveLeagueGames struct{}

DOTA2MatchGetLiveLeagueGames holds the result of the method IDOTA2Match/GetLiveLeagueGames.

type DOTA2MatchGetMatchDetails

type DOTA2MatchGetMatchDetails struct{}

DOTA2MatchGetMatchDetails holds the result of the method IDOTA2Match/GetMatchDetails.

type DOTA2MatchGetMatchHistory

type DOTA2MatchGetMatchHistory struct{}

DOTA2MatchGetMatchHistory holds the result of the method IDOTA2Match/GetMatchHistory.

type DOTA2MatchGetMatchHistoryBySequenceNum

type DOTA2MatchGetMatchHistoryBySequenceNum struct{}

DOTA2MatchGetMatchHistoryBySequenceNum holds the result of the method IDOTA2Match/GetMatchHistoryBySequenceNum.

type DOTA2MatchGetTeamInfoByTeamID

type DOTA2MatchGetTeamInfoByTeamID struct{}

DOTA2MatchGetTeamInfoByTeamID holds the result of the method IDOTA2Match/GetTeamInfoByTeamID.

type DOTA2MatchGetTopLiveEventGame

type DOTA2MatchGetTopLiveEventGame struct{}

DOTA2MatchGetTopLiveEventGame holds the result of the method IDOTA2Match/GetTopLiveEventGame.

type DOTA2MatchGetTopLiveGame

type DOTA2MatchGetTopLiveGame struct{}

DOTA2MatchGetTopLiveGame holds the result of the method IDOTA2Match/GetTopLiveGame.

type DOTA2MatchGetTopWeekendTourneyGames

type DOTA2MatchGetTopWeekendTourneyGames struct{}

DOTA2MatchGetTopWeekendTourneyGames holds the result of the method IDOTA2Match/GetTopWeekendTourneyGames.

type DOTA2MatchGetTournamentPlayerStats

type DOTA2MatchGetTournamentPlayerStats struct{}

DOTA2MatchGetTournamentPlayerStats holds the result of the method IDOTA2Match/GetTournamentPlayerStats.

type DOTA2MatchStats

type DOTA2MatchStats struct {
	Client    *Client
	Interface *SchemaInterface
}

DOTA2MatchStats represents interface IDOTA2MatchStats.

Supported AppIDs: 570, 205790.

func NewDOTA2MatchStats

func NewDOTA2MatchStats(c *Client, appID uint32) (*DOTA2MatchStats, error)

NewDOTA2MatchStats creates a new DOTA2MatchStats interface.

Supported AppIDs: 570, 205790.

func (*DOTA2MatchStats) GetRealtimeStats

func (i *DOTA2MatchStats) GetRealtimeStats() (*Request, error)

GetRealtimeStats creates a Request for interface method GetRealtimeStats.

Parameters

  • server_steam_id [uint64] (required)

type DOTA2MatchStatsGetRealtimeStats

type DOTA2MatchStatsGetRealtimeStats struct{}

DOTA2MatchStatsGetRealtimeStats holds the result of the method IDOTA2MatchStats/GetRealtimeStats.

type DOTA2StreamSystem

type DOTA2StreamSystem struct {
	Client    *Client
	Interface *SchemaInterface
}

DOTA2StreamSystem represents interface IDOTA2StreamSystem.

Supported AppIDs: 570, 205790.

func NewDOTA2StreamSystem

func NewDOTA2StreamSystem(c *Client, appID uint32) (*DOTA2StreamSystem, error)

NewDOTA2StreamSystem creates a new DOTA2StreamSystem interface.

Supported AppIDs: 570, 205790.

func (*DOTA2StreamSystem) GetBroadcasterInfo

func (i *DOTA2StreamSystem) GetBroadcasterInfo() (*Request, error)

GetBroadcasterInfo creates a Request for interface method GetBroadcasterInfo.

Parameters

  • broadcaster_steam_id [uint64] (required): 64-bit Steam ID of the broadcaster
  • league_id [uint32]: LeagueID to use if we aren't in a lobby

type DOTA2StreamSystemGetBroadcasterInfo

type DOTA2StreamSystemGetBroadcasterInfo struct{}

DOTA2StreamSystemGetBroadcasterInfo holds the result of the method IDOTA2StreamSystem/GetBroadcasterInfo.

type DOTA2Ticket

type DOTA2Ticket struct {
	Client    *Client
	Interface *SchemaInterface
}

DOTA2Ticket represents interface IDOTA2Ticket.

Supported AppIDs: 570, 205790.

func NewDOTA2Ticket

func NewDOTA2Ticket(c *Client, appID uint32) (*DOTA2Ticket, error)

NewDOTA2Ticket creates a new DOTA2Ticket interface.

Supported AppIDs: 570, 205790.

func (*DOTA2Ticket) ClaimBadgeReward

func (i *DOTA2Ticket) ClaimBadgeReward() (*Request, error)

ClaimBadgeReward creates a Request for interface method ClaimBadgeReward.

Parameters

  • BadgeID [string] (required): The Badge ID
  • ValidBadgeType1 [uint32] (required): Valid Badge Type 1
  • ValidBadgeType2 [uint32] (required): Valid Badge Type 2
  • ValidBadgeType3 [uint32] (required): Valid Badge Type 3

func (*DOTA2Ticket) GetSteamIDForBadgeID

func (i *DOTA2Ticket) GetSteamIDForBadgeID() (*Request, error)

GetSteamIDForBadgeID creates a Request for interface method GetSteamIDForBadgeID.

Parameters

  • BadgeID [string] (required): The badge ID

func (*DOTA2Ticket) SetSteamAccountPurchased

func (i *DOTA2Ticket) SetSteamAccountPurchased() (*Request, error)

SetSteamAccountPurchased creates a Request for interface method SetSteamAccountPurchased.

Parameters

  • steamid [uint64] (required): The 64-bit Steam ID
  • BadgeType [uint32] (required): Badge Type

func (*DOTA2Ticket) SteamAccountValidForBadgeType

func (i *DOTA2Ticket) SteamAccountValidForBadgeType() (*Request, error)

SteamAccountValidForBadgeType creates a Request for interface method SteamAccountValidForBadgeType.

Parameters

  • steamid [uint64] (required): The 64-bit Steam ID
  • ValidBadgeType1 [uint32] (required): Valid Badge Type 1
  • ValidBadgeType2 [uint32] (required): Valid Badge Type 2
  • ValidBadgeType3 [uint32] (required): Valid Badge Type 3

type DOTA2TicketClaimBadgeReward

type DOTA2TicketClaimBadgeReward struct{}

DOTA2TicketClaimBadgeReward holds the result of the method IDOTA2Ticket/ClaimBadgeReward.

type DOTA2TicketGetSteamIDForBadgeID

type DOTA2TicketGetSteamIDForBadgeID struct{}

DOTA2TicketGetSteamIDForBadgeID holds the result of the method IDOTA2Ticket/GetSteamIDForBadgeID.

type DOTA2TicketSetSteamAccountPurchased

type DOTA2TicketSetSteamAccountPurchased struct{}

DOTA2TicketSetSteamAccountPurchased holds the result of the method IDOTA2Ticket/SetSteamAccountPurchased.

type DOTA2TicketSteamAccountValidForBadgeType

type DOTA2TicketSteamAccountValidForBadgeType struct{}

DOTA2TicketSteamAccountValidForBadgeType holds the result of the method IDOTA2Ticket/SteamAccountValidForBadgeType.

type EconDOTA2

type EconDOTA2 struct {
	Client    *Client
	Interface *SchemaInterface
}

EconDOTA2 represents interface IEconDOTA2.

Supported AppIDs: 570, 205790.

func NewEconDOTA2

func NewEconDOTA2(c *Client, appID uint32) (*EconDOTA2, error)

NewEconDOTA2 creates a new EconDOTA2 interface.

Supported AppIDs: 570, 205790.

func (*EconDOTA2) GetEventStatsForAccount

func (i *EconDOTA2) GetEventStatsForAccount() (*Request, error)

GetEventStatsForAccount creates a Request for interface method GetEventStatsForAccount.

Parameters

  • eventid [uint32] (required): The League ID of the compendium you're looking for.
  • accountid [uint32] (required): The account ID to look up.
  • language [string]: The language to provide hero names in.

func (*EconDOTA2) GetGameItems

func (i *EconDOTA2) GetGameItems() (*Request, error)

GetGameItems creates a Request for interface method GetGameItems.

Parameters

  • language [string]: The language to provide item names in.

func (*EconDOTA2) GetHeroes

func (i *EconDOTA2) GetHeroes() (*Request, error)

GetHeroes creates a Request for interface method GetHeroes.

Parameters

  • language [string]: The language to provide hero names in.
  • itemizedonly [bool]: Return a list of itemized heroes only.

func (*EconDOTA2) GetItemCreators

func (i *EconDOTA2) GetItemCreators() (*Request, error)

GetItemCreators creates a Request for interface method GetItemCreators.

Parameters

  • itemdef [uint32] (required): The item definition to get creator information for.

func (*EconDOTA2) GetItemIconPath

func (i *EconDOTA2) GetItemIconPath() (*Request, error)

GetItemIconPath creates a Request for interface method GetItemIconPath.

Parameters

  • iconname [string] (required): The item icon name to get the CDN path of
  • icontype [uint32]: The type of image you want. 0 = normal, 1 = large, 2 = ingame

func (*EconDOTA2) GetRarities

func (i *EconDOTA2) GetRarities() (*Request, error)

GetRarities creates a Request for interface method GetRarities.

Parameters

  • language [string]: The language to provide rarity names in.

func (*EconDOTA2) GetTournamentPrizePool

func (i *EconDOTA2) GetTournamentPrizePool() (*Request, error)

GetTournamentPrizePool creates a Request for interface method GetTournamentPrizePool.

Parameters

  • leagueid [uint32]: The ID of the league to get the prize pool of

type EconDOTA2GetEventStatsForAccount

type EconDOTA2GetEventStatsForAccount struct{}

EconDOTA2GetEventStatsForAccount holds the result of the method IEconDOTA2/GetEventStatsForAccount.

type EconDOTA2GetGameItems

type EconDOTA2GetGameItems struct{}

EconDOTA2GetGameItems holds the result of the method IEconDOTA2/GetGameItems.

type EconDOTA2GetHeroes

type EconDOTA2GetHeroes struct{}

EconDOTA2GetHeroes holds the result of the method IEconDOTA2/GetHeroes.

type EconDOTA2GetItemCreators

type EconDOTA2GetItemCreators struct{}

EconDOTA2GetItemCreators holds the result of the method IEconDOTA2/GetItemCreators.

type EconDOTA2GetItemIconPath

type EconDOTA2GetItemIconPath struct{}

EconDOTA2GetItemIconPath holds the result of the method IEconDOTA2/GetItemIconPath.

type EconDOTA2GetRarities

type EconDOTA2GetRarities struct{}

EconDOTA2GetRarities holds the result of the method IEconDOTA2/GetRarities.

type EconDOTA2GetTournamentPrizePool

type EconDOTA2GetTournamentPrizePool struct{}

EconDOTA2GetTournamentPrizePool holds the result of the method IEconDOTA2/GetTournamentPrizePool.

type EconItems

type EconItems struct {
	Client    *Client
	Interface *SchemaInterface
}

EconItems represents interface IEconItems.

Supported AppIDs: 440, 570, 620, 730, 205790, 221540, 238460, 583950.

func NewEconItems

func NewEconItems(c *Client, appID uint32) (*EconItems, error)

NewEconItems creates a new EconItems interface.

Supported AppIDs: 440, 570, 620, 730, 205790, 221540, 238460, 583950.

func (*EconItems) GetEquippedPlayerItems

func (i *EconItems) GetEquippedPlayerItems() (*Request, error)

GetEquippedPlayerItems creates a Request for interface method GetEquippedPlayerItems.

Parameters

  • steamid [uint64] (required): The Steam ID to fetch items for
  • class_id [uint32] (required): Return items equipped for this class id

func (*EconItems) GetPlayerItems

func (i *EconItems) GetPlayerItems() (*Request, error)

GetPlayerItems creates a Request for interface method GetPlayerItems.

Parameters

  • steamid [uint64] (required): The Steam ID to fetch items for

func (*EconItems) GetSchema

func (i *EconItems) GetSchema(version int) (*Request, error)

GetSchema creates a Request for interface method GetSchema.

Supported versions: 1, 2.

Parameters (v1)

  • language [string]: The language to return the names in. Defaults to returning string keys.

Parameters (v2)

  • language [string]: The language to return the names in. Defaults to returning string keys.

func (*EconItems) GetSchemaItems

func (i *EconItems) GetSchemaItems() (*Request, error)

GetSchemaItems creates a Request for interface method GetSchemaItems.

Parameters

  • language [string]: The language to return the names in. Defaults to returning string keys.
  • start [int32]: The first item id to return. Defaults to 0. Response will indicate next value to query if applicable.

func (*EconItems) GetSchemaOverview

func (i *EconItems) GetSchemaOverview() (*Request, error)

GetSchemaOverview creates a Request for interface method GetSchemaOverview.

Parameters

  • language [string]: The language to return the names in. Defaults to returning string keys.

func (*EconItems) GetSchemaURL

func (i *EconItems) GetSchemaURL(version int) (*Request, error)

GetSchemaURL creates a Request for interface method GetSchemaURL.

Supported versions: 1, 2.

func (*EconItems) GetStoreMetaData

func (i *EconItems) GetStoreMetaData() (*Request, error)

GetStoreMetaData creates a Request for interface method GetStoreMetaData.

Parameters

  • language [string]: The language to results in.

func (*EconItems) GetStoreStatus

func (i *EconItems) GetStoreStatus() (*Request, error)

GetStoreStatus creates a Request for interface method GetStoreStatus.

type EconItemsGetEquippedPlayerItems

type EconItemsGetEquippedPlayerItems struct{}

EconItemsGetEquippedPlayerItems holds the result of the method IEconItems/GetEquippedPlayerItems.

type EconItemsGetPlayerItems

type EconItemsGetPlayerItems struct{}

EconItemsGetPlayerItems holds the result of the method IEconItems/GetPlayerItems.

type EconItemsGetSchema

type EconItemsGetSchema struct{}

EconItemsGetSchema holds the result of the method IEconItems/GetSchema.

type EconItemsGetSchemaItems

type EconItemsGetSchemaItems struct{}

EconItemsGetSchemaItems holds the result of the method IEconItems/GetSchemaItems.

type EconItemsGetSchemaOverview

type EconItemsGetSchemaOverview struct{}

EconItemsGetSchemaOverview holds the result of the method IEconItems/GetSchemaOverview.

type EconItemsGetSchemaURL

type EconItemsGetSchemaURL struct{}

EconItemsGetSchemaURL holds the result of the method IEconItems/GetSchemaURL.

type EconItemsGetStoreMetaData

type EconItemsGetStoreMetaData struct{}

EconItemsGetStoreMetaData holds the result of the method IEconItems/GetStoreMetaData.

type EconItemsGetStoreStatus

type EconItemsGetStoreStatus struct{}

EconItemsGetStoreStatus holds the result of the method IEconItems/GetStoreStatus.

type EconService

type EconService struct {
	Client    *Client
	Interface *SchemaInterface
}

EconService represents interface IEconService.

func NewEconService

func NewEconService(c *Client) (*EconService, error)

NewEconService creates a new EconService interface.

func (*EconService) CancelTradeOffer

func (i *EconService) CancelTradeOffer() (*Request, error)

CancelTradeOffer creates a Request for interface method CancelTradeOffer.

Parameters

  • key [string] (required): Access key
  • tradeofferid [uint64] (required)

func (*EconService) DeclineTradeOffer

func (i *EconService) DeclineTradeOffer() (*Request, error)

DeclineTradeOffer creates a Request for interface method DeclineTradeOffer.

Parameters

  • key [string] (required): Access key
  • tradeofferid [uint64] (required)

func (*EconService) GetTradeHistory

func (i *EconService) GetTradeHistory() (*Request, error)

GetTradeHistory creates a Request for interface method GetTradeHistory.

Parameters

  • key [string] (required): Access key
  • max_trades [uint32] (required): The number of trades to return information for
  • start_after_time [uint32] (required): The time of the last trade shown on the previous page of results, or the time of the first trade if navigating back
  • start_after_tradeid [uint64] (required): The tradeid shown on the previous page of results, or the ID of the first trade if navigating back
  • navigating_back [bool] (required): The user wants the previous page of results, so return the previous max_trades trades before the start time and ID
  • get_descriptions [bool] (required): If set, the item display data for the items included in the returned trades will also be returned
  • language [string] (required): The language to use when loading item display data
  • include_failed [bool] (required)
  • include_total [bool] (required): If set, the total number of trades the account has participated in will be included in the response

func (*EconService) GetTradeHoldDurations

func (i *EconService) GetTradeHoldDurations() (*Request, error)

GetTradeHoldDurations creates a Request for interface method GetTradeHoldDurations.

Parameters

  • key [string] (required): Access key
  • steamid_target [uint64] (required): User you are trading with
  • trade_offer_access_token [string] (required): A special token that allows for trade offers from non-friends.

func (*EconService) GetTradeOffer

func (i *EconService) GetTradeOffer() (*Request, error)

GetTradeOffer creates a Request for interface method GetTradeOffer.

Parameters

  • key [string] (required): Access key
  • tradeofferid [uint64] (required)
  • language [string] (required)
  • get_descriptions [bool] (required): If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.

func (*EconService) GetTradeOffers

func (i *EconService) GetTradeOffers() (*Request, error)

GetTradeOffers creates a Request for interface method GetTradeOffers.

Parameters

  • key [string] (required): Access key
  • get_sent_offers [bool] (required): Request the list of sent offers.
  • get_received_offers [bool] (required): Request the list of received offers.
  • get_descriptions [bool] (required): If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.
  • language [string] (required): The language to use when loading item display data.
  • active_only [bool] (required): Indicates we should only return offers which are still active, or offers that have changed in state since the time_historical_cutoff
  • historical_only [bool] (required): Indicates we should only return offers which are not active.
  • time_historical_cutoff [uint32] (required): When active_only is set, offers updated since this time will also be returned

func (*EconService) GetTradeOffersSummary

func (i *EconService) GetTradeOffersSummary() (*Request, error)

GetTradeOffersSummary creates a Request for interface method GetTradeOffersSummary.

Parameters

  • key [string] (required): Access key
  • time_last_visit [uint32] (required): The time the user last visited. If not passed, will use the time the user last visited the trade offer page.

func (*EconService) GetTradeStatus

func (i *EconService) GetTradeStatus() (*Request, error)

GetTradeStatus creates a Request for interface method GetTradeStatus.

Parameters

  • key [string] (required): Access key
  • tradeid [uint64] (required)
  • get_descriptions [bool] (required): If set, the item display data for the items included in the returned trades will also be returned
  • language [string] (required): The language to use when loading item display data

type EconServiceCancelTradeOffer

type EconServiceCancelTradeOffer struct{}

EconServiceCancelTradeOffer holds the result of the method IEconService/CancelTradeOffer.

type EconServiceDeclineTradeOffer

type EconServiceDeclineTradeOffer struct{}

EconServiceDeclineTradeOffer holds the result of the method IEconService/DeclineTradeOffer.

type EconServiceGetTradeHistory

type EconServiceGetTradeHistory struct{}

EconServiceGetTradeHistory holds the result of the method IEconService/GetTradeHistory.

type EconServiceGetTradeHoldDurations

type EconServiceGetTradeHoldDurations struct{}

EconServiceGetTradeHoldDurations holds the result of the method IEconService/GetTradeHoldDurations.

type EconServiceGetTradeOffer

type EconServiceGetTradeOffer struct{}

EconServiceGetTradeOffer holds the result of the method IEconService/GetTradeOffer.

type EconServiceGetTradeOffers

type EconServiceGetTradeOffers struct{}

EconServiceGetTradeOffers holds the result of the method IEconService/GetTradeOffers.

type EconServiceGetTradeOffersSummary

type EconServiceGetTradeOffersSummary struct{}

EconServiceGetTradeOffersSummary holds the result of the method IEconService/GetTradeOffersSummary.

type EconServiceGetTradeStatus

type EconServiceGetTradeStatus struct{}

EconServiceGetTradeStatus holds the result of the method IEconService/GetTradeStatus.

type FriendMessagesService added in v0.2.0

type FriendMessagesService struct {
	Client    *Client
	Interface *SchemaInterface
}

FriendMessagesService represents interface IFriendMessagesService.

This is an undocumented interface.

func NewFriendMessagesService added in v0.2.0

func NewFriendMessagesService(c *Client) (*FriendMessagesService, error)

NewFriendMessagesService creates a new FriendMessagesService interface.

func (*FriendMessagesService) GetActiveMessageSessions added in v0.2.0

func (i *FriendMessagesService) GetActiveMessageSessions() (*Request, error)

GetActiveMessageSessions creates a Request for interface method GetActiveMessageSessions.

This is an undocumented method.

func (*FriendMessagesService) GetRecentMessages added in v0.2.0

func (i *FriendMessagesService) GetRecentMessages() (*Request, error)

GetRecentMessages creates a Request for interface method GetRecentMessages.

This is an undocumented method.

func (*FriendMessagesService) MarkOfflineMessagesRead added in v0.2.0

func (i *FriendMessagesService) MarkOfflineMessagesRead() (*Request, error)

MarkOfflineMessagesRead creates a Request for interface method MarkOfflineMessagesRead.

This is an undocumented method.

type FriendMessagesServiceGetActiveMessageSessions added in v0.2.0

type FriendMessagesServiceGetActiveMessageSessions struct{}

FriendMessagesServiceGetActiveMessageSessions holds the result of the method IFriendMessagesService/GetActiveMessageSessions.

type FriendMessagesServiceGetRecentMessages added in v0.2.0

type FriendMessagesServiceGetRecentMessages struct{}

FriendMessagesServiceGetRecentMessages holds the result of the method IFriendMessagesService/GetRecentMessages.

type FriendMessagesServiceMarkOfflineMessagesRead added in v0.2.0

type FriendMessagesServiceMarkOfflineMessagesRead struct{}

FriendMessagesServiceMarkOfflineMessagesRead holds the result of the method IFriendMessagesService/MarkOfflineMessagesRead.

type GCVersion

type GCVersion struct {
	Client    *Client
	Interface *SchemaInterface
}

GCVersion represents interface IGCVersion.

Supported AppIDs: 440, 570, 730, 205790, 583950, 1046930.

func NewGCVersion

func NewGCVersion(c *Client, appID uint32) (*GCVersion, error)

NewGCVersion creates a new GCVersion interface.

Supported AppIDs: 440, 570, 730, 205790, 583950, 1046930.

func (*GCVersion) GetClientVersion

func (i *GCVersion) GetClientVersion() (*Request, error)

GetClientVersion creates a Request for interface method GetClientVersion.

func (*GCVersion) GetServerVersion

func (i *GCVersion) GetServerVersion() (*Request, error)

GetServerVersion creates a Request for interface method GetServerVersion.

type GCVersionGetClientVersion

type GCVersionGetClientVersion struct{}

GCVersionGetClientVersion holds the result of the method IGCVersion/GetClientVersion.

type GCVersionGetServerVersion

type GCVersionGetServerVersion struct{}

GCVersionGetServerVersion holds the result of the method IGCVersion/GetServerVersion.

type GameCoordinator added in v0.2.0

type GameCoordinator struct {
	Client    *Client
	Interface *SchemaInterface
}

GameCoordinator represents interface IGameCoordinator.

This is an undocumented interface.

func NewGameCoordinator added in v0.2.0

func NewGameCoordinator(c *Client) (*GameCoordinator, error)

NewGameCoordinator creates a new GameCoordinator interface.

func (*GameCoordinator) GetMessages added in v0.2.0

func (i *GameCoordinator) GetMessages() (*Request, error)

GetMessages creates a Request for interface method GetMessages.

This is an undocumented method.

func (*GameCoordinator) PostMessages added in v0.2.0

func (i *GameCoordinator) PostMessages() (*Request, error)

PostMessages creates a Request for interface method PostMessages.

This is an undocumented method.

type GameCoordinatorGetMessages added in v0.2.0

type GameCoordinatorGetMessages struct{}

GameCoordinatorGetMessages holds the result of the method IGameCoordinator/GetMessages.

type GameCoordinatorPostMessages added in v0.2.0

type GameCoordinatorPostMessages struct{}

GameCoordinatorPostMessages holds the result of the method IGameCoordinator/PostMessages.

type GameInventory added in v0.2.0

type GameInventory struct {
	Client    *Client
	Interface *SchemaInterface
}

GameInventory represents interface IGameInventory.

This is an undocumented interface.

func NewGameInventory added in v0.2.0

func NewGameInventory(c *Client) (*GameInventory, error)

NewGameInventory creates a new GameInventory interface.

func (*GameInventory) GetItemDefArchive added in v0.2.0

func (i *GameInventory) GetItemDefArchive() (*Request, error)

GetItemDefArchive creates a Request for interface method GetItemDefArchive.

This is an undocumented method.

type GameInventoryGetItemDefArchive added in v0.2.0

type GameInventoryGetItemDefArchive struct{}

GameInventoryGetItemDefArchive holds the result of the method IGameInventory/GetItemDefArchive.

type GameNotificationsService

type GameNotificationsService struct {
	Client    *Client
	Interface *SchemaInterface
}

GameNotificationsService represents interface IGameNotificationsService.

func NewGameNotificationsService

func NewGameNotificationsService(c *Client) (*GameNotificationsService, error)

NewGameNotificationsService creates a new GameNotificationsService interface.

func (*GameNotificationsService) UserCreateSession

func (i *GameNotificationsService) UserCreateSession() (*Request, error)

UserCreateSession creates a Request for interface method UserCreateSession.

Parameters

  • appid [uint32] (required): The appid to create the session for.
  • context [uint64] (required): Game-specified context value the game can used to associate the session with some object on their backend.
  • title [{message}] (required): The title of the session to be displayed within each user's list of sessions.
  • users [{message}] (required): The initial state of all users in the session.
  • steamid [uint64] (required): (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.

func (*GameNotificationsService) UserDeleteSession

func (i *GameNotificationsService) UserDeleteSession() (*Request, error)

UserDeleteSession creates a Request for interface method UserDeleteSession.

Parameters

  • sessionid [uint64] (required): The sessionid to delete.
  • appid [uint32] (required): The appid of the session to delete.
  • steamid [uint64] (required): (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.

func (*GameNotificationsService) UserUpdateSession

func (i *GameNotificationsService) UserUpdateSession() (*Request, error)

UserUpdateSession creates a Request for interface method UserUpdateSession.

Parameters

  • sessionid [uint64] (required): The sessionid to update.
  • appid [uint32] (required): The appid of the session to update.
  • title [{message}] (required): (Optional) The new title of the session. If not specified, the title will not be changed.
  • users [{message}] (required): (Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it.
  • steamid [uint64] (required): (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.

type GameNotificationsServiceUserCreateSession

type GameNotificationsServiceUserCreateSession struct{}

GameNotificationsServiceUserCreateSession holds the result of the method IGameNotificationsService/UserCreateSession.

type GameNotificationsServiceUserDeleteSession

type GameNotificationsServiceUserDeleteSession struct{}

GameNotificationsServiceUserDeleteSession holds the result of the method IGameNotificationsService/UserDeleteSession.

type GameNotificationsServiceUserUpdateSession

type GameNotificationsServiceUserUpdateSession struct{}

GameNotificationsServiceUserUpdateSession holds the result of the method IGameNotificationsService/UserUpdateSession.

type GameServersService

type GameServersService struct {
	Client    *Client
	Interface *SchemaInterface
}

GameServersService represents interface IGameServersService.

func NewGameServersService

func NewGameServersService(c *Client) (*GameServersService, error)

NewGameServersService creates a new GameServersService interface.

func (*GameServersService) CreateAccount

func (i *GameServersService) CreateAccount() (*Request, error)

CreateAccount creates a Request for interface method CreateAccount.

Parameters

  • key [string] (required): Access key
  • appid [uint32] (required): The app to use the account for
  • memo [string] (required): The memo to set on the new account

func (*GameServersService) DeleteAccount

func (i *GameServersService) DeleteAccount() (*Request, error)

DeleteAccount creates a Request for interface method DeleteAccount.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The SteamID of the game server account to delete

func (*GameServersService) GetAccountList

func (i *GameServersService) GetAccountList() (*Request, error)

GetAccountList creates a Request for interface method GetAccountList.

Parameters

  • key [string] (required): Access key

func (*GameServersService) GetAccountPublicInfo

func (i *GameServersService) GetAccountPublicInfo() (*Request, error)

GetAccountPublicInfo creates a Request for interface method GetAccountPublicInfo.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The SteamID of the game server to get info on

func (*GameServersService) GetServerIPsBySteamID

func (i *GameServersService) GetServerIPsBySteamID() (*Request, error)

GetServerIPsBySteamID creates a Request for interface method GetServerIPsBySteamID.

Parameters

  • key [string] (required): Access key
  • server_steamids [uint64] (required)

func (*GameServersService) GetServerList added in v0.2.0

func (i *GameServersService) GetServerList() (*Request, error)

GetServerList creates a Request for interface method GetServerList.

This is an undocumented method.

func (*GameServersService) GetServerSteamIDsByIP

func (i *GameServersService) GetServerSteamIDsByIP() (*Request, error)

GetServerSteamIDsByIP creates a Request for interface method GetServerSteamIDsByIP.

Parameters

  • key [string] (required): Access key
  • server_ips [string] (required)

func (*GameServersService) QueryLoginToken

func (i *GameServersService) QueryLoginToken() (*Request, error)

QueryLoginToken creates a Request for interface method QueryLoginToken.

Parameters

  • key [string] (required): Access key
  • login_token [string] (required): Login token to query

func (*GameServersService) ResetLoginToken

func (i *GameServersService) ResetLoginToken() (*Request, error)

ResetLoginToken creates a Request for interface method ResetLoginToken.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The SteamID of the game server to reset the login token of

func (*GameServersService) SetMemo

func (i *GameServersService) SetMemo() (*Request, error)

SetMemo creates a Request for interface method SetMemo.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The SteamID of the game server to set the memo on
  • memo [string] (required): The memo to set on the new account

type GameServersServiceCreateAccount

type GameServersServiceCreateAccount struct{}

GameServersServiceCreateAccount holds the result of the method IGameServersService/CreateAccount.

type GameServersServiceDeleteAccount

type GameServersServiceDeleteAccount struct{}

GameServersServiceDeleteAccount holds the result of the method IGameServersService/DeleteAccount.

type GameServersServiceGetAccountList

type GameServersServiceGetAccountList struct{}

GameServersServiceGetAccountList holds the result of the method IGameServersService/GetAccountList.

type GameServersServiceGetAccountPublicInfo

type GameServersServiceGetAccountPublicInfo struct{}

GameServersServiceGetAccountPublicInfo holds the result of the method IGameServersService/GetAccountPublicInfo.

type GameServersServiceGetServerIPsBySteamID

type GameServersServiceGetServerIPsBySteamID struct{}

GameServersServiceGetServerIPsBySteamID holds the result of the method IGameServersService/GetServerIPsBySteamID.

type GameServersServiceGetServerList added in v0.2.0

type GameServersServiceGetServerList struct{}

GameServersServiceGetServerList holds the result of the method IGameServersService/GetServerList.

type GameServersServiceGetServerSteamIDsByIP

type GameServersServiceGetServerSteamIDsByIP struct{}

GameServersServiceGetServerSteamIDsByIP holds the result of the method IGameServersService/GetServerSteamIDsByIP.

type GameServersServiceQueryLoginToken

type GameServersServiceQueryLoginToken struct{}

GameServersServiceQueryLoginToken holds the result of the method IGameServersService/QueryLoginToken.

type GameServersServiceResetLoginToken

type GameServersServiceResetLoginToken struct{}

GameServersServiceResetLoginToken holds the result of the method IGameServersService/ResetLoginToken.

type GameServersServiceSetMemo

type GameServersServiceSetMemo struct{}

GameServersServiceSetMemo holds the result of the method IGameServersService/SetMemo.

type InterfaceMethodNotFoundError

type InterfaceMethodNotFoundError struct {
	Key SchemaMethodKey
}

InterfaceMethodNotFoundError is returned when tried to access an interface method with invalid name or invalid version.

func (InterfaceMethodNotFoundError) Error

type InterfaceNotFoundError

type InterfaceNotFoundError struct {
	Key SchemaInterfaceKey
}

InterfaceNotFoundError is returned when tried to access an interface with invalid name or invalid AppID.

func (InterfaceNotFoundError) Error

type InvalidInterfaceNameError added in v0.2.0

type InvalidInterfaceNameError struct {
	Interface *SchemaInterface
	Err       error
}

InvalidInterfaceNameError is returned when an interface has an invalid name.

func (InvalidInterfaceNameError) Error added in v0.2.0

type InvalidMethodHTTPMethodError added in v0.2.0

type InvalidMethodHTTPMethodError struct {
	Method *SchemaMethod
}

InvalidMethodHTTPMethodError is returned when a method has an invalid version.

func (InvalidMethodHTTPMethodError) Error added in v0.2.0

type InvalidMethodNameError added in v0.2.0

type InvalidMethodNameError struct {
	Method *SchemaMethod
}

InvalidMethodNameError is returned when a method has an invalid name.

func (InvalidMethodNameError) Error added in v0.2.0

type InvalidMethodVersionError added in v0.2.0

type InvalidMethodVersionError struct {
	Method *SchemaMethod
}

InvalidMethodVersionError is returned when a method has an invalid version.

func (InvalidMethodVersionError) Error added in v0.2.0

type InventoryService

type InventoryService struct {
	Client    *Client
	Interface *SchemaInterface
}

InventoryService represents interface IInventoryService.

func NewInventoryService

func NewInventoryService(c *Client) (*InventoryService, error)

NewInventoryService creates a new InventoryService interface.

func (*InventoryService) AddPromoItem added in v0.2.0

func (i *InventoryService) AddPromoItem() (*Request, error)

AddPromoItem creates a Request for interface method AddPromoItem.

This is an undocumented method.

func (*InventoryService) CombineItemStacks

func (i *InventoryService) CombineItemStacks() (*Request, error)

CombineItemStacks creates a Request for interface method CombineItemStacks.

Parameters

  • key [string] (required): Access key
  • appid [uint32] (required)
  • fromitemid [uint64] (required)
  • destitemid [uint64] (required)
  • quantity [uint32] (required)

func (*InventoryService) ConsumeItem added in v0.2.0

func (i *InventoryService) ConsumeItem() (*Request, error)

ConsumeItem creates a Request for interface method ConsumeItem.

This is an undocumented method.

func (*InventoryService) ExchangeItem added in v0.2.0

func (i *InventoryService) ExchangeItem() (*Request, error)

ExchangeItem creates a Request for interface method ExchangeItem.

This is an undocumented method.

func (*InventoryService) GetInventory added in v0.2.0

func (i *InventoryService) GetInventory() (*Request, error)

GetInventory creates a Request for interface method GetInventory.

This is an undocumented method.

func (*InventoryService) GetItemDefMeta added in v0.2.0

func (i *InventoryService) GetItemDefMeta() (*Request, error)

GetItemDefMeta creates a Request for interface method GetItemDefMeta.

This is an undocumented method.

func (*InventoryService) GetItemDefs added in v0.2.0

func (i *InventoryService) GetItemDefs() (*Request, error)

GetItemDefs creates a Request for interface method GetItemDefs.

This is an undocumented method.

func (*InventoryService) GetPriceSheet

func (i *InventoryService) GetPriceSheet() (*Request, error)

GetPriceSheet creates a Request for interface method GetPriceSheet.

Parameters

  • key [string] (required): Access key
  • ecurrency [int32] (required)

func (*InventoryService) SplitItemStack

func (i *InventoryService) SplitItemStack() (*Request, error)

SplitItemStack creates a Request for interface method SplitItemStack.

Parameters

  • key [string] (required): Access key
  • appid [uint32] (required)
  • itemid [uint64] (required)
  • quantity [uint32] (required)

type InventoryServiceAddPromoItem added in v0.2.0

type InventoryServiceAddPromoItem struct{}

InventoryServiceAddPromoItem holds the result of the method IInventoryService/AddPromoItem.

type InventoryServiceCombineItemStacks

type InventoryServiceCombineItemStacks struct{}

InventoryServiceCombineItemStacks holds the result of the method IInventoryService/CombineItemStacks.

type InventoryServiceConsumeItem added in v0.2.0

type InventoryServiceConsumeItem struct{}

InventoryServiceConsumeItem holds the result of the method IInventoryService/ConsumeItem.

type InventoryServiceExchangeItem added in v0.2.0

type InventoryServiceExchangeItem struct{}

InventoryServiceExchangeItem holds the result of the method IInventoryService/ExchangeItem.

type InventoryServiceGetInventory added in v0.2.0

type InventoryServiceGetInventory struct{}

InventoryServiceGetInventory holds the result of the method IInventoryService/GetInventory.

type InventoryServiceGetItemDefMeta added in v0.2.0

type InventoryServiceGetItemDefMeta struct{}

InventoryServiceGetItemDefMeta holds the result of the method IInventoryService/GetItemDefMeta.

type InventoryServiceGetItemDefs added in v0.2.0

type InventoryServiceGetItemDefs struct{}

InventoryServiceGetItemDefs holds the result of the method IInventoryService/GetItemDefs.

type InventoryServiceGetPriceSheet

type InventoryServiceGetPriceSheet struct{}

InventoryServiceGetPriceSheet holds the result of the method IInventoryService/GetPriceSheet.

type InventoryServiceSplitItemStack

type InventoryServiceSplitItemStack struct{}

InventoryServiceSplitItemStack holds the result of the method IInventoryService/SplitItemStack.

type Logger

type Logger interface {
	Errorf(format string, v ...interface{})
	Warnf(format string, v ...interface{})
	Debugf(format string, v ...interface{})
}

Logger is the logger interface type accepted by `Client`.

type MobileAuthService added in v0.2.0

type MobileAuthService struct {
	Client    *Client
	Interface *SchemaInterface
}

MobileAuthService represents interface IMobileAuthService.

This is an undocumented interface.

func NewMobileAuthService added in v0.2.0

func NewMobileAuthService(c *Client) (*MobileAuthService, error)

NewMobileAuthService creates a new MobileAuthService interface.

func (*MobileAuthService) GetWGToken added in v0.2.0

func (i *MobileAuthService) GetWGToken() (*Request, error)

GetWGToken creates a Request for interface method GetWGToken.

This is an undocumented method.

type MobileAuthServiceGetWGToken added in v0.2.0

type MobileAuthServiceGetWGToken struct{}

MobileAuthServiceGetWGToken holds the result of the method IMobileAuthService/GetWGToken.

type MobileNotificationService added in v0.2.0

type MobileNotificationService struct {
	Client    *Client
	Interface *SchemaInterface
}

MobileNotificationService represents interface IMobileNotificationService.

This is an undocumented interface.

func NewMobileNotificationService added in v0.2.0

func NewMobileNotificationService(c *Client) (*MobileNotificationService, error)

NewMobileNotificationService creates a new MobileNotificationService interface.

func (*MobileNotificationService) GetUserNotificationCounts added in v0.2.0

func (i *MobileNotificationService) GetUserNotificationCounts() (*Request, error)

GetUserNotificationCounts creates a Request for interface method GetUserNotificationCounts.

This is an undocumented method.

func (*MobileNotificationService) SwitchSessionToPush added in v0.2.0

func (i *MobileNotificationService) SwitchSessionToPush() (*Request, error)

SwitchSessionToPush creates a Request for interface method SwitchSessionToPush.

This is an undocumented method.

type MobileNotificationServiceGetUserNotificationCounts added in v0.2.0

type MobileNotificationServiceGetUserNotificationCounts struct{}

MobileNotificationServiceGetUserNotificationCounts holds the result of the method IMobileNotificationService/GetUserNotificationCounts.

type MobileNotificationServiceSwitchSessionToPush added in v0.2.0

type MobileNotificationServiceSwitchSessionToPush struct{}

MobileNotificationServiceSwitchSessionToPush holds the result of the method IMobileNotificationService/SwitchSessionToPush.

type PlayerService

type PlayerService struct {
	Client    *Client
	Interface *SchemaInterface
}

PlayerService represents interface IPlayerService.

func NewPlayerService

func NewPlayerService(c *Client) (*PlayerService, error)

NewPlayerService creates a new PlayerService interface.

func (*PlayerService) AddFriend added in v0.2.0

func (i *PlayerService) AddFriend() (*Request, error)

AddFriend creates a Request for interface method AddFriend.

This is an undocumented method.

func (*PlayerService) GetBadges

func (i *PlayerService) GetBadges() (*Request, error)

GetBadges creates a Request for interface method GetBadges.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The player we're asking about

func (*PlayerService) GetCommunityBadgeProgress

func (i *PlayerService) GetCommunityBadgeProgress() (*Request, error)

GetCommunityBadgeProgress creates a Request for interface method GetCommunityBadgeProgress.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The player we're asking about
  • badgeid [int32] (required): The badge we're asking about

func (*PlayerService) GetNicknameList added in v0.2.0

func (i *PlayerService) GetNicknameList() (*Request, error)

GetNicknameList creates a Request for interface method GetNicknameList.

This is an undocumented method.

func (*PlayerService) GetOwnedGames

func (i *PlayerService) GetOwnedGames() (*Request, error)

GetOwnedGames creates a Request for interface method GetOwnedGames.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The player we're asking about
  • include_appinfo [bool] (required): true if we want additional details (name, icon) about each game
  • include_played_free_games [bool] (required): Free games are excluded by default. If this is set, free games the user has played will be returned.
  • appids_filter [uint32] (required): if set, restricts result set to the passed in apps

func (*PlayerService) GetRecentlyPlayedGames

func (i *PlayerService) GetRecentlyPlayedGames() (*Request, error)

GetRecentlyPlayedGames creates a Request for interface method GetRecentlyPlayedGames.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The player we're asking about
  • count [uint32] (required): The number of games to return (0/unset: all)

func (*PlayerService) GetSteamLevel

func (i *PlayerService) GetSteamLevel() (*Request, error)

GetSteamLevel creates a Request for interface method GetSteamLevel.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The player we're asking about

func (*PlayerService) GetSteamLevelDistribution added in v0.2.0

func (i *PlayerService) GetSteamLevelDistribution() (*Request, error)

GetSteamLevelDistribution creates a Request for interface method GetSteamLevelDistribution.

This is an undocumented method.

func (*PlayerService) IgnoreFriend added in v0.2.0

func (i *PlayerService) IgnoreFriend() (*Request, error)

IgnoreFriend creates a Request for interface method IgnoreFriend.

This is an undocumented method.

func (*PlayerService) IsPlayingSharedGame

func (i *PlayerService) IsPlayingSharedGame() (*Request, error)

IsPlayingSharedGame creates a Request for interface method IsPlayingSharedGame.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): The player we're asking about
  • appid_playing [uint32] (required): The game player is currently playing

func (*PlayerService) RecordOfflinePlaytime

func (i *PlayerService) RecordOfflinePlaytime() (*Request, error)

RecordOfflinePlaytime creates a Request for interface method RecordOfflinePlaytime.

Parameters

  • steamid [uint64] (required)
  • ticket [string] (required)
  • play_sessions [{message}] (required)

func (*PlayerService) RemoveFriend added in v0.2.0

func (i *PlayerService) RemoveFriend() (*Request, error)

RemoveFriend creates a Request for interface method RemoveFriend.

This is an undocumented method.

type PlayerServiceAddFriend added in v0.2.0

type PlayerServiceAddFriend struct{}

PlayerServiceAddFriend holds the result of the method IPlayerService/AddFriend.

type PlayerServiceGetBadges

type PlayerServiceGetBadges struct{}

PlayerServiceGetBadges holds the result of the method IPlayerService/GetBadges.

type PlayerServiceGetCommunityBadgeProgress

type PlayerServiceGetCommunityBadgeProgress struct{}

PlayerServiceGetCommunityBadgeProgress holds the result of the method IPlayerService/GetCommunityBadgeProgress.

type PlayerServiceGetNicknameList added in v0.2.0

type PlayerServiceGetNicknameList struct{}

PlayerServiceGetNicknameList holds the result of the method IPlayerService/GetNicknameList.

type PlayerServiceGetOwnedGames

type PlayerServiceGetOwnedGames struct{}

PlayerServiceGetOwnedGames holds the result of the method IPlayerService/GetOwnedGames.

type PlayerServiceGetRecentlyPlayedGames

type PlayerServiceGetRecentlyPlayedGames struct{}

PlayerServiceGetRecentlyPlayedGames holds the result of the method IPlayerService/GetRecentlyPlayedGames.

type PlayerServiceGetSteamLevel

type PlayerServiceGetSteamLevel struct{}

PlayerServiceGetSteamLevel holds the result of the method IPlayerService/GetSteamLevel.

type PlayerServiceGetSteamLevelDistribution added in v0.2.0

type PlayerServiceGetSteamLevelDistribution struct{}

PlayerServiceGetSteamLevelDistribution holds the result of the method IPlayerService/GetSteamLevelDistribution.

type PlayerServiceIgnoreFriend added in v0.2.0

type PlayerServiceIgnoreFriend struct{}

PlayerServiceIgnoreFriend holds the result of the method IPlayerService/IgnoreFriend.

type PlayerServiceIsPlayingSharedGame

type PlayerServiceIsPlayingSharedGame struct{}

PlayerServiceIsPlayingSharedGame holds the result of the method IPlayerService/IsPlayingSharedGame.

type PlayerServiceRecordOfflinePlaytime

type PlayerServiceRecordOfflinePlaytime struct{}

PlayerServiceRecordOfflinePlaytime holds the result of the method IPlayerService/RecordOfflinePlaytime.

type PlayerServiceRemoveFriend added in v0.2.0

type PlayerServiceRemoveFriend struct{}

PlayerServiceRemoveFriend holds the result of the method IPlayerService/RemoveFriend.

type Portal2Leaderboards

type Portal2Leaderboards struct {
	Client    *Client
	Interface *SchemaInterface
}

Portal2Leaderboards represents interface IPortal2Leaderboards.

Supported AppIDs: 620.

func NewPortal2Leaderboards

func NewPortal2Leaderboards(c *Client, appID uint32) (*Portal2Leaderboards, error)

NewPortal2Leaderboards creates a new Portal2Leaderboards interface.

Supported AppIDs: 620.

func (*Portal2Leaderboards) GetBucketizedData

func (i *Portal2Leaderboards) GetBucketizedData() (*Request, error)

GetBucketizedData creates a Request for interface method GetBucketizedData.

Parameters

  • leaderboardName [string] (required): The leaderboard name to fetch data for.

type Portal2LeaderboardsGetBucketizedData

type Portal2LeaderboardsGetBucketizedData struct{}

Portal2LeaderboardsGetBucketizedData holds the result of the method IPortal2Leaderboards/GetBucketizedData.

type PublishedFileService

type PublishedFileService struct {
	Client    *Client
	Interface *SchemaInterface
}

PublishedFileService represents interface IPublishedFileService.

func NewPublishedFileService

func NewPublishedFileService(c *Client) (*PublishedFileService, error)

NewPublishedFileService creates a new PublishedFileService interface.

func (*PublishedFileService) CanSubscribe added in v0.2.0

func (i *PublishedFileService) CanSubscribe() (*Request, error)

CanSubscribe creates a Request for interface method CanSubscribe.

This is an undocumented method.

func (*PublishedFileService) GetDetails

func (i *PublishedFileService) GetDetails() (*Request, error)

GetDetails creates a Request for interface method GetDetails.

Parameters

  • key [string] (required): Access key
  • publishedfileids [uint64] (required): Set of published file Ids to retrieve details for.
  • includetags [bool] (required): If true, return tag information in the returned details.
  • includeadditionalpreviews [bool] (required): If true, return preview information in the returned details.
  • includechildren [bool] (required): If true, return children in the returned details.
  • includekvtags [bool] (required): If true, return key value tags in the returned details.
  • includevotes [bool] (required): If true, return vote data in the returned details.
  • short_description [bool] (required): If true, return a short description instead of the full description.
  • includeforsaledata [bool] (required): If true, return pricing data, if applicable.
  • includemetadata [bool] (required): If true, populate the metadata field.
  • language [int32]: Specifies the localized text to return. Defaults to English.
  • return_playtime_stats [uint32] (required): Return playtime stats for the specified number of days before today.
  • appid [uint32] (required)
  • strip_description_bbcode [bool] (required): Strips BBCode from descriptions.
  • desired_revision [{enum}]: Return the data for the specified revision.

func (*PublishedFileService) GetUserFiles

func (i *PublishedFileService) GetUserFiles() (*Request, error)

GetUserFiles creates a Request for interface method GetUserFiles.

Parameters

  • key [string] (required): Access key
  • steamid [uint64] (required): Steam ID of the user whose files are being requested.
  • appid [uint32] (required): App Id of the app that the files were published to.
  • page [uint32]: (Optional) Starting page for results.
  • numperpage [uint32]: (Optional) The number of results, per page to return.
  • type [string]: (Optional) Type of files to be returned.
  • sortmethod [string]: (Optional) Sorting method to use on returned values.
  • privacy [uint32] (required): (optional) Filter by privacy settings.
  • requiredtags [string] (required): (Optional) Tags that must be present on a published file to satisfy the query.
  • excludedtags [string] (required): (Optional) Tags that must NOT be present on a published file to satisfy the query.
  • required_kv_tags [{message}] (required): Required key-value tags to match on.
  • filetype [uint32] (required): (Optional) File type to match files to.
  • creator_appid [uint32] (required): App Id of the app that published the files, only matched if specified.
  • match_cloud_filename [string] (required): Match this cloud filename if specified.
  • cache_max_age_seconds [uint32]: Allow stale data to be returned for the specified number of seconds.
  • language [int32]: Specifies the localized text to return. Defaults to English.
  • taggroups [{message}] (required): (Optional) At least one of the tags must be present on a published file to satisfy the query.
  • totalonly [bool] (required): (Optional) If true, only return the total number of files that satisfy this query.
  • ids_only [bool] (required): (Optional) If true, only return the published file ids of files that satisfy this query.
  • return_vote_data [bool]: Return vote data
  • return_tags [bool] (required): Return tags in the file details
  • return_kv_tags [bool]: Return key-value tags in the file details
  • return_previews [bool] (required): Return preview image and video details in the file details
  • return_children [bool] (required): Return child item ids in the file details
  • return_short_description [bool]: Populate the short_description field instead of file_description
  • return_for_sale_data [bool] (required): Return pricing information, if applicable
  • return_metadata [bool]: Populate the metadata field
  • return_playtime_stats [uint32] (required): Return playtime stats for the specified number of days before today.
  • strip_description_bbcode [bool] (required): Strips BBCode from descriptions.
  • desired_revision [{enum}]: Return the data for the specified revision.

func (*PublishedFileService) Publish added in v0.2.0

func (i *PublishedFileService) Publish() (*Request, error)

Publish creates a Request for interface method Publish.

This is an undocumented method.

func (*PublishedFileService) QueryFiles

func (i *PublishedFileService) QueryFiles() (*Request, error)

QueryFiles creates a Request for interface method QueryFiles.

Parameters

  • key [string] (required): Access key
  • query_type [uint32] (required): enumeration EPublishedFileQueryType in clientenums.h
  • page [uint32] (required): Current page
  • cursor [string] (required): Cursor to paginate through the results (set to '*' for the first request). Prefer this over using the page parameter, as it will allow you to do deep pagination. When used, the page parameter will be ignored.
  • numperpage [uint32]: (Optional) The number of results, per page to return.
  • creator_appid [uint32] (required): App that created the files
  • appid [uint32] (required): App that consumes the files
  • requiredtags [string] (required): Tags to match on. See match_all_tags parameter below
  • excludedtags [string] (required): (Optional) Tags that must NOT be present on a published file to satisfy the query.
  • match_all_tags [bool]: If true, then items must have all the tags specified, otherwise they must have at least one of the tags.
  • required_flags [string] (required): Required flags that must be set on any returned items
  • omitted_flags [string] (required): Flags that must not be set on any returned items
  • search_text [string] (required): Text to match in the item's title or description
  • filetype [uint32] (required): EPublishedFileInfoMatchingFileType
  • child_publishedfileid [uint64] (required): Find all items that reference the given item.
  • days [uint32] (required): If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].
  • include_recent_votes_only [bool] (required): If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given
  • cache_max_age_seconds [uint32]: Allow stale data to be returned for the specified number of seconds.
  • language [int32]: Language to search in and also what gets returned. Defaults to English.
  • required_kv_tags [{message}] (required): Required key-value tags to match on.
  • taggroups [{message}] (required): (Optional) At least one of the tags must be present on a published file to satisfy the query.
  • totalonly [bool] (required): (Optional) If true, only return the total number of files that satisfy this query.
  • ids_only [bool] (required): (Optional) If true, only return the published file ids of files that satisfy this query.
  • return_vote_data [bool] (required): Return vote data
  • return_tags [bool] (required): Return tags in the file details
  • return_kv_tags [bool] (required): Return key-value tags in the file details
  • return_previews [bool] (required): Return preview image and video details in the file details
  • return_children [bool] (required): Return child item ids in the file details
  • return_short_description [bool] (required): Populate the short_description field instead of file_description
  • return_for_sale_data [bool] (required): Return pricing information, if applicable
  • return_metadata [bool]: Populate the metadata
  • return_playtime_stats [uint32] (required): Return playtime stats for the specified number of days before today.
  • return_details [bool] (required): By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details.
  • strip_description_bbcode [bool] (required): Strips BBCode from descriptions.
  • desired_revision [{enum}]: Return the data for the specified revision.

func (*PublishedFileService) RefreshVotingQueue added in v0.2.0

func (i *PublishedFileService) RefreshVotingQueue() (*Request, error)

RefreshVotingQueue creates a Request for interface method RefreshVotingQueue.

This is an undocumented method.

func (*PublishedFileService) SetDeveloperMetadata added in v0.2.0

func (i *PublishedFileService) SetDeveloperMetadata() (*Request, error)

SetDeveloperMetadata creates a Request for interface method SetDeveloperMetadata.

This is an undocumented method.

func (*PublishedFileService) Subscribe added in v0.2.0

func (i *PublishedFileService) Subscribe() (*Request, error)

Subscribe creates a Request for interface method Subscribe.

This is an undocumented method.

func (*PublishedFileService) Unsubscribe added in v0.2.0

func (i *PublishedFileService) Unsubscribe() (*Request, error)

Unsubscribe creates a Request for interface method Unsubscribe.

This is an undocumented method.

func (*PublishedFileService) Update added in v0.2.0

func (i *PublishedFileService) Update() (*Request, error)

Update creates a Request for interface method Update.

This is an undocumented method.

func (*PublishedFileService) UpdateTags added in v0.2.0

func (i *PublishedFileService) UpdateTags() (*Request, error)

UpdateTags creates a Request for interface method UpdateTags.

This is an undocumented method.

type PublishedFileServiceCanSubscribe added in v0.2.0

type PublishedFileServiceCanSubscribe struct{}

PublishedFileServiceCanSubscribe holds the result of the method IPublishedFileService/CanSubscribe.

type PublishedFileServiceGetDetails

type PublishedFileServiceGetDetails struct{}

PublishedFileServiceGetDetails holds the result of the method IPublishedFileService/GetDetails.

type PublishedFileServiceGetUserFiles

type PublishedFileServiceGetUserFiles struct{}

PublishedFileServiceGetUserFiles holds the result of the method IPublishedFileService/GetUserFiles.

type PublishedFileServicePublish added in v0.2.0

type PublishedFileServicePublish struct{}

PublishedFileServicePublish holds the result of the method IPublishedFileService/Publish.

type PublishedFileServiceQueryFiles

type PublishedFileServiceQueryFiles struct{}

PublishedFileServiceQueryFiles holds the result of the method IPublishedFileService/QueryFiles.

type PublishedFileServiceRefreshVotingQueue added in v0.2.0

type PublishedFileServiceRefreshVotingQueue struct{}

PublishedFileServiceRefreshVotingQueue holds the result of the method IPublishedFileService/RefreshVotingQueue.

type PublishedFileServiceSetDeveloperMetadata added in v0.2.0

type PublishedFileServiceSetDeveloperMetadata struct{}

PublishedFileServiceSetDeveloperMetadata holds the result of the method IPublishedFileService/SetDeveloperMetadata.

type PublishedFileServiceSubscribe added in v0.2.0

type PublishedFileServiceSubscribe struct{}

PublishedFileServiceSubscribe holds the result of the method IPublishedFileService/Subscribe.

type PublishedFileServiceUnsubscribe added in v0.2.0

type PublishedFileServiceUnsubscribe struct{}

PublishedFileServiceUnsubscribe holds the result of the method IPublishedFileService/Unsubscribe.

type PublishedFileServiceUpdate added in v0.2.0

type PublishedFileServiceUpdate struct{}

PublishedFileServiceUpdate holds the result of the method IPublishedFileService/Update.

type PublishedFileServiceUpdateTags added in v0.2.0

type PublishedFileServiceUpdateTags struct{}

PublishedFileServiceUpdateTags holds the result of the method IPublishedFileService/UpdateTags.

type QuestService added in v0.2.0

type QuestService struct {
	Client    *Client
	Interface *SchemaInterface
}

QuestService represents interface IQuestService.

This is an undocumented interface.

func NewQuestService added in v0.2.0

func NewQuestService(c *Client) (*QuestService, error)

NewQuestService creates a new QuestService interface.

func (*QuestService) GetCommunityItemDefinitions added in v0.2.0

func (i *QuestService) GetCommunityItemDefinitions() (*Request, error)

GetCommunityItemDefinitions creates a Request for interface method GetCommunityItemDefinitions.

This is an undocumented method.

type QuestServiceGetCommunityItemDefinitions added in v0.2.0

type QuestServiceGetCommunityItemDefinitions struct{}

QuestServiceGetCommunityItemDefinitions holds the result of the method IQuestService/GetCommunityItemDefinitions.

type RemoteClientService added in v0.2.0

type RemoteClientService struct {
	Client    *Client
	Interface *SchemaInterface
}

RemoteClientService represents interface IRemoteClientService.

This is an undocumented interface.

func NewRemoteClientService added in v0.2.0

func NewRemoteClientService(c *Client) (*RemoteClientService, error)

NewRemoteClientService creates a new RemoteClientService interface.

func (*RemoteClientService) NotifyRegisterStatusUpdate added in v0.2.0

func (i *RemoteClientService) NotifyRegisterStatusUpdate() (*Request, error)

NotifyRegisterStatusUpdate creates a Request for interface method NotifyRegisterStatusUpdate.

This is an undocumented method.

func (*RemoteClientService) NotifyRemotePacket added in v0.2.0

func (i *RemoteClientService) NotifyRemotePacket() (*Request, error)

NotifyRemotePacket creates a Request for interface method NotifyRemotePacket.

This is an undocumented method.

func (*RemoteClientService) NotifyUnregisterStatusUpdate added in v0.2.0

func (i *RemoteClientService) NotifyUnregisterStatusUpdate() (*Request, error)

NotifyUnregisterStatusUpdate creates a Request for interface method NotifyUnregisterStatusUpdate.

This is an undocumented method.

type RemoteClientServiceNotifyRegisterStatusUpdate added in v0.2.0

type RemoteClientServiceNotifyRegisterStatusUpdate struct{}

RemoteClientServiceNotifyRegisterStatusUpdate holds the result of the method IRemoteClientService/NotifyRegisterStatusUpdate.

type RemoteClientServiceNotifyRemotePacket added in v0.2.0

type RemoteClientServiceNotifyRemotePacket struct{}

RemoteClientServiceNotifyRemotePacket holds the result of the method IRemoteClientService/NotifyRemotePacket.

type RemoteClientServiceNotifyUnregisterStatusUpdate added in v0.2.0

type RemoteClientServiceNotifyUnregisterStatusUpdate struct{}

RemoteClientServiceNotifyUnregisterStatusUpdate holds the result of the method IRemoteClientService/NotifyUnregisterStatusUpdate.

type Request

type Request struct {
	Client    Requester
	Interface *SchemaInterface
	Method    *SchemaMethod
	Options   RequestOptions
	Result    interface{}
}

Request represents a "bound" request with client, interface and method.

func (*Request) Execute

func (req *Request) Execute() (*resty.Response, error)

Execute executes the request.

func (*Request) SetOptions

func (req *Request) SetOptions(options RequestOptions) *Request

SetOptions sets request options.

The options provided here override the "global" client options.

func (*Request) SetResult

func (req *Request) SetResult(result interface{}) *Request

SetResult sets the result object where the response will be deserialized into.

It expects a JSON "unmarshable" object.

type RequestOptions

type RequestOptions struct {
	Context  context.Context
	Headers  map[string]string
	Params   url.Values
	FormData url.Values
	Body     interface{}
	Key      string
	Lang     string
}

RequestOptions wrap options to pass to a request.

type Requester added in v0.2.0

type Requester interface {
	Request(ClientRequest) (*resty.Response, error)
}

Requester is the minimal interface for a `Request` to `Execute`.

type RequiredParameterError

type RequiredParameterError struct {
	Param *SchemaMethodParam
}

RequiredParameterError is returned when a required parameter is missing.

func (RequiredParameterError) Error

type Schema added in v0.2.0

type Schema struct {
	Host       string           `json:"host"`
	Interfaces SchemaInterfaces `json:"interfaces"`
}

Schema is the root of an API schema specification.

func (*Schema) Validate added in v0.2.0

func (s *Schema) Validate() error

Validate checks if all contained interfaces are valid.

Returns errors described in `SchemaInterfaces.Validate`

type SchemaInterface

type SchemaInterface struct {
	Name         string        `json:"name"`
	Methods      SchemaMethods `json:"methods"`
	Undocumented bool          `json:"undocumented"`
	// contains filtered or unexported fields
}

SchemaInterface holds the specification of an API interface.

The struct should be read-only.

func (*SchemaInterface) Key added in v0.2.0

Key returns the key identifying the interface.

Returns errors described in `Validate`.

func (*SchemaInterface) Validate added in v0.2.0

func (i *SchemaInterface) Validate() error

Validate checks if the interface and all its methods are valid.

Returns an error of type `*InvalidInterfaceNameError` if the interface name is invalid.

Returns errors described in `SchemaMethods.Validate`.

type SchemaInterfaceKey added in v0.2.0

type SchemaInterfaceKey struct {
	Name  string
	AppID uint32
}

SchemaInterfaceKey is the key that uniquely identifies a `SchemaInterface`.

type SchemaInterfaces

type SchemaInterfaces []*SchemaInterface

SchemaInterfaces is a collection of `SchemaInterface`.

func MustNewSchemaInterfaces

func MustNewSchemaInterfaces(interfaces ...*SchemaInterface) SchemaInterfaces

MustNewSchemaInterfaces is like `NewSchemaInterfaces` but panics if it returned an error.

func NewSchemaInterfaces

func NewSchemaInterfaces(interfaces ...*SchemaInterface) (SchemaInterfaces, error)

NewSchemaInterfaces creates a new collection.

Returns errors described in `SchemaInterface.Validate`.

func (SchemaInterfaces) Get

Get returns the interface with given key.

Returns an error of type `*InterfaceNotFoundError` if none was found.

Returns errors described in `SchemaInterface.Key`.

func (SchemaInterfaces) GroupByBaseName added in v0.2.0

func (c SchemaInterfaces) GroupByBaseName() (map[string]SchemaInterfacesGroup, error)

GroupByName groups the interfaces by base name.

Returns errors described in `SchemaInterface.Key`.

func (SchemaInterfaces) Validate added in v0.2.0

func (c SchemaInterfaces) Validate() error

Validate checks if all contained interfaces are valid.

Returns errors described in `SchemaInterface.Validate`.

type SchemaInterfacesGroup added in v0.2.0

type SchemaInterfacesGroup map[SchemaInterfaceKey]*SchemaInterface

SchemaInterfacesGroup is a group of `SchemaInterface`s with the same base name.

func (SchemaInterfacesGroup) AppIDs added in v0.2.0

func (g SchemaInterfacesGroup) AppIDs() []uint32

AppIDs collects the AppID of all interfaces in the group.

func (SchemaInterfacesGroup) GroupMethods added in v0.2.0

func (g SchemaInterfacesGroup) GroupMethods() (map[string]SchemaMethodsGroup, error)

GroupMethods groups interfaces methods by method name.

Returns errors described in `SchemaMethods.GroupByName`.

func (SchemaInterfacesGroup) Name added in v0.2.0

func (g SchemaInterfacesGroup) Name() (name string)

Name returns the common name of all interfaces in the group.

type SchemaMethod

type SchemaMethod struct {
	Name         string             `json:"name"`
	Version      int                `json:"version"`
	HTTPMethod   string             `json:"httpmethod"`
	Params       SchemaMethodParams `json:"parameters"`
	Undocumented bool               `json:"undocumented"`
	// contains filtered or unexported fields
}

SchemaMethod holds the specification of an API interface method.

The struct should be read-only.

func (*SchemaMethod) Key added in v0.2.0

func (m *SchemaMethod) Key() (SchemaMethodKey, error)

Key returns the key identifying the method.

Returns errors described in `Validate`.

func (*SchemaMethod) Validate added in v0.2.0

func (m *SchemaMethod) Validate() error

Validate checks if the method is valid.

Returns an error of type `*InvalidMethodNameError` if the method has an invalid name.

Returns an error of type `*InvalidMethodVersionError` if the method has an invalid version.

Returns an error of type `*InvalidMethodHTTPMethodError` if the method has an invalid http method.

func (*SchemaMethod) ValidateParams

func (m *SchemaMethod) ValidateParams(params url.Values) error

ValidateParams validates the given parameters against the params collection.

Returns errors described in `SchemaMethodParams.ValidateParams`.

type SchemaMethodKey added in v0.2.0

type SchemaMethodKey struct {
	Name    string
	Version int
}

SchemaMethodKey is the key that uniquely identifies a `SchemaMethod`.

type SchemaMethodParam

type SchemaMethodParam struct {
	Name        string `json:"name"`
	Type        string `json:"type"`
	Optional    bool   `json:"optional"`
	Description string `json:"description"`
}

SchemaMethodParam holds the specification of an API interface method parameter.

The struct should be read-only.

func (*SchemaMethodParam) ValidateValue added in v0.2.0

func (p *SchemaMethodParam) ValidateValue(value string) error

ValidateValue validates the given value against the parameter specification.

Returns an error of type `*RequiredParameterError` if the parameter is required and the value is empty.

type SchemaMethodParams

type SchemaMethodParams []*SchemaMethodParam

SchemaMethodParams is a collection of `SchemaMethodParam`.

func NewSchemaMethodParams

func NewSchemaMethodParams(params ...*SchemaMethodParam) SchemaMethodParams

NewSchemaMethodParams creates a new collection.

func (SchemaMethodParams) ValidateParams added in v0.2.0

func (c SchemaMethodParams) ValidateParams(params url.Values) error

ValidateParams validates the given parameters against each parameter in the collection.

Returns errors described in `SchemaMethodParam.ValidateParam`.

type SchemaMethods

type SchemaMethods []*SchemaMethod

SchemaMethods is a collection of `SchemaMethod`.

func MustNewSchemaMethods added in v0.2.0

func MustNewSchemaMethods(methods ...*SchemaMethod) SchemaMethods

MustNewSchemaMethods is like `NewSchemaMethods` but panics if it returned an error.

func NewSchemaMethods

func NewSchemaMethods(methods ...*SchemaMethod) (SchemaMethods, error)

NewSchemaMethods creates a new collection.

Returns errors described in `SchemaMethod.Validate`.

func (SchemaMethods) Get

Get returns the method with the given key.

Returns an error of type `*InterfaceMethodNotFoundError` if none was found.

func (SchemaMethods) GroupByName

func (c SchemaMethods) GroupByName() (map[string]SchemaMethodsGroup, error)

GroupByName groups the methods by name.

Returns errors described in `SchemaMethod.Key`.

func (SchemaMethods) Validate added in v0.2.0

func (c SchemaMethods) Validate() error

Validate checks if all contained methods are valid.

Returns errors described in `SchemaMethod.Validate`.

type SchemaMethodsGroup added in v0.2.0

type SchemaMethodsGroup map[SchemaMethodKey]*SchemaMethod

SchemaMethodsGroup is a group of `SchemaMethod`s with the same name.

func (SchemaMethodsGroup) Versions added in v0.2.0

func (g SchemaMethodsGroup) Versions() []int

Versions collects the unique versions of all methods in the group.

type SteamApps

type SteamApps struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamApps represents interface ISteamApps.

func NewSteamApps

func NewSteamApps(c *Client) (*SteamApps, error)

NewSteamApps creates a new SteamApps interface.

func (*SteamApps) GetAppList

func (i *SteamApps) GetAppList(version int) (*Request, error)

GetAppList creates a Request for interface method GetAppList.

Supported versions: 1, 2.

func (*SteamApps) GetSDRConfig

func (i *SteamApps) GetSDRConfig() (*Request, error)

GetSDRConfig creates a Request for interface method GetSDRConfig.

Parameters

  • appid [uint32] (required): AppID of game
  • partner [string]: Partner type

func (*SteamApps) GetServersAtAddress

func (i *SteamApps) GetServersAtAddress() (*Request, error)

GetServersAtAddress creates a Request for interface method GetServersAtAddress.

Parameters

  • addr [string] (required): IP or IP:queryport to list

func (*SteamApps) UpToDateCheck

func (i *SteamApps) UpToDateCheck() (*Request, error)

UpToDateCheck creates a Request for interface method UpToDateCheck.

Parameters

  • appid [uint32] (required): AppID of game
  • version [uint32] (required): The installed version of the game

type SteamAppsGetAppList

type SteamAppsGetAppList struct{}

SteamAppsGetAppList holds the result of the method ISteamApps/GetAppList.

type SteamAppsGetSDRConfig

type SteamAppsGetSDRConfig struct{}

SteamAppsGetSDRConfig holds the result of the method ISteamApps/GetSDRConfig.

type SteamAppsGetServersAtAddress

type SteamAppsGetServersAtAddress struct{}

SteamAppsGetServersAtAddress holds the result of the method ISteamApps/GetServersAtAddress.

type SteamAppsUpToDateCheck

type SteamAppsUpToDateCheck struct{}

SteamAppsUpToDateCheck holds the result of the method ISteamApps/UpToDateCheck.

type SteamBitPay added in v0.2.0

type SteamBitPay struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamBitPay represents interface ISteamBitPay.

This is an undocumented interface.

func NewSteamBitPay added in v0.2.0

func NewSteamBitPay(c *Client) (*SteamBitPay, error)

NewSteamBitPay creates a new SteamBitPay interface.

func (*SteamBitPay) BitPayPaymentNotification added in v0.2.0

func (i *SteamBitPay) BitPayPaymentNotification() (*Request, error)

BitPayPaymentNotification creates a Request for interface method BitPayPaymentNotification.

This is an undocumented method.

type SteamBitPayBitPayPaymentNotification added in v0.2.0

type SteamBitPayBitPayPaymentNotification struct{}

SteamBitPayBitPayPaymentNotification holds the result of the method ISteamBitPay/BitPayPaymentNotification.

type SteamBoaCompra added in v0.2.0

type SteamBoaCompra struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamBoaCompra represents interface ISteamBoaCompra.

This is an undocumented interface.

func NewSteamBoaCompra added in v0.2.0

func NewSteamBoaCompra(c *Client) (*SteamBoaCompra, error)

NewSteamBoaCompra creates a new SteamBoaCompra interface.

func (*SteamBoaCompra) BoaCompraCheckTransactionStatus added in v0.2.0

func (i *SteamBoaCompra) BoaCompraCheckTransactionStatus() (*Request, error)

BoaCompraCheckTransactionStatus creates a Request for interface method BoaCompraCheckTransactionStatus.

This is an undocumented method.

type SteamBoaCompraBoaCompraCheckTransactionStatus added in v0.2.0

type SteamBoaCompraBoaCompraCheckTransactionStatus struct{}

SteamBoaCompraBoaCompraCheckTransactionStatus holds the result of the method ISteamBoaCompra/BoaCompraCheckTransactionStatus.

type SteamBroadcast

type SteamBroadcast struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamBroadcast represents interface ISteamBroadcast.

func NewSteamBroadcast

func NewSteamBroadcast(c *Client) (*SteamBroadcast, error)

NewSteamBroadcast creates a new SteamBroadcast interface.

func (*SteamBroadcast) ViewerHeartbeat

func (i *SteamBroadcast) ViewerHeartbeat() (*Request, error)

ViewerHeartbeat creates a Request for interface method ViewerHeartbeat.

Parameters

  • steamid [uint64] (required): Steam ID of the broadcaster
  • sessionid [uint64] (required): Broadcast Session ID
  • token [uint64] (required): Viewer token
  • stream [int32]: video stream representation watching

type SteamBroadcastViewerHeartbeat

type SteamBroadcastViewerHeartbeat struct{}

SteamBroadcastViewerHeartbeat holds the result of the method ISteamBroadcast/ViewerHeartbeat.

type SteamCDN

type SteamCDN struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamCDN represents interface ISteamCDN.

func NewSteamCDN

func NewSteamCDN(c *Client) (*SteamCDN, error)

NewSteamCDN creates a new SteamCDN interface.

func (*SteamCDN) SetClientFilters

func (i *SteamCDN) SetClientFilters() (*Request, error)

SetClientFilters creates a Request for interface method SetClientFilters.

Parameters

  • key [string] (required): access key
  • cdnname [string] (required): Steam name of CDN property
  • allowedipblocks [string]: comma-separated list of allowed IP address blocks in CIDR format - blank for not used
  • allowedasns [string]: comma-separated list of allowed client network AS numbers - blank for not used
  • allowedipcountries [string]: comma-separated list of allowed client IP country codes in ISO 3166-1 format - blank for not used

func (*SteamCDN) SetPerformanceStats

func (i *SteamCDN) SetPerformanceStats() (*Request, error)

SetPerformanceStats creates a Request for interface method SetPerformanceStats.

Parameters

  • key [string] (required): access key
  • cdnname [string] (required): Steam name of CDN property
  • mbps_sent [uint32]: Outgoing network traffic in Mbps
  • mbps_recv [uint32]: Incoming network traffic in Mbps
  • cpu_percent [uint32]: Percent CPU load
  • cache_hit_percent [uint32]: Percent cache hits

type SteamCDNSetClientFilters

type SteamCDNSetClientFilters struct{}

SteamCDNSetClientFilters holds the result of the method ISteamCDN/SetClientFilters.

type SteamCDNSetPerformanceStats

type SteamCDNSetPerformanceStats struct{}

SteamCDNSetPerformanceStats holds the result of the method ISteamCDN/SetPerformanceStats.

type SteamDirectory

type SteamDirectory struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamDirectory represents interface ISteamDirectory.

func NewSteamDirectory

func NewSteamDirectory(c *Client) (*SteamDirectory, error)

NewSteamDirectory creates a new SteamDirectory interface.

func (*SteamDirectory) GetCMList

func (i *SteamDirectory) GetCMList() (*Request, error)

GetCMList creates a Request for interface method GetCMList.

Parameters

  • cellid [uint32] (required): Client's Steam cell ID
  • maxcount [uint32]: Max number of servers to return

func (*SteamDirectory) GetCSList

func (i *SteamDirectory) GetCSList() (*Request, error)

GetCSList creates a Request for interface method GetCSList.

Parameters

  • cellid [uint32] (required): Client's Steam cell ID
  • maxcount [uint32]: Max number of servers to return

func (*SteamDirectory) GetSteamPipeDomains

func (i *SteamDirectory) GetSteamPipeDomains() (*Request, error)

GetSteamPipeDomains creates a Request for interface method GetSteamPipeDomains.

type SteamDirectoryGetCMList

type SteamDirectoryGetCMList struct{}

SteamDirectoryGetCMList holds the result of the method ISteamDirectory/GetCMList.

type SteamDirectoryGetCSList

type SteamDirectoryGetCSList struct{}

SteamDirectoryGetCSList holds the result of the method ISteamDirectory/GetCSList.

type SteamDirectoryGetSteamPipeDomains

type SteamDirectoryGetSteamPipeDomains struct{}

SteamDirectoryGetSteamPipeDomains holds the result of the method ISteamDirectory/GetSteamPipeDomains.

type SteamEconomy

type SteamEconomy struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamEconomy represents interface ISteamEconomy.

func NewSteamEconomy

func NewSteamEconomy(c *Client) (*SteamEconomy, error)

NewSteamEconomy creates a new SteamEconomy interface.

func (*SteamEconomy) GetAssetClassInfo

func (i *SteamEconomy) GetAssetClassInfo() (*Request, error)

GetAssetClassInfo creates a Request for interface method GetAssetClassInfo.

Parameters

  • appid [uint32] (required): Must be a steam economy app.
  • language [string]: The user's local language
  • class_count [uint32] (required): Number of classes requested. Must be at least one.
  • classid0 [uint64] (required): Class ID of the nth class.
  • instanceid0 [uint64]: Instance ID of the nth class.

func (*SteamEconomy) GetAssetPrices

func (i *SteamEconomy) GetAssetPrices() (*Request, error)

GetAssetPrices creates a Request for interface method GetAssetPrices.

Parameters

  • appid [uint32] (required): Must be a steam economy app.
  • currency [string]: The currency to filter for
  • language [string]: The user's local language

type SteamEconomyGetAssetClassInfo

type SteamEconomyGetAssetClassInfo struct{}

SteamEconomyGetAssetClassInfo holds the result of the method ISteamEconomy/GetAssetClassInfo.

type SteamEconomyGetAssetPrices

type SteamEconomyGetAssetPrices struct{}

SteamEconomyGetAssetPrices holds the result of the method ISteamEconomy/GetAssetPrices.

type SteamGameOAuth added in v0.2.0

type SteamGameOAuth struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamGameOAuth represents interface ISteamGameOAuth.

This is an undocumented interface.

func NewSteamGameOAuth added in v0.2.0

func NewSteamGameOAuth(c *Client) (*SteamGameOAuth, error)

NewSteamGameOAuth creates a new SteamGameOAuth interface.

func (*SteamGameOAuth) GetAppInfo added in v0.2.0

func (i *SteamGameOAuth) GetAppInfo() (*Request, error)

GetAppInfo creates a Request for interface method GetAppInfo.

This is an undocumented method.

func (*SteamGameOAuth) GetPackageInfo added in v0.2.0

func (i *SteamGameOAuth) GetPackageInfo() (*Request, error)

GetPackageInfo creates a Request for interface method GetPackageInfo.

This is an undocumented method.

type SteamGameOAuthGetAppInfo added in v0.2.0

type SteamGameOAuthGetAppInfo struct{}

SteamGameOAuthGetAppInfo holds the result of the method ISteamGameOAuth/GetAppInfo.

type SteamGameOAuthGetPackageInfo added in v0.2.0

type SteamGameOAuthGetPackageInfo struct{}

SteamGameOAuthGetPackageInfo holds the result of the method ISteamGameOAuth/GetPackageInfo.

type SteamNews

type SteamNews struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamNews represents interface ISteamNews.

func NewSteamNews

func NewSteamNews(c *Client) (*SteamNews, error)

NewSteamNews creates a new SteamNews interface.

func (*SteamNews) GetNewsForApp

func (i *SteamNews) GetNewsForApp(version int) (*Request, error)

GetNewsForApp creates a Request for interface method GetNewsForApp.

Supported versions: 1, 2.

Parameters (v1)

  • appid [uint32] (required): AppID to retrieve news for
  • maxlength [uint32]: Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
  • enddate [uint32]: Retrieve posts earlier than this date (unix epoch timestamp)
  • count [uint32]: # of posts to retrieve (default 20)
  • tags [string]: Comma-separated list of tags to filter by (e.g. 'patchnodes')

Parameters (v2)

  • appid [uint32] (required): AppID to retrieve news for
  • maxlength [uint32]: Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
  • enddate [uint32]: Retrieve posts earlier than this date (unix epoch timestamp)
  • count [uint32]: # of posts to retrieve (default 20)
  • feeds [string]: Comma-separated list of feed names to return news for
  • tags [string]: Comma-separated list of tags to filter by (e.g. 'patchnodes')

type SteamNewsGetNewsForApp

type SteamNewsGetNewsForApp struct{}

SteamNewsGetNewsForApp holds the result of the method ISteamNews/GetNewsForApp.

type SteamNodwin added in v0.2.0

type SteamNodwin struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamNodwin represents interface ISteamNodwin.

This is an undocumented interface.

func NewSteamNodwin added in v0.2.0

func NewSteamNodwin(c *Client) (*SteamNodwin, error)

NewSteamNodwin creates a new SteamNodwin interface.

func (*SteamNodwin) NodwinPaymentNotification added in v0.2.0

func (i *SteamNodwin) NodwinPaymentNotification() (*Request, error)

NodwinPaymentNotification creates a Request for interface method NodwinPaymentNotification.

This is an undocumented method.

type SteamNodwinNodwinPaymentNotification added in v0.2.0

type SteamNodwinNodwinPaymentNotification struct{}

SteamNodwinNodwinPaymentNotification holds the result of the method ISteamNodwin/NodwinPaymentNotification.

type SteamPayPalPaymentsHub added in v0.2.0

type SteamPayPalPaymentsHub struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamPayPalPaymentsHub represents interface ISteamPayPalPaymentsHub.

This is an undocumented interface.

func NewSteamPayPalPaymentsHub added in v0.2.0

func NewSteamPayPalPaymentsHub(c *Client) (*SteamPayPalPaymentsHub, error)

NewSteamPayPalPaymentsHub creates a new SteamPayPalPaymentsHub interface.

func (*SteamPayPalPaymentsHub) PayPalPaymentsHubPaymentNotification added in v0.2.0

func (i *SteamPayPalPaymentsHub) PayPalPaymentsHubPaymentNotification() (*Request, error)

PayPalPaymentsHubPaymentNotification creates a Request for interface method PayPalPaymentsHubPaymentNotification.

This is an undocumented method.

type SteamPayPalPaymentsHubPayPalPaymentsHubPaymentNotification added in v0.2.0

type SteamPayPalPaymentsHubPayPalPaymentsHubPaymentNotification struct{}

SteamPayPalPaymentsHubPayPalPaymentsHubPaymentNotification holds the result of the method ISteamPayPalPaymentsHub/PayPalPaymentsHubPaymentNotification.

type SteamRemoteStorage

type SteamRemoteStorage struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamRemoteStorage represents interface ISteamRemoteStorage.

func NewSteamRemoteStorage

func NewSteamRemoteStorage(c *Client) (*SteamRemoteStorage, error)

NewSteamRemoteStorage creates a new SteamRemoteStorage interface.

func (*SteamRemoteStorage) GetCollectionDetails

func (i *SteamRemoteStorage) GetCollectionDetails() (*Request, error)

GetCollectionDetails creates a Request for interface method GetCollectionDetails.

Parameters

  • collectioncount [uint32] (required): Number of collections being requested
  • publishedfileids[0] [uint64] (required): collection ids to get the details for

func (*SteamRemoteStorage) GetPublishedFileDetails

func (i *SteamRemoteStorage) GetPublishedFileDetails() (*Request, error)

GetPublishedFileDetails creates a Request for interface method GetPublishedFileDetails.

Parameters

  • itemcount [uint32] (required): Number of items being requested
  • publishedfileids[0] [uint64] (required): published file id to look up

func (*SteamRemoteStorage) GetUGCFileDetails

func (i *SteamRemoteStorage) GetUGCFileDetails() (*Request, error)

GetUGCFileDetails creates a Request for interface method GetUGCFileDetails.

Parameters

  • steamid [uint64]: If specified, only returns details if the file is owned by the SteamID specified
  • ugcid [uint64] (required): ID of UGC file to get info for
  • appid [uint32] (required): appID of product

type SteamRemoteStorageGetCollectionDetails

type SteamRemoteStorageGetCollectionDetails struct{}

SteamRemoteStorageGetCollectionDetails holds the result of the method ISteamRemoteStorage/GetCollectionDetails.

type SteamRemoteStorageGetPublishedFileDetails

type SteamRemoteStorageGetPublishedFileDetails struct{}

SteamRemoteStorageGetPublishedFileDetails holds the result of the method ISteamRemoteStorage/GetPublishedFileDetails.

type SteamRemoteStorageGetUGCFileDetails

type SteamRemoteStorageGetUGCFileDetails struct{}

SteamRemoteStorageGetUGCFileDetails holds the result of the method ISteamRemoteStorage/GetUGCFileDetails.

type SteamTVService added in v0.2.0

type SteamTVService struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamTVService represents interface ISteamTVService.

This is an undocumented interface.

func NewSteamTVService added in v0.2.0

func NewSteamTVService(c *Client) (*SteamTVService, error)

NewSteamTVService creates a new SteamTVService interface.

func (*SteamTVService) AddChatBan added in v0.2.0

func (i *SteamTVService) AddChatBan() (*Request, error)

AddChatBan creates a Request for interface method AddChatBan.

This is an undocumented method.

func (*SteamTVService) AddChatModerator added in v0.2.0

func (i *SteamTVService) AddChatModerator() (*Request, error)

AddChatModerator creates a Request for interface method AddChatModerator.

This is an undocumented method.

func (*SteamTVService) AddWordBan added in v0.2.0

func (i *SteamTVService) AddWordBan() (*Request, error)

AddWordBan creates a Request for interface method AddWordBan.

This is an undocumented method.

func (*SteamTVService) CreateBroadcastChannel added in v0.2.0

func (i *SteamTVService) CreateBroadcastChannel() (*Request, error)

CreateBroadcastChannel creates a Request for interface method CreateBroadcastChannel.

This is an undocumented method.

func (*SteamTVService) FollowBroadcastChannel added in v0.2.0

func (i *SteamTVService) FollowBroadcastChannel() (*Request, error)

FollowBroadcastChannel creates a Request for interface method FollowBroadcastChannel.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelBroadcasters added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelBroadcasters() (*Request, error)

GetBroadcastChannelBroadcasters creates a Request for interface method GetBroadcastChannelBroadcasters.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelClips added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelClips() (*Request, error)

GetBroadcastChannelClips creates a Request for interface method GetBroadcastChannelClips.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelID added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelID() (*Request, error)

GetBroadcastChannelID creates a Request for interface method GetBroadcastChannelID.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelImages added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelImages() (*Request, error)

GetBroadcastChannelImages creates a Request for interface method GetBroadcastChannelImages.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelInteraction added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelInteraction() (*Request, error)

GetBroadcastChannelInteraction creates a Request for interface method GetBroadcastChannelInteraction.

This is an undocumented method.

func (i *SteamTVService) GetBroadcastChannelLinks() (*Request, error)

GetBroadcastChannelLinks creates a Request for interface method GetBroadcastChannelLinks.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelProfile added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelProfile() (*Request, error)

GetBroadcastChannelProfile creates a Request for interface method GetBroadcastChannelProfile.

This is an undocumented method.

func (*SteamTVService) GetBroadcastChannelStatus added in v0.2.0

func (i *SteamTVService) GetBroadcastChannelStatus() (*Request, error)

GetBroadcastChannelStatus creates a Request for interface method GetBroadcastChannelStatus.

This is an undocumented method.

func (*SteamTVService) GetChannels added in v0.2.0

func (i *SteamTVService) GetChannels() (*Request, error)

GetChannels creates a Request for interface method GetChannels.

This is an undocumented method.

func (*SteamTVService) GetChatBans added in v0.2.0

func (i *SteamTVService) GetChatBans() (*Request, error)

GetChatBans creates a Request for interface method GetChatBans.

This is an undocumented method.

func (*SteamTVService) GetChatModerators added in v0.2.0

func (i *SteamTVService) GetChatModerators() (*Request, error)

GetChatModerators creates a Request for interface method GetChatModerators.

This is an undocumented method.

func (*SteamTVService) GetFeatured added in v0.2.0

func (i *SteamTVService) GetFeatured() (*Request, error)

GetFeatured creates a Request for interface method GetFeatured.

This is an undocumented method.

func (*SteamTVService) GetFollowedChannels added in v0.2.0

func (i *SteamTVService) GetFollowedChannels() (*Request, error)

GetFollowedChannels creates a Request for interface method GetFollowedChannels.

This is an undocumented method.

func (*SteamTVService) GetGames added in v0.2.0

func (i *SteamTVService) GetGames() (*Request, error)

GetGames creates a Request for interface method GetGames.

This is an undocumented method.

func (*SteamTVService) GetHomePageContents added in v0.2.0

func (i *SteamTVService) GetHomePageContents() (*Request, error)

GetHomePageContents creates a Request for interface method GetHomePageContents.

This is an undocumented method.

func (*SteamTVService) GetMyBroadcastChannels added in v0.2.0

func (i *SteamTVService) GetMyBroadcastChannels() (*Request, error)

GetMyBroadcastChannels creates a Request for interface method GetMyBroadcastChannels.

This is an undocumented method.

func (*SteamTVService) GetSteamTVUserSettings added in v0.2.0

func (i *SteamTVService) GetSteamTVUserSettings() (*Request, error)

GetSteamTVUserSettings creates a Request for interface method GetSteamTVUserSettings.

This is an undocumented method.

func (*SteamTVService) GetSubscribedChannels added in v0.2.0

func (i *SteamTVService) GetSubscribedChannels() (*Request, error)

GetSubscribedChannels creates a Request for interface method GetSubscribedChannels.

This is an undocumented method.

func (*SteamTVService) GetWordBans added in v0.2.0

func (i *SteamTVService) GetWordBans() (*Request, error)

GetWordBans creates a Request for interface method GetWordBans.

This is an undocumented method.

func (*SteamTVService) JoinChat added in v0.2.0

func (i *SteamTVService) JoinChat() (*Request, error)

JoinChat creates a Request for interface method JoinChat.

This is an undocumented method.

func (*SteamTVService) ReportBroadcastChannel added in v0.2.0

func (i *SteamTVService) ReportBroadcastChannel() (*Request, error)

ReportBroadcastChannel creates a Request for interface method ReportBroadcastChannel.

This is an undocumented method.

func (*SteamTVService) Search added in v0.2.0

func (i *SteamTVService) Search() (*Request, error)

Search creates a Request for interface method Search.

This is an undocumented method.

func (*SteamTVService) SetBroadcastChannelImage added in v0.2.0

func (i *SteamTVService) SetBroadcastChannelImage() (*Request, error)

SetBroadcastChannelImage creates a Request for interface method SetBroadcastChannelImage.

This is an undocumented method.

func (*SteamTVService) SetBroadcastChannelLinkRegions added in v0.2.0

func (i *SteamTVService) SetBroadcastChannelLinkRegions() (*Request, error)

SetBroadcastChannelLinkRegions creates a Request for interface method SetBroadcastChannelLinkRegions.

This is an undocumented method.

func (*SteamTVService) SetBroadcastChannelProfile added in v0.2.0

func (i *SteamTVService) SetBroadcastChannelProfile() (*Request, error)

SetBroadcastChannelProfile creates a Request for interface method SetBroadcastChannelProfile.

This is an undocumented method.

func (*SteamTVService) SetSteamTVUserSettings added in v0.2.0

func (i *SteamTVService) SetSteamTVUserSettings() (*Request, error)

SetSteamTVUserSettings creates a Request for interface method SetSteamTVUserSettings.

This is an undocumented method.

func (*SteamTVService) SubscribeBroadcastChannel added in v0.2.0

func (i *SteamTVService) SubscribeBroadcastChannel() (*Request, error)

SubscribeBroadcastChannel creates a Request for interface method SubscribeBroadcastChannel.

This is an undocumented method.

type SteamTVServiceAddChatBan added in v0.2.0

type SteamTVServiceAddChatBan struct{}

SteamTVServiceAddChatBan holds the result of the method ISteamTVService/AddChatBan.

type SteamTVServiceAddChatModerator added in v0.2.0

type SteamTVServiceAddChatModerator struct{}

SteamTVServiceAddChatModerator holds the result of the method ISteamTVService/AddChatModerator.

type SteamTVServiceAddWordBan added in v0.2.0

type SteamTVServiceAddWordBan struct{}

SteamTVServiceAddWordBan holds the result of the method ISteamTVService/AddWordBan.

type SteamTVServiceCreateBroadcastChannel added in v0.2.0

type SteamTVServiceCreateBroadcastChannel struct{}

SteamTVServiceCreateBroadcastChannel holds the result of the method ISteamTVService/CreateBroadcastChannel.

type SteamTVServiceFollowBroadcastChannel added in v0.2.0

type SteamTVServiceFollowBroadcastChannel struct{}

SteamTVServiceFollowBroadcastChannel holds the result of the method ISteamTVService/FollowBroadcastChannel.

type SteamTVServiceGetBroadcastChannelBroadcasters added in v0.2.0

type SteamTVServiceGetBroadcastChannelBroadcasters struct{}

SteamTVServiceGetBroadcastChannelBroadcasters holds the result of the method ISteamTVService/GetBroadcastChannelBroadcasters.

type SteamTVServiceGetBroadcastChannelClips added in v0.2.0

type SteamTVServiceGetBroadcastChannelClips struct{}

SteamTVServiceGetBroadcastChannelClips holds the result of the method ISteamTVService/GetBroadcastChannelClips.

type SteamTVServiceGetBroadcastChannelID added in v0.2.0

type SteamTVServiceGetBroadcastChannelID struct{}

SteamTVServiceGetBroadcastChannelID holds the result of the method ISteamTVService/GetBroadcastChannelID.

type SteamTVServiceGetBroadcastChannelImages added in v0.2.0

type SteamTVServiceGetBroadcastChannelImages struct{}

SteamTVServiceGetBroadcastChannelImages holds the result of the method ISteamTVService/GetBroadcastChannelImages.

type SteamTVServiceGetBroadcastChannelInteraction added in v0.2.0

type SteamTVServiceGetBroadcastChannelInteraction struct{}

SteamTVServiceGetBroadcastChannelInteraction holds the result of the method ISteamTVService/GetBroadcastChannelInteraction.

type SteamTVServiceGetBroadcastChannelLinks struct{}

SteamTVServiceGetBroadcastChannelLinks holds the result of the method ISteamTVService/GetBroadcastChannelLinks.

type SteamTVServiceGetBroadcastChannelProfile added in v0.2.0

type SteamTVServiceGetBroadcastChannelProfile struct{}

SteamTVServiceGetBroadcastChannelProfile holds the result of the method ISteamTVService/GetBroadcastChannelProfile.

type SteamTVServiceGetBroadcastChannelStatus added in v0.2.0

type SteamTVServiceGetBroadcastChannelStatus struct{}

SteamTVServiceGetBroadcastChannelStatus holds the result of the method ISteamTVService/GetBroadcastChannelStatus.

type SteamTVServiceGetChannels added in v0.2.0

type SteamTVServiceGetChannels struct{}

SteamTVServiceGetChannels holds the result of the method ISteamTVService/GetChannels.

type SteamTVServiceGetChatBans added in v0.2.0

type SteamTVServiceGetChatBans struct{}

SteamTVServiceGetChatBans holds the result of the method ISteamTVService/GetChatBans.

type SteamTVServiceGetChatModerators added in v0.2.0

type SteamTVServiceGetChatModerators struct{}

SteamTVServiceGetChatModerators holds the result of the method ISteamTVService/GetChatModerators.

type SteamTVServiceGetFeatured added in v0.2.0

type SteamTVServiceGetFeatured struct{}

SteamTVServiceGetFeatured holds the result of the method ISteamTVService/GetFeatured.

type SteamTVServiceGetFollowedChannels added in v0.2.0

type SteamTVServiceGetFollowedChannels struct{}

SteamTVServiceGetFollowedChannels holds the result of the method ISteamTVService/GetFollowedChannels.

type SteamTVServiceGetGames added in v0.2.0

type SteamTVServiceGetGames struct{}

SteamTVServiceGetGames holds the result of the method ISteamTVService/GetGames.

type SteamTVServiceGetHomePageContents added in v0.2.0

type SteamTVServiceGetHomePageContents struct{}

SteamTVServiceGetHomePageContents holds the result of the method ISteamTVService/GetHomePageContents.

type SteamTVServiceGetMyBroadcastChannels added in v0.2.0

type SteamTVServiceGetMyBroadcastChannels struct{}

SteamTVServiceGetMyBroadcastChannels holds the result of the method ISteamTVService/GetMyBroadcastChannels.

type SteamTVServiceGetSteamTVUserSettings added in v0.2.0

type SteamTVServiceGetSteamTVUserSettings struct{}

SteamTVServiceGetSteamTVUserSettings holds the result of the method ISteamTVService/GetSteamTVUserSettings.

type SteamTVServiceGetSubscribedChannels added in v0.2.0

type SteamTVServiceGetSubscribedChannels struct{}

SteamTVServiceGetSubscribedChannels holds the result of the method ISteamTVService/GetSubscribedChannels.

type SteamTVServiceGetWordBans added in v0.2.0

type SteamTVServiceGetWordBans struct{}

SteamTVServiceGetWordBans holds the result of the method ISteamTVService/GetWordBans.

type SteamTVServiceJoinChat added in v0.2.0

type SteamTVServiceJoinChat struct{}

SteamTVServiceJoinChat holds the result of the method ISteamTVService/JoinChat.

type SteamTVServiceReportBroadcastChannel added in v0.2.0

type SteamTVServiceReportBroadcastChannel struct{}

SteamTVServiceReportBroadcastChannel holds the result of the method ISteamTVService/ReportBroadcastChannel.

type SteamTVServiceSearch added in v0.2.0

type SteamTVServiceSearch struct{}

SteamTVServiceSearch holds the result of the method ISteamTVService/Search.

type SteamTVServiceSetBroadcastChannelImage added in v0.2.0

type SteamTVServiceSetBroadcastChannelImage struct{}

SteamTVServiceSetBroadcastChannelImage holds the result of the method ISteamTVService/SetBroadcastChannelImage.

type SteamTVServiceSetBroadcastChannelLinkRegions added in v0.2.0

type SteamTVServiceSetBroadcastChannelLinkRegions struct{}

SteamTVServiceSetBroadcastChannelLinkRegions holds the result of the method ISteamTVService/SetBroadcastChannelLinkRegions.

type SteamTVServiceSetBroadcastChannelProfile added in v0.2.0

type SteamTVServiceSetBroadcastChannelProfile struct{}

SteamTVServiceSetBroadcastChannelProfile holds the result of the method ISteamTVService/SetBroadcastChannelProfile.

type SteamTVServiceSetSteamTVUserSettings added in v0.2.0

type SteamTVServiceSetSteamTVUserSettings struct{}

SteamTVServiceSetSteamTVUserSettings holds the result of the method ISteamTVService/SetSteamTVUserSettings.

type SteamTVServiceSubscribeBroadcastChannel added in v0.2.0

type SteamTVServiceSubscribeBroadcastChannel struct{}

SteamTVServiceSubscribeBroadcastChannel holds the result of the method ISteamTVService/SubscribeBroadcastChannel.

type SteamUser

type SteamUser struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamUser represents interface ISteamUser.

func NewSteamUser

func NewSteamUser(c *Client) (*SteamUser, error)

NewSteamUser creates a new SteamUser interface.

func (*SteamUser) GetFriendList

func (i *SteamUser) GetFriendList() (*Request, error)

GetFriendList creates a Request for interface method GetFriendList.

Parameters

  • key [string] (required): access key
  • steamid [uint64] (required): SteamID of user
  • relationship [string]: relationship type (ex: friend)

func (*SteamUser) GetPlayerBans

func (i *SteamUser) GetPlayerBans() (*Request, error)

GetPlayerBans creates a Request for interface method GetPlayerBans.

Parameters

  • key [string] (required): access key
  • steamids [string] (required): Comma-delimited list of SteamIDs

func (*SteamUser) GetPlayerSummaries

func (i *SteamUser) GetPlayerSummaries(version int) (*Request, error)

GetPlayerSummaries creates a Request for interface method GetPlayerSummaries.

Supported versions: 1, 2.

Parameters (v1)

  • key [string] (required): access key
  • steamids [string] (required): Comma-delimited list of SteamIDs

Parameters (v2)

  • key [string] (required): access key
  • steamids [string] (required): Comma-delimited list of SteamIDs (max: 100)

func (*SteamUser) GetUserGroupList

func (i *SteamUser) GetUserGroupList() (*Request, error)

GetUserGroupList creates a Request for interface method GetUserGroupList.

Parameters

  • key [string] (required): access key
  • steamid [uint64] (required): SteamID of user

func (*SteamUser) ResolveVanityURL

func (i *SteamUser) ResolveVanityURL() (*Request, error)

ResolveVanityURL creates a Request for interface method ResolveVanityURL.

Parameters

  • key [string] (required): access key
  • vanityurl [string] (required): The vanity URL to get a SteamID for
  • url_type [int32]: The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group

type SteamUserAuth

type SteamUserAuth struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamUserAuth represents interface ISteamUserAuth.

func NewSteamUserAuth

func NewSteamUserAuth(c *Client) (*SteamUserAuth, error)

NewSteamUserAuth creates a new SteamUserAuth interface.

func (*SteamUserAuth) AuthenticateUser

func (i *SteamUserAuth) AuthenticateUser() (*Request, error)

AuthenticateUser creates a Request for interface method AuthenticateUser.

Parameters

  • steamid [uint64] (required): Should be the users steamid, unencrypted.
  • sessionkey [rawbinary] (required): Should be a 32 byte random blob of data, which is then encrypted with RSA using the Steam system's public key. Randomness is important here for security.
  • encrypted_loginkey [rawbinary] (required): Should be the users hashed loginkey, AES encrypted with the sessionkey.

func (*SteamUserAuth) AuthenticateUserTicket

func (i *SteamUserAuth) AuthenticateUserTicket() (*Request, error)

AuthenticateUserTicket creates a Request for interface method AuthenticateUserTicket.

Parameters

  • key [string] (required): access key
  • appid [uint32] (required): appid of game
  • ticket [string] (required): Ticket from GetAuthSessionTicket.

type SteamUserAuthAuthenticateUser

type SteamUserAuthAuthenticateUser struct {
	AuthenticateUser SteamUserAuthAuthenticateUserAuthenticateUser `json:"authenticateuser"`
}

SteamUserAuthAuthenticateUser holds the result of the method ISteamUserAuth/AuthenticateUser.

type SteamUserAuthAuthenticateUserAuthenticateUser

type SteamUserAuthAuthenticateUserAuthenticateUser struct {
	Token       string `json:"token"`
	TokenSecure string `json:"token_secure"`
}

type SteamUserAuthAuthenticateUserTicket

type SteamUserAuthAuthenticateUserTicket struct{}

SteamUserAuthAuthenticateUserTicket holds the result of the method ISteamUserAuth/AuthenticateUserTicket.

type SteamUserGetFriendList

type SteamUserGetFriendList struct{}

SteamUserGetFriendList holds the result of the method ISteamUser/GetFriendList.

type SteamUserGetPlayerBans

type SteamUserGetPlayerBans struct{}

SteamUserGetPlayerBans holds the result of the method ISteamUser/GetPlayerBans.

type SteamUserGetPlayerSummaries

type SteamUserGetPlayerSummaries struct{}

SteamUserGetPlayerSummaries holds the result of the method ISteamUser/GetPlayerSummaries.

type SteamUserGetUserGroupList

type SteamUserGetUserGroupList struct{}

SteamUserGetUserGroupList holds the result of the method ISteamUser/GetUserGroupList.

type SteamUserOAuth

type SteamUserOAuth struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamUserOAuth represents interface ISteamUserOAuth.

func NewSteamUserOAuth

func NewSteamUserOAuth(c *Client) (*SteamUserOAuth, error)

NewSteamUserOAuth creates a new SteamUserOAuth interface.

func (*SteamUserOAuth) GetFriendList added in v0.2.0

func (i *SteamUserOAuth) GetFriendList() (*Request, error)

GetFriendList creates a Request for interface method GetFriendList.

This is an undocumented method.

func (*SteamUserOAuth) GetGroupList added in v0.2.0

func (i *SteamUserOAuth) GetGroupList() (*Request, error)

GetGroupList creates a Request for interface method GetGroupList.

This is an undocumented method.

func (*SteamUserOAuth) GetGroupSummaries added in v0.2.0

func (i *SteamUserOAuth) GetGroupSummaries() (*Request, error)

GetGroupSummaries creates a Request for interface method GetGroupSummaries.

This is an undocumented method.

func (*SteamUserOAuth) GetTokenDetails

func (i *SteamUserOAuth) GetTokenDetails() (*Request, error)

GetTokenDetails creates a Request for interface method GetTokenDetails.

Parameters

  • access_token [string] (required): OAuth2 token for which to return details

func (*SteamUserOAuth) GetUserSummaries added in v0.2.0

func (i *SteamUserOAuth) GetUserSummaries() (*Request, error)

GetUserSummaries creates a Request for interface method GetUserSummaries.

This is an undocumented method.

func (*SteamUserOAuth) Search added in v0.2.0

func (i *SteamUserOAuth) Search() (*Request, error)

Search creates a Request for interface method Search.

This is an undocumented method.

type SteamUserOAuthGetFriendList added in v0.2.0

type SteamUserOAuthGetFriendList struct{}

SteamUserOAuthGetFriendList holds the result of the method ISteamUserOAuth/GetFriendList.

type SteamUserOAuthGetGroupList added in v0.2.0

type SteamUserOAuthGetGroupList struct{}

SteamUserOAuthGetGroupList holds the result of the method ISteamUserOAuth/GetGroupList.

type SteamUserOAuthGetGroupSummaries added in v0.2.0

type SteamUserOAuthGetGroupSummaries struct{}

SteamUserOAuthGetGroupSummaries holds the result of the method ISteamUserOAuth/GetGroupSummaries.

type SteamUserOAuthGetTokenDetails

type SteamUserOAuthGetTokenDetails struct{}

SteamUserOAuthGetTokenDetails holds the result of the method ISteamUserOAuth/GetTokenDetails.

type SteamUserOAuthGetUserSummaries added in v0.2.0

type SteamUserOAuthGetUserSummaries struct{}

SteamUserOAuthGetUserSummaries holds the result of the method ISteamUserOAuth/GetUserSummaries.

type SteamUserOAuthSearch added in v0.2.0

type SteamUserOAuthSearch struct{}

SteamUserOAuthSearch holds the result of the method ISteamUserOAuth/Search.

type SteamUserResolveVanityURL

type SteamUserResolveVanityURL struct{}

SteamUserResolveVanityURL holds the result of the method ISteamUser/ResolveVanityURL.

type SteamUserStats

type SteamUserStats struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamUserStats represents interface ISteamUserStats.

func NewSteamUserStats

func NewSteamUserStats(c *Client) (*SteamUserStats, error)

NewSteamUserStats creates a new SteamUserStats interface.

func (*SteamUserStats) GetGlobalAchievementPercentagesForApp

func (i *SteamUserStats) GetGlobalAchievementPercentagesForApp(version int) (*Request, error)

GetGlobalAchievementPercentagesForApp creates a Request for interface method GetGlobalAchievementPercentagesForApp.

Supported versions: 1, 2.

Parameters (v1)

  • gameid [uint64] (required): GameID to retrieve the achievement percentages for

Parameters (v2)

  • gameid [uint64] (required): GameID to retrieve the achievement percentages for

func (*SteamUserStats) GetGlobalStatsForGame

func (i *SteamUserStats) GetGlobalStatsForGame() (*Request, error)

GetGlobalStatsForGame creates a Request for interface method GetGlobalStatsForGame.

Parameters

  • appid [uint32] (required): AppID that we're getting global stats for
  • count [uint32] (required): Number of stats get data for
  • name[0] [string] (required): Names of stat to get data for
  • startdate [uint32]: Start date for daily totals (unix epoch timestamp)
  • enddate [uint32]: End date for daily totals (unix epoch timestamp)

func (*SteamUserStats) GetNumberOfCurrentPlayers

func (i *SteamUserStats) GetNumberOfCurrentPlayers() (*Request, error)

GetNumberOfCurrentPlayers creates a Request for interface method GetNumberOfCurrentPlayers.

Parameters

  • appid [uint32] (required): AppID that we're getting user count for

func (*SteamUserStats) GetPlayerAchievements

func (i *SteamUserStats) GetPlayerAchievements() (*Request, error)

GetPlayerAchievements creates a Request for interface method GetPlayerAchievements.

Parameters

  • key [string] (required): access key
  • steamid [uint64] (required): SteamID of user
  • appid [uint32] (required): AppID to get achievements for
  • l [string]: Language to return strings for

func (*SteamUserStats) GetSchemaForGame

func (i *SteamUserStats) GetSchemaForGame(version int) (*Request, error)

GetSchemaForGame creates a Request for interface method GetSchemaForGame.

Supported versions: 1, 2.

Parameters (v1)

  • key [string] (required): access key
  • appid [uint32] (required): appid of game
  • l [string]: localized langauge to return (english, french, etc.)

Parameters (v2)

  • key [string] (required): access key
  • appid [uint32] (required): appid of game
  • l [string]: localized language to return (english, french, etc.)

func (*SteamUserStats) GetUserStatsForGame

func (i *SteamUserStats) GetUserStatsForGame(version int) (*Request, error)

GetUserStatsForGame creates a Request for interface method GetUserStatsForGame.

Supported versions: 1, 2.

Parameters (v1)

  • key [string] (required): access key
  • steamid [uint64] (required): SteamID of user
  • appid [uint32] (required): appid of game

Parameters (v2)

  • key [string] (required): access key
  • steamid [uint64] (required): SteamID of user
  • appid [uint32] (required): appid of game

type SteamUserStatsGetGlobalAchievementPercentagesForApp

type SteamUserStatsGetGlobalAchievementPercentagesForApp struct{}

SteamUserStatsGetGlobalAchievementPercentagesForApp holds the result of the method ISteamUserStats/GetGlobalAchievementPercentagesForApp.

type SteamUserStatsGetGlobalStatsForGame

type SteamUserStatsGetGlobalStatsForGame struct{}

SteamUserStatsGetGlobalStatsForGame holds the result of the method ISteamUserStats/GetGlobalStatsForGame.

type SteamUserStatsGetNumberOfCurrentPlayers

type SteamUserStatsGetNumberOfCurrentPlayers struct{}

SteamUserStatsGetNumberOfCurrentPlayers holds the result of the method ISteamUserStats/GetNumberOfCurrentPlayers.

type SteamUserStatsGetPlayerAchievements

type SteamUserStatsGetPlayerAchievements struct{}

SteamUserStatsGetPlayerAchievements holds the result of the method ISteamUserStats/GetPlayerAchievements.

type SteamUserStatsGetSchemaForGame

type SteamUserStatsGetSchemaForGame struct{}

SteamUserStatsGetSchemaForGame holds the result of the method ISteamUserStats/GetSchemaForGame.

type SteamUserStatsGetUserStatsForGame

type SteamUserStatsGetUserStatsForGame struct{}

SteamUserStatsGetUserStatsForGame holds the result of the method ISteamUserStats/GetUserStatsForGame.

type SteamWebAPIUtil

type SteamWebAPIUtil struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamWebAPIUtil represents interface ISteamWebAPIUtil.

func NewSteamWebAPIUtil

func NewSteamWebAPIUtil(c *Client) (*SteamWebAPIUtil, error)

NewSteamWebAPIUtil creates a new SteamWebAPIUtil interface.

func (*SteamWebAPIUtil) GetServerInfo

func (i *SteamWebAPIUtil) GetServerInfo() (*Request, error)

GetServerInfo creates a Request for interface method GetServerInfo.

func (*SteamWebAPIUtil) GetSupportedAPIList

func (i *SteamWebAPIUtil) GetSupportedAPIList() (*Request, error)

GetSupportedAPIList creates a Request for interface method GetSupportedAPIList.

Parameters

  • key [string]: access key

type SteamWebAPIUtilGetServerInfo

type SteamWebAPIUtilGetServerInfo struct {
	ServerTime       uint64 `json:"servertime"`
	ServerTimeString string `json:"servertimestring"`
}

SteamWebAPIUtilGetServerInfo holds the result of the method ISteamWebAPIUtil/GetServerInfo.

type SteamWebAPIUtilGetSupportedAPIList

type SteamWebAPIUtilGetSupportedAPIList struct {
	API *Schema `json:"apilist"`
}

SteamWebAPIUtilGetSupportedAPIList holds the result of the method ISteamWebAPIUtil/GetSupportedAPIList.

type SteamWebUserPresenceOAuth

type SteamWebUserPresenceOAuth struct {
	Client    *Client
	Interface *SchemaInterface
}

SteamWebUserPresenceOAuth represents interface ISteamWebUserPresenceOAuth.

func NewSteamWebUserPresenceOAuth

func NewSteamWebUserPresenceOAuth(c *Client) (*SteamWebUserPresenceOAuth, error)

NewSteamWebUserPresenceOAuth creates a new SteamWebUserPresenceOAuth interface.

func (*SteamWebUserPresenceOAuth) DeviceInfo added in v0.2.0

func (i *SteamWebUserPresenceOAuth) DeviceInfo() (*Request, error)

DeviceInfo creates a Request for interface method DeviceInfo.

This is an undocumented method.

func (*SteamWebUserPresenceOAuth) Logoff added in v0.2.0

func (i *SteamWebUserPresenceOAuth) Logoff() (*Request, error)

Logoff creates a Request for interface method Logoff.

This is an undocumented method.

func (*SteamWebUserPresenceOAuth) Logon added in v0.2.0

func (i *SteamWebUserPresenceOAuth) Logon() (*Request, error)

Logon creates a Request for interface method Logon.

This is an undocumented method.

func (*SteamWebUserPresenceOAuth) Message added in v0.2.0

func (i *SteamWebUserPresenceOAuth) Message() (*Request, error)

Message creates a Request for interface method Message.

This is an undocumented method.

func (*SteamWebUserPresenceOAuth) Poll added in v0.2.0

func (i *SteamWebUserPresenceOAuth) Poll() (*Request, error)

Poll creates a Request for interface method Poll.

This is an undocumented method.

func (*SteamWebUserPresenceOAuth) PollStatus

func (i *SteamWebUserPresenceOAuth) PollStatus() (*Request, error)

PollStatus creates a Request for interface method PollStatus.

Parameters

  • steamid [string] (required): Steam ID of the user
  • umqid [uint64] (required): UMQ Session ID
  • message [uint32] (required): Message that was last known to the user
  • pollid [uint32]: Caller-specific poll id
  • sectimeout [uint32]: Long-poll timeout in seconds
  • secidletime [uint32]: How many seconds is client considering itself idle, e.g. screen is off
  • use_accountids [uint32]: Boolean, 0 (default): return steamid_from in output, 1: return accountid_from

type SteamWebUserPresenceOAuthDeviceInfo added in v0.2.0

type SteamWebUserPresenceOAuthDeviceInfo struct{}

SteamWebUserPresenceOAuthDeviceInfo holds the result of the method ISteamWebUserPresenceOAuth/DeviceInfo.

type SteamWebUserPresenceOAuthLogoff added in v0.2.0

type SteamWebUserPresenceOAuthLogoff struct{}

SteamWebUserPresenceOAuthLogoff holds the result of the method ISteamWebUserPresenceOAuth/Logoff.

type SteamWebUserPresenceOAuthLogon added in v0.2.0

type SteamWebUserPresenceOAuthLogon struct{}

SteamWebUserPresenceOAuthLogon holds the result of the method ISteamWebUserPresenceOAuth/Logon.

type SteamWebUserPresenceOAuthMessage added in v0.2.0

type SteamWebUserPresenceOAuthMessage struct{}

SteamWebUserPresenceOAuthMessage holds the result of the method ISteamWebUserPresenceOAuth/Message.

type SteamWebUserPresenceOAuthPoll added in v0.2.0

type SteamWebUserPresenceOAuthPoll struct{}

SteamWebUserPresenceOAuthPoll holds the result of the method ISteamWebUserPresenceOAuth/Poll.

type SteamWebUserPresenceOAuthPollStatus

type SteamWebUserPresenceOAuthPollStatus struct{}

SteamWebUserPresenceOAuthPollStatus holds the result of the method ISteamWebUserPresenceOAuth/PollStatus.

type StoreService

type StoreService struct {
	Client    *Client
	Interface *SchemaInterface
}

StoreService represents interface IStoreService.

func NewStoreService

func NewStoreService(c *Client) (*StoreService, error)

NewStoreService creates a new StoreService interface.

func (*StoreService) GetAppList

func (i *StoreService) GetAppList() (*Request, error)

GetAppList creates a Request for interface method GetAppList.

Parameters

  • key [string] (required): Access key
  • if_modified_since [uint32]: Return only items that have been modified since this date.
  • have_description_language [string]: Return only items that have a description in this language.
  • include_games [bool]: Include games (defaults to enabled)
  • include_dlc [bool]: Include DLC
  • include_software [bool]: Include software items
  • include_videos [bool]: Include videos and series
  • include_hardware [bool]: Include hardware
  • last_appid [uint32]: For continuations, this is the last appid returned from the previous call.
  • max_results [uint32]: Number of results to return at a time. Default 10k, max 50k.

type StoreServiceGetAppList

type StoreServiceGetAppList struct{}

StoreServiceGetAppList holds the result of the method IStoreService/GetAppList.

type TFItems

type TFItems struct {
	Client    *Client
	Interface *SchemaInterface
}

TFItems represents interface ITFItems.

Supported AppIDs: 440.

func NewTFItems

func NewTFItems(c *Client, appID uint32) (*TFItems, error)

NewTFItems creates a new TFItems interface.

Supported AppIDs: 440.

func (*TFItems) GetGoldenWrenches

func (i *TFItems) GetGoldenWrenches(version int) (*Request, error)

GetGoldenWrenches creates a Request for interface method GetGoldenWrenches.

Supported versions: 1, 2.

type TFItemsGetGoldenWrenches

type TFItemsGetGoldenWrenches struct{}

TFItemsGetGoldenWrenches holds the result of the method ITFItems/GetGoldenWrenches.

type TFPromos

type TFPromos struct {
	Client    *Client
	Interface *SchemaInterface
}

TFPromos represents interface ITFPromos.

Supported AppIDs: 440, 570, 620, 205790.

func NewTFPromos

func NewTFPromos(c *Client, appID uint32) (*TFPromos, error)

NewTFPromos creates a new TFPromos interface.

Supported AppIDs: 440, 570, 620, 205790.

func (*TFPromos) GetItemID

func (i *TFPromos) GetItemID() (*Request, error)

GetItemID creates a Request for interface method GetItemID.

Parameters

  • steamid [uint64] (required): The Steam ID to fetch items for
  • promoid [uint32] (required): The promo ID to grant an item for

func (*TFPromos) GrantItem

func (i *TFPromos) GrantItem() (*Request, error)

GrantItem creates a Request for interface method GrantItem.

Parameters

  • steamid [uint64] (required): The Steam ID to fetch items for
  • promoid [uint32] (required): The promo ID to grant an item for

type TFPromosGetItemID

type TFPromosGetItemID struct{}

TFPromosGetItemID holds the result of the method ITFPromos/GetItemID.

type TFPromosGrantItem

type TFPromosGrantItem struct{}

TFPromosGrantItem holds the result of the method ITFPromos/GrantItem.

type TFSystem

type TFSystem struct {
	Client    *Client
	Interface *SchemaInterface
}

TFSystem represents interface ITFSystem.

Supported AppIDs: 440.

func NewTFSystem

func NewTFSystem(c *Client, appID uint32) (*TFSystem, error)

NewTFSystem creates a new TFSystem interface.

Supported AppIDs: 440.

func (*TFSystem) GetWorldStatus

func (i *TFSystem) GetWorldStatus() (*Request, error)

GetWorldStatus creates a Request for interface method GetWorldStatus.

type TFSystemGetWorldStatus

type TFSystemGetWorldStatus struct{}

TFSystemGetWorldStatus holds the result of the method ITFSystem/GetWorldStatus.

type TwoFactorService added in v0.2.0

type TwoFactorService struct {
	Client    *Client
	Interface *SchemaInterface
}

TwoFactorService represents interface ITwoFactorService.

This is an undocumented interface.

func NewTwoFactorService added in v0.2.0

func NewTwoFactorService(c *Client) (*TwoFactorService, error)

NewTwoFactorService creates a new TwoFactorService interface.

func (*TwoFactorService) AddAuthenticator added in v0.2.0

func (i *TwoFactorService) AddAuthenticator() (*Request, error)

AddAuthenticator creates a Request for interface method AddAuthenticator.

This is an undocumented method.

func (*TwoFactorService) CreateEmergencyCodes added in v0.2.0

func (i *TwoFactorService) CreateEmergencyCodes() (*Request, error)

CreateEmergencyCodes creates a Request for interface method CreateEmergencyCodes.

This is an undocumented method.

func (*TwoFactorService) DestroyEmergencyCodes added in v0.2.0

func (i *TwoFactorService) DestroyEmergencyCodes() (*Request, error)

DestroyEmergencyCodes creates a Request for interface method DestroyEmergencyCodes.

This is an undocumented method.

func (*TwoFactorService) FinalizeAddAuthenticator added in v0.2.0

func (i *TwoFactorService) FinalizeAddAuthenticator() (*Request, error)

FinalizeAddAuthenticator creates a Request for interface method FinalizeAddAuthenticator.

This is an undocumented method.

func (*TwoFactorService) QuerySecrets added in v0.2.0

func (i *TwoFactorService) QuerySecrets() (*Request, error)

QuerySecrets creates a Request for interface method QuerySecrets.

This is an undocumented method.

func (*TwoFactorService) QueryStatus added in v0.2.0

func (i *TwoFactorService) QueryStatus() (*Request, error)

QueryStatus creates a Request for interface method QueryStatus.

This is an undocumented method.

func (*TwoFactorService) QueryTime added in v0.2.0

func (i *TwoFactorService) QueryTime() (*Request, error)

QueryTime creates a Request for interface method QueryTime.

This is an undocumented method.

func (*TwoFactorService) RecoverAuthenticatorCommit added in v0.2.0

func (i *TwoFactorService) RecoverAuthenticatorCommit() (*Request, error)

RecoverAuthenticatorCommit creates a Request for interface method RecoverAuthenticatorCommit.

This is an undocumented method.

func (*TwoFactorService) RecoverAuthenticatorContinue added in v0.2.0

func (i *TwoFactorService) RecoverAuthenticatorContinue() (*Request, error)

RecoverAuthenticatorContinue creates a Request for interface method RecoverAuthenticatorContinue.

This is an undocumented method.

func (*TwoFactorService) RemoveAuthenticator added in v0.2.0

func (i *TwoFactorService) RemoveAuthenticator() (*Request, error)

RemoveAuthenticator creates a Request for interface method RemoveAuthenticator.

This is an undocumented method.

func (*TwoFactorService) RemoveAuthenticatorViaChallengeContinue added in v0.2.0

func (i *TwoFactorService) RemoveAuthenticatorViaChallengeContinue() (*Request, error)

RemoveAuthenticatorViaChallengeContinue creates a Request for interface method RemoveAuthenticatorViaChallengeContinue.

This is an undocumented method.

func (*TwoFactorService) RemoveAuthenticatorViaChallengeStart added in v0.2.0

func (i *TwoFactorService) RemoveAuthenticatorViaChallengeStart() (*Request, error)

RemoveAuthenticatorViaChallengeStart creates a Request for interface method RemoveAuthenticatorViaChallengeStart.

This is an undocumented method.

func (*TwoFactorService) SendEmail added in v0.2.0

func (i *TwoFactorService) SendEmail() (*Request, error)

SendEmail creates a Request for interface method SendEmail.

This is an undocumented method.

func (*TwoFactorService) ValidateToken added in v0.2.0

func (i *TwoFactorService) ValidateToken() (*Request, error)

ValidateToken creates a Request for interface method ValidateToken.

This is an undocumented method.

type TwoFactorServiceAddAuthenticator added in v0.2.0

type TwoFactorServiceAddAuthenticator struct{}

TwoFactorServiceAddAuthenticator holds the result of the method ITwoFactorService/AddAuthenticator.

type TwoFactorServiceCreateEmergencyCodes added in v0.2.0

type TwoFactorServiceCreateEmergencyCodes struct{}

TwoFactorServiceCreateEmergencyCodes holds the result of the method ITwoFactorService/CreateEmergencyCodes.

type TwoFactorServiceDestroyEmergencyCodes added in v0.2.0

type TwoFactorServiceDestroyEmergencyCodes struct{}

TwoFactorServiceDestroyEmergencyCodes holds the result of the method ITwoFactorService/DestroyEmergencyCodes.

type TwoFactorServiceFinalizeAddAuthenticator added in v0.2.0

type TwoFactorServiceFinalizeAddAuthenticator struct{}

TwoFactorServiceFinalizeAddAuthenticator holds the result of the method ITwoFactorService/FinalizeAddAuthenticator.

type TwoFactorServiceQuerySecrets added in v0.2.0

type TwoFactorServiceQuerySecrets struct{}

TwoFactorServiceQuerySecrets holds the result of the method ITwoFactorService/QuerySecrets.

type TwoFactorServiceQueryStatus added in v0.2.0

type TwoFactorServiceQueryStatus struct{}

TwoFactorServiceQueryStatus holds the result of the method ITwoFactorService/QueryStatus.

type TwoFactorServiceQueryTime added in v0.2.0

type TwoFactorServiceQueryTime struct{}

TwoFactorServiceQueryTime holds the result of the method ITwoFactorService/QueryTime.

type TwoFactorServiceRecoverAuthenticatorCommit added in v0.2.0

type TwoFactorServiceRecoverAuthenticatorCommit struct{}

TwoFactorServiceRecoverAuthenticatorCommit holds the result of the method ITwoFactorService/RecoverAuthenticatorCommit.

type TwoFactorServiceRecoverAuthenticatorContinue added in v0.2.0

type TwoFactorServiceRecoverAuthenticatorContinue struct{}

TwoFactorServiceRecoverAuthenticatorContinue holds the result of the method ITwoFactorService/RecoverAuthenticatorContinue.

type TwoFactorServiceRemoveAuthenticator added in v0.2.0

type TwoFactorServiceRemoveAuthenticator struct{}

TwoFactorServiceRemoveAuthenticator holds the result of the method ITwoFactorService/RemoveAuthenticator.

type TwoFactorServiceRemoveAuthenticatorViaChallengeContinue added in v0.2.0

type TwoFactorServiceRemoveAuthenticatorViaChallengeContinue struct{}

TwoFactorServiceRemoveAuthenticatorViaChallengeContinue holds the result of the method ITwoFactorService/RemoveAuthenticatorViaChallengeContinue.

type TwoFactorServiceRemoveAuthenticatorViaChallengeStart added in v0.2.0

type TwoFactorServiceRemoveAuthenticatorViaChallengeStart struct{}

TwoFactorServiceRemoveAuthenticatorViaChallengeStart holds the result of the method ITwoFactorService/RemoveAuthenticatorViaChallengeStart.

type TwoFactorServiceSendEmail added in v0.2.0

type TwoFactorServiceSendEmail struct{}

TwoFactorServiceSendEmail holds the result of the method ITwoFactorService/SendEmail.

type TwoFactorServiceValidateToken added in v0.2.0

type TwoFactorServiceValidateToken struct{}

TwoFactorServiceValidateToken holds the result of the method ITwoFactorService/ValidateToken.

type VideoService added in v0.2.0

type VideoService struct {
	Client    *Client
	Interface *SchemaInterface
}

VideoService represents interface IVideoService.

This is an undocumented interface.

func NewVideoService added in v0.2.0

func NewVideoService(c *Client) (*VideoService, error)

NewVideoService creates a new VideoService interface.

func (*VideoService) GetVideoBookmarks added in v0.2.0

func (i *VideoService) GetVideoBookmarks() (*Request, error)

GetVideoBookmarks creates a Request for interface method GetVideoBookmarks.

This is an undocumented method.

func (*VideoService) SetVideoBookmark added in v0.2.0

func (i *VideoService) SetVideoBookmark() (*Request, error)

SetVideoBookmark creates a Request for interface method SetVideoBookmark.

This is an undocumented method.

type VideoServiceGetVideoBookmarks added in v0.2.0

type VideoServiceGetVideoBookmarks struct{}

VideoServiceGetVideoBookmarks holds the result of the method IVideoService/GetVideoBookmarks.

type VideoServiceSetVideoBookmark added in v0.2.0

type VideoServiceSetVideoBookmark struct{}

VideoServiceSetVideoBookmark holds the result of the method IVideoService/SetVideoBookmark.

Source Files

Directories

Path Synopsis
Package dota2 implements an HTTP client for the (undocumented) Dota 2 Web API.
Package dota2 implements an HTTP client for the (undocumented) Dota 2 Web API.

Jump to

Keyboard shortcuts

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