charts

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 25, 2023 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ChartSupport chartSupportNS

Functions

This section is empty.

Types

type Archive 

type Archive struct {
	Client *req.Client
}

func (*Archive) All 

func (archive *Archive) All(opts ...shared.PaginationParamsOption) ([]Chart, error)

func (*Archive) ListFirstPage added in v0.0.5 

func (archive *Archive) ListFirstPage(opts ...shared.PaginationParamsOption) (*shared.Page[Chart], error)

func (*Archive) ListPageAfter added in v0.0.5 

func (archive *Archive) ListPageAfter(id int64, opts ...shared.PaginationParamsOption) (*shared.Page[Chart], error)

func (*Archive) ListPageBefore added in v0.0.5 

func (archive *Archive) ListPageBefore(id int64, opts ...shared.PaginationParamsOption) (*shared.Page[Chart], error)

type Chart 

type Chart struct {
	Id                           int64                 `json:"id"`
	Key                          string                `json:"key"`
	Name                         string                `json:"name"`
	Status                       string                `json:"status"`
	Tags                         []string              `json:"tags"`
	PublishedVersionThumbnailUrl string                `json:"publishedVersionThumbnailUrl"`
	DraftVersionThumbnailUrl     string                `json:"draftVersionThumbnailUrl"`
	Events                       []events.Event        `json:"events"`
	Archived                     bool                  `json:"archived"`
	Validation                   ChartValidationResult `json:"validation"`
}

type ChartValidationResult 

type ChartValidationResult struct {
	Errors   []string `json:"errors"`
	Warnings []string `json:"warnings"`
}

type Charts 

type Charts struct {
	Client  *req.Client
	Archive *Archive
}

func (*Charts) AddCategory 

func (charts *Charts) AddCategory(chartKey string, category events.Category) error

func (*Charts) AddTag 

func (charts *Charts) AddTag(chartKey string, tag string) error

func (*Charts) Copy 

func (charts *Charts) Copy(chartKey string) (*Chart, error)

func (*Charts) CopyDraftVersion 

func (charts *Charts) CopyDraftVersion(chartKey string) (*Chart, error)

func (*Charts) CopyToWorkspace 

func (charts *Charts) CopyToWorkspace(chartKey string, targetWorkspaceKey string) (*Chart, error)

func (*Charts) Create 

func (charts *Charts) Create(params *CreateChartParams) (*Chart, error)

func (*Charts) DiscardDraftVersion 

func (charts *Charts) DiscardDraftVersion(chartKey string) error

func (*Charts) List 

func (charts *Charts) List() *shared.Lister[Chart]

func (*Charts) ListAll 

func (charts *Charts) ListAll() ([]Chart, error)

func (*Charts) ListAllTags 

func (charts *Charts) ListAllTags() ([]string, error)

func (*Charts) ListCategories 

func (charts *Charts) ListCategories(chartKey string) ([]events.Category, error)

func (*Charts) ListFirstPage 

func (charts *Charts) ListFirstPage(opts ...shared.PaginationParamsOption) (*shared.Page[Chart], error)

func (*Charts) ListPageAfter added in v0.0.5 

func (charts *Charts) ListPageAfter(id int64, opts ...shared.PaginationParamsOption) (*shared.Page[Chart], error)

func (*Charts) ListPageBefore added in v0.0.5 

func (charts *Charts) ListPageBefore(id int64, opts ...shared.PaginationParamsOption) (*shared.Page[Chart], error)

func (*Charts) MoveOutOfArchive 

func (charts *Charts) MoveOutOfArchive(chartKey string) error

func (*Charts) MoveToArchive 

func (charts *Charts) MoveToArchive(chartKey string) error

func (*Charts) PublishDraftVersion 

func (charts *Charts) PublishDraftVersion(chartKey string) error

func (*Charts) RemoveCategory 

func (charts *Charts) RemoveCategory(chartKey string, categoryKey events.CategoryKey) error

func (*Charts) RemoveTag 

func (charts *Charts) RemoveTag(chartKey string, tag string) error

func (*Charts) Retrieve 

func (charts *Charts) Retrieve(chartKey string) (*Chart, error)

func (*Charts) RetrieveDraftVersion 

func (charts *Charts) RetrieveDraftVersion(chartKey string) (map[string]interface{}, error)

func (*Charts) RetrieveDraftVersionThumbnail added in v0.0.5 

func (charts *Charts) RetrieveDraftVersionThumbnail(chartKey string) (*os.File, error)

func (*Charts) RetrievePublishedVersion 

func (charts *Charts) RetrievePublishedVersion(chartKey string) (map[string]interface{}, error)

func (*Charts) RetrievePublishedVersionThumbnail added in v0.0.5 

func (charts *Charts) RetrievePublishedVersionThumbnail(chartKey string) (*os.File, error)

func (*Charts) RetrieveWithEvents 

func (charts *Charts) RetrieveWithEvents(chartKey string) (*Chart, error)

func (*Charts) Update 

func (charts *Charts) Update(chartKey string, params *UpdateChartParams) error

func (*Charts) ValidateDraftVersion 

func (charts *Charts) ValidateDraftVersion(key string) (*ChartValidationResult, error)

func (*Charts) ValidatePublishedVersion 

func (charts *Charts) ValidatePublishedVersion(key string) (*ChartValidationResult, error)

type CreateChartParams 

type CreateChartParams struct {
	Name       string            `json:"name,omitempty"`
	VenueType  string            `json:"venueType,omitempty"`
	Categories []events.Category `json:"categories,omitempty"`
}

type Tags 

type Tags struct {
	Tags []string `json:"tags"`
}

type UpdateChartParams 

type UpdateChartParams struct {
	Name       string            `json:"name,omitempty"`
	Categories []events.Category `json:"categories,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.