apiclient

Documentation

Index

• type APIClient
  • func New(client *http.Client, host, key string, port int, protocol string) *APIClient
  • func NewFromViper(client *http.Client) (*APIClient, error)
  • func (a *APIClient) DeleteAsset(assetID int64) (response responses.DeleteAssetResponse, err error)
  • func (a *APIClient) DeleteAssetAttribute(assetAttributeID int64) (response responses.DeleteAssetAttributeResponse, err error)
  • func (a *APIClient) DeleteAssetTarget(assetID int64) (response responses.DeleteAssetTargetResponse, err error)
  • func (a *APIClient) DeleteAssets(assetIDs []int64) (response responses.DeleteAssetsResponse, err error)
  • func (a *APIClient) DeleteAttribute(attributeID int64) (response responses.DeleteAttributeResponse, err error)
  • func (a *APIClient) GetAllAssets(options options.GetAllAssetsOptions) (response apiresponse.AssetsAllGET, err error)
  • func (a *APIClient) GetAsset(assetID int64) (response responses.GetAssetResponse, err error)
  • func (a *APIClient) GetAssetAttributes(assetID int64) (response responses.GetAssetAttributesResponse, err error)
  • func (a *APIClient) GetAssetDescription(assetID int64) (response responses.GetAssetDescriptionResponse, err error)
  • func (a *APIClient) GetAssetStatus(assetID int64) (response responses.GetAssetStatusResponse, err error)
  • func (a *APIClient) GetAssetTarget(assetID int64) (response responses.GetAssetTargetResponse, err error)
  • func (a *APIClient) GetAssetWithAttributes(assetID int64) (responses.GetAssetWithAttributesResponse, error)
  • func (a *APIClient) GetAssets(options options.GetAssetsOptions) (response responses.GetAssetsResponse, err error)
  • func (a *APIClient) GetAssetsAttributes() (response responses.GetAssetsAttributesResponse, err error)
  • func (a *APIClient) GetAssetsWithAttributes(deleted bool, pageSize, page int) (responses.GetAssetsWithAttributesResponse, error)
  • func (a *APIClient) GetAttribute(attributeID int64) (response responses.GetAttributeResponse, err error)
  • func (a *APIClient) GetAttributeAssets(attributeID int64) (response responses.GetAttributeAssetsResponse, err error)
  • func (a *APIClient) GetAttributes() (response responses.GetAttributesResponse, err error)
  • func (a *APIClient) GetEvents() (response responses.GetEventsResponse, err error)
  • func (a *APIClient) GetHealth() (response apiresponse.HealthGET, err error)
  • func (a *APIClient) InsertAssetAttributes(assetAttributes []models.AssetAttribute) (response responses.PostAssetAttributesResponse, err error)
  • func (a *APIClient) InsertAssets(assets []models.Asset) (response responses.PostAssetsResponse, err error)
  • func (a *APIClient) InsertAttributes(attributes []models.Attribute) (response responses.PostAttributesResponse, err error)
  • func (a *APIClient) RestoreAsset(assetID int64) (response responses.RestoreAssetResponse, err error)
  • func (a *APIClient) RestoreAttribute(attributeID int64) (response responses.RestoreAttributeResponse, err error)
  • func (a *APIClient) Seed() (response apiresponse.SeedPOST, err error)
  • func (a *APIClient) UpdateAssetDescription(assetID int64, description string) (response responses.PutAssetDescriptionResponse, err error)
  • func (a *APIClient) UpdateAssetStatus(assetID int64, status string) (response responses.PutAssetStatusResponse, err error)
  • func (a *APIClient) UpdateAssetTarget(assetID, target int64) (response responses.PutAssetTargetResponse, err error)

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 responses.DeleteAssetResponse, err error)

func (*APIClient) DeleteAssetAttribute

func (a *APIClient) DeleteAssetAttribute(assetAttributeID int64) (response responses.DeleteAssetAttributeResponse, err error)

func (*APIClient) DeleteAssetTarget

func (a *APIClient) DeleteAssetTarget(assetID int64) (response responses.DeleteAssetTargetResponse, err error)

func (*APIClient) DeleteAssets

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

func (*APIClient) DeleteAttribute

func (a *APIClient) DeleteAttribute(attributeID int64) (response responses.DeleteAttributeResponse, 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 responses.GetAssetResponse, err error)

func (*APIClient) GetAssetAttributes

func (a *APIClient) GetAssetAttributes(assetID int64) (response responses.GetAssetAttributesResponse, err error)

func (*APIClient) GetAssetDescription

func (a *APIClient) GetAssetDescription(assetID int64) (response responses.GetAssetDescriptionResponse, err error)

func (*APIClient) GetAssetStatus

func (a *APIClient) GetAssetStatus(assetID int64) (response responses.GetAssetStatusResponse, err error)

func (*APIClient) GetAssetTarget

func (a *APIClient) GetAssetTarget(assetID int64) (response responses.GetAssetTargetResponse, err error)

func (*APIClient) GetAssetWithAttributes

func (a *APIClient) GetAssetWithAttributes(assetID int64) (responses.GetAssetWithAttributesResponse, error)

func (*APIClient) GetAssets

func (a *APIClient) GetAssets(options options.GetAssetsOptions) (response responses.GetAssetsResponse, err error)

func (*APIClient) GetAssetsAttributes

func (a *APIClient) GetAssetsAttributes() (response responses.GetAssetsAttributesResponse, err error)

func (*APIClient) GetAssetsWithAttributes

func (a *APIClient) GetAssetsWithAttributes(deleted bool, pageSize, page int) (responses.GetAssetsWithAttributesResponse, error)

func (*APIClient) GetAttribute

func (a *APIClient) GetAttribute(attributeID int64) (response responses.GetAttributeResponse, err error)

func (*APIClient) GetAttributeAssets

func (a *APIClient) GetAttributeAssets(attributeID int64) (response responses.GetAttributeAssetsResponse, err error)

func (*APIClient) GetAttributes

func (a *APIClient) GetAttributes() (response responses.GetAttributesResponse, err error)

func (*APIClient) GetEvents

func (a *APIClient) GetEvents() (response responses.GetEventsResponse, 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 responses.PostAssetAttributesResponse, err error)

func (*APIClient) InsertAssets

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

func (*APIClient) InsertAttributes

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

func (*APIClient) RestoreAsset

func (a *APIClient) RestoreAsset(assetID int64) (response responses.RestoreAssetResponse, err error)

func (*APIClient) RestoreAttribute

func (a *APIClient) RestoreAttribute(attributeID int64) (response responses.RestoreAttributeResponse, 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 responses.PutAssetDescriptionResponse, err error)

func (*APIClient) UpdateAssetStatus

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

func (*APIClient) UpdateAssetTarget

func (a *APIClient) UpdateAssetTarget(assetID, target int64) (response responses.PutAssetTargetResponse, err error)