workspaces

Documentation

Index

• Variables
• type CreateWorkspaceParams
• type UpdateWorkspaceParams
• type Workspace
• type WorkspaceStatus
• type Workspaces
  • func (workspaces Workspaces) Activate(key string) error
  • func (workspaces Workspaces) CreateProductionWorkspace(name string) (*Workspace, error)
  • func (workspaces Workspaces) CreateTestWorkspace(name string) (*Workspace, error)
  • func (workspaces Workspaces) Deactivate(key string) error
  • func (workspaces Workspaces) ListAll(status WorkspaceStatus, opts ...shared.PaginationParamsOption) ([]Workspace, error)
  • func (workspaces Workspaces) ListFirstPage(status WorkspaceStatus, opts ...shared.PaginationParamsOption) (*shared.Page[Workspace], error)
  • func (workspaces Workspaces) ListPageAfter(id int64, status WorkspaceStatus, opts ...shared.PaginationParamsOption) (*shared.Page[Workspace], error)
  • func (workspaces Workspaces) ListPageBefore(id int64, status WorkspaceStatus, opts ...shared.PaginationParamsOption) (*shared.Page[Workspace], error)
  • func (workspaces Workspaces) RegenerateSecretKey(key string) (*string, error)
  • func (workspaces Workspaces) Retrieve(key string) (*Workspace, error)
  • func (workspaces Workspaces) SetDefaultWorkspace(key string) error
  • func (workspaces Workspaces) Update(key string, Name string) error

Variables

var WorkspaceSupport workspaceNS

Types

type CreateWorkspaceParams

type CreateWorkspaceParams struct {
	Name   string `json:"name"`
	IsTest bool   `json:"isTest"`
}

type UpdateWorkspaceParams

type UpdateWorkspaceParams struct {
	Name string `json:"name"`
}

type Workspace

type Workspace struct {
	Name      string `json:"name"`
	Key       string `json:"key"`
	SecretKey string `json:"secretKey"`
	IsTest    bool   `json:"isTest"`
	IsActive  bool   `json:"isActive"`
	IsDefault bool   `json:"isDefault"`
}

type WorkspaceStatus

type WorkspaceStatus string

const (
	All      WorkspaceStatus = ""
	Active   WorkspaceStatus = "/active"
	Inactive WorkspaceStatus = "/inactive"
)

type Workspaces

type Workspaces struct {
	Client *req.Client
}

func (Workspaces) Activate

func (workspaces Workspaces) Activate(key string) error

func (Workspaces) CreateProductionWorkspace

func (workspaces Workspaces) CreateProductionWorkspace(name string) (*Workspace, error)

func (Workspaces) CreateTestWorkspace

func (workspaces Workspaces) CreateTestWorkspace(name string) (*Workspace, error)

func (Workspaces) Deactivate

func (workspaces Workspaces) Deactivate(key string) error

func (Workspaces) ListAll

func (workspaces Workspaces) ListAll(status WorkspaceStatus, opts ...shared.PaginationParamsOption) ([]Workspace, error)

func (Workspaces) ListFirstPage

func (workspaces Workspaces) ListFirstPage(status WorkspaceStatus, opts ...shared.PaginationParamsOption) (*shared.Page[Workspace], error)

func (Workspaces) ListPageAfter

func (workspaces Workspaces) ListPageAfter(id int64, status WorkspaceStatus, opts ...shared.PaginationParamsOption) (*shared.Page[Workspace], error)

func (Workspaces) ListPageBefore

func (workspaces Workspaces) ListPageBefore(id int64, status WorkspaceStatus, opts ...shared.PaginationParamsOption) (*shared.Page[Workspace], error)

func (Workspaces) RegenerateSecretKey

func (workspaces Workspaces) RegenerateSecretKey(key string) (*string, error)

func (Workspaces) Retrieve

func (workspaces Workspaces) Retrieve(key string) (*Workspace, error)

func (Workspaces) SetDefaultWorkspace

func (workspaces Workspaces) SetDefaultWorkspace(key string) error

func (Workspaces) Update

func (workspaces Workspaces) Update(key string, Name string) error