client

Documentation

Index

• Variables
• type AuthorizedRoundTripper
  • func (a *AuthorizedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type Client
  • func New() (Client, error)
  • func NewGuest() Client
• type ErrorResponse
• type GeneratedRunbook
• type GuestRoundTripper
  • func (g *GuestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type RecordedCommand
• type Runbook
  • func (rb *Runbook) Commands() []string
• type Step

Variables

var ErrCannotUseGuest = errors.New("cannot use guest client for this operation")

var ErrInvalidClient = errors.New("invalid client")

Types

type AuthorizedRoundTripper

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

func (*AuthorizedRoundTripper) RoundTrip

func (a *AuthorizedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type Client

type Client interface {
	WhoAmI(ctx context.Context) (string, error)
	GenerateRunbookV2(ctx context.Context, commands []RecordedCommand) (*GeneratedRunbook, error)
	// Deprecated. Use GenerateRunbookV2 instead
	GenerateRunbook(ctx context.Context, commands []string) (*GeneratedRunbook, error)
	RunbookByID(ctx context.Context, id string) (*Runbook, error)
}

func New

func New() (Client, error)

func NewGuest

func NewGuest() Client

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

type GeneratedRunbook

type GeneratedRunbook struct {
	Runbook Runbook `json:"runbook"`
	URL     string  `json:"url"`
}

type GuestRoundTripper

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

func (*GuestRoundTripper) RoundTrip

func (g *GuestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type RecordedCommand

type RecordedCommand struct {
	Command string `json:"command"`
	Prompt  string `json:"prompt,omitempty"`
}

type Runbook

type Runbook struct {
	RunbookID string `json:"runbook_id"`
	Title     string `json:"title"`
	Steps     []Step `json:"steps"`
}

func (*Runbook) Commands

func (rb *Runbook) Commands() []string

type Step

type Step struct {
	Description string `json:"description"`
	Command     string `json:"command"`
}