scapiWebsite

Documentation

Index

• type OrgData
• type OrgDataFocus
• type OrgDataFocusItems
• type OrgDataHeadline
• type OrgResponse
• type ShipQuery
• type ShipsData
• type ShipsDataCompiled
• type ShipsDataManufacturer
• type ShipsDataMedia
• type ShipsDataMediaImages
• type ShipsResponse
• type StatsData
• type StatsResponse
• type UserData
• type UserDataOrg
• type UserDataProfile
• type UserDataProfilePage
• type UserResponse
• type Website
  • func CreateWebsite(sling *sling.Sling) *Website
  • func (w *Website) Org(sid string) (*http.Response, *OrgResponse, error)
  • func (w *Website) Ships(params ShipQuery) (*http.Response, *ShipsResponse, error)
  • func (w *Website) Stats() (*http.Response, *StatsResponse, error)
  • func (w *Website) User(handle string) (*http.Response, *UserResponse, error)

Types

type OrgData

type OrgData struct {
	Archetype  string
	Banner     string
	Commitment string
	Focus      OrgDataFocusItems
	Headline   OrgDataHeadline
	Href       string
	Lang       string
	Logo       string
	Members    uint32
	Name       string
	Recruiting bool
	Roleplay   bool
	Sid        string
	Url        string
}

type OrgDataFocus

type OrgDataFocus struct {
	Image string
	Name  string
}

type OrgDataFocusItems

type OrgDataFocusItems struct {
	Primary   OrgDataFocus
	Secondary OrgDataFocus
}

type OrgDataHeadline

type OrgDataHeadline struct {
	Html      string
	Plaintext string
}

type OrgResponse

type OrgResponse struct {
	scapiUtils.BaseRes
	Data OrgData
}

type ShipQuery

type ShipQuery struct {
	Name           string `url:"name,omitempty"`
	Classification string `url:"classification,omitempty"`

	LengthMin int `url:"length_min,omitempty"`
	LengthMax int `url:"length_max,omitempty"`

	CrewMin int `url:"crew_min,omitempty"`
	CrewMax int `url:"crew_max,omitempty"`

	PriceMin int `url:"price_min,omitempty"`
	PriceMax int `url:"price_max,omitempty"`

	MassMin int `url:"mass_min,omitempty"`
	MassMax int `url:"mass_max,omitempty"`

	PageMax int `url:"page_max,omitempty"`

	Id int `url:"id,omitempty"`
}

type ShipsData

type ShipsData struct {
	AfterburnerSpeed       string `json:"afterburner_speed"`
	Beam                   string
	CargoCapacity          string
	ChassisId              string `json:"chassis_id"`
	Compiled               ShipsDataCompiled
	Description            string
	Focus                  string
	Height                 string
	Id                     string
	Length                 string
	Manufacturer           ShipsDataManufacturer
	ManufacturerId         string `json:"manufacturer_id"`
	Mass                   string
	MaxCrew                string `json:"max_crew"`
	Media                  []ShipsDataMedia
	MinCrew                string
	Name                   string
	PitchMax               string `json:"pitch_max"`
	Price                  float32
	ProductionNote         string `json:"production_note"`
	ProductionStatus       string `json:"production_status"`
	RollMax                string `json:"roll_max"`
	ScmSpeed               string `json:"scm_speed"`
	Size                   string
	TimeModified           string `json:"time_modified"`
	TimeModifiedUnfiltered string `json:"time_modified.unfiltered"`
	Type                   string
	Url                    string
	XAxisAccel             string `json:"xaxis_acceleration"`
	YawMax                 string `json:"yaw_max"`
	YAxisAccel             string `json:"yaxis_acceleration"`
	ZAxisAccel             string `json:"zaxis_acceleration"`
}

type ShipsDataCompiled

type ShipsDataCompiled struct {
}

type ShipsDataManufacturer

type ShipsDataManufacturer struct {
}

type ShipsDataMedia

type ShipsDataMedia struct {
	// missing items
	// not documented
	Id           string
	Images       ShipsDataMediaImages
	SourceUrl    string `json:"source_url"`
	TimeModified string `json:"time_modified"`
}

type ShipsDataMediaImages

type ShipsDataMediaImages struct {
	// missing items
	// not documented
	Avatar string
	Banner string
	Cover  string
}

type ShipsResponse

type ShipsResponse struct {
	scapiUtils.BaseRes
	Data []ShipsData
}

type StatsData

type StatsData struct {
	CurrentEtf  string `json:"current_etf"`
	CurrentLive string `json:"current_live"`
	CurrentPtu  string `json:"current_ptu"`
	Fans        uint32
	Fleet       uint32
	Funds       float64
}

type StatsResponse

type StatsResponse struct {
	scapiUtils.BaseRes
	Data StatsData
}

type UserData

type UserData struct {
	Organization UserDataOrg
	Profile      UserDataProfile
}

type UserDataOrg

type UserDataOrg struct {
	Image string
	Name  string
	Rank  string
	Sid   string
}

type UserDataProfile

type UserDataProfile struct {
	Badge      string
	BadgeImage string `json:"badge_image"`
	Display    string
	Enlisted   string
	Fluency    []string
	Handle     string
	Id         string
	Image      string
	Page       UserDataProfilePage
}

type UserDataProfilePage

type UserDataProfilePage struct {
	Title string
	Url   string
}

type UserResponse

type UserResponse struct {
	scapiUtils.BaseRes
	Data UserData
}

type Website

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

func CreateWebsite

func CreateWebsite(sling *sling.Sling) *Website

func (*Website) Org

func (w *Website) Org(sid string) (*http.Response, *OrgResponse, error)

func (*Website) Ships

func (w *Website) Ships(params ShipQuery) (*http.Response, *ShipsResponse, error)

func (*Website) Stats

func (w *Website) Stats() (*http.Response, *StatsResponse, error)

func (*Website) User

func (w *Website) User(handle string) (*http.Response, *UserResponse, error)