api

Documentation

Overview

DO NOT EDIT THIS FILE. This file will be overwritten when re-running go-raml.

THIS FILE IS SAFE TO EDIT. It will not be overwritten when rerunning go-raml.

DO NOT EDIT THIS FILE. This file will be overwritten when re-running go-raml.

Index

• func StartServer()
• func V1InterfaceRoutes(r *mux.Router, i V1Interface)
• type V1Interface

Functions

func StartServer

func StartServer()

func V1InterfaceRoutes

func V1InterfaceRoutes(r *mux.Router, i V1Interface)

V1InterfaceRoutes is routing for /v1 root endpoint

Types

type V1Interface

type V1Interface interface {
	// Collect statistics based on the provided parameters and save them for historical purposes
	Channelsservice_idchannelstatisticsPost(http.ResponseWriter, *http.Request)
	// ConfigurationGet is the handler for GET /v1/configuration
	// Get a configuration containing relevant information for running a service bot
	ConfigurationGet(http.ResponseWriter, *http.Request)
	// Updatesservice_idsubscribeGet is the handler for GET /v1/updates/{service_id}/subscribe
	// Long polling rest endpoint for receiving verification updates
	Updatesservice_idsubscribeGet(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idapikeynameGet is the handler for GET /v1/users/{service_id}/{service_user_id}/apikey/name
	// Get a service user's apikey name they are required to use if apikey name restriction is enforced
	Usersservice_idservice_user_idapikeynameGet(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idapikeyPut is the handler for PUT /v1/users/{service_id}/{service_user_id}/apikey
	// Set a service user's API key
	Usersservice_idservice_user_idapikeyPut(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idbanPut is the handler for PUT /v1/users/{service_id}/{service_user_id}/ban
	// Ban a user's gw2 account from being verified
	Usersservice_idservice_user_idbanPut(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idpropertiespropertyGet is the handler for GET /v1/users/{service_id}/{service_user_id}/properties/{property}
	// Get a user property
	Usersservice_idservice_user_idpropertiespropertyGet(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idpropertiesGet is the handler for GET /v1/users/{service_id}/{service_user_id}/properties
	// Get all user properties
	Usersservice_idservice_user_idpropertiesGet(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idpropertiesPut is the handler for PUT /v1/users/{service_id}/{service_user_id}/properties
	// Set a user property
	Usersservice_idservice_user_idpropertiesPut(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idverificationrefreshPost is the handler for POST /v1/users/{service_id}/{service_user_id}/verification/refresh
	// Forces a refresh of the API data and returns the new verification status after the API data has been refreshed. Note this can take a few seconds
	Usersservice_idservice_user_idverificationrefreshPost(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idverificationstatusGet is the handler for GET /v1/users/{service_id}/{service_user_id}/verification/status
	// Get a users verification status
	Usersservice_idservice_user_idverificationstatusGet(http.ResponseWriter, *http.Request)
	// Usersservice_idservice_user_idverificationtemporaryPut is the handler for PUT /v1/users/{service_id}/{service_user_id}/verification/temporary
	// Grant a user temporary world relation. Additionally, the "temp_expired" property will be removed from the user's properties
	Usersservice_idservice_user_idverificationtemporaryPut(http.ResponseWriter, *http.Request)
}

V1Interface is interface for /v1 root endpoint