gottx

TTX API Wrapper

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import gottx "github.com/ttxdev/gottx"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value gottx.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), gottx.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value gottx.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), gottx.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using gottx.ContextOperationServerIndices and gottx.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), gottx.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), gottx.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
TTXAPI	CreateCreator	Post /creators
TTXAPI	DiscordCallback	Get /sessions/discord/callback
TTXAPI	Gamba	Put /players/me/lootboxes/{lootBoxId}/open
TTXAPI	GetCreator	Get /creators/{slug}
TTXAPI	GetCreatorTransactions	Get /creators/{creatorSlug}/transactions
TTXAPI	GetCreators	Get /creators
TTXAPI	GetPlayer	Get /players/{username}
TTXAPI	GetPlayers	Get /players
TTXAPI	GetSelf	Get /players/me
TTXAPI	LinkDiscordTwitch	Post /sessions/discord/link
TTXAPI	PlaceOrder	Post /transactions
TTXAPI	TwitchCallback	Get /sessions/twitch/callback

Documentation For Models

• CreateTransactionDto
• CreatorDto
• CreatorOrderBy
• CreatorPartialDto
• CreatorPartialDtoPaginationDto
• CreatorRarityDto
• CreatorShareDto
• CreatorTransactionDto
• DiscordTokenDto
• LinkDiscordTwitchDto
• LootBoxDto
• LootBoxResultDto
• ModelId
• OrderDirection
• PlayerDto
• PlayerDtoPaginationDto
• PlayerOrderBy
• PlayerPartialDto
• PlayerShareDto
• PlayerTransactionDto
• PlayerType
• PortfolioSnapshotDto
• Rarity
• StreamStatusDto
• TimeStep
• TokenDto
• TransactionAction
• TwitchUserDto
• VoteDto

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

NathanRoberts55