api

Documentation

Overview

Package api provides an API client sdk for making requests to a haul API server

Index

• type ApiClient
  • func NewApiClient(key, host, protocol string, port int) *ApiClient
  • func NewApiClientFromViper() (*ApiClient, error)
  • func (a *ApiClient) Call(method, route string, requestBody io.Reader, useKey bool) (*http.Response, error)
  • func (a *ApiClient) ClearAssetTarget(assetID int64) (responses.DeleteAssetTargetResponse, error)
  • func (a *ApiClient) DeleteAsset(assetID int64) (responses.DeleteAssetResponse, error)
  • func (a *ApiClient) GetAssetAttributes(assetID int64) (responses.GetAssetAttributesResponse, error)
  • func (a *ApiClient) GetAssetDescription(assetID int64) (responses.GetAssetDescriptionResponse, error)
  • func (a *ApiClient) GetAssetStatus(assetID int64) (responses.GetAssetStatusResponse, error)
  • func (a *ApiClient) GetAssetTarget(assetID int64) (responses.GetAssetTargetResponse, error)
  • func (a *ApiClient) GetAssets(deleted bool) (responses.GetAssetsResponse, error)
  • func (a *ApiClient) GetAssetsAttributes() (responses.GetAssetsAttributesResponse, error)
  • func (a *ApiClient) GetAttributes() (responses.GetAttributesResponse, error)
  • func (a *ApiClient) GetEvents() (responses.GetEventsResponse, error)
  • func (a *ApiClient) GetHealth() (responses.GetHealthcheckResponse, error)
  • func (a *ApiClient) InsertAssetAttributes(assetAttributes []models.AssetAttribute) (responses.PostAssetAttributesResponse, error)
  • func (a *ApiClient) InsertAssets(assets []models.Asset) (responses.PostAssetsResponse, error)
  • func (a *ApiClient) InsertAttributes(attributes []models.Attribute) (responses.PostAttributesResponse, error)
  • func (a *ApiClient) RestoreAsset(assetID int64) (responses.RestoreAssetResponse, error)
  • func (a *ApiClient) Seed() (responses.PostSeedResponse, error)
  • func (a *ApiClient) UpdateAssetDescription(assetID int64, description string) (responses.PutAssetDescriptionResponse, error)
  • func (a *ApiClient) UpdateAssetStatus(assetID int64, status string) (responses.PutAssetStatusResponse, error)
  • func (a *ApiClient) UpdateAssetTarget(assetID, target int64) (responses.PutAssetTargetResponse, error)

Types

type ApiClient

type ApiClient struct {
	Key      string
	Host     string
	Port     int
	Protocol string
}

func NewApiClient

func NewApiClient(key, host, protocol string, port int) *ApiClient

func NewApiClientFromViper

func NewApiClientFromViper() (*ApiClient, error)

func (*ApiClient) Call

func (a *ApiClient) Call(method, route string, requestBody io.Reader, useKey bool) (*http.Response, error)

func (*ApiClient) ClearAssetTarget

func (a *ApiClient) ClearAssetTarget(assetID int64) (responses.DeleteAssetTargetResponse, error)

func (*ApiClient) DeleteAsset

func (a *ApiClient) DeleteAsset(assetID int64) (responses.DeleteAssetResponse, error)

func (*ApiClient) GetAssetAttributes

func (a *ApiClient) GetAssetAttributes(assetID int64) (responses.GetAssetAttributesResponse, error)

func (*ApiClient) GetAssetDescription

func (a *ApiClient) GetAssetDescription(assetID int64) (responses.GetAssetDescriptionResponse, error)

func (*ApiClient) GetAssetStatus

func (a *ApiClient) GetAssetStatus(assetID int64) (responses.GetAssetStatusResponse, error)

func (*ApiClient) GetAssetTarget

func (a *ApiClient) GetAssetTarget(assetID int64) (responses.GetAssetTargetResponse, error)

func (*ApiClient) GetAssets

func (a *ApiClient) GetAssets(deleted bool) (responses.GetAssetsResponse, error)

func (*ApiClient) GetAssetsAttributes

func (a *ApiClient) GetAssetsAttributes() (responses.GetAssetsAttributesResponse, error)

func (*ApiClient) GetAttributes

func (a *ApiClient) GetAttributes() (responses.GetAttributesResponse, error)

func (*ApiClient) GetEvents

func (a *ApiClient) GetEvents() (responses.GetEventsResponse, error)

func (*ApiClient) GetHealth

func (a *ApiClient) GetHealth() (responses.GetHealthcheckResponse, error)

GetHealth allows checking for API server health

func (*ApiClient) InsertAssetAttributes

func (a *ApiClient) InsertAssetAttributes(assetAttributes []models.AssetAttribute) (responses.PostAssetAttributesResponse, error)

func (*ApiClient) InsertAssets

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

func (*ApiClient) InsertAttributes

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

func (*ApiClient) RestoreAsset

func (a *ApiClient) RestoreAsset(assetID int64) (responses.RestoreAssetResponse, error)

func (*ApiClient) Seed

func (a *ApiClient) Seed() (responses.PostSeedResponse, error)

Seed allows creating the required tables in the database

func (*ApiClient) UpdateAssetDescription

func (a *ApiClient) UpdateAssetDescription(assetID int64, description string) (responses.PutAssetDescriptionResponse, error)

func (*ApiClient) UpdateAssetStatus

func (a *ApiClient) UpdateAssetStatus(assetID int64, status string) (responses.PutAssetStatusResponse, error)

func (*ApiClient) UpdateAssetTarget

func (a *ApiClient) UpdateAssetTarget(assetID, target int64) (responses.PutAssetTargetResponse, error)