v1

Documentation

Overview

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

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

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

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

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

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

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

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

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

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

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

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

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

Index

• Variables
• func RespWithSuccess(w http.ResponseWriter, r *http.Request, respBody interface{})
• func ThrowReqError(w http.ResponseWriter, r *http.Request, errorMsg string, userErr error, ...)
• type V1API
  • func (api V1API) Channelsservice_idchannelstatisticsPost(w http.ResponseWriter, r *http.Request)
  • func (api V1API) ConfigurationGet(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Updatesservice_idsubscribeGet(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idapikeyPut(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idapikeynameGet(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idbanPut(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idpropertiesGet(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idpropertiesPut(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idpropertiespropertyGet(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idverificationrefreshPost(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idverificationstatusGet(w http.ResponseWriter, r *http.Request)
  • func (api V1API) Usersservice_idservice_user_idverificationtemporaryPut(w http.ResponseWriter, r *http.Request)
• type VerificationStatusExtended

Variables

var HARD_CODED_WORLD_PERSPECTIVE = 2007

@TODO fix hardcoded later

Functions

func RespWithSuccess

func RespWithSuccess(w http.ResponseWriter, r *http.Request, respBody interface{})

func ThrowReqError

func ThrowReqError(w http.ResponseWriter, r *http.Request, errorMsg string, userErr error, statusCode int)

Types

type V1API

type V1API struct {
}

V1API is API implementation of /v1 root endpoint

func (V1API) Channelsservice_idchannelstatisticsPost

func (api V1API) Channelsservice_idchannelstatisticsPost(w http.ResponseWriter, r *http.Request)

Channelsservice_idchannelstatisticsPost is the handler for POST /v1/channels/{service_id}/{channel}/statistics Collect statistics based on the provided parameters and save them for historical purposes

func (V1API) ConfigurationGet

func (api V1API) ConfigurationGet(w http.ResponseWriter, r *http.Request)

ConfigurationGet is the handler for GET /v1/configuration Get a configuration containing relevant information for running a service bot

func (V1API) Updatesservice_idsubscribeGet

func (api V1API) Updatesservice_idsubscribeGet(w http.ResponseWriter, r *http.Request)

Updatesservice_idsubscribeGet is the handler for GET /v1/updates/{service_id}/subscribe Long polling rest endpoint for receiving verification updates

func (V1API) Usersservice_idservice_user_idapikeyPut

func (api V1API) Usersservice_idservice_user_idapikeyPut(w http.ResponseWriter, r *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

func (V1API) Usersservice_idservice_user_idapikeynameGet

func (api V1API) Usersservice_idservice_user_idapikeynameGet(w http.ResponseWriter, r *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

func (V1API) Usersservice_idservice_user_idbanPut

func (api V1API) Usersservice_idservice_user_idbanPut(w http.ResponseWriter, r *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

func (V1API) Usersservice_idservice_user_idpropertiesGet

func (api V1API) Usersservice_idservice_user_idpropertiesGet(w http.ResponseWriter, r *http.Request)

Usersservice_idservice_user_idpropertiesGet is the handler for GET /v1/users/{service_id}/{service_user_id}/properties Get all user properties

func (V1API) Usersservice_idservice_user_idpropertiesPut

func (api V1API) Usersservice_idservice_user_idpropertiesPut(w http.ResponseWriter, r *http.Request)

Usersservice_idservice_user_idpropertiesPut is the handler for PUT /v1/users/{service_id}/{service_user_id}/properties Set a user property

func (V1API) Usersservice_idservice_user_idpropertiespropertyGet

func (api V1API) Usersservice_idservice_user_idpropertiespropertyGet(w http.ResponseWriter, r *http.Request)

Usersservice_idservice_user_idpropertiespropertyGet is the handler for GET /v1/users/{service_id}/{service_user_id}/properties/{property} Get a user property

func (V1API) Usersservice_idservice_user_idverificationrefreshPost

func (api V1API) Usersservice_idservice_user_idverificationrefreshPost(w http.ResponseWriter, r *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

func (V1API) Usersservice_idservice_user_idverificationstatusGet

func (api V1API) Usersservice_idservice_user_idverificationstatusGet(w http.ResponseWriter, r *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

func (V1API) Usersservice_idservice_user_idverificationtemporaryPut

func (api V1API) Usersservice_idservice_user_idverificationtemporaryPut(w http.ResponseWriter, r *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

type VerificationStatusExtended

type VerificationStatusExtended struct {
	types.VerificationStatus
	AccountData gw2api.Account
}