api

package

v0.6.3 Latest Latest Go to latest Published: Jun 11, 2026 License: MPL-2.0 Imports: 18 Imported by: 0

Details

This section is empty.

This section is empty.

func NewTFEAPI(
	client tfeClient,
	responder *tfeapi.Responder,
	authorizer *authz.Authorizer,
) *tfe

type API struct {
	*tfeapi.Responder
	Client apiClient
}

func (a *API) AddHandlers(r *mux.Router)

type Client struct {
	*otfhttp.Client
}

func (c *Client) GetWorkspace(ctx context.Context, workspaceID resource.TfeID) (*workspace.Workspace, error)

func (c *Client) GetWorkspaceByName(ctx context.Context, organization organization.Name, name string) (*workspace.Workspace, error)

func (c *Client) ListWorkspaces(ctx context.Context, opts workspace.ListOptions) (*resource.Page[*workspace.Workspace], error)

func (c *Client) Lock(ctx context.Context, workspaceID resource.TfeID, runID *resource.TfeID) (*workspace.Workspace, error)

func (c *Client) Unlock(ctx context.Context, workspaceID resource.TfeID, runID *resource.TfeID, force bool) (*workspace.Workspace, error)

func (c *Client) UpdateWorkspace(ctx context.Context, workspaceID resource.TfeID, opts workspace.UpdateOptions) (*workspace.Workspace, error)

type WorkspaceClient = Client

Alias client to permit embedding it with other clients in a struct without a name clash.