Help us shape the future of Go! Take the 2026 Go Developer Survey

fixtureclient

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package fixtureclient is the Go client of the API at /api/v1 (D19, D67), generated from its livewire registry: build a Client with New and call one method per read, mutation, upload and export.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BatchChargePart 

func BatchChargePart(parameters ChargePartParameters, body billing.Record) (livewire.BatchCall, error)

BatchChargePart is a ChargePart call as one call of a batch (D47, Client.Batch).

func BatchCreatePart 

func BatchCreatePart(body fixture.CreatePart) (livewire.BatchCall, error)

BatchCreatePart is a CreatePart call as one call of a batch (D47, Client.Batch).

func BatchDeletePart 

func BatchDeletePart(parameters DeletePartParameters) (livewire.BatchCall, error)

BatchDeletePart is a DeletePart call as one call of a batch (D47, Client.Batch).

func BatchRebuild 

func BatchRebuild() (livewire.BatchCall, error)

BatchRebuild is a Rebuild call as one call of a batch (D47, Client.Batch).

func BatchRenamePart 

func BatchRenamePart(parameters RenamePartParameters, body fixture.RenamePart) (livewire.BatchCall, error)

BatchRenamePart is a RenamePart call as one call of a batch (D47, Client.Batch).

func HistoryActorContains 

func HistoryActorContains(value string) client.Node[HistoryField]

HistoryActorContains is the condition actor contains.

func HistoryActorEqual 

func HistoryActorEqual(value string) client.Node[HistoryField]

HistoryActorEqual is the condition actor eq.

func HistoryActorIn 

func HistoryActorIn(values ...string) client.Node[HistoryField]

HistoryActorIn is the condition actor in.

func HistoryActorIsNull 

func HistoryActorIsNull(value bool) client.Node[HistoryField]

HistoryActorIsNull is the condition actor isNull.

func HistoryActorNotEqual 

func HistoryActorNotEqual(value string) client.Node[HistoryField]

HistoryActorNotEqual is the condition actor ne.

func HistoryActorNotIn 

func HistoryActorNotIn(values ...string) client.Node[HistoryField]

HistoryActorNotIn is the condition actor notIn.

func HistoryActorStartsWith 

func HistoryActorStartsWith(value string) client.Node[HistoryField]

HistoryActorStartsWith is the condition actor startsWith.

func HistoryIDEqual 

func HistoryIDEqual(value int64) client.Node[HistoryField]

HistoryIDEqual is the condition id eq.

func HistoryIDGreater 

func HistoryIDGreater(value int64) client.Node[HistoryField]

HistoryIDGreater is the condition id gt.

func HistoryIDGreaterOrEqual 

func HistoryIDGreaterOrEqual(value int64) client.Node[HistoryField]

HistoryIDGreaterOrEqual is the condition id gte.

func HistoryIDIn 

func HistoryIDIn(values ...int64) client.Node[HistoryField]

HistoryIDIn is the condition id in.

func HistoryIDIsNull 

func HistoryIDIsNull(value bool) client.Node[HistoryField]

HistoryIDIsNull is the condition id isNull.

func HistoryIDLess 

func HistoryIDLess(value int64) client.Node[HistoryField]

HistoryIDLess is the condition id lt.

func HistoryIDLessOrEqual 

func HistoryIDLessOrEqual(value int64) client.Node[HistoryField]

HistoryIDLessOrEqual is the condition id lte.

func HistoryIDNotEqual 

func HistoryIDNotEqual(value int64) client.Node[HistoryField]

HistoryIDNotEqual is the condition id ne.

func HistoryIDNotIn 

func HistoryIDNotIn(values ...int64) client.Node[HistoryField]

HistoryIDNotIn is the condition id notIn.

func HistoryMutationContains 

func HistoryMutationContains(value string) client.Node[HistoryField]

HistoryMutationContains is the condition mutation contains.

func HistoryMutationEqual 

func HistoryMutationEqual(value string) client.Node[HistoryField]

HistoryMutationEqual is the condition mutation eq.

func HistoryMutationIn 

func HistoryMutationIn(values ...string) client.Node[HistoryField]

HistoryMutationIn is the condition mutation in.

func HistoryMutationIsNull 

func HistoryMutationIsNull(value bool) client.Node[HistoryField]

HistoryMutationIsNull is the condition mutation isNull.

func HistoryMutationNotEqual 

func HistoryMutationNotEqual(value string) client.Node[HistoryField]

HistoryMutationNotEqual is the condition mutation ne.

func HistoryMutationNotIn 

func HistoryMutationNotIn(values ...string) client.Node[HistoryField]

HistoryMutationNotIn is the condition mutation notIn.

func HistoryMutationStartsWith 

func HistoryMutationStartsWith(value string) client.Node[HistoryField]

HistoryMutationStartsWith is the condition mutation startsWith.

func HistoryOperationEqual 

func HistoryOperationEqual(value HistoryOperation) client.Node[HistoryField]

HistoryOperationEqual is the condition operation eq.

func HistoryOperationIn 

func HistoryOperationIn(values ...HistoryOperation) client.Node[HistoryField]

HistoryOperationIn is the condition operation in.

func HistoryOperationIsNull 

func HistoryOperationIsNull(value bool) client.Node[HistoryField]

HistoryOperationIsNull is the condition operation isNull.

func HistoryOperationNotEqual 

func HistoryOperationNotEqual(value HistoryOperation) client.Node[HistoryField]

HistoryOperationNotEqual is the condition operation ne.

func HistoryOperationNotIn 

func HistoryOperationNotIn(values ...HistoryOperation) client.Node[HistoryField]

HistoryOperationNotIn is the condition operation notIn.

func HistoryRealActorContains 

func HistoryRealActorContains(value string) client.Node[HistoryField]

HistoryRealActorContains is the condition realActor contains.

func HistoryRealActorEqual 

func HistoryRealActorEqual(value string) client.Node[HistoryField]

HistoryRealActorEqual is the condition realActor eq.

func HistoryRealActorIn 

func HistoryRealActorIn(values ...string) client.Node[HistoryField]

HistoryRealActorIn is the condition realActor in.

func HistoryRealActorIsNull 

func HistoryRealActorIsNull(value bool) client.Node[HistoryField]

HistoryRealActorIsNull is the condition realActor isNull.

func HistoryRealActorNotEqual 

func HistoryRealActorNotEqual(value string) client.Node[HistoryField]

HistoryRealActorNotEqual is the condition realActor ne.

func HistoryRealActorNotIn 

func HistoryRealActorNotIn(values ...string) client.Node[HistoryField]

HistoryRealActorNotIn is the condition realActor notIn.

func HistoryRealActorStartsWith 

func HistoryRealActorStartsWith(value string) client.Node[HistoryField]

HistoryRealActorStartsWith is the condition realActor startsWith.

func HistoryRequestIDContains 

func HistoryRequestIDContains(value string) client.Node[HistoryField]

HistoryRequestIDContains is the condition requestId contains.

func HistoryRequestIDEqual 

func HistoryRequestIDEqual(value string) client.Node[HistoryField]

HistoryRequestIDEqual is the condition requestId eq.

func HistoryRequestIDIn 

func HistoryRequestIDIn(values ...string) client.Node[HistoryField]

HistoryRequestIDIn is the condition requestId in.

func HistoryRequestIDIsNull 

func HistoryRequestIDIsNull(value bool) client.Node[HistoryField]

HistoryRequestIDIsNull is the condition requestId isNull.

func HistoryRequestIDNotEqual 

func HistoryRequestIDNotEqual(value string) client.Node[HistoryField]

HistoryRequestIDNotEqual is the condition requestId ne.

func HistoryRequestIDNotIn 

func HistoryRequestIDNotIn(values ...string) client.Node[HistoryField]

HistoryRequestIDNotIn is the condition requestId notIn.

func HistoryRequestIDStartsWith 

func HistoryRequestIDStartsWith(value string) client.Node[HistoryField]

HistoryRequestIDStartsWith is the condition requestId startsWith.

func HistoryValidFromEqual 

func HistoryValidFromEqual(value client.Time) client.Node[HistoryField]

HistoryValidFromEqual is the condition validFrom eq.

func HistoryValidFromGreater 

func HistoryValidFromGreater(value client.Time) client.Node[HistoryField]

HistoryValidFromGreater is the condition validFrom gt.

func HistoryValidFromGreaterOrEqual 

func HistoryValidFromGreaterOrEqual(value client.Time) client.Node[HistoryField]

HistoryValidFromGreaterOrEqual is the condition validFrom gte.

func HistoryValidFromIn 

func HistoryValidFromIn(values ...client.Time) client.Node[HistoryField]

HistoryValidFromIn is the condition validFrom in.

func HistoryValidFromIsNull 

func HistoryValidFromIsNull(value bool) client.Node[HistoryField]

HistoryValidFromIsNull is the condition validFrom isNull.

func HistoryValidFromLess 

func HistoryValidFromLess(value client.Time) client.Node[HistoryField]

HistoryValidFromLess is the condition validFrom lt.

func HistoryValidFromLessOrEqual 

func HistoryValidFromLessOrEqual(value client.Time) client.Node[HistoryField]

HistoryValidFromLessOrEqual is the condition validFrom lte.

func HistoryValidFromNotEqual 

func HistoryValidFromNotEqual(value client.Time) client.Node[HistoryField]

HistoryValidFromNotEqual is the condition validFrom ne.

func HistoryValidFromNotIn 

func HistoryValidFromNotIn(values ...client.Time) client.Node[HistoryField]

HistoryValidFromNotIn is the condition validFrom notIn.

func HistoryValidToEqual 

func HistoryValidToEqual(value client.Time) client.Node[HistoryField]

HistoryValidToEqual is the condition validTo eq.

func HistoryValidToGreater 

func HistoryValidToGreater(value client.Time) client.Node[HistoryField]

HistoryValidToGreater is the condition validTo gt.

func HistoryValidToGreaterOrEqual 

func HistoryValidToGreaterOrEqual(value client.Time) client.Node[HistoryField]

HistoryValidToGreaterOrEqual is the condition validTo gte.

func HistoryValidToIn 

func HistoryValidToIn(values ...client.Time) client.Node[HistoryField]

HistoryValidToIn is the condition validTo in.

func HistoryValidToIsNull 

func HistoryValidToIsNull(value bool) client.Node[HistoryField]

HistoryValidToIsNull is the condition validTo isNull.

func HistoryValidToLess 

func HistoryValidToLess(value client.Time) client.Node[HistoryField]

HistoryValidToLess is the condition validTo lt.

func HistoryValidToLessOrEqual 

func HistoryValidToLessOrEqual(value client.Time) client.Node[HistoryField]

HistoryValidToLessOrEqual is the condition validTo lte.

func HistoryValidToNotEqual 

func HistoryValidToNotEqual(value client.Time) client.Node[HistoryField]

HistoryValidToNotEqual is the condition validTo ne.

func HistoryValidToNotIn 

func HistoryValidToNotIn(values ...client.Time) client.Node[HistoryField]

HistoryValidToNotIn is the condition validTo notIn.

func NotesIDEqual 

func NotesIDEqual(value int64) client.Node[NotesField]

NotesIDEqual is the condition id eq.

func NotesIDGreater 

func NotesIDGreater(value int64) client.Node[NotesField]

NotesIDGreater is the condition id gt.

func NotesIDGreaterOrEqual 

func NotesIDGreaterOrEqual(value int64) client.Node[NotesField]

NotesIDGreaterOrEqual is the condition id gte.

func NotesIDIn 

func NotesIDIn(values ...int64) client.Node[NotesField]

NotesIDIn is the condition id in.

func NotesIDIsNull 

func NotesIDIsNull(value bool) client.Node[NotesField]

NotesIDIsNull is the condition id isNull.

func NotesIDLess 

func NotesIDLess(value int64) client.Node[NotesField]

NotesIDLess is the condition id lt.

func NotesIDLessOrEqual 

func NotesIDLessOrEqual(value int64) client.Node[NotesField]

NotesIDLessOrEqual is the condition id lte.

func NotesIDNotEqual 

func NotesIDNotEqual(value int64) client.Node[NotesField]

NotesIDNotEqual is the condition id ne.

func NotesIDNotIn 

func NotesIDNotIn(values ...int64) client.Node[NotesField]

NotesIDNotIn is the condition id notIn.

func PartsCreatedAtEqual 

func PartsCreatedAtEqual(value client.Time) client.Node[PartsField]

PartsCreatedAtEqual is the condition createdAt eq.

func PartsCreatedAtGreater 

func PartsCreatedAtGreater(value client.Time) client.Node[PartsField]

PartsCreatedAtGreater is the condition createdAt gt.

func PartsCreatedAtGreaterOrEqual 

func PartsCreatedAtGreaterOrEqual(value client.Time) client.Node[PartsField]

PartsCreatedAtGreaterOrEqual is the condition createdAt gte.

func PartsCreatedAtIn 

func PartsCreatedAtIn(values ...client.Time) client.Node[PartsField]

PartsCreatedAtIn is the condition createdAt in.

func PartsCreatedAtIsNull 

func PartsCreatedAtIsNull(value bool) client.Node[PartsField]

PartsCreatedAtIsNull is the condition createdAt isNull.

func PartsCreatedAtLess 

func PartsCreatedAtLess(value client.Time) client.Node[PartsField]

PartsCreatedAtLess is the condition createdAt lt.

func PartsCreatedAtLessOrEqual 

func PartsCreatedAtLessOrEqual(value client.Time) client.Node[PartsField]

PartsCreatedAtLessOrEqual is the condition createdAt lte.

func PartsCreatedAtNotEqual 

func PartsCreatedAtNotEqual(value client.Time) client.Node[PartsField]

PartsCreatedAtNotEqual is the condition createdAt ne.

func PartsCreatedAtNotIn 

func PartsCreatedAtNotIn(values ...client.Time) client.Node[PartsField]

PartsCreatedAtNotIn is the condition createdAt notIn.

func PartsFlagEqual 

func PartsFlagEqual(value bool) client.Node[PartsField]

PartsFlagEqual is the condition flag eq.

func PartsFlagIsNull 

func PartsFlagIsNull(value bool) client.Node[PartsField]

PartsFlagIsNull is the condition flag isNull.

func PartsFlagNotEqual 

func PartsFlagNotEqual(value bool) client.Node[PartsField]

PartsFlagNotEqual is the condition flag ne.

func PartsIDEqual 

func PartsIDEqual(value uuid.UUID) client.Node[PartsField]

PartsIDEqual is the condition id eq.

func PartsIDIn 

func PartsIDIn(values ...uuid.UUID) client.Node[PartsField]

PartsIDIn is the condition id in.

func PartsIDIsNull 

func PartsIDIsNull(value bool) client.Node[PartsField]

PartsIDIsNull is the condition id isNull.

func PartsIDNotEqual 

func PartsIDNotEqual(value uuid.UUID) client.Node[PartsField]

PartsIDNotEqual is the condition id ne.

func PartsIDNotIn 

func PartsIDNotIn(values ...uuid.UUID) client.Node[PartsField]

PartsIDNotIn is the condition id notIn.

func PartsKindEqual 

func PartsKindEqual(value PartsKind) client.Node[PartsField]

PartsKindEqual is the condition kind eq.

func PartsKindIn 

func PartsKindIn(values ...PartsKind) client.Node[PartsField]

PartsKindIn is the condition kind in.

func PartsKindIsNull 

func PartsKindIsNull(value bool) client.Node[PartsField]

PartsKindIsNull is the condition kind isNull.

func PartsKindNotEqual 

func PartsKindNotEqual(value PartsKind) client.Node[PartsField]

PartsKindNotEqual is the condition kind ne.

func PartsKindNotIn 

func PartsKindNotIn(values ...PartsKind) client.Node[PartsField]

PartsKindNotIn is the condition kind notIn.

func PartsNameContains 

func PartsNameContains(value string) client.Node[PartsField]

PartsNameContains is the condition name contains.

func PartsNameEqual 

func PartsNameEqual(value string) client.Node[PartsField]

PartsNameEqual is the condition name eq.

func PartsNameIn 

func PartsNameIn(values ...string) client.Node[PartsField]

PartsNameIn is the condition name in.

func PartsNameIsNull 

func PartsNameIsNull(value bool) client.Node[PartsField]

PartsNameIsNull is the condition name isNull.

func PartsNameNotEqual 

func PartsNameNotEqual(value string) client.Node[PartsField]

PartsNameNotEqual is the condition name ne.

func PartsNameNotIn 

func PartsNameNotIn(values ...string) client.Node[PartsField]

PartsNameNotIn is the condition name notIn.

func PartsNameStartsWith 

func PartsNameStartsWith(value string) client.Node[PartsField]

PartsNameStartsWith is the condition name startsWith.

func PartsPriceEqual 

func PartsPriceEqual(value float64) client.Node[PartsField]

PartsPriceEqual is the condition price eq.

func PartsPriceGreater 

func PartsPriceGreater(value float64) client.Node[PartsField]

PartsPriceGreater is the condition price gt.

func PartsPriceGreaterOrEqual 

func PartsPriceGreaterOrEqual(value float64) client.Node[PartsField]

PartsPriceGreaterOrEqual is the condition price gte.

func PartsPriceIn 

func PartsPriceIn(values ...float64) client.Node[PartsField]

PartsPriceIn is the condition price in.

func PartsPriceIsNull 

func PartsPriceIsNull(value bool) client.Node[PartsField]

PartsPriceIsNull is the condition price isNull.

func PartsPriceLess 

func PartsPriceLess(value float64) client.Node[PartsField]

PartsPriceLess is the condition price lt.

func PartsPriceLessOrEqual 

func PartsPriceLessOrEqual(value float64) client.Node[PartsField]

PartsPriceLessOrEqual is the condition price lte.

func PartsPriceNotEqual 

func PartsPriceNotEqual(value float64) client.Node[PartsField]

PartsPriceNotEqual is the condition price ne.

func PartsPriceNotIn 

func PartsPriceNotIn(values ...float64) client.Node[PartsField]

PartsPriceNotIn is the condition price notIn.

func PartsSecretContains 

func PartsSecretContains(value string) client.Node[PartsField]

PartsSecretContains is the condition secret contains.

func PartsSecretEqual 

func PartsSecretEqual(value string) client.Node[PartsField]

PartsSecretEqual is the condition secret eq.

func PartsSecretIn 

func PartsSecretIn(values ...string) client.Node[PartsField]

PartsSecretIn is the condition secret in.

func PartsSecretIsNull 

func PartsSecretIsNull(value bool) client.Node[PartsField]

PartsSecretIsNull is the condition secret isNull.

func PartsSecretNotEqual 

func PartsSecretNotEqual(value string) client.Node[PartsField]

PartsSecretNotEqual is the condition secret ne.

func PartsSecretNotIn 

func PartsSecretNotIn(values ...string) client.Node[PartsField]

PartsSecretNotIn is the condition secret notIn.

func PartsSecretStartsWith 

func PartsSecretStartsWith(value string) client.Node[PartsField]

PartsSecretStartsWith is the condition secret startsWith.

func PartsTagsHas 

func PartsTagsHas(value string) client.Node[PartsField]

PartsTagsHas is the condition tags has.

func PartsTagsHasAll 

func PartsTagsHasAll(values ...string) client.Node[PartsField]

PartsTagsHasAll is the condition tags hasAll.

func PartsTagsHasAny 

func PartsTagsHasAny(values ...string) client.Node[PartsField]

PartsTagsHasAny is the condition tags hasAny.

func PartsTagsIsEmpty 

func PartsTagsIsEmpty(value bool) client.Node[PartsField]

PartsTagsIsEmpty is the condition tags isEmpty.

func PartsVersionEqual 

func PartsVersionEqual(value int64) client.Node[PartsField]

PartsVersionEqual is the condition version eq.

func PartsVersionGreater 

func PartsVersionGreater(value int64) client.Node[PartsField]

PartsVersionGreater is the condition version gt.

func PartsVersionGreaterOrEqual 

func PartsVersionGreaterOrEqual(value int64) client.Node[PartsField]

PartsVersionGreaterOrEqual is the condition version gte.

func PartsVersionIn 

func PartsVersionIn(values ...int64) client.Node[PartsField]

PartsVersionIn is the condition version in.

func PartsVersionIsNull 

func PartsVersionIsNull(value bool) client.Node[PartsField]

PartsVersionIsNull is the condition version isNull.

func PartsVersionLess 

func PartsVersionLess(value int64) client.Node[PartsField]

PartsVersionLess is the condition version lt.

func PartsVersionLessOrEqual 

func PartsVersionLessOrEqual(value int64) client.Node[PartsField]

PartsVersionLessOrEqual is the condition version lte.

func PartsVersionNotEqual 

func PartsVersionNotEqual(value int64) client.Node[PartsField]

PartsVersionNotEqual is the condition version ne.

func PartsVersionNotIn 

func PartsVersionNotIn(values ...int64) client.Node[PartsField]

PartsVersionNotIn is the condition version notIn.

func PrepareCreatePart 

func PrepareCreatePart(body fixture.CreatePart) (fixture.CreatePart, client.CallOptions)

PrepareCreatePart prepares a CreatePart call to send again (D16, D18): the body with its id (a fresh UUID v7 when it has none) and options with a fresh Idempotency-Key; pass both to every attempt.

Types

type ChargePartParameters 

type ChargePartParameters struct {
	// Invoice: query parameter.
	Invoice string
}

ChargePartParameters are the parameters of ChargePart.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is the client of the API: its REST routes and one socket for every subscription, as the identity of one API key (D20). It is safe for concurrent use.

func New 

func New(options *client.Options) (*Client, error)

New validates and copies options (DES-001): BaseURL is the API's URL with its base path /api/v1, APIKey the key the server resolves.

func (*Client) Batch 

func (c *Client) Batch(ctx context.Context, calls []livewire.BatchCall, options *client.CallOptions) ([]livewire.BatchResult, error)

Batch runs several mutations in one transaction, all or nothing (POST /batch, D33, D47); build the calls with the Batch functions of the mutations.

func (*Client) ChargePart 

func (c *Client) ChargePart(ctx context.Context, parameters ChargePartParameters, body billing.Record, options *client.CallOptions) (*billing.Part, error)

ChargePart calls POST /api/v1/billing/charges, answering 200, under the Idempotency-Key of options (D16; a fresh one for nil).

func (*Client) CreatePart 

func (c *Client) CreatePart(ctx context.Context, body fixture.CreatePart, options *client.CallOptions) (*fixture.Part, error)

CreatePart calls POST /api/v1/parts, answering 201, under the Idempotency-Key of options (D16; a fresh one for nil). A body without an id gets a UUID v7 (D18); PrepareCreatePart makes one to send again.

func (*Client) DeleteFilter 

func (c *Client) DeleteFilter(ctx context.Context, id string) error

DeleteFilter removes one of the caller's filters.

func (*Client) DeletePart 

func (c *Client) DeletePart(ctx context.Context, parameters DeletePartParameters, options *client.CallOptions) error

DeletePart calls DELETE /api/v1/parts/{id}, answering 204, under the Idempotency-Key of options (D16; a fresh one for nil).

func (*Client) ExportParts 

func (c *Client) ExportParts(ctx context.Context, parameters PartsExportQuery, writer io.Writer) (int, error)

ExportParts streams GET /api/v1/parts/export as CSV into writer (D35) and answers the rows it wrote; a cut export fails (D60).

func (*Client) GetDashboard 

func (c *Client) GetDashboard(ctx context.Context, parameters DashboardParameters) (*fixture.Dashboard, error)

GetDashboard reads GET /api/v1/boards/{board}/dashboard, the socket target "dashboard".

func (*Client) GetDashboardPresence 

func (c *Client) GetDashboardPresence(ctx context.Context, parameters DashboardPresenceParameters) (*livewire.ListResponse[livewire.PresenceItem], error)

GetDashboardPresence reads GET /api/v1/boards/{board}/dashboard/presence, the socket target "dashboard.presence".

func (*Client) GetLabels 

func (c *Client) GetLabels(ctx context.Context) (*livewire.ListResponse[string], error)

GetLabels reads GET /api/v1/labels, the socket target "labels".

func (*Client) GetNotes 

func (c *Client) GetNotes(ctx context.Context, parameters NotesListQuery) (*livewire.ListResponse[fixture.Note], error)

GetNotes reads GET /api/v1/notes, the socket target "notes".

func (*Client) GetParts 

func (c *Client) GetParts(ctx context.Context, parameters PartsListQuery) (*livewire.ListResponse[fixture.Part], error)

GetParts reads GET /api/v1/parts, the socket target "parts".

func (*Client) GetPartsDistinct 

func (c *Client) GetPartsDistinct(ctx context.Context, parameters PartsDistinctQuery) ([]livewire.DistinctValue, error)

GetPartsDistinct reads GET /api/v1/parts/distinct, the socket target "parts.distinct".

func (*Client) GetPartsHistory 

func (c *Client) GetPartsHistory(ctx context.Context, parameters PartsHistoryQuery) (*livewire.ListResponse[livewire.Version[fixture.Part]], error)

GetPartsHistory reads GET /api/v1/parts/{id}/history, the socket target "parts.history".

func (*Client) GetPartsItem 

func (c *Client) GetPartsItem(ctx context.Context, parameters PartsItemParameters) (*fixture.Part, error)

GetPartsItem reads GET /api/v1/parts/{id}, the socket target "parts.item".

func (*Client) GetPartsPresence 

func (c *Client) GetPartsPresence(ctx context.Context, parameters PartsPresenceParameters) (*livewire.ListResponse[livewire.PresenceItem], error)

GetPartsPresence reads GET /api/v1/parts/presence, the socket target "parts.presence".

func (*Client) GetStats 

func (c *Client) GetStats(ctx context.Context, parameters StatsParameters) (*livewire.ListResponse[fixture.Stat], error)

GetStats reads GET /api/v1/boards/{board}/stats, the socket target "stats".

func (*Client) ListFilters 

func (c *Client) ListFilters(ctx context.Context, resource string) (*livewire.ListResponse[livewire.FilterItem], error)

ListFilters answers the caller's named filters of a resource (or "name.history"), of every one for "".

func (*Client) Rebuild 

func (c *Client) Rebuild(ctx context.Context, options *client.CallOptions) (*fixture.Page[fixture.Node], error)

Rebuild calls POST /api/v1/rebuild, answering 200, under the Idempotency-Key of options (D16; a fresh one for nil).

func (*Client) RenamePart 

func (c *Client) RenamePart(ctx context.Context, parameters RenamePartParameters, body fixture.RenamePart, options *client.CallOptions) (*fixture.Part, error)

RenamePart calls PATCH /api/v1/parts/{id}, answering 200, under the Idempotency-Key of options (D16; a fresh one for nil).

func (*Client) SaveFilter 

func (c *Client) SaveFilter(ctx context.Context, filterRequest *livewire.FilterRequest) (*livewire.FilterItem, error)

SaveFilter stores a filter (POST /filters, D13); an unnamed one is recovered when the server evicts it (D54).

func (*Client) SubscribeDashboard 

func (c *Client) SubscribeDashboard(ctx context.Context, parameters DashboardParameters) (<-chan client.Push[fixture.Dashboard], error)

SubscribeDashboard subscribes to the socket target "dashboard" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribeDashboardPresence 

func (c *Client) SubscribeDashboardPresence(ctx context.Context, parameters DashboardPresenceParameters) (<-chan client.Push[livewire.ListResponse[livewire.PresenceItem]], error)

SubscribeDashboardPresence subscribes to the socket target "dashboard.presence" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribeParts 

func (c *Client) SubscribeParts(ctx context.Context, parameters PartsListQuery) (<-chan client.Push[livewire.ListResponse[fixture.Part]], error)

SubscribeParts subscribes to the socket target "parts" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribePartsDistinct 

func (c *Client) SubscribePartsDistinct(ctx context.Context, parameters PartsDistinctQuery) (<-chan client.Push[[]livewire.DistinctValue], error)

SubscribePartsDistinct subscribes to the socket target "parts.distinct" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribePartsHistory 

func (c *Client) SubscribePartsHistory(ctx context.Context, parameters PartsHistoryQuery) (<-chan client.Push[livewire.ListResponse[livewire.Version[fixture.Part]]], error)

SubscribePartsHistory subscribes to the socket target "parts.history" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribePartsItem 

func (c *Client) SubscribePartsItem(ctx context.Context, parameters PartsItemParameters) (<-chan client.Push[fixture.Part], error)

SubscribePartsItem subscribes to the socket target "parts.item" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribePartsPresence 

func (c *Client) SubscribePartsPresence(ctx context.Context, parameters PartsPresenceParameters) (<-chan client.Push[livewire.ListResponse[livewire.PresenceItem]], error)

SubscribePartsPresence subscribes to the socket target "parts.presence" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) SubscribeStats 

func (c *Client) SubscribeStats(ctx context.Context, parameters StatsParameters) (<-chan client.Push[livewire.ListResponse[fixture.Stat]], error)

SubscribeStats subscribes to the socket target "stats" (client.Subscribe): its pushes arrive on the channel until ctx ends or one of kind error.

func (*Client) UploadAttachment 

func (c *Client) UploadAttachment(ctx context.Context, parameters UploadAttachmentParameters, file livewire.File, options *client.CallOptions) (*fixture.Attachment, error)

UploadAttachment uploads to POST /api/v1/parts/{id}/attachments (D17), answering 201: file.Body is sent raw with file.Size as its Content-Length (at most 1048576 bytes) and file.ContentType, one of image/png, image/jpeg.

type DashboardParameters 

type DashboardParameters struct {
	// Board: path parameter; required.
	Board string
}

DashboardParameters are the parameters of GetDashboard and SubscribeDashboard.

type DashboardPresenceParameters 

type DashboardPresenceParameters struct {
	// Board: path parameter; required.
	Board string
	// Key: query parameter; required.
	Key string
}

DashboardPresenceParameters are the parameters of GetDashboardPresence and SubscribeDashboardPresence.

type DeletePartParameters 

type DeletePartParameters struct {
	// ID: path parameter; required.
	ID uuid.UUID
}

DeletePartParameters are the parameters of DeletePart.

type HistoryField 

type HistoryField string

HistoryField is a field of every history read (HistoryFields) a filter may name.

type HistoryFilter 

type HistoryFilter struct {
	Where *client.Node[HistoryField] `json:"where,omitempty"`
}

HistoryFilter is a filter document of every history read (HistoryFields): its conditions under Where, combined with client.And, Or and Not; the zero value matches every row.

type HistoryOperation 

type HistoryOperation string

HistoryOperation is a value of the enum field operation. 

const (
	HistoryOperationInsert HistoryOperation = "insert"
	HistoryOperationUpdate HistoryOperation = "update"
	HistoryOperationDelete HistoryOperation = "delete"
)

The values of HistoryOperation.

type HistorySortTerm 

type HistorySortTerm string

HistorySortTerm is a sort term: a sortable field, with a leading - descending. 

const (
	HistorySortID                  HistorySortTerm = "id"
	HistorySortIDDescending        HistorySortTerm = "-id"
	HistorySortValidFrom           HistorySortTerm = "validFrom"
	HistorySortValidFromDescending HistorySortTerm = "-validFrom"
	HistorySortValidTo             HistorySortTerm = "validTo"
	HistorySortValidToDescending   HistorySortTerm = "-validTo"
)

The values of HistorySortTerm.

type NotesDistinctField 

type NotesDistinctField string

NotesDistinctField is a field a distinct read counts the values of (D15). 

const (
	NotesDistinctID NotesDistinctField = "id"
)

The values of NotesDistinctField.

type NotesField 

type NotesField string

NotesField is a field of the resource notes a filter may name.

type NotesFilter 

type NotesFilter struct {
	Where *client.Node[NotesField] `json:"where,omitempty"`
}

NotesFilter is a filter document of the resource notes: its conditions under Where, combined with client.And, Or and Not; the zero value matches every row.

type NotesListQuery 

type NotesListQuery struct {
	// Filter: an inline filter document (JSON, D12).
	Filter *NotesFilter
	// FilterID: the id of a stored filter (D13).
	FilterID string
	// Sort: sort terms, a leading - descending (id).
	Sort []NotesSortTerm
	// Limit: the page size, clamped to the maximum (D14).
	Limit int
	// Offset: the rows to skip.
	Offset int
}

NotesListQuery are the parameters of GetNotes.

type NotesSortTerm 

type NotesSortTerm string

NotesSortTerm is a sort term: a sortable field, with a leading - descending. 

const (
	NotesSortID           NotesSortTerm = "id"
	NotesSortIDDescending NotesSortTerm = "-id"
)

The values of NotesSortTerm.

type PartsDistinctField 

type PartsDistinctField string

PartsDistinctField is a field a distinct read counts the values of (D15). 

const (
	PartsDistinctID        PartsDistinctField = "id"
	PartsDistinctName      PartsDistinctField = "name"
	PartsDistinctKind      PartsDistinctField = "kind"
	PartsDistinctPrice     PartsDistinctField = "price"
	PartsDistinctSecret    PartsDistinctField = "secret"
	PartsDistinctCreatedAt PartsDistinctField = "createdAt"
	PartsDistinctVersion   PartsDistinctField = "version"
	PartsDistinctFlag      PartsDistinctField = "flag"
)

The values of PartsDistinctField.

type PartsDistinctQuery 

type PartsDistinctQuery struct {
	// Filter: an inline filter document (JSON, D12).
	Filter *PartsFilter
	// FilterID: the id of a stored filter (D13).
	FilterID string
	// Field: the field whose values are counted (D15), one of id, name, kind, price, secret, createdAt, version, flag; required.
	Field PartsDistinctField
	// Limit: the page size, clamped to the maximum (D14).
	Limit int
	// Offset: the rows to skip.
	Offset int
}

PartsDistinctQuery are the parameters of GetPartsDistinct and SubscribePartsDistinct.

type PartsExportQuery 

type PartsExportQuery struct {
	// Filter: an inline filter document (JSON, D12).
	Filter *PartsFilter
	// FilterID: the id of a stored filter (D13).
	FilterID string
	// Sort: sort terms, a leading - descending (id, name, kind, price, createdAt, version).
	Sort []PartsSortTerm
}

PartsExportQuery are the parameters of ExportParts.

type PartsField 

type PartsField string

PartsField is a field of the resource parts a filter may name.

type PartsFilter 

type PartsFilter struct {
	Where  *client.Node[PartsField] `json:"where,omitempty"`
	Search string                   `json:"search,omitempty"`
}

PartsFilter is a filter document of the resource parts: its conditions under Where, combined with client.And, Or and Not; the zero value matches every row.

type PartsHistoryQuery 

type PartsHistoryQuery struct {
	// ID: path parameter; required.
	ID uuid.UUID
	// Filter: an inline filter document (JSON, D12).
	Filter *HistoryFilter
	// FilterID: the id of a stored filter (D13).
	FilterID string
	// Sort: sort terms, a leading - descending (id, validFrom, validTo).
	Sort []HistorySortTerm
	// Limit: the page size, clamped to the maximum (D14).
	Limit int
	// Offset: the rows to skip.
	Offset int
}

PartsHistoryQuery are the parameters of GetPartsHistory and SubscribePartsHistory.

type PartsItemParameters 

type PartsItemParameters struct {
	// ID: path parameter; required.
	ID uuid.UUID
}

PartsItemParameters are the parameters of GetPartsItem and SubscribePartsItem.

type PartsKind 

type PartsKind string

PartsKind is a value of the enum field kind. 

const (
	PartsKindBolt PartsKind = "bolt"
	PartsKindNut  PartsKind = "nut"
)

The values of PartsKind.

type PartsListQuery 

type PartsListQuery struct {
	// Filter: an inline filter document (JSON, D12).
	Filter *PartsFilter
	// FilterID: the id of a stored filter (D13).
	FilterID string
	// Sort: sort terms, a leading - descending (id, name, kind, price, createdAt, version).
	Sort []PartsSortTerm
	// Limit: the page size, clamped to the maximum (D14).
	Limit int
	// Offset: the rows to skip.
	Offset int
	// After: the next of the previous page (cursor mode, D38).
	After string
}

PartsListQuery are the parameters of GetParts and SubscribeParts.

type PartsPresenceParameters 

type PartsPresenceParameters struct {
	// Key: query parameter; required.
	Key string
}

PartsPresenceParameters are the parameters of GetPartsPresence and SubscribePartsPresence.

type PartsSortTerm 

type PartsSortTerm string

PartsSortTerm is a sort term: a sortable field, with a leading - descending. 

const (
	PartsSortID                  PartsSortTerm = "id"
	PartsSortIDDescending        PartsSortTerm = "-id"
	PartsSortName                PartsSortTerm = "name"
	PartsSortNameDescending      PartsSortTerm = "-name"
	PartsSortKind                PartsSortTerm = "kind"
	PartsSortKindDescending      PartsSortTerm = "-kind"
	PartsSortPrice               PartsSortTerm = "price"
	PartsSortPriceDescending     PartsSortTerm = "-price"
	PartsSortCreatedAt           PartsSortTerm = "createdAt"
	PartsSortCreatedAtDescending PartsSortTerm = "-createdAt"
	PartsSortVersion             PartsSortTerm = "version"
	PartsSortVersionDescending   PartsSortTerm = "-version"
)

The values of PartsSortTerm.

type RenamePartParameters 

type RenamePartParameters struct {
	// ID: path parameter; required.
	ID uuid.UUID
}

RenamePartParameters are the parameters of RenamePart.

type StatsParameters 

type StatsParameters struct {
	// Board: path parameter; required.
	Board string
	// State: query parameter, one of open, done.
	State string
	// Tag: query parameter.
	Tag []string
	// Limit: query parameter.
	Limit *int64
	// Hidden: query parameter.
	Hidden bool
	// Since: query parameter.
	Since *time.Time
	// Owner: query parameter.
	Owner uuid.UUID
	// Kind: query parameter, one of bolt, nut.
	Kind string
}

StatsParameters are the parameters of GetStats and SubscribeStats.

type UploadAttachmentParameters 

type UploadAttachmentParameters struct {
	// ID: path parameter; required.
	ID uuid.UUID
}

UploadAttachmentParameters are the parameters of UploadAttachment.

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.