api

Documentation

Index

• type AuthDetails
• type NitricApiClient
  • func NewNitricApiClient(apiUrl *url.URL, transformers ...transformer.RequestTransformer) *NitricApiClient
  • func (c *NitricApiClient) GetPluginManifest(team, lib, version, name string) (interface{}, error)
  • func (c *NitricApiClient) GetTemplate(teamSlug string, templateName string, version string) (*TemplateVersion, error)
  • func (c *NitricApiClient) GetTemplates() ([]Template, error)
  • func (c *NitricApiClient) GetWorkOSPublicDetails() (*WorkOSDetails, error)
• type Template
  • func (t *Template) String() string
• type TemplateVersion
  • func (t *TemplateVersion) String() string
• type WorkOSDetails

Types

type AuthDetails

type AuthDetails struct {
	WorkOS WorkOSDetails `json:"workos"`
}

type NitricApiClient

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

func NewNitricApiClient

func NewNitricApiClient(apiUrl *url.URL, transformers ...transformer.RequestTransformer) *NitricApiClient

func (*NitricApiClient) GetPluginManifest

func (c *NitricApiClient) GetPluginManifest(team, lib, version, name string) (interface{}, error)

FIXME: Because of the difference in fields between identity and resource plugins we need to return an interface

func (*NitricApiClient) GetTemplate

func (c *NitricApiClient) GetTemplate(teamSlug string, templateName string, version string) (*TemplateVersion, error)

GetTemplate gets a specific template by teamSlug, templateName and version version is optional, if it is not provided, the latest version will be returned

func (*NitricApiClient) GetTemplates

func (c *NitricApiClient) GetTemplates() ([]Template, error)

func (*NitricApiClient) GetWorkOSPublicDetails

func (c *NitricApiClient) GetWorkOSPublicDetails() (*WorkOSDetails, error)

type Template

type Template struct {
	Slug     string   `json:"slug"`
	TeamSlug string   `json:"teamSlug"`
	Versions []string `json:"versions"`
}

func (*Template) String

func (t *Template) String() string

type TemplateVersion

type TemplateVersion struct {
	TemplateSlug      string    `json:"templateSlug"`
	TeamSlug          string    `json:"teamSlug"`
	Version           string    `json:"version"`
	TemplateLibraryId string    `json:"templateLibraryId"`
	GitSource         string    `json:"gitSource"`
	Public            bool      `json:"public"`
	CreatedAt         time.Time `json:"createdAt"`
	UpdatedAt         time.Time `json:"updatedAt"`
}

func (*TemplateVersion) String

func (t *TemplateVersion) String() string

type WorkOSDetails

type WorkOSDetails struct {
	ClientID    string `json:"client_id"`
	ApiHostname string `json:"api_hostname"`
}