inventory

Documentation

Index

• type AuthorizationKey
• type Client
  • func NewClient(baseURL, organizationID string, store *authutil.SessionStore, ...) *Client
  • func (c *Client) AssignOrganizationSSHKeyToSite(ctx context.Context, keyID, siteID string) error
  • func (c *Client) CreateOrganizationSSHKey(ctx context.Context, request OrganizationSSHKeyRequest) (*OrganizationSSHKey, error)
  • func (c *Client) CreateSiteAuthorizationKey(ctx context.Context, siteID string, request CreateAuthorizationKeyRequest) (*AuthorizationKey, error)
  • func (c *Client) CreateSiteEnvironmentVariable(ctx context.Context, siteID string, request EnvironmentVariableMutate) (*EnvironmentVariable, error)
  • func (c *Client) CreateSiteRedirect(ctx context.Context, siteID string, request RedirectMutate) (*Redirect, error)
  • func (c *Client) DeleteSiteEnvironmentVariable(ctx context.Context, siteID, variableID string) error
  • func (c *Client) DeleteSiteRedirect(ctx context.Context, siteID, redirectID string) error
  • func (c *Client) ListCurrentUserOrganizations(ctx context.Context) ([]CurrentUserOrganization, error)
  • func (c *Client) ListOrganizationSSHKeys(ctx context.Context) ([]OrganizationSSHKey, error)
  • func (c *Client) ListSiteAuthorizationKeys(ctx context.Context, siteID string) ([]AuthorizationKey, error)
  • func (c *Client) ListSiteEnvironmentVariables(ctx context.Context, siteID string) ([]EnvironmentVariable, error)
  • func (c *Client) ListSiteRedirects(ctx context.Context, siteID string) ([]Redirect, error)
  • func (c *Client) ListSites(ctx context.Context) ([]SiteServer, error)
  • func (c *Client) UnassignOrganizationSSHKeyFromSite(ctx context.Context, keyID, siteID string, deleteIfUnassigned bool) error
  • func (c *Client) UpdateSiteEnvironmentVariable(ctx context.Context, siteID, variableID string, ...) error
• type CreateAuthorizationKeyRequest
• type CurrentUserOrganization
• type EnvironmentVariable
• type EnvironmentVariableMutate
• type OrganizationSSHKey
• type OrganizationSSHKeyRequest
• type Redirect
• type RedirectMutate
• type SiteServer

Types

type AuthorizationKey

type AuthorizationKey struct {
	ID      string `json:"id"`
	Content string `json:"content"`
	Comment string `json:"comment"`
}

type Client

type Client struct {
	BaseURL    string
	OrgID      string
	Store      *authutil.SessionStore
	Clerk      *authutil.ClerkClient
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(baseURL, organizationID string, store *authutil.SessionStore, clerk *authutil.ClerkClient) *Client

func (*Client) AssignOrganizationSSHKeyToSite

func (c *Client) AssignOrganizationSSHKeyToSite(ctx context.Context, keyID, siteID string) error

func (*Client) CreateOrganizationSSHKey

func (c *Client) CreateOrganizationSSHKey(ctx context.Context, request OrganizationSSHKeyRequest) (*OrganizationSSHKey, error)

func (*Client) CreateSiteAuthorizationKey

func (c *Client) CreateSiteAuthorizationKey(ctx context.Context, siteID string, request CreateAuthorizationKeyRequest) (*AuthorizationKey, error)

func (*Client) CreateSiteEnvironmentVariable

func (c *Client) CreateSiteEnvironmentVariable(ctx context.Context, siteID string, request EnvironmentVariableMutate) (*EnvironmentVariable, error)

func (*Client) CreateSiteRedirect

func (c *Client) CreateSiteRedirect(ctx context.Context, siteID string, request RedirectMutate) (*Redirect, error)

func (*Client) DeleteSiteEnvironmentVariable

func (c *Client) DeleteSiteEnvironmentVariable(ctx context.Context, siteID, variableID string) error

func (*Client) DeleteSiteRedirect

func (c *Client) DeleteSiteRedirect(ctx context.Context, siteID, redirectID string) error

func (*Client) ListCurrentUserOrganizations

func (c *Client) ListCurrentUserOrganizations(ctx context.Context) ([]CurrentUserOrganization, error)

func (*Client) ListOrganizationSSHKeys

func (c *Client) ListOrganizationSSHKeys(ctx context.Context) ([]OrganizationSSHKey, error)

func (*Client) ListSiteAuthorizationKeys

func (c *Client) ListSiteAuthorizationKeys(ctx context.Context, siteID string) ([]AuthorizationKey, error)

func (*Client) ListSiteEnvironmentVariables

func (c *Client) ListSiteEnvironmentVariables(ctx context.Context, siteID string) ([]EnvironmentVariable, error)

func (*Client) ListSiteRedirects

func (c *Client) ListSiteRedirects(ctx context.Context, siteID string) ([]Redirect, error)

func (*Client) ListSites

func (c *Client) ListSites(ctx context.Context) ([]SiteServer, error)

func (*Client) UnassignOrganizationSSHKeyFromSite

func (c *Client) UnassignOrganizationSSHKeyFromSite(ctx context.Context, keyID, siteID string, deleteIfUnassigned bool) error

func (*Client) UpdateSiteEnvironmentVariable

func (c *Client) UpdateSiteEnvironmentVariable(ctx context.Context, siteID, variableID string, request EnvironmentVariableMutate) error

type CreateAuthorizationKeyRequest

type CreateAuthorizationKeyRequest struct {
	Content string `json:"content"`
	Comment string `json:"comment,omitempty"`
}

type CurrentUserOrganization

type CurrentUserOrganization struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Slug string `json:"slug"`
	Role string `json:"role"`
}

type EnvironmentVariable

type EnvironmentVariable struct {
	ID     string `json:"id"`
	Name   string `json:"name"`
	Value  string `json:"value"`
	Secret bool   `json:"secret"`
}

type EnvironmentVariableMutate

type EnvironmentVariableMutate struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Secret bool   `json:"secret"`
}

type OrganizationSSHKey

type OrganizationSSHKey struct {
	ID             string `json:"id"`
	Content        string `json:"content"`
	Comment        string `json:"comment"`
	ExpirationDate string `json:"expirationdate"`
	CreatedAtUTC   string `json:"createdatutc"`
	UpdatedAtUTC   string `json:"updatedatutc"`
	SiteIDs        []int  `json:"siteids"`
}

type OrganizationSSHKeyRequest

type OrganizationSSHKeyRequest struct {
	Content        string `json:"content"`
	Comment        string `json:"comment,omitempty"`
	ExpirationDate string `json:"expirationdate,omitempty"`
}

type Redirect

type Redirect struct {
	ID         string `json:"id"`
	Domain     string `json:"domain"`
	ReturnCode int    `json:"returncode"`
	Location   string `json:"location"`
	Value      string `json:"value"`
}

type RedirectMutate

type RedirectMutate struct {
	Domain     string `json:"domain"`
	ReturnCode int    `json:"returncode"`
	Location   string `json:"location"`
	Value      string `json:"value"`
}

type SiteServer

type SiteServer struct {
	ID         string `json:"id"`
	Username   string `json:"username"`
	MainDomain string `json:"maindomain"`
	ServerID   string `json:"serverid"`
	ServerName string `json:"servername"`
}