apiclient

package

v0.64.0 Latest Latest Go to latest Published: Sep 24, 2023 License: GPL-2.0 Imports: 10 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

codeberg.org/haulproject/haul

Links

Open Source Insights

Documentation ¶

Index ¶

type APIClient
- func New(client *http.Client, host, key string, port int, protocol string) *APIClient
- func NewFromViper(client *http.Client) (*APIClient, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type APIClient ¶

type APIClient struct {
	Voki *voki.Voki
}

func New ¶

func New(client *http.Client, host, key string, port int, protocol string) *APIClient

func NewFromViper ¶

func NewFromViper(client *http.Client) (*APIClient, error)

func (*APIClient) DeleteAsset ¶

func (a *APIClient) DeleteAsset(assetID int64) (response apiresponse.AssetDELETE, err error)

func (*APIClient) DeleteAssetAttribute ¶

func (a *APIClient) DeleteAssetAttribute(assetAttributeID int64) (response apiresponse.AssetAttributeDELETE, err error)

func (*APIClient) DeleteAssetTarget ¶

func (a *APIClient) DeleteAssetTarget(assetID int64) (response apiresponse.AssetTargetDELETE, err error)

func (*APIClient) DeleteAssets ¶

func (a *APIClient) DeleteAssets(assetIDs []int64) (response apiresponse.AssetsDELETE, err error)

func (*APIClient) DeleteAttribute ¶

func (a *APIClient) DeleteAttribute(attributeID int64) (response apiresponse.AttributeDELETE, err error)

func (*APIClient) GetAllAssets ¶

func (a *APIClient) GetAllAssets(options options.GetAllAssetsOptions) (response apiresponse.AssetsAllGET, err error)

func (*APIClient) GetAsset ¶

func (a *APIClient) GetAsset(assetID int64) (response apiresponse.AssetGET, err error)

func (*APIClient) GetAssetAttribute ¶ added in v0.64.0

func (a *APIClient) GetAssetAttribute(assetAttributeID int64) (r apiresponse.AssetAttributeGET, err error)

func (*APIClient) GetAssetAttributes ¶

func (a *APIClient) GetAssetAttributes(assetID int64) (response apiresponse.AssetAttributesGET, err error)

func (*APIClient) GetAssetDescription ¶

func (a *APIClient) GetAssetDescription(assetID int64) (response apiresponse.AssetDescriptionGET, err error)

func (*APIClient) GetAssetStatus ¶

func (a *APIClient) GetAssetStatus(assetID int64) (response apiresponse.AssetStatusGET, err error)

func (*APIClient) GetAssetTarget ¶

func (a *APIClient) GetAssetTarget(assetID int64) (response apiresponse.AssetTargetGET, err error)

func (*APIClient) GetAssetWithAttributes ¶

func (a *APIClient) GetAssetWithAttributes(assetID int64) (apiresponse.AssetAttributesGET, error)

func (*APIClient) GetAssets ¶

func (a *APIClient) GetAssets(options options.GetAssetsOptions) (response apiresponse.AssetsGET, err error)

func (*APIClient) GetAssetsAttributes ¶

func (a *APIClient) GetAssetsAttributes() (response apiresponse.AssetsAttributesGET, err error)

func (*APIClient) GetAssetsWithAttributes ¶

func (a *APIClient) GetAssetsWithAttributes(deleted bool, pageSize, page int) (apiresponse.AttributeAssetsGET, error)

func (*APIClient) GetAttribute ¶

func (a *APIClient) GetAttribute(attributeID int64) (response apiresponse.AttributeGET, err error)

func (*APIClient) GetAttributeAssets ¶

func (a *APIClient) GetAttributeAssets(attributeID int64) (response apiresponse.AttributeAssetsGET, err error)

func (*APIClient) GetAttributes ¶

func (a *APIClient) GetAttributes() (response apiresponse.AttributesGET, err error)

func (*APIClient) GetEvents ¶

func (a *APIClient) GetEvents() (response apiresponse.EventsGET, err error)

func (*APIClient) GetHealth ¶

func (a *APIClient) GetHealth() (response apiresponse.HealthGET, err error)

GetHealth allows checking for API server health

func (*APIClient) InsertAssetAttributes ¶

func (a *APIClient) InsertAssetAttributes(assetAttributes []models.AssetAttribute) (response apiresponse.AssetsAttributesPOST, err error)

func (*APIClient) InsertAssets ¶

func (a *APIClient) InsertAssets(assets []models.Asset) (response apiresponse.AssetsPOST, err error)

func (*APIClient) InsertAttributes ¶

func (a *APIClient) InsertAttributes(attributes []models.Attribute) (response apiresponse.AttributesPOST, err error)

func (*APIClient) RestoreAsset ¶

func (a *APIClient) RestoreAsset(assetID int64) (response apiresponse.AssetRestorePOST, err error)

func (*APIClient) RestoreAttribute ¶

func (a *APIClient) RestoreAttribute(attributeID int64) (response apiresponse.AttributeRestorePOST, err error)

func (*APIClient) Seed ¶

func (a *APIClient) Seed() (response apiresponse.SeedPOST, err error)

Seed allows creating the required tables in the database

func (*APIClient) UpdateAssetDescription ¶

func (a *APIClient) UpdateAssetDescription(assetID int64, description string) (response apiresponse.AssetDescriptionPUT, err error)

func (*APIClient) UpdateAssetStatus ¶

func (a *APIClient) UpdateAssetStatus(assetID int64, status string) (response apiresponse.AssetStatusPUT, err error)

func (*APIClient) UpdateAssetTarget ¶

func (a *APIClient) UpdateAssetTarget(assetID, target int64) (response apiresponse.AssetTargetPUT, err error)

Source Files ¶

View all Source files

apiclient.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL