se2

Documentation

Index

• Constants
• type API
  • func New(endpoint string) *API
  • func (a *API) ForEnvironment(token string) (*EnvironmentAPI, error)
  • func (a *API) ForVerifiedEmail(email string, codeFn func() (string, error)) (*VerifiedAPI, error)
• type EnvironmentAPI
  • func (e *EnvironmentAPI) SendHeartbeat(heartbeat *types.HeartbeatRequest) error
• type VerifiedAPI
  • func (a *VerifiedAPI) CreateEnvironmentToken() (*types.CreateEnvironmentTokenResponse, error)

Constants

const (
	DefaultEndpoint = "https://api.suborbital.network"
)

Types

type API

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

API is an API client.

func New

func New(endpoint string) *API

func (*API) ForEnvironment

func (a *API) ForEnvironment(token string) (*EnvironmentAPI, error)

ForEnvironment returns an EnvironmentAPI scoped to the given token.

func (*API) ForVerifiedEmail

func (a *API) ForVerifiedEmail(email string, codeFn func() (string, error)) (*VerifiedAPI, error)

ForVerifiedEmail verifies an email address is correct and then creates a VerifiedAPI object.

type EnvironmentAPI

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

EnvironmentAPI is an API authenticated to a particular SE2 environment.

func (*EnvironmentAPI) SendHeartbeat

func (e *EnvironmentAPI) SendHeartbeat(heartbeat *types.HeartbeatRequest) error

SendHeartbeat sends a telemetry heartbeat request.

type VerifiedAPI

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

VerifiedAPI is an API that has an email-verified access level.

func (*VerifiedAPI) CreateEnvironmentToken

func (a *VerifiedAPI) CreateEnvironmentToken() (*types.CreateEnvironmentTokenResponse, error)

CreateEnvironmentToken creates an environment token.