abs

package
v0.7.1 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2026 License: GPL-3.0 Imports: 18 Imported by: 0

Documentation ¶

Overview ¶

Package abs is a typed client for Audiobookshelf API 2.37.1, generated by pandorest from the definitions in api-defs/audiobookshelf-2.37.1, which were imported from api-defs/audiobookshelf-openapi-2.37.1.json.

Layout ¶

Every operation of the API is a method on Client, in a file of its own named <tag>_method_<operation>.go. Each model is in <tag>_model_<model>.go and each tag's enums in <tag>_constants.go; a model or enum more than one tag uses is under common_. The requests go through the hand-written base client, github.com/katbyte/pandorest/client.

Calls ¶

A method takes a context, then the path parameters in path order, then the request body (input: the model for a JSON body, or an io.Reader and its content type for raw bytes), then, when the operation has query or header parameters, a <Name>Options, which may be left out when every one of them is optional. Unset options are not sent: a boolean or a number is a pointer, sent when set (so 0 and false can be asked for), an empty string or list is skipped, and a list is sent comma-joined or as one parameter for each element, as the document says.

It returns a <Name>Response holding HttpResponse and, when the operation answers JSON, Answer: a pointer for a struct, enum or primitive, nil when the server answered with no body, and the value for a list, map or raw JSON. Answered() says whether a body came and was decoded. A struct answer is also embedded, so res.Answer.Name may be read as res.Name, a zero record when nothing was answered, and Record() hands it back by value with an error when none came. HttpResponse is set whenever the server answered, including alongside an error. An operation that answers a file has no Answer: WriteTo(w) copies the file out and closes the body, Bytes(max) reads it whole up to a size, Reader() hands the body over with its content type, ContentLength() and Filename() say what the server said of it, and the body is also still in HttpResponse.Body. A status the operation does not document is an error: client.StatusCode reads the status from it, and IsNotFound and the other Is helpers say which it is.

A list operation, one whose options page with Page and Limit, also has a <Name>Complete method that loads every result, and a <Name>Each that hands them out one at a time as a range, so a loop that stops asks for no page more.

Audiobookshelf writes its times as milliseconds since 1970, read here as dates, and counts the pages of a list from 0. Its ids are uuids, except on a server upgraded from an old version, which may still hold ids of an older form.

Ids ¶

LibraryID, LibraryItemID, AuthorID, SeriesID, CollectionID, PlaylistID, EpisodeID, FeedID, FolderID, UserID, APIKeyID, ProviderID are kinds of id the package tells apart, each a bare named type over the int or string the document declares, so that one kind where another goes does not compile. Where an id sits among the options it is held by value and sent when not zero. string(id) and LibraryID(s) convert one value, client.IDs and client.StringIDs a list.

Workarounds ¶

The importer fixed these bugs in the document before generating from it:

  • audiobookshelf-unix-dates

Index ¶

Constants ¶

View Source
const APIVersion = "2.37.1"

APIVersion is the version of the API document this package was generated from (Audiobookshelf API, as the document names itself); a server of another version may answer differently.

View Source
const DocumentVersion = "2.37.1"

DocumentVersion is the version the document's file is named by: the release of the server it was taken from, which is the one to compare with a running server's where the document's own version names the API and does not move from release to release.

Variables ¶

View Source
var Operations = []OperationInfo{}/* 218 elements not displayed */

Operations is every operation of the package, group by group in the order of their names.

Functions ¶

func IsForbidden ¶

func IsForbidden(err error) bool

IsForbidden reports whether err is Audiobookshelf refusing the key: a 401, or the 403 a route for admins answers any other key.

func IsNotFound ¶

func IsNotFound(err error) bool

IsNotFound reports whether err is Audiobookshelf answering that what was asked for is not there.

func ListFilter ¶ added in v0.7.1

func ListFilter(group, value string) string

ListFilter is a list's filter query: a group alone, such as issues, or a group and a value, written <group>.<value in base64>, such as a series by its id or a genre by its name. The groups include genres, tags, series, authors, narrators, languages, publishers, publishedDecades, progress, missing, ebooks, tracks and abridged.

func PathName ¶ added in v0.7.1

func PathName(value string) string

PathName is a tag, genre or narrator as the server names one in a path, to rename or remove it: the value in base64, as a list's filter writes it.

func PossibleValuesForChapterSearchErrorKey ¶ added in v0.7.1

func PossibleValuesForChapterSearchErrorKey() []string

PossibleValuesForChapterSearchErrorKey returns every value of ChapterSearchErrorKey.

func PossibleValuesForMediaItemType ¶ added in v0.7.1

func PossibleValuesForMediaItemType() []string

PossibleValuesForMediaItemType returns every value of MediaItemType.

func PossibleValuesForNotificationEvent ¶ added in v0.7.1

func PossibleValuesForNotificationEvent() []string

PossibleValuesForNotificationEvent returns every value of NotificationEvent.

func PossibleValuesForNotificationEventDescriptionKey ¶ added in v0.7.1

func PossibleValuesForNotificationEventDescriptionKey() []string

PossibleValuesForNotificationEventDescriptionKey returns every value of NotificationEventDescriptionKey.

func PossibleValuesForSessionSort ¶ added in v0.7.1

func PossibleValuesForSessionSort() []string

PossibleValuesForSessionSort returns every value of SessionSort.

func PossibleValuesForShelfID ¶ added in v0.7.1

func PossibleValuesForShelfID() []string

PossibleValuesForShelfID returns every value of ShelfID.

func PossibleValuesForShelfLabelKey ¶ added in v0.7.1

func PossibleValuesForShelfLabelKey() []string

PossibleValuesForShelfLabelKey returns every value of ShelfLabelKey.

func PossibleValuesForShelfType ¶ added in v0.7.1

func PossibleValuesForShelfType() []string

PossibleValuesForShelfType returns every value of ShelfType.

Types ¶

type APIKeyID ¶ added in v0.7.1

type APIKeyID string

APIKeyID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and APIKeyID(n) convert one value, client.StringIDs a list.

type ApiKeyCreateAnswer ¶ added in v0.7.1

type ApiKeyCreateAnswer struct {
	ApiKey *ApiKeyRecord `json:"apiKey,omitempty"`
}

ApiKeyCreateAnswer is an object the document declares inline.

type ApiKeyCreateRequest ¶ added in v0.7.1

type ApiKeyCreateRequest struct {
	ExpiresIn float64 `json:"expiresIn,omitempty"`
	IsActive  *bool   `json:"isActive,omitempty"`
	Name      string  `json:"name,omitempty"`
	UserId    UserID  `json:"userId,omitempty"`
}

ApiKeyCreateRequest is an object the document declares inline.

type ApiKeyCreateResponse ¶ added in v0.7.1

type ApiKeyCreateResponse struct {
	HttpResponse *http.Response
	Answer       *ApiKeyCreateAnswer
	*ApiKeyCreateAnswer
}

ApiKeyCreateResponse is the result of ApiKeyCreate.

Answer is the ApiKeyCreateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ApiKeyCreateResponse) Answered ¶ added in v0.7.1

func (r ApiKeyCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ApiKeyCreateResponse) Record ¶ added in v0.7.1

Record is the ApiKeyCreateAnswer answered, as a value to change and write back, or an error when the server answered none.

type ApiKeyDeleteResponse ¶ added in v0.7.1

type ApiKeyDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ApiKeyDeleteResponse is the result of ApiKeyDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ApiKeyDeleteResponse) Answered ¶ added in v0.7.1

func (r ApiKeyDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ApiKeyGetAllAnswer ¶ added in v0.7.1

type ApiKeyGetAllAnswer struct {
	ApiKeys []ApiKeyRecord `json:"apiKeys,omitzero"`
}

ApiKeyGetAllAnswer is an object the document declares inline.

type ApiKeyGetAllResponse ¶ added in v0.7.1

type ApiKeyGetAllResponse struct {
	HttpResponse *http.Response
	Answer       *ApiKeyGetAllAnswer
	*ApiKeyGetAllAnswer
}

ApiKeyGetAllResponse is the result of ApiKeyGetAll.

Answer is the ApiKeyGetAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ApiKeyGetAllResponse) Answered ¶ added in v0.7.1

func (r ApiKeyGetAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ApiKeyGetAllResponse) Record ¶ added in v0.7.1

Record is the ApiKeyGetAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type ApiKeyRecord ¶ added in v0.7.1

type ApiKeyRecord struct {
	ApiKey          string                     `json:"apiKey,omitempty"`
	CreatedAt       string                     `json:"createdAt,omitempty"`
	CreatedByUser   *ApiKeyRecordCreatedByUser `json:"createdByUser,omitempty"`
	CreatedByUserId UserID                     `json:"createdByUserId,omitempty"`
	Description     string                     `json:"description,omitempty"`
	ExpiresAt       string                     `json:"expiresAt,omitempty"`
	Id              APIKeyID                   `json:"id,omitempty"`
	IsActive        bool                       `json:"isActive"`
	LastUsedAt      string                     `json:"lastUsedAt,omitempty"`
	Name            string                     `json:"name,omitempty"`
	Permissions     any                        `json:"permissions,omitempty"`
	UpdatedAt       string                     `json:"updatedAt,omitempty"`
	User            *ApiKeyRecordUser          `json:"user,omitempty"`
	UserId          UserID                     `json:"userId,omitempty"`
}

ApiKeyRecord is the "ApiKeyRecord" schema.

func (ApiKeyRecord) GetId ¶ added in v0.7.1

func (m ApiKeyRecord) GetId() APIKeyID

GetId is the record's Id, for code that handles records of several types alike.

func (ApiKeyRecord) GetName ¶ added in v0.7.1

func (m ApiKeyRecord) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type ApiKeyRecordCreatedByUser ¶ added in v0.7.1

type ApiKeyRecordCreatedByUser struct {
	Id       string `json:"id,omitempty"`
	Type     string `json:"type,omitempty"`
	Username string `json:"username,omitempty"`
}

ApiKeyRecordCreatedByUser is an object the document declares inline.

type ApiKeyRecordUser ¶ added in v0.7.1

type ApiKeyRecordUser struct {
	Id       string `json:"id,omitempty"`
	Type     string `json:"type,omitempty"`
	Username string `json:"username,omitempty"`
}

ApiKeyRecordUser is an object the document declares inline.

type ApiKeyUpdateAnswer ¶ added in v0.7.1

type ApiKeyUpdateAnswer struct {
	ApiKey *ApiKeyRecord `json:"apiKey,omitempty"`
}

ApiKeyUpdateAnswer is an object the document declares inline.

type ApiKeyUpdateRequest ¶ added in v0.7.1

type ApiKeyUpdateRequest struct {
	IsActive *bool `json:"isActive,omitempty"`
	UserId   any   `json:"userId,omitempty"`
}

ApiKeyUpdateRequest is an object the document declares inline.

type ApiKeyUpdateResponse ¶ added in v0.7.1

type ApiKeyUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *ApiKeyUpdateAnswer
	*ApiKeyUpdateAnswer
}

ApiKeyUpdateResponse is the result of ApiKeyUpdate.

Answer is the ApiKeyUpdateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ApiKeyUpdateResponse) Answered ¶ added in v0.7.1

func (r ApiKeyUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ApiKeyUpdateResponse) Record ¶ added in v0.7.1

Record is the ApiKeyUpdateAnswer answered, as a value to change and write back, or an error when the server answered none.

type AudioBookmark ¶ added in v0.7.1

type AudioBookmark struct {
	CreatedAt     UnixMilli     `json:"createdAt,omitzero"`
	LibraryItemId LibraryItemID `json:"libraryItemId,omitempty"`
	Time          float64       `json:"time,omitempty"`
	Title         string        `json:"title,omitempty"`
}

AudioBookmark is the "AudioBookmark" schema.

type AudioFile ¶

type AudioFile struct {
	AddedAt              UnixMilli      `json:"addedAt,omitzero"`
	BitRate              int            `json:"bitRate,omitempty"`
	ChannelLayout        string         `json:"channelLayout,omitempty"`
	Channels             int            `json:"channels,omitempty"`
	Chapters             []Chapter      `json:"chapters,omitzero"`
	Codec                string         `json:"codec,omitempty"`
	DiscNumFromFilename  int            `json:"discNumFromFilename,omitempty"`
	DiscNumFromMeta      int            `json:"discNumFromMeta,omitempty"`
	Duration             float64        `json:"duration,omitempty"`
	EmbeddedCoverArt     string         `json:"embeddedCoverArt,omitempty"`
	Error                string         `json:"error,omitempty"`
	Exclude              bool           `json:"exclude"`
	Format               string         `json:"format,omitempty"`
	Index                int            `json:"index,omitempty"`
	Ino                  string         `json:"ino,omitempty"`
	Language             string         `json:"language,omitempty"`
	ManuallyVerified     bool           `json:"manuallyVerified"`
	MetaTags             *AudioMetaTags `json:"metaTags,omitempty"`
	Metadata             *FileMetadata  `json:"metadata,omitempty"`
	MimeType             string         `json:"mimeType,omitempty"`
	TimeBase             string         `json:"timeBase,omitempty"`
	TrackNumFromFilename int            `json:"trackNumFromFilename,omitempty"`
	TrackNumFromMeta     int            `json:"trackNumFromMeta,omitempty"`
	UpdatedAt            UnixMilli      `json:"updatedAt,omitzero"`
}

AudioFile is the "AudioFile" schema.

type AudioMetaTags ¶ added in v0.7.1

type AudioMetaTags struct {
	TagAlbum       string `json:"tagAlbum,omitempty"`
	TagAlbumArtist string `json:"tagAlbumArtist,omitempty"`
	TagAlbumSort   string `json:"tagAlbumSort,omitempty"`
	TagArtist      string `json:"tagArtist,omitempty"`
	TagArtistSort  string `json:"tagArtistSort,omitempty"`
	TagComposer    string `json:"tagComposer,omitempty"`
	TagDate        string `json:"tagDate,omitempty"`
	TagEncoder     string `json:"tagEncoder,omitempty"`
	TagGenre       string `json:"tagGenre,omitempty"`
	TagGrouping    string `json:"tagGrouping,omitempty"`
	TagLanguage    string `json:"tagLanguage,omitempty"`
	TagPublisher   string `json:"tagPublisher,omitempty"`
	TagSeries      string `json:"tagSeries,omitempty"`
	TagTitle       string `json:"tagTitle,omitempty"`
	TagTitleSort   string `json:"tagTitleSort,omitempty"`
	TagTrack       string `json:"tagTrack,omitempty"`
}

AudioMetaTags is the "AudioMetaTags" schema.

type AudioTrack ¶

type AudioTrack struct {
	AddedAt              UnixMilli      `json:"addedAt,omitzero"`
	BitRate              int            `json:"bitRate,omitempty"`
	ChannelLayout        string         `json:"channelLayout,omitempty"`
	Channels             int            `json:"channels,omitempty"`
	Chapters             []Chapter      `json:"chapters,omitzero"`
	Codec                string         `json:"codec,omitempty"`
	ContentUrl           string         `json:"contentUrl,omitempty"`
	DiscNumFromFilename  int            `json:"discNumFromFilename,omitempty"`
	DiscNumFromMeta      any            `json:"discNumFromMeta,omitempty"`
	Duration             float64        `json:"duration,omitempty"`
	EmbeddedCoverArt     string         `json:"embeddedCoverArt,omitempty"`
	Error                any            `json:"error,omitempty"`
	Exclude              bool           `json:"exclude"`
	Format               string         `json:"format,omitempty"`
	Index                int            `json:"index,omitempty"`
	Ino                  string         `json:"ino,omitempty"`
	Language             string         `json:"language,omitempty"`
	ManuallyVerified     bool           `json:"manuallyVerified"`
	MetaTags             *AudioMetaTags `json:"metaTags,omitempty"`
	Metadata             *FileMetadata  `json:"metadata,omitempty"`
	MimeType             string         `json:"mimeType,omitempty"`
	StartOffset          float64        `json:"startOffset,omitempty"`
	TimeBase             string         `json:"timeBase,omitempty"`
	Title                string         `json:"title,omitempty"`
	TrackNumFromFilename int            `json:"trackNumFromFilename,omitempty"`
	TrackNumFromMeta     int            `json:"trackNumFromMeta,omitempty"`
	UpdatedAt            UnixMilli      `json:"updatedAt,omitzero"`
}

AudioTrack is the "AudioTrack" schema.

type Author ¶

type Author struct {
	AddedAt      UnixMilli             `json:"addedAt,omitzero"`
	Asin         string                `json:"asin,omitempty"`
	Description  string                `json:"description,omitempty"`
	Id           AuthorID              `json:"id,omitempty"`
	ImagePath    string                `json:"imagePath,omitempty"`
	LastFirst    string                `json:"lastFirst,omitempty"`
	LibraryId    LibraryID             `json:"libraryId,omitempty"`
	LibraryItems []LibraryItemMinified `json:"libraryItems,omitzero"`
	Name         string                `json:"name,omitempty"`
	NumBooks     int                   `json:"numBooks,omitempty"`
	Series       []AuthorSeries        `json:"series,omitzero"`
	UpdatedAt    UnixMilli             `json:"updatedAt,omitzero"`
}

Author is the "Author" schema.

func (Author) GetId ¶ added in v0.7.1

func (m Author) GetId() AuthorID

GetId is the record's Id, for code that handles records of several types alike.

func (Author) GetName ¶ added in v0.7.1

func (m Author) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type AuthorDeleteImageAnswer ¶ added in v0.7.1

type AuthorDeleteImageAnswer struct {
	Author *Author `json:"author,omitempty"`
}

AuthorDeleteImageAnswer is an object the document declares inline.

type AuthorDeleteImageResponse ¶ added in v0.7.1

type AuthorDeleteImageResponse struct {
	HttpResponse *http.Response
	Answer       *AuthorDeleteImageAnswer
	*AuthorDeleteImageAnswer
}

AuthorDeleteImageResponse is the result of AuthorDeleteImage.

Answer is the AuthorDeleteImageAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (AuthorDeleteImageResponse) Answered ¶ added in v0.7.1

func (r AuthorDeleteImageResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (AuthorDeleteImageResponse) Record ¶ added in v0.7.1

Record is the AuthorDeleteImageAnswer answered, as a value to change and write back, or an error when the server answered none.

type AuthorDeleteResponse ¶ added in v0.7.1

type AuthorDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

AuthorDeleteResponse is the result of AuthorDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (AuthorDeleteResponse) Answered ¶ added in v0.7.1

func (r AuthorDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type AuthorFindOneOptions ¶ added in v0.7.1

type AuthorFindOneOptions struct {
	Include string
}

AuthorFindOneOptions holds the query and header parameters of AuthorFindOne.

func (AuthorFindOneOptions) ToHeaders ¶ added in v0.7.1

func (o AuthorFindOneOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (AuthorFindOneOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type AuthorFindOneResponse ¶ added in v0.7.1

type AuthorFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *Author
	*Author
}

AuthorFindOneResponse is the result of AuthorFindOne.

Answer is the Author answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (AuthorFindOneResponse) Answered ¶ added in v0.7.1

func (r AuthorFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (AuthorFindOneResponse) Record ¶ added in v0.7.1

func (r AuthorFindOneResponse) Record() (Author, error)

Record is the Author answered, as a value to change and write back, or an error when the server answered none.

type AuthorGetImageOptions ¶ added in v0.7.1

type AuthorGetImageOptions struct {
	Format string
	Height string
	Raw    string
	Width  string
}

AuthorGetImageOptions holds the query and header parameters of AuthorGetImage.

func (AuthorGetImageOptions) ToHeaders ¶ added in v0.7.1

func (o AuthorGetImageOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (AuthorGetImageOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type AuthorGetImageResponse ¶ added in v0.7.1

type AuthorGetImageResponse struct {
	HttpResponse *http.Response
}

AuthorGetImageResponse is the result of AuthorGetImage.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (AuthorGetImageResponse) Bytes ¶ added in v0.7.1

func (r AuthorGetImageResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (AuthorGetImageResponse) ContentLength ¶ added in v0.7.1

func (r AuthorGetImageResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (AuthorGetImageResponse) Filename ¶ added in v0.7.1

func (r AuthorGetImageResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (AuthorGetImageResponse) Reader ¶ added in v0.7.1

func (r AuthorGetImageResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (AuthorGetImageResponse) WriteTo ¶ added in v0.7.1

func (r AuthorGetImageResponse) WriteTo(w io.Writer) (int64, error)

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type AuthorID ¶ added in v0.7.1

type AuthorID string

AuthorID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and AuthorID(n) convert one value, client.StringIDs a list.

type AuthorMatchAnswer ¶ added in v0.7.1

type AuthorMatchAnswer struct {
	Author  *Author `json:"author,omitempty"`
	Updated bool    `json:"updated"`
}

AuthorMatchAnswer is an object the document declares inline.

type AuthorMatchRequest ¶ added in v0.7.1

type AuthorMatchRequest struct {
	Asin   string `json:"asin,omitempty"`
	Q      string `json:"q,omitempty"`
	Region string `json:"region,omitempty"`
}

AuthorMatchRequest is an object the document declares inline.

type AuthorMatchResponse ¶ added in v0.7.1

type AuthorMatchResponse struct {
	HttpResponse *http.Response
	Answer       *AuthorMatchAnswer
	*AuthorMatchAnswer
}

AuthorMatchResponse is the result of AuthorMatch.

Answer is the AuthorMatchAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (AuthorMatchResponse) Answered ¶ added in v0.7.1

func (r AuthorMatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (AuthorMatchResponse) Record ¶ added in v0.7.1

Record is the AuthorMatchAnswer answered, as a value to change and write back, or an error when the server answered none.

type AuthorMinimal ¶ added in v0.7.1

type AuthorMinimal struct {
	Id   AuthorID `json:"id,omitempty"`
	Name string   `json:"name,omitempty"`
}

AuthorMinimal is the "AuthorMinimal" schema.

func (AuthorMinimal) GetId ¶ added in v0.7.1

func (m AuthorMinimal) GetId() AuthorID

GetId is the record's Id, for code that handles records of several types alike.

func (AuthorMinimal) GetName ¶ added in v0.7.1

func (m AuthorMinimal) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type AuthorSeries ¶ added in v0.7.1

type AuthorSeries struct {
	Id    any   `json:"id,omitempty"`
	Items []any `json:"items,omitzero"`
	Name  any   `json:"name,omitempty"`
}

AuthorSeries is an object the document declares inline.

type AuthorShelf ¶ added in v0.7.1

type AuthorShelf struct {
	Entities       []Author      `json:"entities,omitzero"`
	Id             ShelfID       `json:"id,omitempty"`
	Label          string        `json:"label,omitempty"`
	LabelStringKey ShelfLabelKey `json:"labelStringKey,omitempty"`
	Total          float64       `json:"total,omitempty"`
	Type           ShelfType     `json:"type,omitempty"`
}

AuthorShelf is the "AuthorShelf" schema.

type AuthorUpdateAnswer ¶ added in v0.7.1

type AuthorUpdateAnswer struct {
	Author  *Author `json:"author,omitempty"`
	Merged  bool    `json:"merged"`
	Updated bool    `json:"updated"`
}

AuthorUpdateAnswer is an object the document declares inline.

type AuthorUpdateRequest ¶ added in v0.7.1

type AuthorUpdateRequest struct {
	Asin        *string `json:"asin,omitempty"`
	Description *string `json:"description,omitempty"`
	Name        string  `json:"name,omitempty"`
}

AuthorUpdateRequest is an object the document declares inline.

type AuthorUpdateResponse ¶ added in v0.7.1

type AuthorUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *AuthorUpdateAnswer
	*AuthorUpdateAnswer
}

AuthorUpdateResponse is the result of AuthorUpdate.

Answer is the AuthorUpdateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (AuthorUpdateResponse) Answered ¶ added in v0.7.1

func (r AuthorUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (AuthorUpdateResponse) Record ¶ added in v0.7.1

Record is the AuthorUpdateAnswer answered, as a value to change and write back, or an error when the server answered none.

type AuthorUploadImageAnswer ¶ added in v0.7.1

type AuthorUploadImageAnswer struct {
	Author *Author `json:"author,omitempty"`
}

AuthorUploadImageAnswer is an object the document declares inline.

type AuthorUploadImageRequest ¶ added in v0.7.1

type AuthorUploadImageRequest struct {
	Url string `json:"url,omitempty"`
}

AuthorUploadImageRequest is an object the document declares inline.

type AuthorUploadImageResponse ¶ added in v0.7.1

type AuthorUploadImageResponse struct {
	HttpResponse *http.Response
	Answer       *AuthorUploadImageAnswer
	*AuthorUploadImageAnswer
}

AuthorUploadImageResponse is the result of AuthorUploadImage.

Answer is the AuthorUploadImageAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (AuthorUploadImageResponse) Answered ¶ added in v0.7.1

func (r AuthorUploadImageResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (AuthorUploadImageResponse) Record ¶ added in v0.7.1

Record is the AuthorUploadImageAnswer answered, as a value to change and write back, or an error when the server answered none.

type Backup ¶

type Backup struct {
	BackupDirPath string    `json:"backupDirPath,omitempty"`
	CreatedAt     UnixMilli `json:"createdAt,omitzero"`
	DatePretty    string    `json:"datePretty,omitempty"`
	FileSize      int       `json:"fileSize,omitempty"`
	Filename      string    `json:"filename,omitempty"`
	FullPath      string    `json:"fullPath,omitempty"`
	Id            string    `json:"id,omitempty"`
	Key           string    `json:"key,omitempty"`
	Path          string    `json:"path,omitempty"`
	ServerVersion string    `json:"serverVersion,omitempty"`
}

Backup is the "Backup" schema.

type BackupApplyResponse ¶ added in v0.7.1

type BackupApplyResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

BackupApplyResponse is the result of BackupApply.

The operation answers text (text/plain), which Answer holds as it was sent.

func (BackupApplyResponse) Answered ¶ added in v0.7.1

func (r BackupApplyResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type BackupCreateAnswer ¶ added in v0.7.1

type BackupCreateAnswer struct {
	Backups []Backup `json:"backups,omitzero"`
}

BackupCreateAnswer is an object the document declares inline.

type BackupCreateResponse ¶ added in v0.7.1

type BackupCreateResponse struct {
	HttpResponse *http.Response
	Answer       *BackupCreateAnswer
	*BackupCreateAnswer
}

BackupCreateResponse is the result of BackupCreate.

Answer is the BackupCreateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (BackupCreateResponse) Answered ¶ added in v0.7.1

func (r BackupCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (BackupCreateResponse) Record ¶ added in v0.7.1

Record is the BackupCreateAnswer answered, as a value to change and write back, or an error when the server answered none.

type BackupDeleteAnswer ¶ added in v0.7.1

type BackupDeleteAnswer struct {
	Backups []Backup `json:"backups,omitzero"`
}

BackupDeleteAnswer is an object the document declares inline.

type BackupDeleteResponse ¶ added in v0.7.1

type BackupDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *BackupDeleteAnswer
	*BackupDeleteAnswer
}

BackupDeleteResponse is the result of BackupDelete.

Answer is the BackupDeleteAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (BackupDeleteResponse) Answered ¶ added in v0.7.1

func (r BackupDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (BackupDeleteResponse) Record ¶ added in v0.7.1

Record is the BackupDeleteAnswer answered, as a value to change and write back, or an error when the server answered none.

type BackupDownloadResponse ¶ added in v0.7.1

type BackupDownloadResponse struct {
	HttpResponse *http.Response
}

BackupDownloadResponse is the result of BackupDownload.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (BackupDownloadResponse) Bytes ¶ added in v0.7.1

func (r BackupDownloadResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (BackupDownloadResponse) ContentLength ¶ added in v0.7.1

func (r BackupDownloadResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (BackupDownloadResponse) Filename ¶ added in v0.7.1

func (r BackupDownloadResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (BackupDownloadResponse) Reader ¶ added in v0.7.1

func (r BackupDownloadResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (BackupDownloadResponse) WriteTo ¶ added in v0.7.1

func (r BackupDownloadResponse) WriteTo(w io.Writer) (int64, error)

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type BackupGetAllAnswer ¶ added in v0.7.1

type BackupGetAllAnswer struct {
	BackupLocation   string   `json:"backupLocation,omitempty"`
	BackupPathEnvSet bool     `json:"backupPathEnvSet"`
	Backups          []Backup `json:"backups,omitzero"`
}

BackupGetAllAnswer is an object the document declares inline.

type BackupGetAllResponse ¶ added in v0.7.1

type BackupGetAllResponse struct {
	HttpResponse *http.Response
	Answer       *BackupGetAllAnswer
	*BackupGetAllAnswer
}

BackupGetAllResponse is the result of BackupGetAll.

Answer is the BackupGetAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (BackupGetAllResponse) Answered ¶ added in v0.7.1

func (r BackupGetAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (BackupGetAllResponse) Record ¶ added in v0.7.1

Record is the BackupGetAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type BackupUpdatePathRequest ¶ added in v0.7.1

type BackupUpdatePathRequest struct {
	Path string `json:"path,omitempty"`
}

BackupUpdatePathRequest is an object the document declares inline.

type BackupUpdatePathResponse ¶ added in v0.7.1

type BackupUpdatePathResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

BackupUpdatePathResponse is the result of BackupUpdatePath.

The operation answers text (text/plain), which Answer holds as it was sent.

func (BackupUpdatePathResponse) Answered ¶ added in v0.7.1

func (r BackupUpdatePathResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type BackupUploadAnswer ¶ added in v0.7.1

type BackupUploadAnswer struct {
	Backups []Backup `json:"backups,omitzero"`
}

BackupUploadAnswer is an object the document declares inline.

type BackupUploadResponse ¶ added in v0.7.1

type BackupUploadResponse struct {
	HttpResponse *http.Response
	Answer       *BackupUploadAnswer
	*BackupUploadAnswer
}

BackupUploadResponse is the result of BackupUpload.

Answer is the BackupUploadAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (BackupUploadResponse) Answered ¶ added in v0.7.1

func (r BackupUploadResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (BackupUploadResponse) Record ¶ added in v0.7.1

Record is the BackupUploadAnswer answered, as a value to change and write back, or an error when the server answered none.

type CachePurgeCacheResponse ¶ added in v0.7.1

type CachePurgeCacheResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

CachePurgeCacheResponse is the result of CachePurgeCache.

The operation answers text (text/plain), which Answer holds as it was sent.

func (CachePurgeCacheResponse) Answered ¶ added in v0.7.1

func (r CachePurgeCacheResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type CachePurgeItemsCacheResponse ¶ added in v0.7.1

type CachePurgeItemsCacheResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

CachePurgeItemsCacheResponse is the result of CachePurgeItemsCache.

The operation answers text (text/plain), which Answer holds as it was sent.

func (CachePurgeItemsCacheResponse) Answered ¶ added in v0.7.1

func (r CachePurgeItemsCacheResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type Chapter ¶

type Chapter struct {
	End   float64 `json:"end"`
	Id    int     `json:"id,omitempty"`
	Start float64 `json:"start"`
	Title string  `json:"title"`
}

Chapter is the "Chapter" schema.

type ChapterSearchErrorKey ¶ added in v0.7.1

type ChapterSearchErrorKey string

ChapterSearchErrorKey is the "ChapterSearchErrorKey" enum.

const (
	ChapterSearchErrorKeyMessageChaptersNotFound ChapterSearchErrorKey = "MessageChaptersNotFound"
	ChapterSearchErrorKeyMessageInvalidAsin      ChapterSearchErrorKey = "MessageInvalidAsin"
	ChapterSearchErrorKeyMessageInvalidRegion    ChapterSearchErrorKey = "MessageInvalidRegion"
)

Values of ChapterSearchErrorKey.

func (ChapterSearchErrorKey) Known ¶ added in v0.7.1

func (v ChapterSearchErrorKey) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type Client ¶

type Client struct {
	Client *client.Client
}

Client is a client for Audiobookshelf API; each of its operations is a method. Requests go through Client.Client, the shared base client.

func New ¶

func New(baseURL, apiKey string, opts ...client.Option) (*Client, error)

New returns a client for the Audiobookshelf server at baseURL (scheme and host) that authenticates with an API key, made under Settings → Users → API Keys, or a user's token. The options are the base client's: client.WithLog to trace what is sent, client.WithTransport to send it through a transport of the caller's own.

func (Client) ApiKeyCreate ¶ added in v0.7.1

func (c Client) ApiKeyCreate(ctx context.Context, input ApiKeyCreateRequest) (result ApiKeyCreateResponse, err error)

ApiKeyCreate calls POST /api/api-keys.

func (Client) ApiKeyDelete ¶ added in v0.7.1

func (c Client) ApiKeyDelete(ctx context.Context, id string) (result ApiKeyDeleteResponse, err error)

ApiKeyDelete calls DELETE /api/api-keys/{id}.

func (Client) ApiKeyGetAll ¶ added in v0.7.1

func (c Client) ApiKeyGetAll(ctx context.Context) (result ApiKeyGetAllResponse, err error)

ApiKeyGetAll calls GET /api/api-keys.

func (Client) ApiKeyUpdate ¶ added in v0.7.1

func (c Client) ApiKeyUpdate(ctx context.Context, id string, input ApiKeyUpdateRequest) (result ApiKeyUpdateResponse, err error)

ApiKeyUpdate calls PATCH /api/api-keys/{id}.

func (Client) As ¶

func (c Client) As(apiKey string) (*Client, error)

As is a client for the same server that sends another account's key, for a call only that account can make, such as writing its listening progress. It goes through this client's connection, so it is retried, logged and carried the same way, and keeps that key out of its errors as this one keeps its own. This file is written by hand.

func (Client) AuthorDelete ¶ added in v0.7.1

func (c Client) AuthorDelete(ctx context.Context, id AuthorID) (result AuthorDeleteResponse, err error)

AuthorDelete calls DELETE /api/authors/{id}.

func (Client) AuthorDeleteImage ¶ added in v0.7.1

func (c Client) AuthorDeleteImage(ctx context.Context, id AuthorID) (result AuthorDeleteImageResponse, err error)

AuthorDeleteImage calls DELETE /api/authors/{id}/image.

func (Client) AuthorFindOne ¶ added in v0.7.1

func (c Client) AuthorFindOne(ctx context.Context, id AuthorID, options ...AuthorFindOneOptions) (result AuthorFindOneResponse, err error)

AuthorFindOne calls GET /api/authors/{id}.

func (Client) AuthorGetImage ¶ added in v0.7.1

func (c Client) AuthorGetImage(ctx context.Context, id AuthorID, options ...AuthorGetImageOptions) (result AuthorGetImageResponse, err error)

AuthorGetImage calls GET /api/authors/{id}/image.

func (Client) AuthorMatch ¶ added in v0.7.1

func (c Client) AuthorMatch(ctx context.Context, id AuthorID, input AuthorMatchRequest) (result AuthorMatchResponse, err error)

AuthorMatch calls POST /api/authors/{id}/match.

func (Client) AuthorUpdate ¶ added in v0.7.1

func (c Client) AuthorUpdate(ctx context.Context, id AuthorID, input AuthorUpdateRequest) (result AuthorUpdateResponse, err error)

AuthorUpdate calls PATCH /api/authors/{id}.

func (Client) AuthorUploadImage ¶ added in v0.7.1

func (c Client) AuthorUploadImage(ctx context.Context, id AuthorID, input AuthorUploadImageRequest) (result AuthorUploadImageResponse, err error)

AuthorUploadImage calls POST /api/authors/{id}/image.

func (Client) BackupApply ¶ added in v0.7.1

func (c Client) BackupApply(ctx context.Context, id string) (result BackupApplyResponse, err error)

BackupApply calls GET /api/backups/{id}/apply.

func (Client) BackupCreate ¶ added in v0.7.1

func (c Client) BackupCreate(ctx context.Context) (result BackupCreateResponse, err error)

BackupCreate calls POST /api/backups.

func (Client) BackupDelete ¶ added in v0.7.1

func (c Client) BackupDelete(ctx context.Context, id string) (result BackupDeleteResponse, err error)

BackupDelete calls DELETE /api/backups/{id}.

func (Client) BackupDownload ¶ added in v0.7.1

func (c Client) BackupDownload(ctx context.Context, id string) (result BackupDownloadResponse, err error)

BackupDownload calls GET /api/backups/{id}/download.

func (Client) BackupGetAll ¶ added in v0.7.1

func (c Client) BackupGetAll(ctx context.Context) (result BackupGetAllResponse, err error)

BackupGetAll calls GET /api/backups.

func (Client) BackupUpdatePath ¶ added in v0.7.1

func (c Client) BackupUpdatePath(ctx context.Context, input BackupUpdatePathRequest) (result BackupUpdatePathResponse, err error)

BackupUpdatePath calls PATCH /api/backups/path.

func (Client) BackupUpload ¶ added in v0.7.1

func (c Client) BackupUpload(ctx context.Context, input io.Reader, contentType string) (result BackupUploadResponse, err error)

BackupUpload calls POST /api/backups/upload.

input is sent as contentType, or as multipart/form-data when that is empty.

func (Client) CachePurgeCache ¶ added in v0.7.1

func (c Client) CachePurgeCache(ctx context.Context) (result CachePurgeCacheResponse, err error)

CachePurgeCache calls POST /api/cache/purge.

func (Client) CachePurgeItemsCache ¶ added in v0.7.1

func (c Client) CachePurgeItemsCache(ctx context.Context) (result CachePurgeItemsCacheResponse, err error)

CachePurgeItemsCache calls POST /api/cache/items/purge.

func (Client) CollectionAddBatch ¶ added in v0.7.1

func (c Client) CollectionAddBatch(ctx context.Context, id CollectionID, input CollectionAddBatchRequest) (result CollectionAddBatchResponse, err error)

CollectionAddBatch calls POST /api/collections/{id}/batch/add.

func (Client) CollectionAddBook ¶ added in v0.7.1

func (c Client) CollectionAddBook(ctx context.Context, id CollectionID, input CollectionAddBookRequest) (result CollectionAddBookResponse, err error)

CollectionAddBook calls POST /api/collections/{id}/book.

func (Client) CollectionCreate ¶ added in v0.7.1

func (c Client) CollectionCreate(ctx context.Context, input CollectionCreateRequest) (result CollectionCreateResponse, err error)

CollectionCreate calls POST /api/collections.

func (Client) CollectionDelete ¶ added in v0.7.1

func (c Client) CollectionDelete(ctx context.Context, id CollectionID) (result CollectionDeleteResponse, err error)

CollectionDelete calls DELETE /api/collections/{id}.

func (Client) CollectionFindAll ¶ added in v0.7.1

func (c Client) CollectionFindAll(ctx context.Context) (result CollectionFindAllResponse, err error)

CollectionFindAll calls GET /api/collections.

func (Client) CollectionFindOne ¶ added in v0.7.1

func (c Client) CollectionFindOne(ctx context.Context, id CollectionID, options ...CollectionFindOneOptions) (result CollectionFindOneResponse, err error)

CollectionFindOne calls GET /api/collections/{id}.

func (Client) CollectionRemoveBatch ¶ added in v0.7.1

func (c Client) CollectionRemoveBatch(ctx context.Context, id CollectionID, input CollectionRemoveBatchRequest) (result CollectionRemoveBatchResponse, err error)

CollectionRemoveBatch calls POST /api/collections/{id}/batch/remove.

func (Client) CollectionRemoveBook ¶ added in v0.7.1

func (c Client) CollectionRemoveBook(ctx context.Context, id CollectionID, bookId LibraryItemID) (result CollectionRemoveBookResponse, err error)

CollectionRemoveBook calls DELETE /api/collections/{id}/book/{bookId}.

func (Client) CollectionUpdate ¶ added in v0.7.1

func (c Client) CollectionUpdate(ctx context.Context, id CollectionID, input CollectionUpdateRequest) (result CollectionUpdateResponse, err error)

CollectionUpdate calls PATCH /api/collections/{id}.

func (Client) CustomMetadataProviderCreate ¶ added in v0.7.1

func (c Client) CustomMetadataProviderCreate(ctx context.Context, input CustomMetadataProviderCreateRequest) (result CustomMetadataProviderCreateResponse, err error)

CustomMetadataProviderCreate calls POST /api/custom-metadata-providers.

func (Client) CustomMetadataProviderDelete ¶ added in v0.7.1

func (c Client) CustomMetadataProviderDelete(ctx context.Context, id string) (result CustomMetadataProviderDeleteResponse, err error)

CustomMetadataProviderDelete calls DELETE /api/custom-metadata-providers/{id}.

func (Client) CustomMetadataProviderGetAll ¶ added in v0.7.1

func (c Client) CustomMetadataProviderGetAll(ctx context.Context) (result CustomMetadataProviderGetAllResponse, err error)

CustomMetadataProviderGetAll calls GET /api/custom-metadata-providers.

func (Client) EmailGetSettings ¶ added in v0.7.1

func (c Client) EmailGetSettings(ctx context.Context) (result EmailGetSettingsResponse, err error)

EmailGetSettings calls GET /api/emails/settings.

func (Client) EmailSendEBookToDevice ¶ added in v0.7.1

func (c Client) EmailSendEBookToDevice(ctx context.Context, input EmailSendEBookToDeviceRequest) (result EmailSendEBookToDeviceResponse, err error)

EmailSendEBookToDevice calls POST /api/emails/send-ebook-to-device.

func (Client) EmailSendTest ¶ added in v0.7.1

func (c Client) EmailSendTest(ctx context.Context) (result EmailSendTestResponse, err error)

EmailSendTest calls POST /api/emails/test.

func (Client) EmailUpdateEReaderDevices ¶ added in v0.7.1

func (c Client) EmailUpdateEReaderDevices(ctx context.Context, input EmailUpdateEReaderDevicesRequest) (result EmailUpdateEReaderDevicesResponse, err error)

EmailUpdateEReaderDevices calls POST /api/emails/ereader-devices.

func (Client) EmailUpdateSettings ¶ added in v0.7.1

func (c Client) EmailUpdateSettings(ctx context.Context, input EmailUpdateSettingsRequest) (result EmailUpdateSettingsResponse, err error)

EmailUpdateSettings calls PATCH /api/emails/settings.

func (Client) FileSystemCheckPathExists ¶ added in v0.7.1

func (c Client) FileSystemCheckPathExists(ctx context.Context, input FileSystemCheckPathExistsRequest) (result FileSystemCheckPathExistsResponse, err error)

FileSystemCheckPathExists calls POST /api/filesystem/pathexists.

func (Client) FileSystemGetPaths ¶ added in v0.7.1

func (c Client) FileSystemGetPaths(ctx context.Context, options ...FileSystemGetPathsOptions) (result FileSystemGetPathsResponse, err error)

FileSystemGetPaths calls GET /api/filesystem.

func (Client) LibraryCreate ¶ added in v0.7.1

func (c Client) LibraryCreate(ctx context.Context, input LibraryCreateRequest) (result LibraryCreateResponse, err error)

LibraryCreate calls POST /api/libraries.

func (Client) LibraryDelete ¶ added in v0.7.1

func (c Client) LibraryDelete(ctx context.Context, id LibraryID) (result LibraryDeleteResponse, err error)

LibraryDelete calls DELETE /api/libraries/{id}.

func (Client) LibraryDownloadMultiple ¶ added in v0.7.1

func (c Client) LibraryDownloadMultiple(ctx context.Context, id LibraryID, options ...LibraryDownloadMultipleOptions) (result LibraryDownloadMultipleResponse, err error)

LibraryDownloadMultiple calls GET /api/libraries/{id}/download.

func (Client) LibraryFindAll ¶ added in v0.7.1

func (c Client) LibraryFindAll(ctx context.Context, options ...LibraryFindAllOptions) (result LibraryFindAllResponse, err error)

LibraryFindAll calls GET /api/libraries.

func (Client) LibraryFindOne ¶ added in v0.7.1

func (c Client) LibraryFindOne(ctx context.Context, id LibraryID, options ...LibraryFindOneOptions) (result LibraryFindOneResponse, err error)

LibraryFindOne calls GET /api/libraries/{id}.

func (Client) LibraryGetAllSeriesForLibrary ¶ added in v0.7.1

func (c Client) LibraryGetAllSeriesForLibrary(ctx context.Context, id LibraryID, options ...LibraryGetAllSeriesForLibraryOptions) (result LibraryGetAllSeriesForLibraryResponse, err error)

LibraryGetAllSeriesForLibrary calls GET /api/libraries/{id}/series.

func (Client) LibraryGetAllSeriesForLibraryComplete ¶ added in v0.7.1

func (c Client) LibraryGetAllSeriesForLibraryComplete(ctx context.Context, id LibraryID, options ...LibraryGetAllSeriesForLibraryOptions) (result LibraryGetAllSeriesForLibraryCompleteResult, err error)

LibraryGetAllSeriesForLibraryComplete calls LibraryGetAllSeriesForLibrary page by page, from the page options.Page names (the first when unset), until every result is loaded. options.Limit is the page size, client.DefaultPageSize when unset.

func (Client) LibraryGetAllSeriesForLibraryEach ¶ added in v0.7.1

func (c Client) LibraryGetAllSeriesForLibraryEach(ctx context.Context, id LibraryID, options ...LibraryGetAllSeriesForLibraryOptions) iter.Seq2[Series, error]

LibraryGetAllSeriesForLibraryEach calls LibraryGetAllSeriesForLibrary page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.LibraryGetAllSeriesForLibraryEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero Series. The pages are asked for as LibraryGetAllSeriesForLibraryComplete asks for them.

func (Client) LibraryGetAuthors ¶ added in v0.7.1

func (c Client) LibraryGetAuthors(ctx context.Context, id LibraryID, options ...LibraryGetAuthorsOptions) (result LibraryGetAuthorsResponse, err error)

LibraryGetAuthors calls GET /api/libraries/{id}/authors.

func (Client) LibraryGetAuthorsComplete ¶ added in v0.7.1

func (c Client) LibraryGetAuthorsComplete(ctx context.Context, id LibraryID, options ...LibraryGetAuthorsOptions) (result LibraryGetAuthorsCompleteResult, err error)

LibraryGetAuthorsComplete calls LibraryGetAuthors page by page, from the page options.Page names (the first when unset), until every result is loaded. options.Limit is the page size, client.DefaultPageSize when unset.

func (Client) LibraryGetAuthorsEach ¶ added in v0.7.1

func (c Client) LibraryGetAuthorsEach(ctx context.Context, id LibraryID, options ...LibraryGetAuthorsOptions) iter.Seq2[Author, error]

LibraryGetAuthorsEach calls LibraryGetAuthors page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.LibraryGetAuthorsEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero Author. The pages are asked for as LibraryGetAuthorsComplete asks for them.

func (Client) LibraryGetCollectionsForLibrary ¶ added in v0.7.1

func (c Client) LibraryGetCollectionsForLibrary(ctx context.Context, id LibraryID, options ...LibraryGetCollectionsForLibraryOptions) (result LibraryGetCollectionsForLibraryResponse, err error)

LibraryGetCollectionsForLibrary calls GET /api/libraries/{id}/collections.

func (Client) LibraryGetCollectionsForLibraryComplete ¶ added in v0.7.1

func (c Client) LibraryGetCollectionsForLibraryComplete(ctx context.Context, id LibraryID, options ...LibraryGetCollectionsForLibraryOptions) (result LibraryGetCollectionsForLibraryCompleteResult, err error)

LibraryGetCollectionsForLibraryComplete calls LibraryGetCollectionsForLibrary page by page, from the page options.Page names (the first when unset), until every result is loaded. options.Limit is the page size, client.DefaultPageSize when unset.

func (Client) LibraryGetCollectionsForLibraryEach ¶ added in v0.7.1

func (c Client) LibraryGetCollectionsForLibraryEach(ctx context.Context, id LibraryID, options ...LibraryGetCollectionsForLibraryOptions) iter.Seq2[Collection, error]

LibraryGetCollectionsForLibraryEach calls LibraryGetCollectionsForLibrary page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.LibraryGetCollectionsForLibraryEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero Collection. The pages are asked for as LibraryGetCollectionsForLibraryComplete asks for them.

func (Client) LibraryGetEpisodeDownloadQueue ¶ added in v0.7.1

func (c Client) LibraryGetEpisodeDownloadQueue(ctx context.Context, id LibraryID, options ...LibraryGetEpisodeDownloadQueueOptions) (result LibraryGetEpisodeDownloadQueueResponse, err error)

LibraryGetEpisodeDownloadQueue calls GET /api/libraries/{id}/episode-downloads.

func (Client) LibraryGetLibraryFilterData ¶ added in v0.7.1

func (c Client) LibraryGetLibraryFilterData(ctx context.Context, id LibraryID, options ...LibraryGetLibraryFilterDataOptions) (result LibraryGetLibraryFilterDataResponse, err error)

LibraryGetLibraryFilterData calls GET /api/libraries/{id}/filterdata.

func (Client) LibraryGetLibraryItems ¶ added in v0.7.1

func (c Client) LibraryGetLibraryItems(ctx context.Context, id LibraryID, options ...LibraryGetLibraryItemsOptions) (result LibraryGetLibraryItemsResponse, err error)

LibraryGetLibraryItems calls GET /api/libraries/{id}/items.

func (Client) LibraryGetLibraryItemsComplete ¶ added in v0.7.1

func (c Client) LibraryGetLibraryItemsComplete(ctx context.Context, id LibraryID, options ...LibraryGetLibraryItemsOptions) (result LibraryGetLibraryItemsCompleteResult, err error)

LibraryGetLibraryItemsComplete calls LibraryGetLibraryItems page by page, from the page options.Page names (the first when unset), until every result is loaded. options.Limit is the page size, client.DefaultPageSize when unset.

func (Client) LibraryGetLibraryItemsEach ¶ added in v0.7.1

func (c Client) LibraryGetLibraryItemsEach(ctx context.Context, id LibraryID, options ...LibraryGetLibraryItemsOptions) iter.Seq2[LibraryItemMinified, error]

LibraryGetLibraryItemsEach calls LibraryGetLibraryItems page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.LibraryGetLibraryItemsEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero LibraryItemMinified. The pages are asked for as LibraryGetLibraryItemsComplete asks for them.

func (Client) LibraryGetNarrators ¶ added in v0.7.1

func (c Client) LibraryGetNarrators(ctx context.Context, id LibraryID, options ...LibraryGetNarratorsOptions) (result LibraryGetNarratorsResponse, err error)

LibraryGetNarrators calls GET /api/libraries/{id}/narrators.

func (Client) LibraryGetOPMLFile ¶ added in v0.7.1

func (c Client) LibraryGetOPMLFile(ctx context.Context, id LibraryID, options ...LibraryGetOPMLFileOptions) (result LibraryGetOPMLFileResponse, err error)

LibraryGetOPMLFile calls GET /api/libraries/{id}/opml.

func (Client) LibraryGetPodcastTitles ¶ added in v0.7.1

func (c Client) LibraryGetPodcastTitles(ctx context.Context, id LibraryID, options ...LibraryGetPodcastTitlesOptions) (result LibraryGetPodcastTitlesResponse, err error)

LibraryGetPodcastTitles calls GET /api/libraries/{id}/podcast-titles.

func (Client) LibraryGetRecentEpisodes ¶ added in v0.7.1

func (c Client) LibraryGetRecentEpisodes(ctx context.Context, id LibraryID, options ...LibraryGetRecentEpisodesOptions) (result LibraryGetRecentEpisodesResponse, err error)

LibraryGetRecentEpisodes calls GET /api/libraries/{id}/recent-episodes.

func (Client) LibraryGetSeriesForLibrary ¶ added in v0.7.1

func (c Client) LibraryGetSeriesForLibrary(ctx context.Context, id LibraryID, seriesId SeriesID, options ...LibraryGetSeriesForLibraryOptions) (result LibraryGetSeriesForLibraryResponse, err error)

LibraryGetSeriesForLibrary calls GET /api/libraries/{id}/series/{seriesId}.

func (Client) LibraryGetUserPersonalizedShelves ¶ added in v0.7.1

func (c Client) LibraryGetUserPersonalizedShelves(ctx context.Context, id LibraryID, options ...LibraryGetUserPersonalizedShelvesOptions) (result LibraryGetUserPersonalizedShelvesResponse, err error)

LibraryGetUserPersonalizedShelves calls GET /api/libraries/{id}/personalized.

func (Client) LibraryGetUserPlaylistsForLibrary ¶ added in v0.7.1

func (c Client) LibraryGetUserPlaylistsForLibrary(ctx context.Context, id LibraryID, options ...LibraryGetUserPlaylistsForLibraryOptions) (result LibraryGetUserPlaylistsForLibraryResponse, err error)

LibraryGetUserPlaylistsForLibrary calls GET /api/libraries/{id}/playlists.

func (Client) LibraryGetUserPlaylistsForLibraryComplete ¶ added in v0.7.1

func (c Client) LibraryGetUserPlaylistsForLibraryComplete(ctx context.Context, id LibraryID, options ...LibraryGetUserPlaylistsForLibraryOptions) (result LibraryGetUserPlaylistsForLibraryCompleteResult, err error)

LibraryGetUserPlaylistsForLibraryComplete calls LibraryGetUserPlaylistsForLibrary page by page, from the page options.Page names (the first when unset), until every result is loaded. options.Limit is the page size, client.DefaultPageSize when unset.

func (Client) LibraryGetUserPlaylistsForLibraryEach ¶ added in v0.7.1

func (c Client) LibraryGetUserPlaylistsForLibraryEach(ctx context.Context, id LibraryID, options ...LibraryGetUserPlaylistsForLibraryOptions) iter.Seq2[Playlist, error]

LibraryGetUserPlaylistsForLibraryEach calls LibraryGetUserPlaylistsForLibrary page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.LibraryGetUserPlaylistsForLibraryEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero Playlist. The pages are asked for as LibraryGetUserPlaylistsForLibraryComplete asks for them.

func (Client) LibraryItemBatchDelete ¶ added in v0.7.1

func (c Client) LibraryItemBatchDelete(ctx context.Context, input LibraryItemBatchDeleteRequest, options ...LibraryItemBatchDeleteOptions) (result LibraryItemBatchDeleteResponse, err error)

LibraryItemBatchDelete calls POST /api/items/batch/delete.

func (Client) LibraryItemBatchGet ¶ added in v0.7.1

func (c Client) LibraryItemBatchGet(ctx context.Context, input LibraryItemBatchGetRequest) (result LibraryItemBatchGetResponse, err error)

LibraryItemBatchGet calls POST /api/items/batch/get.

func (Client) LibraryItemBatchQuickMatch ¶ added in v0.7.1

func (c Client) LibraryItemBatchQuickMatch(ctx context.Context, input LibraryItemBatchQuickMatchRequest) (result LibraryItemBatchQuickMatchResponse, err error)

LibraryItemBatchQuickMatch calls POST /api/items/batch/quickmatch.

func (Client) LibraryItemBatchScan ¶ added in v0.7.1

func (c Client) LibraryItemBatchScan(ctx context.Context, input LibraryItemBatchScanRequest) (result LibraryItemBatchScanResponse, err error)

LibraryItemBatchScan calls POST /api/items/batch/scan.

func (Client) LibraryItemBatchUpdate ¶ added in v0.7.1

func (c Client) LibraryItemBatchUpdate(ctx context.Context, input []LibraryItemBatchUpdateRequest) (result LibraryItemBatchUpdateResponse, err error)

LibraryItemBatchUpdate calls POST /api/items/batch/update.

func (Client) LibraryItemDelete ¶ added in v0.7.1

func (c Client) LibraryItemDelete(ctx context.Context, id LibraryItemID, options ...LibraryItemDeleteOptions) (result LibraryItemDeleteResponse, err error)

LibraryItemDelete calls DELETE /api/items/{id}.

func (Client) LibraryItemDeleteLibraryFile ¶ added in v0.7.1

func (c Client) LibraryItemDeleteLibraryFile(ctx context.Context, id LibraryItemID, fileid string) (result LibraryItemDeleteLibraryFileResponse, err error)

LibraryItemDeleteLibraryFile calls DELETE /api/items/{id}/file/{fileid}.

func (Client) LibraryItemDownload ¶ added in v0.7.1

func (c Client) LibraryItemDownload(ctx context.Context, id LibraryItemID) (result LibraryItemDownloadResponse, err error)

LibraryItemDownload calls GET /api/items/{id}/download.

func (Client) LibraryItemDownloadLibraryFile ¶ added in v0.7.1

func (c Client) LibraryItemDownloadLibraryFile(ctx context.Context, id LibraryItemID, fileid string) (result LibraryItemDownloadLibraryFileResponse, err error)

LibraryItemDownloadLibraryFile calls GET /api/items/{id}/file/{fileid}/download.

func (Client) LibraryItemFindOne ¶ added in v0.7.1

func (c Client) LibraryItemFindOne(ctx context.Context, id LibraryItemID, options ...LibraryItemFindOneOptions) (result LibraryItemFindOneResponse, err error)

LibraryItemFindOne calls GET /api/items/{id}.

func (Client) LibraryItemGetCover ¶ added in v0.7.1

func (c Client) LibraryItemGetCover(ctx context.Context, id LibraryItemID, options ...LibraryItemGetCoverOptions) (result LibraryItemGetCoverResponse, err error)

LibraryItemGetCover calls GET /api/items/{id}/cover.

func (Client) LibraryItemGetEBookFile ¶ added in v0.7.1

func (c Client) LibraryItemGetEBookFile(ctx context.Context, id LibraryItemID, fileid string) (result LibraryItemGetEBookFileResponse, err error)

LibraryItemGetEBookFile calls GET /api/items/{id}/ebook/{fileid}.

func (Client) LibraryItemGetEBookFile2 ¶ added in v0.7.1

func (c Client) LibraryItemGetEBookFile2(ctx context.Context, id LibraryItemID) (result LibraryItemGetEBookFile2Response, err error)

LibraryItemGetEBookFile2 calls GET /api/items/{id}/ebook.

func (Client) LibraryItemGetFFprobeData ¶ added in v0.7.1

func (c Client) LibraryItemGetFFprobeData(ctx context.Context, id LibraryItemID, fileid string) (result LibraryItemGetFFprobeDataResponse, err error)

LibraryItemGetFFprobeData calls GET /api/items/{id}/ffprobe/{fileid}.

func (Client) LibraryItemGetLibraryFile ¶ added in v0.7.1

func (c Client) LibraryItemGetLibraryFile(ctx context.Context, id LibraryItemID, fileid string, options ...LibraryItemGetLibraryFileOptions) (result LibraryItemGetLibraryFileResponse, err error)

LibraryItemGetLibraryFile calls GET /api/items/{id}/file/{fileid}.

func (Client) LibraryItemGetMetadataObject ¶ added in v0.7.1

func (c Client) LibraryItemGetMetadataObject(ctx context.Context, id LibraryItemID) (result LibraryItemGetMetadataObjectResponse, err error)

LibraryItemGetMetadataObject calls GET /api/items/{id}/metadata-object.

func (Client) LibraryItemMatch ¶ added in v0.7.1

func (c Client) LibraryItemMatch(ctx context.Context, id LibraryItemID, input LibraryItemMatchRequest) (result LibraryItemMatchResponse, err error)

LibraryItemMatch calls POST /api/items/{id}/match.

func (Client) LibraryItemRemoveCover ¶ added in v0.7.1

func (c Client) LibraryItemRemoveCover(ctx context.Context, id LibraryItemID) (result LibraryItemRemoveCoverResponse, err error)

LibraryItemRemoveCover calls DELETE /api/items/{id}/cover.

func (Client) LibraryItemScan ¶ added in v0.7.1

func (c Client) LibraryItemScan(ctx context.Context, id LibraryItemID) (result LibraryItemScanResponse, err error)

LibraryItemScan calls POST /api/items/{id}/scan.

func (Client) LibraryItemStartEpisodePlaybackSession ¶ added in v0.7.1

func (c Client) LibraryItemStartEpisodePlaybackSession(ctx context.Context, id LibraryItemID, episodeId EpisodeID, input LibraryItemStartEpisodePlaybackSessionRequest) (result LibraryItemStartEpisodePlaybackSessionResponse, err error)

LibraryItemStartEpisodePlaybackSession calls POST /api/items/{id}/play/{episodeId}.

func (Client) LibraryItemStartPlaybackSession ¶ added in v0.7.1

func (c Client) LibraryItemStartPlaybackSession(ctx context.Context, id LibraryItemID, input LibraryItemStartPlaybackSessionRequest) (result LibraryItemStartPlaybackSessionResponse, err error)

LibraryItemStartPlaybackSession calls POST /api/items/{id}/play.

func (Client) LibraryItemUpdateCover ¶ added in v0.7.1

func (c Client) LibraryItemUpdateCover(ctx context.Context, id LibraryItemID, input LibraryItemUpdateCoverRequest) (result LibraryItemUpdateCoverResponse, err error)

LibraryItemUpdateCover calls PATCH /api/items/{id}/cover.

func (Client) LibraryItemUpdateEbookFileStatus ¶ added in v0.7.1

func (c Client) LibraryItemUpdateEbookFileStatus(ctx context.Context, id LibraryItemID, fileid string) (result LibraryItemUpdateEbookFileStatusResponse, err error)

LibraryItemUpdateEbookFileStatus calls PATCH /api/items/{id}/ebook/{fileid}/status.

func (Client) LibraryItemUpdateMedia ¶ added in v0.7.1

func (c Client) LibraryItemUpdateMedia(ctx context.Context, id LibraryItemID, input MediaUpdate) (result LibraryItemUpdateMediaResponse, err error)

LibraryItemUpdateMedia calls PATCH /api/items/{id}/media.

func (Client) LibraryItemUpdateMediaChapters ¶ added in v0.7.1

func (c Client) LibraryItemUpdateMediaChapters(ctx context.Context, id LibraryItemID, input LibraryItemUpdateMediaChaptersRequest) (result LibraryItemUpdateMediaChaptersResponse, err error)

LibraryItemUpdateMediaChapters calls POST /api/items/{id}/chapters.

func (Client) LibraryItemUpdateTracks ¶ added in v0.7.1

func (c Client) LibraryItemUpdateTracks(ctx context.Context, id LibraryItemID, input LibraryItemUpdateTracksRequest) (result LibraryItemUpdateTracksResponse, err error)

LibraryItemUpdateTracks calls PATCH /api/items/{id}/tracks.

func (Client) LibraryItemUploadCover ¶ added in v0.7.1

func (c Client) LibraryItemUploadCover(ctx context.Context, id LibraryItemID, input io.Reader, contentType string) (result LibraryItemUploadCoverResponse, err error)

LibraryItemUploadCover calls POST /api/items/{id}/cover.

input is sent as contentType, or as multipart/form-data when that is empty.

func (Client) LibraryMatchAll ¶ added in v0.7.1

func (c Client) LibraryMatchAll(ctx context.Context, id LibraryID, options ...LibraryMatchAllOptions) (result LibraryMatchAllResponse, err error)

LibraryMatchAll calls GET /api/libraries/{id}/matchall.

func (Client) LibraryRemoveAllMetadataFiles ¶ added in v0.7.1

func (c Client) LibraryRemoveAllMetadataFiles(ctx context.Context, id LibraryID, options ...LibraryRemoveAllMetadataFilesOptions) (result LibraryRemoveAllMetadataFilesResponse, err error)

LibraryRemoveAllMetadataFiles calls POST /api/libraries/{id}/remove-metadata.

func (Client) LibraryRemoveLibraryItemsWithIssues ¶ added in v0.7.1

func (c Client) LibraryRemoveLibraryItemsWithIssues(ctx context.Context, id LibraryID) (result LibraryRemoveLibraryItemsWithIssuesResponse, err error)

LibraryRemoveLibraryItemsWithIssues calls DELETE /api/libraries/{id}/issues.

func (Client) LibraryRemoveNarrator ¶ added in v0.7.1

func (c Client) LibraryRemoveNarrator(ctx context.Context, id LibraryID, narratorId string) (result LibraryRemoveNarratorResponse, err error)

LibraryRemoveNarrator calls DELETE /api/libraries/{id}/narrators/{narratorId}.

func (Client) LibraryReorder ¶ added in v0.7.1

func (c Client) LibraryReorder(ctx context.Context, input []LibraryReorderRequest) (result LibraryReorderResponse, err error)

LibraryReorder calls POST /api/libraries/order.

func (Client) LibraryScan ¶ added in v0.7.1

func (c Client) LibraryScan(ctx context.Context, id LibraryID, options ...LibraryScanOptions) (result LibraryScanResponse, err error)

LibraryScan calls POST /api/libraries/{id}/scan.

func (Client) LibrarySearch ¶ added in v0.7.1

func (c Client) LibrarySearch(ctx context.Context, id LibraryID, options ...LibrarySearchOptions) (result LibrarySearchResponse, err error)

LibrarySearch calls GET /api/libraries/{id}/search.

func (Client) LibraryStats ¶

func (c Client) LibraryStats(ctx context.Context, id LibraryID, options ...LibraryStatsOptions) (result LibraryStatsResponse, err error)

LibraryStats calls GET /api/libraries/{id}/stats.

func (Client) LibraryUpdate ¶ added in v0.7.1

func (c Client) LibraryUpdate(ctx context.Context, id LibraryID, input LibraryUpdateRequest) (result LibraryUpdateResponse, err error)

LibraryUpdate calls PATCH /api/libraries/{id}.

func (Client) LibraryUpdateNarrator ¶ added in v0.7.1

func (c Client) LibraryUpdateNarrator(ctx context.Context, id LibraryID, narratorId string, input LibraryUpdateNarratorRequest) (result LibraryUpdateNarratorResponse, err error)

LibraryUpdateNarrator calls PATCH /api/libraries/{id}/narrators/{narratorId}.

func (Client) MeBatchUpdateMediaProgress ¶ added in v0.7.1

func (c Client) MeBatchUpdateMediaProgress(ctx context.Context, input []ProgressUpdatePayload) (result MeBatchUpdateMediaProgressResponse, err error)

MeBatchUpdateMediaProgress calls PATCH /api/me/progress/batch/update.

func (Client) MeCreateBookmark ¶ added in v0.7.1

func (c Client) MeCreateBookmark(ctx context.Context, id LibraryItemID, input MeCreateBookmarkRequest) (result MeCreateBookmarkResponse, err error)

MeCreateBookmark calls POST /api/me/item/{id}/bookmark.

func (Client) MeCreateUpdateMediaProgress ¶ added in v0.7.1

func (c Client) MeCreateUpdateMediaProgress(ctx context.Context, libraryItemId LibraryItemID, episodeId EpisodeID, input ProgressUpdatePayload) (result MeCreateUpdateMediaProgressResponse, err error)

MeCreateUpdateMediaProgress calls PATCH /api/me/progress/{libraryItemId}/{episodeId}.

func (Client) MeCreateUpdateMediaProgress2 ¶ added in v0.7.1

func (c Client) MeCreateUpdateMediaProgress2(ctx context.Context, libraryItemId LibraryItemID, input ProgressUpdatePayload) (result MeCreateUpdateMediaProgress2Response, err error)

MeCreateUpdateMediaProgress2 calls PATCH /api/me/progress/{libraryItemId}.

func (Client) MeDeleteSession ¶ added in v0.7.1

func (c Client) MeDeleteSession(ctx context.Context, id string) (result MeDeleteSessionResponse, err error)

MeDeleteSession calls DELETE /api/me/sessions/{id}.

func (Client) MeGetAllBookmarks ¶ added in v0.7.1

func (c Client) MeGetAllBookmarks(ctx context.Context) (result MeGetAllBookmarksResponse, err error)

MeGetAllBookmarks calls GET /api/me/bookmarks.

func (Client) MeGetAllLibraryItemsInProgress ¶ added in v0.7.1

func (c Client) MeGetAllLibraryItemsInProgress(ctx context.Context, options ...MeGetAllLibraryItemsInProgressOptions) (result MeGetAllLibraryItemsInProgressResponse, err error)

MeGetAllLibraryItemsInProgress calls GET /api/me/items-in-progress.

func (Client) MeGetAllMediaProgress ¶ added in v0.7.1

func (c Client) MeGetAllMediaProgress(ctx context.Context) (result MeGetAllMediaProgressResponse, err error)

MeGetAllMediaProgress calls GET /api/me/progress.

func (Client) MeGetBookmarksForLibraryItem ¶ added in v0.7.1

func (c Client) MeGetBookmarksForLibraryItem(ctx context.Context, libraryItemId LibraryItemID) (result MeGetBookmarksForLibraryItemResponse, err error)

MeGetBookmarksForLibraryItem calls GET /api/me/bookmarks/{libraryItemId}.

func (Client) MeGetCurrentUser ¶ added in v0.7.1

func (c Client) MeGetCurrentUser(ctx context.Context) (result MeGetCurrentUserResponse, err error)

MeGetCurrentUser calls GET /api/me.

func (Client) MeGetItemListeningSessions ¶ added in v0.7.1

func (c Client) MeGetItemListeningSessions(ctx context.Context, libraryItemId LibraryItemID, episodeId EpisodeID, options ...MeGetItemListeningSessionsOptions) (result MeGetItemListeningSessionsResponse, err error)

MeGetItemListeningSessions calls GET /api/me/item/listening-sessions/{libraryItemId}/{episodeId}.

func (Client) MeGetItemListeningSessions2 ¶ added in v0.7.1

func (c Client) MeGetItemListeningSessions2(ctx context.Context, libraryItemId LibraryItemID, options ...MeGetItemListeningSessions2Options) (result MeGetItemListeningSessions2Response, err error)

MeGetItemListeningSessions2 calls GET /api/me/item/listening-sessions/{libraryItemId}.

func (Client) MeGetItemListeningSessions2Complete ¶ added in v0.7.1

func (c Client) MeGetItemListeningSessions2Complete(ctx context.Context, libraryItemId LibraryItemID, options ...MeGetItemListeningSessions2Options) (result MeGetItemListeningSessions2CompleteResult, err error)

MeGetItemListeningSessions2Complete calls MeGetItemListeningSessions2 page by page, from the page options.Page names (the first when unset), until every result is loaded. options.ItemsPerPage is the page size, client.DefaultPageSize when unset.

func (Client) MeGetItemListeningSessions2Each ¶ added in v0.7.1

func (c Client) MeGetItemListeningSessions2Each(ctx context.Context, libraryItemId LibraryItemID, options ...MeGetItemListeningSessions2Options) iter.Seq2[PlaybackSession, error]

MeGetItemListeningSessions2Each calls MeGetItemListeningSessions2 page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.MeGetItemListeningSessions2Each(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero PlaybackSession. The pages are asked for as MeGetItemListeningSessions2Complete asks for them.

func (Client) MeGetItemListeningSessionsComplete ¶ added in v0.7.1

func (c Client) MeGetItemListeningSessionsComplete(ctx context.Context, libraryItemId LibraryItemID, episodeId EpisodeID, options ...MeGetItemListeningSessionsOptions) (result MeGetItemListeningSessionsCompleteResult, err error)

MeGetItemListeningSessionsComplete calls MeGetItemListeningSessions page by page, from the page options.Page names (the first when unset), until every result is loaded. options.ItemsPerPage is the page size, client.DefaultPageSize when unset.

func (Client) MeGetItemListeningSessionsEach ¶ added in v0.7.1

func (c Client) MeGetItemListeningSessionsEach(ctx context.Context, libraryItemId LibraryItemID, episodeId EpisodeID, options ...MeGetItemListeningSessionsOptions) iter.Seq2[PlaybackSession, error]

MeGetItemListeningSessionsEach calls MeGetItemListeningSessions page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.MeGetItemListeningSessionsEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero PlaybackSession. The pages are asked for as MeGetItemListeningSessionsComplete asks for them.

func (Client) MeGetListeningSessions ¶ added in v0.7.1

func (c Client) MeGetListeningSessions(ctx context.Context, options ...MeGetListeningSessionsOptions) (result MeGetListeningSessionsResponse, err error)

MeGetListeningSessions calls GET /api/me/listening-sessions.

func (Client) MeGetListeningSessionsComplete ¶ added in v0.7.1

func (c Client) MeGetListeningSessionsComplete(ctx context.Context, options ...MeGetListeningSessionsOptions) (result MeGetListeningSessionsCompleteResult, err error)

MeGetListeningSessionsComplete calls MeGetListeningSessions page by page, from the page options.Page names (the first when unset), until every result is loaded. options.ItemsPerPage is the page size, client.DefaultPageSize when unset.

func (Client) MeGetListeningSessionsEach ¶ added in v0.7.1

func (c Client) MeGetListeningSessionsEach(ctx context.Context, options ...MeGetListeningSessionsOptions) iter.Seq2[PlaybackSession, error]

MeGetListeningSessionsEach calls MeGetListeningSessions page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.MeGetListeningSessionsEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero PlaybackSession. The pages are asked for as MeGetListeningSessionsComplete asks for them.

func (Client) MeGetListeningStats ¶ added in v0.7.1

func (c Client) MeGetListeningStats(ctx context.Context) (result MeGetListeningStatsResponse, err error)

MeGetListeningStats calls GET /api/me/listening-stats.

func (Client) MeGetMediaProgress ¶ added in v0.7.1

func (c Client) MeGetMediaProgress(ctx context.Context, id LibraryItemID, episodeId EpisodeID) (result MeGetMediaProgressResponse, err error)

MeGetMediaProgress calls GET /api/me/progress/{id}/{episodeId}.

func (Client) MeGetMediaProgress2 ¶ added in v0.7.1

func (c Client) MeGetMediaProgress2(ctx context.Context, id LibraryItemID) (result MeGetMediaProgress2Response, err error)

MeGetMediaProgress2 calls GET /api/me/progress/{id}.

func (Client) MeGetSessions ¶ added in v0.7.1

func (c Client) MeGetSessions(ctx context.Context, options ...MeGetSessionsOptions) (result MeGetSessionsResponse, err error)

MeGetSessions calls GET /api/me/sessions.

func (Client) MeGetSessionsComplete ¶ added in v0.7.1

func (c Client) MeGetSessionsComplete(ctx context.Context, options ...MeGetSessionsOptions) (result MeGetSessionsCompleteResult, err error)

MeGetSessionsComplete calls MeGetSessions page by page, from the page options.Page names (the first when unset), until every result is loaded. options.ItemsPerPage is the page size, client.DefaultPageSize when unset.

func (Client) MeGetSessionsEach ¶ added in v0.7.1

func (c Client) MeGetSessionsEach(ctx context.Context, options ...MeGetSessionsOptions) iter.Seq2[MeGetSessionsAnswerSessions, error]

MeGetSessionsEach calls MeGetSessions page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.MeGetSessionsEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero MeGetSessionsAnswerSessions. The pages are asked for as MeGetSessionsComplete asks for them.

func (Client) MeGetStatsForYear ¶ added in v0.7.1

func (c Client) MeGetStatsForYear(ctx context.Context, year string) (result MeGetStatsForYearResponse, err error)

MeGetStatsForYear calls GET /api/me/stats/year/{year}.

func (Client) MeReaddSeriesFromContinueListening ¶ added in v0.7.1

func (c Client) MeReaddSeriesFromContinueListening(ctx context.Context, id SeriesID) (result MeReaddSeriesFromContinueListeningResponse, err error)

MeReaddSeriesFromContinueListening calls GET /api/me/series/{id}/readd-to-continue-listening.

func (Client) MeRemoveBookmark ¶ added in v0.7.1

func (c Client) MeRemoveBookmark(ctx context.Context, id LibraryItemID, time string) (result MeRemoveBookmarkResponse, err error)

MeRemoveBookmark calls DELETE /api/me/item/{id}/bookmark/{time}.

func (Client) MeRemoveItemFromContinueListening ¶ added in v0.7.1

func (c Client) MeRemoveItemFromContinueListening(ctx context.Context, id string) (result MeRemoveItemFromContinueListeningResponse, err error)

MeRemoveItemFromContinueListening calls GET /api/me/progress/{id}/remove-from-continue-listening.

func (Client) MeRemoveMediaProgress ¶ added in v0.7.1

func (c Client) MeRemoveMediaProgress(ctx context.Context, id string) (result MeRemoveMediaProgressResponse, err error)

MeRemoveMediaProgress calls DELETE /api/me/progress/{id}.

func (Client) MeRemoveSeriesFromContinueListening ¶ added in v0.7.1

func (c Client) MeRemoveSeriesFromContinueListening(ctx context.Context, id SeriesID) (result MeRemoveSeriesFromContinueListeningResponse, err error)

MeRemoveSeriesFromContinueListening calls GET /api/me/series/{id}/remove-from-continue-listening.

func (Client) MeUpdateBookmark ¶ added in v0.7.1

func (c Client) MeUpdateBookmark(ctx context.Context, id LibraryItemID, input MeUpdateBookmarkRequest) (result MeUpdateBookmarkResponse, err error)

MeUpdateBookmark calls PATCH /api/me/item/{id}/bookmark.

func (Client) MeUpdatePassword ¶ added in v0.7.1

func (c Client) MeUpdatePassword(ctx context.Context, input MeUpdatePasswordRequest) (result MeUpdatePasswordResponse, err error)

MeUpdatePassword calls PATCH /api/me/password.

func (Client) MeUpdateUserEReaderDevices ¶ added in v0.7.1

func (c Client) MeUpdateUserEReaderDevices(ctx context.Context, input MeUpdateUserEReaderDevicesRequest) (result MeUpdateUserEReaderDevicesResponse, err error)

MeUpdateUserEReaderDevices calls POST /api/me/ereader-devices.

func (Client) MiscAuthorize ¶ added in v0.7.1

func (c Client) MiscAuthorize(ctx context.Context) (result MiscAuthorizeResponse, err error)

MiscAuthorize calls POST /api/authorize.

func (Client) MiscDeleteGenre ¶ added in v0.7.1

func (c Client) MiscDeleteGenre(ctx context.Context, genre string) (result MiscDeleteGenreResponse, err error)

MiscDeleteGenre calls DELETE /api/genres/{genre}.

func (Client) MiscDeleteTag ¶ added in v0.7.1

func (c Client) MiscDeleteTag(ctx context.Context, tag string) (result MiscDeleteTagResponse, err error)

MiscDeleteTag calls DELETE /api/tags/{tag}.

func (Client) MiscGetAllGenres ¶ added in v0.7.1

func (c Client) MiscGetAllGenres(ctx context.Context) (result MiscGetAllGenresResponse, err error)

MiscGetAllGenres calls GET /api/genres.

func (Client) MiscGetAllTags ¶ added in v0.7.1

func (c Client) MiscGetAllTags(ctx context.Context) (result MiscGetAllTagsResponse, err error)

MiscGetAllTags calls GET /api/tags.

func (Client) MiscGetAuthSettings ¶ added in v0.7.1

func (c Client) MiscGetAuthSettings(ctx context.Context) (result MiscGetAuthSettingsResponse, err error)

MiscGetAuthSettings calls GET /api/auth-settings.

func (Client) MiscGetLoggerData ¶ added in v0.7.1

func (c Client) MiscGetLoggerData(ctx context.Context) (result MiscGetLoggerDataResponse, err error)

MiscGetLoggerData calls GET /api/logger-data.

func (Client) MiscGetTasks ¶ added in v0.7.1

func (c Client) MiscGetTasks(ctx context.Context, options ...MiscGetTasksOptions) (result MiscGetTasksResponse, err error)

MiscGetTasks calls GET /api/tasks.

func (Client) MiscHandleUpload ¶ added in v0.7.1

func (c Client) MiscHandleUpload(ctx context.Context, input io.Reader, contentType string) (result MiscHandleUploadResponse, err error)

MiscHandleUpload calls POST /api/upload.

input is sent as contentType, or as multipart/form-data when that is empty.

func (Client) MiscRenameGenre ¶ added in v0.7.1

func (c Client) MiscRenameGenre(ctx context.Context, input MiscRenameGenreRequest) (result MiscRenameGenreResponse, err error)

MiscRenameGenre calls POST /api/genres/rename.

func (Client) MiscRenameTag ¶ added in v0.7.1

func (c Client) MiscRenameTag(ctx context.Context, input MiscRenameTagRequest) (result MiscRenameTagResponse, err error)

MiscRenameTag calls POST /api/tags/rename.

func (Client) MiscUpdateAuthSettings ¶ added in v0.7.1

func (c Client) MiscUpdateAuthSettings(ctx context.Context, input MiscUpdateAuthSettingsRequest) (result MiscUpdateAuthSettingsResponse, err error)

MiscUpdateAuthSettings calls PATCH /api/auth-settings.

func (Client) MiscUpdateServerSettings ¶ added in v0.7.1

func (c Client) MiscUpdateServerSettings(ctx context.Context, input MiscUpdateServerSettingsRequest) (result MiscUpdateServerSettingsResponse, err error)

MiscUpdateServerSettings calls PATCH /api/settings.

func (Client) MiscUpdateSortingPrefixes ¶ added in v0.7.1

func (c Client) MiscUpdateSortingPrefixes(ctx context.Context, input MiscUpdateSortingPrefixesRequest) (result MiscUpdateSortingPrefixesResponse, err error)

MiscUpdateSortingPrefixes calls PATCH /api/sorting-prefixes.

func (Client) MiscUpdateWatchedPath ¶ added in v0.7.1

func (c Client) MiscUpdateWatchedPath(ctx context.Context, input MiscUpdateWatchedPathRequest) (result MiscUpdateWatchedPathResponse, err error)

MiscUpdateWatchedPath calls POST /api/watcher/update.

func (Client) MiscValidateCronExpression ¶ added in v0.7.1

func (c Client) MiscValidateCronExpression(ctx context.Context, input MiscValidateCronExpressionRequest) (result MiscValidateCronExpressionResponse, err error)

MiscValidateCronExpression calls POST /api/validate-cron.

func (Client) NotificationCreateNotification ¶ added in v0.7.1

func (c Client) NotificationCreateNotification(ctx context.Context, input NotificationCreateNotificationRequest) (result NotificationCreateNotificationResponse, err error)

NotificationCreateNotification calls POST /api/notifications.

func (Client) NotificationDeleteNotification ¶ added in v0.7.1

func (c Client) NotificationDeleteNotification(ctx context.Context, id string) (result NotificationDeleteNotificationResponse, err error)

NotificationDeleteNotification calls DELETE /api/notifications/{id}.

func (Client) NotificationFireTestEvent ¶ added in v0.7.1

func (c Client) NotificationFireTestEvent(ctx context.Context, options ...NotificationFireTestEventOptions) (result NotificationFireTestEventResponse, err error)

NotificationFireTestEvent calls GET /api/notifications/test.

func (Client) NotificationGet ¶ added in v0.7.1

func (c Client) NotificationGet(ctx context.Context) (result NotificationGetResponse, err error)

NotificationGet calls GET /api/notifications.

func (Client) NotificationGetData ¶ added in v0.7.1

func (c Client) NotificationGetData(ctx context.Context) (result NotificationGetDataResponse, err error)

NotificationGetData calls GET /api/notificationdata.

func (Client) NotificationSendNotificationTest ¶ added in v0.7.1

func (c Client) NotificationSendNotificationTest(ctx context.Context, id string) (result NotificationSendNotificationTestResponse, err error)

NotificationSendNotificationTest calls GET /api/notifications/{id}/test.

func (Client) NotificationUpdate ¶ added in v0.7.1

func (c Client) NotificationUpdate(ctx context.Context, input NotificationUpdateRequest) (result NotificationUpdateResponse, err error)

NotificationUpdate calls PATCH /api/notifications.

func (Client) NotificationUpdateNotification ¶ added in v0.7.1

func (c Client) NotificationUpdateNotification(ctx context.Context, id string, input NotificationUpdateNotificationRequest) (result NotificationUpdateNotificationResponse, err error)

NotificationUpdateNotification calls PATCH /api/notifications/{id}.

func (Client) PlaylistAddBatch ¶ added in v0.7.1

func (c Client) PlaylistAddBatch(ctx context.Context, id PlaylistID, input PlaylistAddBatchRequest) (result PlaylistAddBatchResponse, err error)

PlaylistAddBatch calls POST /api/playlists/{id}/batch/add.

func (Client) PlaylistAddItem ¶ added in v0.7.1

func (c Client) PlaylistAddItem(ctx context.Context, id PlaylistID, input PlaylistEntry) (result PlaylistAddItemResponse, err error)

PlaylistAddItem calls POST /api/playlists/{id}/item.

func (Client) PlaylistCreate ¶ added in v0.7.1

func (c Client) PlaylistCreate(ctx context.Context, input PlaylistCreateRequest) (result PlaylistCreateResponse, err error)

PlaylistCreate calls POST /api/playlists.

func (Client) PlaylistCreateFromCollection ¶ added in v0.7.1

func (c Client) PlaylistCreateFromCollection(ctx context.Context, collectionId CollectionID) (result PlaylistCreateFromCollectionResponse, err error)

PlaylistCreateFromCollection calls POST /api/playlists/collection/{collectionId}.

func (Client) PlaylistDelete ¶ added in v0.7.1

func (c Client) PlaylistDelete(ctx context.Context, id PlaylistID) (result PlaylistDeleteResponse, err error)

PlaylistDelete calls DELETE /api/playlists/{id}.

func (Client) PlaylistFindAllForUser ¶ added in v0.7.1

func (c Client) PlaylistFindAllForUser(ctx context.Context) (result PlaylistFindAllForUserResponse, err error)

PlaylistFindAllForUser calls GET /api/playlists.

func (Client) PlaylistFindOne ¶ added in v0.7.1

func (c Client) PlaylistFindOne(ctx context.Context, id PlaylistID) (result PlaylistFindOneResponse, err error)

PlaylistFindOne calls GET /api/playlists/{id}.

func (Client) PlaylistRemoveBatch ¶ added in v0.7.1

func (c Client) PlaylistRemoveBatch(ctx context.Context, id PlaylistID, input PlaylistRemoveBatchRequest) (result PlaylistRemoveBatchResponse, err error)

PlaylistRemoveBatch calls POST /api/playlists/{id}/batch/remove.

func (Client) PlaylistRemoveItem ¶ added in v0.7.1

func (c Client) PlaylistRemoveItem(ctx context.Context, id PlaylistID, libraryItemId LibraryItemID, episodeId EpisodeID) (result PlaylistRemoveItemResponse, err error)

PlaylistRemoveItem calls DELETE /api/playlists/{id}/item/{libraryItemId}/{episodeId}.

func (Client) PlaylistRemoveItem2 ¶ added in v0.7.1

func (c Client) PlaylistRemoveItem2(ctx context.Context, id PlaylistID, libraryItemId LibraryItemID) (result PlaylistRemoveItem2Response, err error)

PlaylistRemoveItem2 calls DELETE /api/playlists/{id}/item/{libraryItemId}.

func (Client) PlaylistUpdate ¶ added in v0.7.1

func (c Client) PlaylistUpdate(ctx context.Context, id PlaylistID, input PlaylistUpdateRequest) (result PlaylistUpdateResponse, err error)

PlaylistUpdate calls PATCH /api/playlists/{id}.

func (Client) PodcastBulkCreatePodcastsFromOpmlFeedUrls ¶ added in v0.7.1

func (c Client) PodcastBulkCreatePodcastsFromOpmlFeedUrls(ctx context.Context, input PodcastBulkCreatePodcastsFromOpmlFeedUrlsRequest) (result PodcastBulkCreatePodcastsFromOpmlFeedUrlsResponse, err error)

PodcastBulkCreatePodcastsFromOpmlFeedUrls calls POST /api/podcasts/opml/create.

func (Client) PodcastCheckNewEpisodes ¶ added in v0.7.1

func (c Client) PodcastCheckNewEpisodes(ctx context.Context, id LibraryItemID, options ...PodcastCheckNewEpisodesOptions) (result PodcastCheckNewEpisodesResponse, err error)

PodcastCheckNewEpisodes calls GET /api/podcasts/{id}/checknew.

func (Client) PodcastClearEpisodeDownloadQueue ¶ added in v0.7.1

func (c Client) PodcastClearEpisodeDownloadQueue(ctx context.Context, id LibraryItemID) (result PodcastClearEpisodeDownloadQueueResponse, err error)

PodcastClearEpisodeDownloadQueue calls GET /api/podcasts/{id}/clear-queue.

func (Client) PodcastCreate ¶ added in v0.7.1

func (c Client) PodcastCreate(ctx context.Context, input PodcastCreateRequest) (result PodcastCreateResponse, err error)

PodcastCreate calls POST /api/podcasts.

func (Client) PodcastDownloadEpisodes ¶ added in v0.7.1

func (c Client) PodcastDownloadEpisodes(ctx context.Context, id LibraryItemID, input []RssPodcastEpisode) (result PodcastDownloadEpisodesResponse, err error)

PodcastDownloadEpisodes calls POST /api/podcasts/{id}/download-episodes.

func (Client) PodcastFindEpisode ¶ added in v0.7.1

func (c Client) PodcastFindEpisode(ctx context.Context, id LibraryItemID, options ...PodcastFindEpisodeOptions) (result PodcastFindEpisodeResponse, err error)

PodcastFindEpisode calls GET /api/podcasts/{id}/search-episode.

func (Client) PodcastGetEpisode ¶ added in v0.7.1

func (c Client) PodcastGetEpisode(ctx context.Context, id LibraryItemID, episodeId EpisodeID) (result PodcastGetEpisodeResponse, err error)

PodcastGetEpisode calls GET /api/podcasts/{id}/episode/{episodeId}.

func (Client) PodcastGetEpisodeDownloads ¶ added in v0.7.1

func (c Client) PodcastGetEpisodeDownloads(ctx context.Context, id LibraryItemID) (result PodcastGetEpisodeDownloadsResponse, err error)

PodcastGetEpisodeDownloads calls GET /api/podcasts/{id}/downloads.

func (Client) PodcastGetFeedsFromOPMLText ¶ added in v0.7.1

func (c Client) PodcastGetFeedsFromOPMLText(ctx context.Context, input PodcastGetFeedsFromOPMLTextRequest) (result PodcastGetFeedsFromOPMLTextResponse, err error)

PodcastGetFeedsFromOPMLText calls POST /api/podcasts/opml/parse.

func (Client) PodcastGetPodcastFeed ¶ added in v0.7.1

func (c Client) PodcastGetPodcastFeed(ctx context.Context, input PodcastGetPodcastFeedRequest) (result PodcastGetPodcastFeedResponse, err error)

PodcastGetPodcastFeed calls POST /api/podcasts/feed.

func (Client) PodcastQuickMatchEpisodes ¶ added in v0.7.1

func (c Client) PodcastQuickMatchEpisodes(ctx context.Context, id LibraryItemID, options ...PodcastQuickMatchEpisodesOptions) (result PodcastQuickMatchEpisodesResponse, err error)

PodcastQuickMatchEpisodes calls POST /api/podcasts/{id}/match-episodes.

func (Client) PodcastRemoveEpisode ¶ added in v0.7.1

func (c Client) PodcastRemoveEpisode(ctx context.Context, id LibraryItemID, episodeId EpisodeID, options ...PodcastRemoveEpisodeOptions) (result PodcastRemoveEpisodeResponse, err error)

PodcastRemoveEpisode calls DELETE /api/podcasts/{id}/episode/{episodeId}.

func (Client) PodcastUpdateEpisode ¶ added in v0.7.1

func (c Client) PodcastUpdateEpisode(ctx context.Context, id LibraryItemID, episodeId EpisodeID, input PodcastUpdateEpisodeRequest) (result PodcastUpdateEpisodeResponse, err error)

PodcastUpdateEpisode calls PATCH /api/podcasts/{id}/episode/{episodeId}.

func (Client) RSSFeedCloseRSSFeed ¶ added in v0.7.1

func (c Client) RSSFeedCloseRSSFeed(ctx context.Context, id string) (result RSSFeedCloseRSSFeedResponse, err error)

RSSFeedCloseRSSFeed calls POST /api/feeds/{id}/close.

func (Client) RSSFeedGetAll ¶ added in v0.7.1

func (c Client) RSSFeedGetAll(ctx context.Context) (result RSSFeedGetAllResponse, err error)

RSSFeedGetAll calls GET /api/feeds.

func (Client) RSSFeedOpenRSSFeedForCollection ¶ added in v0.7.1

func (c Client) RSSFeedOpenRSSFeedForCollection(ctx context.Context, collectionId CollectionID, input RSSFeedOpenRSSFeedForCollectionRequest) (result RSSFeedOpenRSSFeedForCollectionResponse, err error)

RSSFeedOpenRSSFeedForCollection calls POST /api/feeds/collection/{collectionId}/open.

func (Client) RSSFeedOpenRSSFeedForItem ¶ added in v0.7.1

func (c Client) RSSFeedOpenRSSFeedForItem(ctx context.Context, itemId LibraryItemID, input RSSFeedOpenRSSFeedForItemRequest) (result RSSFeedOpenRSSFeedForItemResponse, err error)

RSSFeedOpenRSSFeedForItem calls POST /api/feeds/item/{itemId}/open.

func (Client) RSSFeedOpenRSSFeedForSeries ¶ added in v0.7.1

func (c Client) RSSFeedOpenRSSFeedForSeries(ctx context.Context, seriesId SeriesID, input RSSFeedOpenRSSFeedForSeriesRequest) (result RSSFeedOpenRSSFeedForSeriesResponse, err error)

RSSFeedOpenRSSFeedForSeries calls POST /api/feeds/series/{seriesId}/open.

func (Client) SearchFindAuthor ¶ added in v0.7.1

func (c Client) SearchFindAuthor(ctx context.Context, options ...SearchFindAuthorOptions) (result SearchFindAuthorResponse, err error)

SearchFindAuthor calls GET /api/search/authors.

func (Client) SearchFindBooks ¶ added in v0.7.1

func (c Client) SearchFindBooks(ctx context.Context, options ...SearchFindBooksOptions) (result SearchFindBooksResponse, err error)

SearchFindBooks calls GET /api/search/books.

func (Client) SearchFindChapters ¶ added in v0.7.1

func (c Client) SearchFindChapters(ctx context.Context, options ...SearchFindChaptersOptions) (result SearchFindChaptersResponse, err error)

SearchFindChapters calls GET /api/search/chapters.

func (Client) SearchFindCovers ¶ added in v0.7.1

func (c Client) SearchFindCovers(ctx context.Context, options ...SearchFindCoversOptions) (result SearchFindCoversResponse, err error)

SearchFindCovers calls GET /api/search/covers.

func (Client) SearchFindPodcasts ¶ added in v0.7.1

func (c Client) SearchFindPodcasts(ctx context.Context, options ...SearchFindPodcastsOptions) (result SearchFindPodcastsResponse, err error)

SearchFindPodcasts calls GET /api/search/podcast.

func (Client) SearchGetAllProviders ¶ added in v0.7.1

func (c Client) SearchGetAllProviders(ctx context.Context) (result SearchGetAllProvidersResponse, err error)

SearchGetAllProviders calls GET /api/search/providers.

func (Client) SeriesFindOne ¶ added in v0.7.1

func (c Client) SeriesFindOne(ctx context.Context, id SeriesID, options ...SeriesFindOneOptions) (result SeriesFindOneResponse, err error)

SeriesFindOne calls GET /api/series/{id}.

func (Client) SeriesUpdate ¶ added in v0.7.1

func (c Client) SeriesUpdate(ctx context.Context, id SeriesID, input SeriesUpdateRequest) (result SeriesUpdateResponse, err error)

SeriesUpdate calls PATCH /api/series/{id}.

func (Client) ServerGetFeed ¶ added in v0.7.1

func (c Client) ServerGetFeed(ctx context.Context, slug string) (result ServerGetFeedResponse, err error)

ServerGetFeed calls GET /feed/{slug}.

func (Client) ServerGetHealthcheck ¶ added in v0.7.1

func (c Client) ServerGetHealthcheck(ctx context.Context) (result ServerGetHealthcheckResponse, err error)

ServerGetHealthcheck calls GET /healthcheck.

func (Client) ServerGetPing ¶ added in v0.7.1

func (c Client) ServerGetPing(ctx context.Context) (result ServerGetPingResponse, err error)

ServerGetPing calls GET /ping.

func (Client) ServerGetStatus ¶ added in v0.7.1

func (c Client) ServerGetStatus(ctx context.Context) (result ServerGetStatusResponse, err error)

ServerGetStatus calls GET /status.

func (Client) ServerPostInit ¶ added in v0.7.1

func (c Client) ServerPostInit(ctx context.Context, input ServerPostInitRequest) (result ServerPostInitResponse, err error)

ServerPostInit calls POST /init.

func (Client) SessionBatchDelete ¶ added in v0.7.1

func (c Client) SessionBatchDelete(ctx context.Context, input SessionBatchDeleteRequest) (result SessionBatchDeleteResponse, err error)

SessionBatchDelete calls POST /api/sessions/batch/delete.

func (Client) SessionClose ¶ added in v0.7.1

func (c Client) SessionClose(ctx context.Context, id string, input SessionCloseRequest) (result SessionCloseResponse, err error)

SessionClose calls POST /api/session/{id}/close.

func (Client) SessionDelete ¶ added in v0.7.1

func (c Client) SessionDelete(ctx context.Context, id string) (result SessionDeleteResponse, err error)

SessionDelete calls DELETE /api/sessions/{id}.

func (Client) SessionGetAllWithUserData ¶ added in v0.7.1

func (c Client) SessionGetAllWithUserData(ctx context.Context, options ...SessionGetAllWithUserDataOptions) (result SessionGetAllWithUserDataResponse, err error)

SessionGetAllWithUserData calls GET /api/sessions.

func (Client) SessionGetAllWithUserDataComplete ¶ added in v0.7.1

func (c Client) SessionGetAllWithUserDataComplete(ctx context.Context, options ...SessionGetAllWithUserDataOptions) (result SessionGetAllWithUserDataCompleteResult, err error)

SessionGetAllWithUserDataComplete calls SessionGetAllWithUserData page by page, from the page options.Page names (the first when unset), until every result is loaded. options.ItemsPerPage is the page size, client.DefaultPageSize when unset.

func (Client) SessionGetAllWithUserDataEach ¶ added in v0.7.1

func (c Client) SessionGetAllWithUserDataEach(ctx context.Context, options ...SessionGetAllWithUserDataOptions) iter.Seq2[PlaybackSessionForClient, error]

SessionGetAllWithUserDataEach calls SessionGetAllWithUserData page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.SessionGetAllWithUserDataEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero PlaybackSessionForClient. The pages are asked for as SessionGetAllWithUserDataComplete asks for them.

func (Client) SessionGetOpenSession ¶ added in v0.7.1

func (c Client) SessionGetOpenSession(ctx context.Context, id string) (result SessionGetOpenSessionResponse, err error)

SessionGetOpenSession calls GET /api/session/{id}.

func (Client) SessionGetOpenSessions ¶ added in v0.7.1

func (c Client) SessionGetOpenSessions(ctx context.Context) (result SessionGetOpenSessionsResponse, err error)

SessionGetOpenSessions calls GET /api/sessions/open.

func (Client) SessionGetTrack ¶ added in v0.7.1

func (c Client) SessionGetTrack(ctx context.Context, id string, index string) (result SessionGetTrackResponse, err error)

SessionGetTrack calls GET /public/session/{id}/track/{index}.

func (Client) SessionSync ¶ added in v0.7.1

func (c Client) SessionSync(ctx context.Context, id string, input SessionSyncRequest) (result SessionSyncResponse, err error)

SessionSync calls POST /api/session/{id}/sync.

func (Client) SessionSyncLocal ¶ added in v0.7.1

func (c Client) SessionSyncLocal(ctx context.Context, input SessionSyncLocalRequest) (result SessionSyncLocalResponse, err error)

SessionSyncLocal calls POST /api/session/local.

func (Client) SessionSyncLocalSessions ¶ added in v0.7.1

func (c Client) SessionSyncLocalSessions(ctx context.Context, input SessionSyncLocalSessionsRequest) (result SessionSyncLocalSessionsResponse, err error)

SessionSyncLocalSessions calls POST /api/session/local-all.

func (Client) ShareCreateMediaItemShare ¶ added in v0.7.1

func (c Client) ShareCreateMediaItemShare(ctx context.Context, input ShareCreateMediaItemShareRequest) (result ShareCreateMediaItemShareResponse, err error)

ShareCreateMediaItemShare calls POST /api/share/mediaitem.

func (Client) ShareDeleteMediaItemShare ¶ added in v0.7.1

func (c Client) ShareDeleteMediaItemShare(ctx context.Context, id string) (result ShareDeleteMediaItemShareResponse, err error)

ShareDeleteMediaItemShare calls DELETE /api/share/mediaitem/{id}.

func (Client) ShareDownloadMediaItemShare ¶ added in v0.7.1

func (c Client) ShareDownloadMediaItemShare(ctx context.Context, slug string) (result ShareDownloadMediaItemShareResponse, err error)

ShareDownloadMediaItemShare calls GET /public/share/{slug}/download.

func (Client) ShareGetMediaItemShareAudioTrack ¶ added in v0.7.1

func (c Client) ShareGetMediaItemShareAudioTrack(ctx context.Context, slug string, index string) (result ShareGetMediaItemShareAudioTrackResponse, err error)

ShareGetMediaItemShareAudioTrack calls GET /public/share/{slug}/track/{index}.

func (Client) ShareGetMediaItemShareBySlug ¶ added in v0.7.1

func (c Client) ShareGetMediaItemShareBySlug(ctx context.Context, slug string, options ...ShareGetMediaItemShareBySlugOptions) (result ShareGetMediaItemShareBySlugResponse, err error)

ShareGetMediaItemShareBySlug calls GET /public/share/{slug}.

func (Client) ShareGetMediaItemShareCoverImage ¶ added in v0.7.1

func (c Client) ShareGetMediaItemShareCoverImage(ctx context.Context, slug string) (result ShareGetMediaItemShareCoverImageResponse, err error)

ShareGetMediaItemShareCoverImage calls GET /public/share/{slug}/cover.

func (Client) ShareUpdateMediaItemShareProgress ¶ added in v0.7.1

func (c Client) ShareUpdateMediaItemShareProgress(ctx context.Context, slug string, input ShareUpdateMediaItemShareProgressRequest) (result ShareUpdateMediaItemShareProgressResponse, err error)

ShareUpdateMediaItemShareProgress calls PATCH /public/share/{slug}/progress.

func (Client) StatsGetAdminStatsForYear ¶ added in v0.7.1

func (c Client) StatsGetAdminStatsForYear(ctx context.Context, year string) (result StatsGetAdminStatsForYearResponse, err error)

StatsGetAdminStatsForYear calls GET /api/stats/year/{year}.

func (Client) StatsGetServerStats ¶ added in v0.7.1

func (c Client) StatsGetServerStats(ctx context.Context) (result StatsGetServerStatsResponse, err error)

StatsGetServerStats calls GET /api/stats/server.

func (Client) ToolsBatchEmbedMetadata ¶ added in v0.7.1

func (c Client) ToolsBatchEmbedMetadata(ctx context.Context, input ToolsBatchEmbedMetadataRequest, options ...ToolsBatchEmbedMetadataOptions) (result ToolsBatchEmbedMetadataResponse, err error)

ToolsBatchEmbedMetadata calls POST /api/tools/batch/embed-metadata.

func (Client) ToolsCancelM4bEncode ¶ added in v0.7.1

func (c Client) ToolsCancelM4bEncode(ctx context.Context, id LibraryItemID) (result ToolsCancelM4bEncodeResponse, err error)

ToolsCancelM4bEncode calls DELETE /api/tools/item/{id}/encode-m4b.

func (Client) ToolsEmbedAudioFileMetadata ¶ added in v0.7.1

func (c Client) ToolsEmbedAudioFileMetadata(ctx context.Context, id LibraryItemID, options ...ToolsEmbedAudioFileMetadataOptions) (result ToolsEmbedAudioFileMetadataResponse, err error)

ToolsEmbedAudioFileMetadata calls POST /api/tools/item/{id}/embed-metadata.

func (Client) ToolsEncodeM4b ¶ added in v0.7.1

func (c Client) ToolsEncodeM4b(ctx context.Context, id LibraryItemID, options ...ToolsEncodeM4bOptions) (result ToolsEncodeM4bResponse, err error)

ToolsEncodeM4b calls POST /api/tools/item/{id}/encode-m4b.

func (Client) UserCreate ¶ added in v0.7.1

func (c Client) UserCreate(ctx context.Context, input UserCreateRequest) (result UserCreateResponse, err error)

UserCreate calls POST /api/users.

func (Client) UserDelete ¶ added in v0.7.1

func (c Client) UserDelete(ctx context.Context, id UserID) (result UserDeleteResponse, err error)

UserDelete calls DELETE /api/users/{id}.

func (Client) UserFindAll ¶ added in v0.7.1

func (c Client) UserFindAll(ctx context.Context, options ...UserFindAllOptions) (result UserFindAllResponse, err error)

UserFindAll calls GET /api/users.

func (Client) UserFindOne ¶ added in v0.7.1

func (c Client) UserFindOne(ctx context.Context, id UserID) (result UserFindOneResponse, err error)

UserFindOne calls GET /api/users/{id}.

func (Client) UserGetListeningSessions ¶ added in v0.7.1

func (c Client) UserGetListeningSessions(ctx context.Context, id UserID, options ...UserGetListeningSessionsOptions) (result UserGetListeningSessionsResponse, err error)

UserGetListeningSessions calls GET /api/users/{id}/listening-sessions.

func (Client) UserGetListeningSessionsComplete ¶ added in v0.7.1

func (c Client) UserGetListeningSessionsComplete(ctx context.Context, id UserID, options ...UserGetListeningSessionsOptions) (result UserGetListeningSessionsCompleteResult, err error)

UserGetListeningSessionsComplete calls UserGetListeningSessions page by page, from the page options.Page names (the first when unset), until every result is loaded. options.ItemsPerPage is the page size, client.DefaultPageSize when unset.

func (Client) UserGetListeningSessionsEach ¶ added in v0.7.1

func (c Client) UserGetListeningSessionsEach(ctx context.Context, id UserID, options ...UserGetListeningSessionsOptions) iter.Seq2[PlaybackSessionForClient, error]

UserGetListeningSessionsEach calls UserGetListeningSessions page by page as its results are ranged over, so a loop that stops ends the paging:

for item, err := range c.UserGetListeningSessionsEach(ctx) {
	if err != nil {
		return err
	}
	if found(item) {
		break
	}
}

An error is the last pair handed out, with a zero PlaybackSessionForClient. The pages are asked for as UserGetListeningSessionsComplete asks for them.

func (Client) UserGetListeningStats ¶ added in v0.7.1

func (c Client) UserGetListeningStats(ctx context.Context, id UserID) (result UserGetListeningStatsResponse, err error)

UserGetListeningStats calls GET /api/users/{id}/listening-stats.

func (Client) UserGetOnlineUsers ¶ added in v0.7.1

func (c Client) UserGetOnlineUsers(ctx context.Context) (result UserGetOnlineUsersResponse, err error)

UserGetOnlineUsers calls GET /api/users/online.

func (Client) UserUnlinkFromOpenID ¶ added in v0.7.1

func (c Client) UserUnlinkFromOpenID(ctx context.Context, id UserID) (result UserUnlinkFromOpenIDResponse, err error)

UserUnlinkFromOpenID calls PATCH /api/users/{id}/openid-unlink.

func (Client) UserUpdate ¶ added in v0.7.1

func (c Client) UserUpdate(ctx context.Context, id UserID, input UserUpdateRequest) (result UserUpdateResponse, err error)

UserUpdate calls PATCH /api/users/{id}.

type Collection ¶

type Collection struct {
	Books       []LibraryItemExpanded `json:"books,omitzero"`
	CreatedAt   UnixMilli             `json:"createdAt,omitzero"`
	Description string                `json:"description,omitempty"`
	Id          CollectionID          `json:"id,omitempty"`
	LastUpdate  UnixMilli             `json:"lastUpdate,omitzero"`
	LibraryId   LibraryID             `json:"libraryId,omitempty"`
	Name        string                `json:"name,omitempty"`
	RssFeed     *Feed                 `json:"rssFeed,omitempty"`
}

Collection is the "Collection" schema.

func (Collection) GetId ¶ added in v0.7.1

func (m Collection) GetId() CollectionID

GetId is the record's Id, for code that handles records of several types alike.

func (Collection) GetName ¶ added in v0.7.1

func (m Collection) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type CollectionAddBatchRequest ¶ added in v0.7.1

type CollectionAddBatchRequest struct {
	Books []string `json:"books,omitzero"`
}

CollectionAddBatchRequest is an object the document declares inline.

type CollectionAddBatchResponse ¶ added in v0.7.1

type CollectionAddBatchResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionAddBatchResponse is the result of CollectionAddBatch.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionAddBatchResponse) Answered ¶ added in v0.7.1

func (r CollectionAddBatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionAddBatchResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CollectionAddBookRequest ¶ added in v0.7.1

type CollectionAddBookRequest struct {
	Id string `json:"id,omitempty"`
}

CollectionAddBookRequest is an object the document declares inline.

type CollectionAddBookResponse ¶ added in v0.7.1

type CollectionAddBookResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionAddBookResponse is the result of CollectionAddBook.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionAddBookResponse) Answered ¶ added in v0.7.1

func (r CollectionAddBookResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionAddBookResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CollectionCreateRequest ¶ added in v0.7.1

type CollectionCreateRequest struct {
	Books       []string  `json:"books,omitzero"`
	Description string    `json:"description,omitempty"`
	LibraryId   LibraryID `json:"libraryId,omitempty"`
	Name        string    `json:"name,omitempty"`
}

CollectionCreateRequest is an object the document declares inline.

type CollectionCreateResponse ¶ added in v0.7.1

type CollectionCreateResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionCreateResponse is the result of CollectionCreate.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionCreateResponse) Answered ¶ added in v0.7.1

func (r CollectionCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionCreateResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CollectionDeleteResponse ¶ added in v0.7.1

type CollectionDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

CollectionDeleteResponse is the result of CollectionDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (CollectionDeleteResponse) Answered ¶ added in v0.7.1

func (r CollectionDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type CollectionFindAllAnswer ¶ added in v0.7.1

type CollectionFindAllAnswer struct {
	Collections []Collection `json:"collections,omitzero"`
}

CollectionFindAllAnswer is an object the document declares inline.

type CollectionFindAllResponse ¶ added in v0.7.1

type CollectionFindAllResponse struct {
	HttpResponse *http.Response
	Answer       *CollectionFindAllAnswer
	*CollectionFindAllAnswer
}

CollectionFindAllResponse is the result of CollectionFindAll.

Answer is the CollectionFindAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionFindAllResponse) Answered ¶ added in v0.7.1

func (r CollectionFindAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionFindAllResponse) Record ¶ added in v0.7.1

Record is the CollectionFindAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type CollectionFindOneOptions ¶ added in v0.7.1

type CollectionFindOneOptions struct {
	Include string
}

CollectionFindOneOptions holds the query and header parameters of CollectionFindOne.

func (CollectionFindOneOptions) ToHeaders ¶ added in v0.7.1

func (o CollectionFindOneOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (CollectionFindOneOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type CollectionFindOneResponse ¶ added in v0.7.1

type CollectionFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionFindOneResponse is the result of CollectionFindOne.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionFindOneResponse) Answered ¶ added in v0.7.1

func (r CollectionFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionFindOneResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CollectionID ¶ added in v0.7.1

type CollectionID string

CollectionID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and CollectionID(n) convert one value, client.StringIDs a list.

type CollectionRemoveBatchRequest ¶ added in v0.7.1

type CollectionRemoveBatchRequest struct {
	Books []string `json:"books,omitzero"`
}

CollectionRemoveBatchRequest is an object the document declares inline.

type CollectionRemoveBatchResponse ¶ added in v0.7.1

type CollectionRemoveBatchResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionRemoveBatchResponse is the result of CollectionRemoveBatch.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionRemoveBatchResponse) Answered ¶ added in v0.7.1

func (r CollectionRemoveBatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionRemoveBatchResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CollectionRemoveBookResponse ¶ added in v0.7.1

type CollectionRemoveBookResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionRemoveBookResponse is the result of CollectionRemoveBook.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionRemoveBookResponse) Answered ¶ added in v0.7.1

func (r CollectionRemoveBookResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionRemoveBookResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CollectionUpdateRequest ¶ added in v0.7.1

type CollectionUpdateRequest struct {
	Books       []string `json:"books,omitzero"`
	Description string   `json:"description,omitempty"`
	Name        string   `json:"name,omitempty"`
}

CollectionUpdateRequest is an object the document declares inline.

type CollectionUpdateResponse ¶ added in v0.7.1

type CollectionUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *Collection
	*Collection
}

CollectionUpdateResponse is the result of CollectionUpdate.

Answer is the Collection answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CollectionUpdateResponse) Answered ¶ added in v0.7.1

func (r CollectionUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CollectionUpdateResponse) Record ¶ added in v0.7.1

Record is the Collection answered, as a value to change and write back, or an error when the server answered none.

type CustomMetadataProviderCreateAnswer ¶ added in v0.7.1

type CustomMetadataProviderCreateAnswer struct {
	Provider *CustomMetadataProviderRecord `json:"provider,omitempty"`
}

CustomMetadataProviderCreateAnswer is an object the document declares inline.

type CustomMetadataProviderCreateRequest ¶ added in v0.7.1

type CustomMetadataProviderCreateRequest struct {
	AuthHeaderValue string `json:"authHeaderValue,omitempty"`
	MediaType       string `json:"mediaType,omitempty"`
	Name            string `json:"name,omitempty"`
	Url             string `json:"url,omitempty"`
}

CustomMetadataProviderCreateRequest is an object the document declares inline.

type CustomMetadataProviderCreateResponse ¶ added in v0.7.1

type CustomMetadataProviderCreateResponse struct {
	HttpResponse *http.Response
	Answer       *CustomMetadataProviderCreateAnswer
	*CustomMetadataProviderCreateAnswer
}

CustomMetadataProviderCreateResponse is the result of CustomMetadataProviderCreate.

Answer is the CustomMetadataProviderCreateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CustomMetadataProviderCreateResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CustomMetadataProviderCreateResponse) Record ¶ added in v0.7.1

Record is the CustomMetadataProviderCreateAnswer answered, as a value to change and write back, or an error when the server answered none.

type CustomMetadataProviderDeleteResponse ¶ added in v0.7.1

type CustomMetadataProviderDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

CustomMetadataProviderDeleteResponse is the result of CustomMetadataProviderDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (CustomMetadataProviderDeleteResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type CustomMetadataProviderGetAllAnswer ¶ added in v0.7.1

type CustomMetadataProviderGetAllAnswer struct {
	Providers []CustomMetadataProviderRecord `json:"providers,omitzero"`
}

CustomMetadataProviderGetAllAnswer is an object the document declares inline.

type CustomMetadataProviderGetAllResponse ¶ added in v0.7.1

type CustomMetadataProviderGetAllResponse struct {
	HttpResponse *http.Response
	Answer       *CustomMetadataProviderGetAllAnswer
	*CustomMetadataProviderGetAllAnswer
}

CustomMetadataProviderGetAllResponse is the result of CustomMetadataProviderGetAll.

Answer is the CustomMetadataProviderGetAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (CustomMetadataProviderGetAllResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (CustomMetadataProviderGetAllResponse) Record ¶ added in v0.7.1

Record is the CustomMetadataProviderGetAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type CustomMetadataProviderRecord ¶ added in v0.7.1

type CustomMetadataProviderRecord struct {
	AuthHeaderValue string     `json:"authHeaderValue,omitempty"`
	CreatedAt       string     `json:"createdAt,omitempty"`
	ExtraData       any        `json:"extraData,omitempty"`
	Id              ProviderID `json:"id,omitempty"`
	MediaType       string     `json:"mediaType,omitempty"`
	Name            string     `json:"name,omitempty"`
	UpdatedAt       string     `json:"updatedAt,omitempty"`
	Url             string     `json:"url,omitempty"`
}

CustomMetadataProviderRecord is the "CustomMetadataProviderRecord" schema.

func (CustomMetadataProviderRecord) GetId ¶ added in v0.7.1

GetId is the record's Id, for code that handles records of several types alike.

func (CustomMetadataProviderRecord) GetName ¶ added in v0.7.1

GetName is the record's Name, for code that handles records of several types alike.

type DeviceInfo ¶

type DeviceInfo struct {
	BrowserName    string `json:"browserName,omitempty"`
	BrowserVersion string `json:"browserVersion,omitempty"`
	ClientName     string `json:"clientName,omitempty"`
	ClientVersion  string `json:"clientVersion,omitempty"`
	DeviceId       string `json:"deviceId,omitempty"`
	DeviceName     string `json:"deviceName,omitempty"`
	DeviceType     string `json:"deviceType,omitempty"`
	Id             string `json:"id,omitempty"`
	IpAddress      string `json:"ipAddress,omitempty"`
	Manufacturer   string `json:"manufacturer,omitempty"`
	Model          string `json:"model,omitempty"`
	OsName         string `json:"osName,omitempty"`
	OsVersion      string `json:"osVersion,omitempty"`
	SdkVersion     string `json:"sdkVersion,omitempty"`
	UserId         UserID `json:"userId,omitempty"`
}

DeviceInfo is the "DeviceInfo" schema.

type EBookFile ¶ added in v0.7.1

type EBookFile struct {
	AddedAt         UnixMilli     `json:"addedAt,omitzero"`
	EbookFormat     string        `json:"ebookFormat,omitempty"`
	FileType        string        `json:"fileType,omitempty"`
	Ino             string        `json:"ino,omitempty"`
	IsSupplementary any           `json:"isSupplementary,omitempty"`
	Metadata        *FileMetadata `json:"metadata,omitempty"`
	UpdatedAt       UnixMilli     `json:"updatedAt,omitzero"`
}

EBookFile is the "EBookFile" schema.

type EmailGetSettingsAnswer ¶ added in v0.7.1

type EmailGetSettingsAnswer struct {
	Settings *EmailSettings `json:"settings,omitempty"`
}

EmailGetSettingsAnswer is an object the document declares inline.

type EmailGetSettingsResponse ¶ added in v0.7.1

type EmailGetSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *EmailGetSettingsAnswer
	*EmailGetSettingsAnswer
}

EmailGetSettingsResponse is the result of EmailGetSettings.

Answer is the EmailGetSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (EmailGetSettingsResponse) Answered ¶ added in v0.7.1

func (r EmailGetSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (EmailGetSettingsResponse) Record ¶ added in v0.7.1

Record is the EmailGetSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type EmailSendEBookToDeviceRequest ¶ added in v0.7.1

type EmailSendEBookToDeviceRequest struct {
	DeviceName    string        `json:"deviceName,omitempty"`
	LibraryItemId LibraryItemID `json:"libraryItemId,omitempty"`
}

EmailSendEBookToDeviceRequest is an object the document declares inline.

type EmailSendEBookToDeviceResponse ¶ added in v0.7.1

type EmailSendEBookToDeviceResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

EmailSendEBookToDeviceResponse is the result of EmailSendEBookToDevice.

The operation answers text (text/plain), which Answer holds as it was sent.

func (EmailSendEBookToDeviceResponse) Answered ¶ added in v0.7.1

func (r EmailSendEBookToDeviceResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type EmailSendTestResponse ¶ added in v0.7.1

type EmailSendTestResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

EmailSendTestResponse is the result of EmailSendTest.

The operation answers text (text/plain), which Answer holds as it was sent.

func (EmailSendTestResponse) Answered ¶ added in v0.7.1

func (r EmailSendTestResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type EmailSettings ¶

type EmailSettings struct {
	EreaderDevices     []EreaderDevice `json:"ereaderDevices,omitzero"`
	FromAddress        string          `json:"fromAddress,omitempty"`
	Host               string          `json:"host,omitempty"`
	Id                 string          `json:"id,omitempty"`
	Pass               any             `json:"pass,omitempty"`
	Port               float64         `json:"port,omitempty"`
	RejectUnauthorized bool            `json:"rejectUnauthorized"`
	Secure             bool            `json:"secure"`
	TestAddress        string          `json:"testAddress,omitempty"`
	User               string          `json:"user,omitempty"`
}

EmailSettings is the "EmailSettings" schema.

type EmailUpdateEReaderDevicesAnswer ¶ added in v0.7.1

type EmailUpdateEReaderDevicesAnswer struct {
	EreaderDevices []EreaderDevice `json:"ereaderDevices,omitzero"`
}

EmailUpdateEReaderDevicesAnswer is an object the document declares inline.

type EmailUpdateEReaderDevicesRequest ¶ added in v0.7.1

type EmailUpdateEReaderDevicesRequest struct {
	EreaderDevices []EreaderDevice `json:"ereaderDevices,omitzero"`
}

EmailUpdateEReaderDevicesRequest is an object the document declares inline.

type EmailUpdateEReaderDevicesResponse ¶ added in v0.7.1

type EmailUpdateEReaderDevicesResponse struct {
	HttpResponse *http.Response
	Answer       *EmailUpdateEReaderDevicesAnswer
	*EmailUpdateEReaderDevicesAnswer
}

EmailUpdateEReaderDevicesResponse is the result of EmailUpdateEReaderDevices.

Answer is the EmailUpdateEReaderDevicesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (EmailUpdateEReaderDevicesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (EmailUpdateEReaderDevicesResponse) Record ¶ added in v0.7.1

Record is the EmailUpdateEReaderDevicesAnswer answered, as a value to change and write back, or an error when the server answered none.

type EmailUpdateSettingsAnswer ¶ added in v0.7.1

type EmailUpdateSettingsAnswer struct {
	Settings *EmailSettings `json:"settings,omitempty"`
}

EmailUpdateSettingsAnswer is an object the document declares inline.

type EmailUpdateSettingsRequest ¶ added in v0.7.1

type EmailUpdateSettingsRequest struct {
	EreaderDevices     any    `json:"ereaderDevices,omitempty"`
	FromAddress        string `json:"fromAddress,omitempty"`
	Port               any    `json:"port,omitempty"`
	RejectUnauthorized any    `json:"rejectUnauthorized,omitempty"`
	Secure             any    `json:"secure,omitempty"`
}

EmailUpdateSettingsRequest is an object the document declares inline.

type EmailUpdateSettingsResponse ¶ added in v0.7.1

type EmailUpdateSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *EmailUpdateSettingsAnswer
	*EmailUpdateSettingsAnswer
}

EmailUpdateSettingsResponse is the result of EmailUpdateSettings.

Answer is the EmailUpdateSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (EmailUpdateSettingsResponse) Answered ¶ added in v0.7.1

func (r EmailUpdateSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (EmailUpdateSettingsResponse) Record ¶ added in v0.7.1

Record is the EmailUpdateSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type EpisodeID ¶ added in v0.7.1

type EpisodeID string

EpisodeID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and EpisodeID(n) convert one value, client.StringIDs a list.

type EreaderDevice ¶ added in v0.7.1

type EreaderDevice struct {
	AvailabilityOption string   `json:"availabilityOption,omitempty"`
	Email              string   `json:"email,omitempty"`
	Name               string   `json:"name,omitempty"`
	Users              []string `json:"users,omitzero"`
}

EreaderDevice is the "EreaderDevice" schema.

type Feed ¶

type Feed struct {
	CoverPath       string         `json:"coverPath,omitempty"`
	CreatedAt       UnixMilli      `json:"createdAt,omitzero"`
	EntityId        string         `json:"entityId,omitempty"`
	EntityType      string         `json:"entityType,omitempty"`
	EntityUpdatedAt UnixMilli      `json:"entityUpdatedAt,omitzero"`
	Episodes        []FeedEpisodes `json:"episodes,omitzero"`
	FeedUrl         string         `json:"feedUrl,omitempty"`
	Id              FeedID         `json:"id,omitempty"`
	Meta            *FeedMeta      `json:"meta,omitempty"`
	ServerAddress   string         `json:"serverAddress,omitempty"`
	Slug            string         `json:"slug,omitempty"`
	UpdatedAt       UnixMilli      `json:"updatedAt,omitzero"`
	UserId          UserID         `json:"userId,omitempty"`
}

Feed is the "Feed" schema.

type FeedEpisodes ¶ added in v0.7.1

type FeedEpisodes struct {
	Author      string                 `json:"author,omitempty"`
	Description string                 `json:"description,omitempty"`
	Duration    float64                `json:"duration,omitempty"`
	Enclosure   *FeedEpisodesEnclosure `json:"enclosure,omitempty"`
	Episode     string                 `json:"episode,omitempty"`
	EpisodeType string                 `json:"episodeType,omitempty"`
	Explicit    *bool                  `json:"explicit,omitempty"`
	FullPath    string                 `json:"fullPath,omitempty"`
	Id          string                 `json:"id,omitempty"`
	Link        string                 `json:"link,omitempty"`
	PubDate     string                 `json:"pubDate,omitempty"`
	Season      string                 `json:"season,omitempty"`
	Title       string                 `json:"title,omitempty"`
}

FeedEpisodes is an object the document declares inline.

type FeedEpisodesEnclosure ¶ added in v0.7.1

type FeedEpisodesEnclosure struct {
	Size int    `json:"size,omitempty"`
	Type string `json:"type,omitempty"`
	Url  string `json:"url,omitempty"`
}

FeedEpisodesEnclosure is an object the document declares inline.

type FeedID ¶ added in v0.7.1

type FeedID string

FeedID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and FeedID(n) convert one value, client.StringIDs a list.

type FeedMeta ¶ added in v0.7.1

type FeedMeta struct {
	Author          string `json:"author,omitempty"`
	Description     string `json:"description,omitempty"`
	Explicit        *bool  `json:"explicit,omitempty"`
	FeedUrl         string `json:"feedUrl,omitempty"`
	ImageUrl        string `json:"imageUrl,omitempty"`
	Language        string `json:"language,omitempty"`
	Link            string `json:"link,omitempty"`
	OwnerEmail      string `json:"ownerEmail,omitempty"`
	OwnerName       string `json:"ownerName,omitempty"`
	PreventIndexing *bool  `json:"preventIndexing,omitempty"`
	Title           string `json:"title,omitempty"`
	Type            string `json:"type,omitempty"`
}

FeedMeta is an object the document declares inline.

type FeedMinified ¶ added in v0.7.1

type FeedMinified struct {
	EntityId   string            `json:"entityId,omitempty"`
	EntityType string            `json:"entityType,omitempty"`
	FeedUrl    string            `json:"feedUrl,omitempty"`
	Id         FeedID            `json:"id,omitempty"`
	Meta       *FeedMinifiedMeta `json:"meta,omitempty"`
}

FeedMinified is the "FeedMinified" schema.

type FeedMinifiedMeta ¶ added in v0.7.1

type FeedMinifiedMeta struct {
	Description     string `json:"description,omitempty"`
	OwnerEmail      string `json:"ownerEmail,omitempty"`
	OwnerName       string `json:"ownerName,omitempty"`
	PreventIndexing *bool  `json:"preventIndexing,omitempty"`
	Title           string `json:"title,omitempty"`
}

FeedMinifiedMeta is an object the document declares inline.

type FileMetadata ¶

type FileMetadata struct {
	BirthtimeMs UnixMilli `json:"birthtimeMs,omitzero"`
	CtimeMs     UnixMilli `json:"ctimeMs,omitzero"`
	Ext         string    `json:"ext,omitempty"`
	Filename    string    `json:"filename,omitempty"`
	MtimeMs     UnixMilli `json:"mtimeMs,omitzero"`
	Path        string    `json:"path,omitempty"`
	RelPath     string    `json:"relPath,omitempty"`
	Size        int       `json:"size,omitempty"`
}

FileMetadata is the "FileMetadata" schema.

type FileSystemCheckPathExistsAnswer ¶ added in v0.7.1

type FileSystemCheckPathExistsAnswer struct {
	Exists           bool   `json:"exists"`
	LibraryItemTitle string `json:"libraryItemTitle,omitempty"`
}

FileSystemCheckPathExistsAnswer is an object the document declares inline.

type FileSystemCheckPathExistsRequest ¶ added in v0.7.1

type FileSystemCheckPathExistsRequest struct {
	Directory  string `json:"directory,omitempty"`
	FolderPath string `json:"folderPath,omitempty"`
}

FileSystemCheckPathExistsRequest is an object the document declares inline.

type FileSystemCheckPathExistsResponse ¶ added in v0.7.1

type FileSystemCheckPathExistsResponse struct {
	HttpResponse *http.Response
	Answer       *FileSystemCheckPathExistsAnswer
	*FileSystemCheckPathExistsAnswer
}

FileSystemCheckPathExistsResponse is the result of FileSystemCheckPathExists.

Answer is the FileSystemCheckPathExistsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (FileSystemCheckPathExistsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (FileSystemCheckPathExistsResponse) Record ¶ added in v0.7.1

Record is the FileSystemCheckPathExistsAnswer answered, as a value to change and write back, or an error when the server answered none.

type FileSystemGetPathsAnswer ¶ added in v0.7.1

type FileSystemGetPathsAnswer struct {
	Directories []FileSystemGetPathsAnswerDirectories `json:"directories,omitzero"`
	Posix       bool                                  `json:"posix"`
}

FileSystemGetPathsAnswer is an object the document declares inline.

type FileSystemGetPathsAnswerDirectories ¶ added in v0.7.1

type FileSystemGetPathsAnswerDirectories struct {
	Dirname string `json:"dirname,omitempty"`
	Level   int    `json:"level,omitempty"`
	Path    string `json:"path,omitempty"`
}

FileSystemGetPathsAnswerDirectories is an object the document declares inline.

type FileSystemGetPathsOptions ¶ added in v0.7.1

type FileSystemGetPathsOptions struct {
	Level *int
	Path  string
}

FileSystemGetPathsOptions holds the query and header parameters of FileSystemGetPaths.

func (FileSystemGetPathsOptions) ToHeaders ¶ added in v0.7.1

func (o FileSystemGetPathsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (FileSystemGetPathsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type FileSystemGetPathsResponse ¶ added in v0.7.1

type FileSystemGetPathsResponse struct {
	HttpResponse *http.Response
	Answer       *FileSystemGetPathsAnswer
	*FileSystemGetPathsAnswer
}

FileSystemGetPathsResponse is the result of FileSystemGetPaths.

Answer is the FileSystemGetPathsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (FileSystemGetPathsResponse) Answered ¶ added in v0.7.1

func (r FileSystemGetPathsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (FileSystemGetPathsResponse) Record ¶ added in v0.7.1

Record is the FileSystemGetPathsAnswer answered, as a value to change and write back, or an error when the server answered none.

type FolderID ¶ added in v0.7.1

type FolderID string

FolderID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and FolderID(n) convert one value, client.StringIDs a list.

type ItemShelf ¶ added in v0.7.1

type ItemShelf struct {
	Entities       []LibraryItemMinified `json:"entities,omitzero"`
	Id             ShelfID               `json:"id,omitempty"`
	Label          string                `json:"label,omitempty"`
	LabelStringKey ShelfLabelKey         `json:"labelStringKey,omitempty"`
	Total          float64               `json:"total,omitempty"`
	Type           ShelfType             `json:"type,omitempty"`
}

ItemShelf is the "ItemShelf" schema.

type Library ¶

type Library struct {
	CreatedAt       UnixMilli        `json:"createdAt,omitzero"`
	DisplayOrder    int              `json:"displayOrder,omitempty"`
	Folders         []LibraryFolder  `json:"folders,omitzero"`
	Icon            string           `json:"icon,omitempty"`
	Id              LibraryID        `json:"id,omitempty"`
	LastScan        UnixMilli        `json:"lastScan,omitzero"`
	LastScanVersion string           `json:"lastScanVersion,omitempty"`
	LastUpdate      UnixMilli        `json:"lastUpdate,omitzero"`
	MediaType       string           `json:"mediaType,omitempty"`
	Name            string           `json:"name,omitempty"`
	Provider        string           `json:"provider,omitempty"`
	Settings        *LibrarySettings `json:"settings,omitempty"`
}

Library is the "Library" schema.

func (Library) GetId ¶ added in v0.7.1

func (m Library) GetId() LibraryID

GetId is the record's Id, for code that handles records of several types alike.

func (Library) GetName ¶ added in v0.7.1

func (m Library) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

func (Library) IsPodcast ¶

func (l Library) IsPodcast() bool

IsPodcast is whether the library holds podcasts rather than books.

type LibraryCreateRequest ¶ added in v0.7.1

type LibraryCreateRequest struct {
	Folders   []LibraryFolder `json:"folders,omitzero"`
	Icon      string          `json:"icon,omitempty"`
	MediaType string          `json:"mediaType,omitempty"`
	Name      string          `json:"name,omitempty"`
	Provider  string          `json:"provider,omitempty"`
	Settings  any             `json:"settings,omitempty"`
}

LibraryCreateRequest is an object the document declares inline.

type LibraryCreateResponse ¶ added in v0.7.1

type LibraryCreateResponse struct {
	HttpResponse *http.Response
	Answer       *Library
	*Library
}

LibraryCreateResponse is the result of LibraryCreate.

Answer is the Library answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryCreateResponse) Answered ¶ added in v0.7.1

func (r LibraryCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryCreateResponse) Record ¶ added in v0.7.1

func (r LibraryCreateResponse) Record() (Library, error)

Record is the Library answered, as a value to change and write back, or an error when the server answered none.

type LibraryDeleteResponse ¶ added in v0.7.1

type LibraryDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *Library
	*Library
}

LibraryDeleteResponse is the result of LibraryDelete.

Answer is the Library answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryDeleteResponse) Answered ¶ added in v0.7.1

func (r LibraryDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryDeleteResponse) Record ¶ added in v0.7.1

func (r LibraryDeleteResponse) Record() (Library, error)

Record is the Library answered, as a value to change and write back, or an error when the server answered none.

type LibraryDownloadMultipleOptions ¶ added in v0.7.1

type LibraryDownloadMultipleOptions struct {
	Ids  string
	Sort string
}

LibraryDownloadMultipleOptions holds the query and header parameters of LibraryDownloadMultiple.

func (LibraryDownloadMultipleOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryDownloadMultipleOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryDownloadMultipleResponse ¶ added in v0.7.1

type LibraryDownloadMultipleResponse struct {
	HttpResponse *http.Response
}

LibraryDownloadMultipleResponse is the result of LibraryDownloadMultiple.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryDownloadMultipleResponse) Bytes ¶ added in v0.7.1

func (r LibraryDownloadMultipleResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryDownloadMultipleResponse) ContentLength ¶ added in v0.7.1

func (r LibraryDownloadMultipleResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryDownloadMultipleResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryDownloadMultipleResponse) Reader ¶ added in v0.7.1

func (r LibraryDownloadMultipleResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryDownloadMultipleResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryFile ¶

type LibraryFile struct {
	AddedAt         UnixMilli     `json:"addedAt,omitzero"`
	FileType        string        `json:"fileType,omitempty"`
	Ino             string        `json:"ino,omitempty"`
	IsSupplementary *bool         `json:"isSupplementary,omitempty"`
	Metadata        *FileMetadata `json:"metadata,omitempty"`
	UpdatedAt       UnixMilli     `json:"updatedAt,omitzero"`
}

LibraryFile is the "LibraryFile" schema.

type LibraryFilterData ¶ added in v0.7.1

type LibraryFilterData struct {
	AuthorCount      int                        `json:"authorCount,omitempty"`
	Authors          []LibraryFilterDataAuthors `json:"authors,omitzero"`
	BookCount        int                        `json:"bookCount,omitempty"`
	Genres           []string                   `json:"genres,omitzero"`
	Languages        []string                   `json:"languages,omitzero"`
	LoadedAt         UnixMilli                  `json:"loadedAt,omitzero"`
	Narrators        []string                   `json:"narrators,omitzero"`
	NumIssues        int                        `json:"numIssues,omitempty"`
	PodcastCount     int                        `json:"podcastCount,omitempty"`
	PublishedDecades []string                   `json:"publishedDecades,omitzero"`
	Publishers       []string                   `json:"publishers,omitzero"`
	Series           []LibraryFilterDataSeries  `json:"series,omitzero"`
	SeriesCount      int                        `json:"seriesCount,omitempty"`
	Tags             []string                   `json:"tags,omitzero"`
}

LibraryFilterData is the "LibraryFilterData" schema.

type LibraryFilterDataAuthors ¶ added in v0.7.1

type LibraryFilterDataAuthors struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

LibraryFilterDataAuthors is an object the document declares inline.

func (LibraryFilterDataAuthors) GetId ¶ added in v0.7.1

func (m LibraryFilterDataAuthors) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (LibraryFilterDataAuthors) GetName ¶ added in v0.7.1

func (m LibraryFilterDataAuthors) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type LibraryFilterDataSeries ¶ added in v0.7.1

type LibraryFilterDataSeries struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

LibraryFilterDataSeries is an object the document declares inline.

func (LibraryFilterDataSeries) GetId ¶ added in v0.7.1

func (m LibraryFilterDataSeries) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (LibraryFilterDataSeries) GetName ¶ added in v0.7.1

func (m LibraryFilterDataSeries) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type LibraryFindAllAnswer ¶ added in v0.7.1

type LibraryFindAllAnswer struct {
	Libraries []Library `json:"libraries,omitzero"`
}

LibraryFindAllAnswer is an object the document declares inline.

type LibraryFindAllOptions ¶ added in v0.7.1

type LibraryFindAllOptions struct {
	Include string
	Sort    string
}

LibraryFindAllOptions holds the query and header parameters of LibraryFindAll.

func (LibraryFindAllOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryFindAllOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryFindAllOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryFindAllResponse ¶ added in v0.7.1

type LibraryFindAllResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryFindAllAnswer
	*LibraryFindAllAnswer
}

LibraryFindAllResponse is the result of LibraryFindAll.

Answer is the LibraryFindAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryFindAllResponse) Answered ¶ added in v0.7.1

func (r LibraryFindAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryFindAllResponse) Record ¶ added in v0.7.1

Record is the LibraryFindAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryFindOneAnswer ¶ added in v0.7.1

type LibraryFindOneAnswer struct {
	CreatedAt        UnixMilli                     `json:"createdAt,omitzero"`
	DisplayOrder     int                           `json:"displayOrder,omitempty"`
	Filterdata       *LibraryFilterData            `json:"filterdata,omitempty"`
	Folders          []LibraryFolder               `json:"folders,omitzero"`
	Icon             string                        `json:"icon,omitempty"`
	Id               string                        `json:"id,omitempty"`
	Issues           int                           `json:"issues,omitempty"`
	LastScan         UnixMilli                     `json:"lastScan,omitzero"`
	LastScanVersion  string                        `json:"lastScanVersion,omitempty"`
	LastUpdate       UnixMilli                     `json:"lastUpdate,omitzero"`
	Library          *Library                      `json:"library,omitempty"`
	MediaType        string                        `json:"mediaType,omitempty"`
	Name             string                        `json:"name,omitempty"`
	NumUserPlaylists int                           `json:"numUserPlaylists,omitempty"`
	Provider         string                        `json:"provider,omitempty"`
	Settings         *LibraryFindOneAnswerSettings `json:"settings,omitempty"`
}

LibraryFindOneAnswer is an object the document declares inline.

func (LibraryFindOneAnswer) GetId ¶ added in v0.7.1

func (m LibraryFindOneAnswer) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (LibraryFindOneAnswer) GetName ¶ added in v0.7.1

func (m LibraryFindOneAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type LibraryFindOneAnswerSettings ¶ added in v0.7.1

type LibraryFindOneAnswerSettings struct {
	AudiobooksOnly                     bool     `json:"audiobooksOnly"`
	AutoScanCronExpression             any      `json:"autoScanCronExpression,omitempty"`
	CoverAspectRatio                   int      `json:"coverAspectRatio,omitempty"`
	DisableWatcher                     bool     `json:"disableWatcher"`
	EpubsAllowScriptedContent          bool     `json:"epubsAllowScriptedContent"`
	HideSingleBookSeries               bool     `json:"hideSingleBookSeries"`
	MarkAsFinishedPercentComplete      float64  `json:"markAsFinishedPercentComplete,omitempty"`
	MarkAsFinishedTimeRemaining        float64  `json:"markAsFinishedTimeRemaining,omitempty"`
	MetadataPrecedence                 []string `json:"metadataPrecedence,omitzero"`
	OnlyShowLaterBooksInContinueSeries bool     `json:"onlyShowLaterBooksInContinueSeries"`
	PodcastSearchRegion                string   `json:"podcastSearchRegion,omitempty"`
	SkipMatchingMediaWithAsin          bool     `json:"skipMatchingMediaWithAsin"`
	SkipMatchingMediaWithIsbn          bool     `json:"skipMatchingMediaWithIsbn"`
}

LibraryFindOneAnswerSettings is an object the document declares inline.

type LibraryFindOneOptions ¶ added in v0.7.1

type LibraryFindOneOptions struct {
	Include string
	Sort    string
}

LibraryFindOneOptions holds the query and header parameters of LibraryFindOne.

func (LibraryFindOneOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryFindOneOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryFindOneOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryFindOneResponse ¶ added in v0.7.1

type LibraryFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryFindOneAnswer
	*LibraryFindOneAnswer
}

LibraryFindOneResponse is the result of LibraryFindOne.

Answer is the LibraryFindOneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryFindOneResponse) Answered ¶ added in v0.7.1

func (r LibraryFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryFindOneResponse) Record ¶ added in v0.7.1

Record is the LibraryFindOneAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryFolder ¶ added in v0.7.1

type LibraryFolder struct {
	AddedAt   UnixMilli `json:"addedAt,omitzero"`
	FullPath  string    `json:"fullPath,omitempty"`
	Id        FolderID  `json:"id,omitempty"`
	LibraryId LibraryID `json:"libraryId,omitempty"`
}

LibraryFolder is the "LibraryFolder" schema.

type LibraryGetAllSeriesForLibraryAnswer ¶ added in v0.7.1

type LibraryGetAllSeriesForLibraryAnswer struct {
	FilterBy string   `json:"filterBy,omitempty"`
	Include  string   `json:"include,omitempty"`
	Limit    int      `json:"limit,omitempty"`
	Minified bool     `json:"minified"`
	Page     int      `json:"page,omitempty"`
	Results  []Series `json:"results,omitzero"`
	SortBy   string   `json:"sortBy,omitempty"`
	SortDesc bool     `json:"sortDesc"`
	Total    int      `json:"total,omitempty"`
}

LibraryGetAllSeriesForLibraryAnswer is an object the document declares inline.

type LibraryGetAllSeriesForLibraryCompleteResult ¶ added in v0.7.1

type LibraryGetAllSeriesForLibraryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Series
}

LibraryGetAllSeriesForLibraryCompleteResult is every result LibraryGetAllSeriesForLibraryComplete loaded.

type LibraryGetAllSeriesForLibraryOptions ¶ added in v0.7.1

type LibraryGetAllSeriesForLibraryOptions struct {
	Desc     string
	Filter   string
	Include  string
	Limit    *int
	Minified string
	Page     *int
	Sort     string
}

LibraryGetAllSeriesForLibraryOptions holds the query and header parameters of LibraryGetAllSeriesForLibrary.

func (LibraryGetAllSeriesForLibraryOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetAllSeriesForLibraryOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetAllSeriesForLibraryResponse ¶ added in v0.7.1

type LibraryGetAllSeriesForLibraryResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetAllSeriesForLibraryAnswer
	*LibraryGetAllSeriesForLibraryAnswer
}

LibraryGetAllSeriesForLibraryResponse is the result of LibraryGetAllSeriesForLibrary.

Answer is the LibraryGetAllSeriesForLibraryAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetAllSeriesForLibraryResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetAllSeriesForLibraryResponse) Record ¶ added in v0.7.1

Record is the LibraryGetAllSeriesForLibraryAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetAuthorsAnswer ¶ added in v0.7.1

type LibraryGetAuthorsAnswer struct {
	Authors  []Author `json:"authors,omitzero"`
	FilterBy string   `json:"filterBy,omitempty"`
	Include  string   `json:"include,omitempty"`
	Limit    float64  `json:"limit,omitempty"`
	Minified bool     `json:"minified"`
	Page     float64  `json:"page,omitempty"`
	Results  []Author `json:"results,omitzero"`
	SortBy   string   `json:"sortBy,omitempty"`
	SortDesc bool     `json:"sortDesc"`
	Total    int      `json:"total,omitempty"`
}

LibraryGetAuthorsAnswer is an object the document declares inline.

type LibraryGetAuthorsCompleteResult ¶ added in v0.7.1

type LibraryGetAuthorsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Author
}

LibraryGetAuthorsCompleteResult is every result LibraryGetAuthorsComplete loaded.

type LibraryGetAuthorsOptions ¶ added in v0.7.1

type LibraryGetAuthorsOptions struct {
	Desc     string
	Filter   string
	Include  string
	Limit    *int
	Minified string
	Page     *int
	Sort     string
}

LibraryGetAuthorsOptions holds the query and header parameters of LibraryGetAuthors.

func (LibraryGetAuthorsOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryGetAuthorsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryGetAuthorsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetAuthorsResponse ¶ added in v0.7.1

type LibraryGetAuthorsResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetAuthorsAnswer
	*LibraryGetAuthorsAnswer
}

LibraryGetAuthorsResponse is the result of LibraryGetAuthors.

Answer is the LibraryGetAuthorsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetAuthorsResponse) Answered ¶ added in v0.7.1

func (r LibraryGetAuthorsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetAuthorsResponse) Record ¶ added in v0.7.1

Record is the LibraryGetAuthorsAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetCollectionsForLibraryAnswer ¶ added in v0.7.1

type LibraryGetCollectionsForLibraryAnswer struct {
	FilterBy string       `json:"filterBy,omitempty"`
	Include  string       `json:"include,omitempty"`
	Limit    int          `json:"limit,omitempty"`
	Minified bool         `json:"minified"`
	Page     int          `json:"page,omitempty"`
	Results  []Collection `json:"results,omitzero"`
	SortBy   string       `json:"sortBy,omitempty"`
	SortDesc bool         `json:"sortDesc"`
	Total    int          `json:"total,omitempty"`
}

LibraryGetCollectionsForLibraryAnswer is an object the document declares inline.

type LibraryGetCollectionsForLibraryCompleteResult ¶ added in v0.7.1

type LibraryGetCollectionsForLibraryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Collection
}

LibraryGetCollectionsForLibraryCompleteResult is every result LibraryGetCollectionsForLibraryComplete loaded.

type LibraryGetCollectionsForLibraryOptions ¶ added in v0.7.1

type LibraryGetCollectionsForLibraryOptions struct {
	Desc     string
	Filter   string
	Include  string
	Limit    *int
	Minified string
	Page     *int
	Sort     string
}

LibraryGetCollectionsForLibraryOptions holds the query and header parameters of LibraryGetCollectionsForLibrary.

func (LibraryGetCollectionsForLibraryOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetCollectionsForLibraryOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetCollectionsForLibraryResponse ¶ added in v0.7.1

type LibraryGetCollectionsForLibraryResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetCollectionsForLibraryAnswer
	*LibraryGetCollectionsForLibraryAnswer
}

LibraryGetCollectionsForLibraryResponse is the result of LibraryGetCollectionsForLibrary.

Answer is the LibraryGetCollectionsForLibraryAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetCollectionsForLibraryResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetCollectionsForLibraryResponse) Record ¶ added in v0.7.1

Record is the LibraryGetCollectionsForLibraryAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetEpisodeDownloadQueueAnswer ¶ added in v0.7.1

type LibraryGetEpisodeDownloadQueueAnswer struct {
	CurrentDownload *PodcastEpisodeDownload  `json:"currentDownload,omitempty"`
	Queue           []PodcastEpisodeDownload `json:"queue,omitzero"`
}

LibraryGetEpisodeDownloadQueueAnswer is an object the document declares inline.

type LibraryGetEpisodeDownloadQueueOptions ¶ added in v0.7.1

type LibraryGetEpisodeDownloadQueueOptions struct {
	Sort string
}

LibraryGetEpisodeDownloadQueueOptions holds the query and header parameters of LibraryGetEpisodeDownloadQueue.

func (LibraryGetEpisodeDownloadQueueOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetEpisodeDownloadQueueOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetEpisodeDownloadQueueResponse ¶ added in v0.7.1

type LibraryGetEpisodeDownloadQueueResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetEpisodeDownloadQueueAnswer
	*LibraryGetEpisodeDownloadQueueAnswer
}

LibraryGetEpisodeDownloadQueueResponse is the result of LibraryGetEpisodeDownloadQueue.

Answer is the LibraryGetEpisodeDownloadQueueAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetEpisodeDownloadQueueResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetEpisodeDownloadQueueResponse) Record ¶ added in v0.7.1

Record is the LibraryGetEpisodeDownloadQueueAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetLibraryFilterDataOptions ¶ added in v0.7.1

type LibraryGetLibraryFilterDataOptions struct {
	Sort string
}

LibraryGetLibraryFilterDataOptions holds the query and header parameters of LibraryGetLibraryFilterData.

func (LibraryGetLibraryFilterDataOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetLibraryFilterDataOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetLibraryFilterDataResponse ¶ added in v0.7.1

type LibraryGetLibraryFilterDataResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryFilterData
	*LibraryFilterData
}

LibraryGetLibraryFilterDataResponse is the result of LibraryGetLibraryFilterData.

Answer is the LibraryFilterData answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetLibraryFilterDataResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetLibraryFilterDataResponse) Record ¶ added in v0.7.1

Record is the LibraryFilterData answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetLibraryItemsAnswer ¶ added in v0.7.1

type LibraryGetLibraryItemsAnswer struct {
	Collapseseries bool                  `json:"collapseseries"`
	FilterBy       string                `json:"filterBy,omitempty"`
	Include        string                `json:"include,omitempty"`
	Limit          int                   `json:"limit,omitempty"`
	MediaType      string                `json:"mediaType,omitempty"`
	Minified       bool                  `json:"minified"`
	Offset         float64               `json:"offset,omitempty"`
	Page           int                   `json:"page,omitempty"`
	Results        []LibraryItemMinified `json:"results,omitzero"`
	SortBy         string                `json:"sortBy,omitempty"`
	SortDesc       bool                  `json:"sortDesc"`
	Total          int                   `json:"total,omitempty"`
}

LibraryGetLibraryItemsAnswer is an object the document declares inline.

type LibraryGetLibraryItemsCompleteResult ¶ added in v0.7.1

type LibraryGetLibraryItemsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []LibraryItemMinified
}

LibraryGetLibraryItemsCompleteResult is every result LibraryGetLibraryItemsComplete loaded.

type LibraryGetLibraryItemsOptions ¶ added in v0.7.1

type LibraryGetLibraryItemsOptions struct {
	Collapseseries string
	Desc           string
	Filter         string
	Include        string
	Limit          *int
	Minified       string
	Page           *int
	Sort           string
}

LibraryGetLibraryItemsOptions holds the query and header parameters of LibraryGetLibraryItems.

func (LibraryGetLibraryItemsOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetLibraryItemsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetLibraryItemsResponse ¶ added in v0.7.1

type LibraryGetLibraryItemsResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetLibraryItemsAnswer
	*LibraryGetLibraryItemsAnswer
}

LibraryGetLibraryItemsResponse is the result of LibraryGetLibraryItems.

Answer is the LibraryGetLibraryItemsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetLibraryItemsResponse) Answered ¶ added in v0.7.1

func (r LibraryGetLibraryItemsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetLibraryItemsResponse) Record ¶ added in v0.7.1

Record is the LibraryGetLibraryItemsAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetNarratorsAnswer ¶ added in v0.7.1

type LibraryGetNarratorsAnswer struct {
	Narrators []LibraryGetNarratorsAnswerNarrators `json:"narrators,omitzero"`
}

LibraryGetNarratorsAnswer is an object the document declares inline.

type LibraryGetNarratorsAnswerNarrators ¶ added in v0.7.1

type LibraryGetNarratorsAnswerNarrators struct {
	Id       string `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	NumBooks int    `json:"numBooks,omitempty"`
}

LibraryGetNarratorsAnswerNarrators is an object the document declares inline.

func (LibraryGetNarratorsAnswerNarrators) GetId ¶ added in v0.7.1

GetId is the record's Id, for code that handles records of several types alike.

func (LibraryGetNarratorsAnswerNarrators) GetName ¶ added in v0.7.1

GetName is the record's Name, for code that handles records of several types alike.

type LibraryGetNarratorsOptions ¶ added in v0.7.1

type LibraryGetNarratorsOptions struct {
	Sort string
}

LibraryGetNarratorsOptions holds the query and header parameters of LibraryGetNarrators.

func (LibraryGetNarratorsOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryGetNarratorsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryGetNarratorsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetNarratorsResponse ¶ added in v0.7.1

type LibraryGetNarratorsResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetNarratorsAnswer
	*LibraryGetNarratorsAnswer
}

LibraryGetNarratorsResponse is the result of LibraryGetNarrators.

Answer is the LibraryGetNarratorsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetNarratorsResponse) Answered ¶ added in v0.7.1

func (r LibraryGetNarratorsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetNarratorsResponse) Record ¶ added in v0.7.1

Record is the LibraryGetNarratorsAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetOPMLFileOptions ¶ added in v0.7.1

type LibraryGetOPMLFileOptions struct {
	Sort string
}

LibraryGetOPMLFileOptions holds the query and header parameters of LibraryGetOPMLFile.

func (LibraryGetOPMLFileOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryGetOPMLFileOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryGetOPMLFileOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetOPMLFileResponse ¶ added in v0.7.1

type LibraryGetOPMLFileResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryGetOPMLFileResponse is the result of LibraryGetOPMLFile.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryGetOPMLFileResponse) Answered ¶ added in v0.7.1

func (r LibraryGetOPMLFileResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryGetPodcastTitlesAnswer ¶ added in v0.7.1

type LibraryGetPodcastTitlesAnswer struct {
	Podcasts []LibraryGetPodcastTitlesAnswerPodcasts `json:"podcasts,omitzero"`
}

LibraryGetPodcastTitlesAnswer is an object the document declares inline.

type LibraryGetPodcastTitlesAnswerPodcasts ¶ added in v0.7.1

type LibraryGetPodcastTitlesAnswerPodcasts struct {
	ItunesId      string        `json:"itunesId,omitempty"`
	LibraryId     LibraryID     `json:"libraryId,omitempty"`
	LibraryItemId LibraryItemID `json:"libraryItemId,omitempty"`
	Title         string        `json:"title,omitempty"`
}

LibraryGetPodcastTitlesAnswerPodcasts is an object the document declares inline.

type LibraryGetPodcastTitlesOptions ¶ added in v0.7.1

type LibraryGetPodcastTitlesOptions struct {
	Sort string
}

LibraryGetPodcastTitlesOptions holds the query and header parameters of LibraryGetPodcastTitles.

func (LibraryGetPodcastTitlesOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetPodcastTitlesOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetPodcastTitlesResponse ¶ added in v0.7.1

type LibraryGetPodcastTitlesResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetPodcastTitlesAnswer
	*LibraryGetPodcastTitlesAnswer
}

LibraryGetPodcastTitlesResponse is the result of LibraryGetPodcastTitles.

Answer is the LibraryGetPodcastTitlesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetPodcastTitlesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetPodcastTitlesResponse) Record ¶ added in v0.7.1

Record is the LibraryGetPodcastTitlesAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetRecentEpisodesAnswer ¶ added in v0.7.1

type LibraryGetRecentEpisodesAnswer struct {
	Episodes []PodcastEpisode `json:"episodes,omitzero"`
	Limit    int              `json:"limit,omitempty"`
	Page     int              `json:"page,omitempty"`
}

LibraryGetRecentEpisodesAnswer is an object the document declares inline.

type LibraryGetRecentEpisodesOptions ¶ added in v0.7.1

type LibraryGetRecentEpisodesOptions struct {
	Limit *int
	Page  *int
	Sort  string
}

LibraryGetRecentEpisodesOptions holds the query and header parameters of LibraryGetRecentEpisodes.

func (LibraryGetRecentEpisodesOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetRecentEpisodesOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetRecentEpisodesResponse ¶ added in v0.7.1

type LibraryGetRecentEpisodesResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetRecentEpisodesAnswer
	*LibraryGetRecentEpisodesAnswer
}

LibraryGetRecentEpisodesResponse is the result of LibraryGetRecentEpisodes.

Answer is the LibraryGetRecentEpisodesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetRecentEpisodesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetRecentEpisodesResponse) Record ¶ added in v0.7.1

Record is the LibraryGetRecentEpisodesAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetSeriesForLibraryOptions ¶ added in v0.7.1

type LibraryGetSeriesForLibraryOptions struct {
	Include string
	Sort    string
}

LibraryGetSeriesForLibraryOptions holds the query and header parameters of LibraryGetSeriesForLibrary.

func (LibraryGetSeriesForLibraryOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetSeriesForLibraryOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetSeriesForLibraryResponse ¶ added in v0.7.1

type LibraryGetSeriesForLibraryResponse struct {
	HttpResponse *http.Response
	Answer       *Series
	*Series
}

LibraryGetSeriesForLibraryResponse is the result of LibraryGetSeriesForLibrary.

Answer is the Series answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetSeriesForLibraryResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetSeriesForLibraryResponse) Record ¶ added in v0.7.1

Record is the Series answered, as a value to change and write back, or an error when the server answered none.

type LibraryGetUserPersonalizedShelvesOptions ¶ added in v0.7.1

type LibraryGetUserPersonalizedShelvesOptions struct {
	Include string
	Limit   *int
	Sort    string
}

LibraryGetUserPersonalizedShelvesOptions holds the query and header parameters of LibraryGetUserPersonalizedShelves.

func (LibraryGetUserPersonalizedShelvesOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetUserPersonalizedShelvesOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetUserPersonalizedShelvesResponse ¶ added in v0.7.1

type LibraryGetUserPersonalizedShelvesResponse struct {
	HttpResponse *http.Response
	Answer       []Shelf
}

LibraryGetUserPersonalizedShelvesResponse is the result of LibraryGetUserPersonalizedShelves.

func (LibraryGetUserPersonalizedShelvesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryGetUserPlaylistsForLibraryAnswer ¶ added in v0.7.1

type LibraryGetUserPlaylistsForLibraryAnswer struct {
	Limit   int        `json:"limit,omitempty"`
	Page    int        `json:"page,omitempty"`
	Results []Playlist `json:"results,omitzero"`
	Total   int        `json:"total,omitempty"`
}

LibraryGetUserPlaylistsForLibraryAnswer is an object the document declares inline.

type LibraryGetUserPlaylistsForLibraryCompleteResult ¶ added in v0.7.1

type LibraryGetUserPlaylistsForLibraryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Playlist
}

LibraryGetUserPlaylistsForLibraryCompleteResult is every result LibraryGetUserPlaylistsForLibraryComplete loaded.

type LibraryGetUserPlaylistsForLibraryOptions ¶ added in v0.7.1

type LibraryGetUserPlaylistsForLibraryOptions struct {
	Limit *int
	Page  *int
	Sort  string
}

LibraryGetUserPlaylistsForLibraryOptions holds the query and header parameters of LibraryGetUserPlaylistsForLibrary.

func (LibraryGetUserPlaylistsForLibraryOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryGetUserPlaylistsForLibraryOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryGetUserPlaylistsForLibraryResponse ¶ added in v0.7.1

type LibraryGetUserPlaylistsForLibraryResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryGetUserPlaylistsForLibraryAnswer
	*LibraryGetUserPlaylistsForLibraryAnswer
}

LibraryGetUserPlaylistsForLibraryResponse is the result of LibraryGetUserPlaylistsForLibrary.

Answer is the LibraryGetUserPlaylistsForLibraryAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryGetUserPlaylistsForLibraryResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryGetUserPlaylistsForLibraryResponse) Record ¶ added in v0.7.1

Record is the LibraryGetUserPlaylistsForLibraryAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryID ¶ added in v0.7.1

type LibraryID string

LibraryID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and LibraryID(n) convert one value, client.StringIDs a list.

type LibraryItem ¶ added in v0.7.1

type LibraryItem struct {
	AddedAt          UnixMilli         `json:"addedAt,omitzero"`
	BirthtimeMs      UnixMilli         `json:"birthtimeMs,omitzero"`
	CtimeMs          UnixMilli         `json:"ctimeMs,omitzero"`
	FolderId         FolderID          `json:"folderId,omitempty"`
	Id               LibraryItemID     `json:"id,omitempty"`
	Ino              string            `json:"ino,omitempty"`
	IsFile           *bool             `json:"isFile,omitempty"`
	IsInvalid        bool              `json:"isInvalid"`
	IsMissing        bool              `json:"isMissing"`
	LastScan         UnixMilli         `json:"lastScan,omitzero"`
	LibraryFiles     []LibraryFile     `json:"libraryFiles,omitzero"`
	LibraryId        LibraryID         `json:"libraryId,omitempty"`
	Media            *LibraryItemMedia `json:"media,omitempty"`
	MediaType        string            `json:"mediaType,omitempty"`
	MtimeMs          UnixMilli         `json:"mtimeMs,omitzero"`
	OldLibraryItemId any               `json:"oldLibraryItemId,omitempty"`
	Path             string            `json:"path,omitempty"`
	RelPath          string            `json:"relPath,omitempty"`
	ScanVersion      string            `json:"scanVersion,omitempty"`
	UpdatedAt        UnixMilli         `json:"updatedAt,omitzero"`
}

LibraryItem is the "LibraryItem" schema.

type LibraryItemBatchDeleteOptions ¶ added in v0.7.1

type LibraryItemBatchDeleteOptions struct {
	Hard string
}

LibraryItemBatchDeleteOptions holds the query and header parameters of LibraryItemBatchDelete.

func (LibraryItemBatchDeleteOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryItemBatchDeleteOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryItemBatchDeleteRequest ¶ added in v0.7.1

type LibraryItemBatchDeleteRequest struct {
	LibraryItemIds []LibraryItemID `json:"libraryItemIds,omitzero"`
}

LibraryItemBatchDeleteRequest is an object the document declares inline.

type LibraryItemBatchDeleteResponse ¶ added in v0.7.1

type LibraryItemBatchDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemBatchDeleteResponse is the result of LibraryItemBatchDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemBatchDeleteResponse) Answered ¶ added in v0.7.1

func (r LibraryItemBatchDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemBatchGetAnswer ¶ added in v0.7.1

type LibraryItemBatchGetAnswer struct {
	LibraryItems []LibraryItemExpanded `json:"libraryItems,omitzero"`
}

LibraryItemBatchGetAnswer is an object the document declares inline.

type LibraryItemBatchGetRequest ¶ added in v0.7.1

type LibraryItemBatchGetRequest struct {
	LibraryItemIds []LibraryItemID `json:"libraryItemIds,omitzero"`
}

LibraryItemBatchGetRequest is an object the document declares inline.

type LibraryItemBatchGetResponse ¶ added in v0.7.1

type LibraryItemBatchGetResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemBatchGetAnswer
	*LibraryItemBatchGetAnswer
}

LibraryItemBatchGetResponse is the result of LibraryItemBatchGet.

Answer is the LibraryItemBatchGetAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemBatchGetResponse) Answered ¶ added in v0.7.1

func (r LibraryItemBatchGetResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemBatchGetResponse) Record ¶ added in v0.7.1

Record is the LibraryItemBatchGetAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemBatchQuickMatchRequest ¶ added in v0.7.1

type LibraryItemBatchQuickMatchRequest struct {
	LibraryItemIds []LibraryItemID                           `json:"libraryItemIds,omitzero"`
	Options        *LibraryItemBatchQuickMatchRequestOptions `json:"options,omitempty"`
}

LibraryItemBatchQuickMatchRequest is an object the document declares inline.

type LibraryItemBatchQuickMatchRequestOptions ¶ added in v0.7.1

type LibraryItemBatchQuickMatchRequestOptions struct {
	OverrideCover   *bool  `json:"overrideCover,omitempty"`
	OverrideDetails *bool  `json:"overrideDetails,omitempty"`
	Provider        string `json:"provider,omitempty"`
}

LibraryItemBatchQuickMatchRequestOptions is an object the document declares inline.

type LibraryItemBatchQuickMatchResponse ¶ added in v0.7.1

type LibraryItemBatchQuickMatchResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemBatchQuickMatchResponse is the result of LibraryItemBatchQuickMatch.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemBatchQuickMatchResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemBatchScanRequest ¶ added in v0.7.1

type LibraryItemBatchScanRequest struct {
	LibraryItemIds []LibraryItemID `json:"libraryItemIds,omitzero"`
}

LibraryItemBatchScanRequest is an object the document declares inline.

type LibraryItemBatchScanResponse ¶ added in v0.7.1

type LibraryItemBatchScanResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemBatchScanResponse is the result of LibraryItemBatchScan.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemBatchScanResponse) Answered ¶ added in v0.7.1

func (r LibraryItemBatchScanResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemBatchUpdateAnswer ¶ added in v0.7.1

type LibraryItemBatchUpdateAnswer struct {
	Success bool `json:"success"`
	Updates int  `json:"updates,omitempty"`
}

LibraryItemBatchUpdateAnswer is an object the document declares inline.

type LibraryItemBatchUpdateRequest ¶ added in v0.7.1

type LibraryItemBatchUpdateRequest struct {
	Id           string       `json:"id,omitempty"`
	MediaPayload *MediaUpdate `json:"mediaPayload,omitempty"`
}

LibraryItemBatchUpdateRequest is an object the document declares inline.

type LibraryItemBatchUpdateResponse ¶ added in v0.7.1

type LibraryItemBatchUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemBatchUpdateAnswer
	*LibraryItemBatchUpdateAnswer
}

LibraryItemBatchUpdateResponse is the result of LibraryItemBatchUpdate.

Answer is the LibraryItemBatchUpdateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemBatchUpdateResponse) Answered ¶ added in v0.7.1

func (r LibraryItemBatchUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemBatchUpdateResponse) Record ¶ added in v0.7.1

Record is the LibraryItemBatchUpdateAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemDeleteLibraryFileResponse ¶ added in v0.7.1

type LibraryItemDeleteLibraryFileResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemDeleteLibraryFileResponse is the result of LibraryItemDeleteLibraryFile.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemDeleteLibraryFileResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemDeleteOptions ¶ added in v0.7.1

type LibraryItemDeleteOptions struct {
	Hard string
}

LibraryItemDeleteOptions holds the query and header parameters of LibraryItemDelete.

func (LibraryItemDeleteOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryItemDeleteOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryItemDeleteOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryItemDeleteResponse ¶ added in v0.7.1

type LibraryItemDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemDeleteResponse is the result of LibraryItemDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemDeleteResponse) Answered ¶ added in v0.7.1

func (r LibraryItemDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemDownloadLibraryFileResponse ¶ added in v0.7.1

type LibraryItemDownloadLibraryFileResponse struct {
	HttpResponse *http.Response
}

LibraryItemDownloadLibraryFileResponse is the result of LibraryItemDownloadLibraryFile.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryItemDownloadLibraryFileResponse) Bytes ¶ added in v0.7.1

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryItemDownloadLibraryFileResponse) ContentLength ¶ added in v0.7.1

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryItemDownloadLibraryFileResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryItemDownloadLibraryFileResponse) Reader ¶ added in v0.7.1

func (r LibraryItemDownloadLibraryFileResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryItemDownloadLibraryFileResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryItemDownloadResponse ¶ added in v0.7.1

type LibraryItemDownloadResponse struct {
	HttpResponse *http.Response
}

LibraryItemDownloadResponse is the result of LibraryItemDownload.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryItemDownloadResponse) Bytes ¶ added in v0.7.1

func (r LibraryItemDownloadResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryItemDownloadResponse) ContentLength ¶ added in v0.7.1

func (r LibraryItemDownloadResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryItemDownloadResponse) Filename ¶ added in v0.7.1

func (r LibraryItemDownloadResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryItemDownloadResponse) Reader ¶ added in v0.7.1

func (r LibraryItemDownloadResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryItemDownloadResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryItemExpanded ¶ added in v0.7.1

type LibraryItemExpanded struct {
	AddedAt                UnixMilli                 `json:"addedAt,omitzero"`
	BirthtimeMs            UnixMilli                 `json:"birthtimeMs,omitzero"`
	CtimeMs                UnixMilli                 `json:"ctimeMs,omitzero"`
	EpisodeDownloadsQueued []any                     `json:"episodeDownloadsQueued,omitzero"`
	EpisodesDownloading    []any                     `json:"episodesDownloading,omitzero"`
	FolderId               FolderID                  `json:"folderId,omitempty"`
	Id                     LibraryItemID             `json:"id,omitempty"`
	Ino                    string                    `json:"ino,omitempty"`
	IsFile                 *bool                     `json:"isFile,omitempty"`
	IsInvalid              bool                      `json:"isInvalid"`
	IsMissing              bool                      `json:"isMissing"`
	LastScan               UnixMilli                 `json:"lastScan,omitzero"`
	LibraryFiles           []LibraryFile             `json:"libraryFiles,omitzero"`
	LibraryId              LibraryID                 `json:"libraryId,omitempty"`
	Media                  *LibraryItemExpandedMedia `json:"media,omitempty"`
	MediaItemShare         *MediaItemShareForClient  `json:"mediaItemShare,omitempty"`
	MediaType              string                    `json:"mediaType,omitempty"`
	MtimeMs                UnixMilli                 `json:"mtimeMs,omitzero"`
	NumFiles               int                       `json:"numFiles,omitempty"`
	OldLibraryItemId       any                       `json:"oldLibraryItemId,omitempty"`
	Path                   string                    `json:"path,omitempty"`
	RecentEpisode          *PodcastEpisode           `json:"recentEpisode,omitempty"`
	RelPath                string                    `json:"relPath,omitempty"`
	RssFeed                *FeedMinified             `json:"rssFeed,omitempty"`
	ScanVersion            string                    `json:"scanVersion,omitempty"`
	Size                   int                       `json:"size,omitempty"`
	UpdatedAt              UnixMilli                 `json:"updatedAt,omitzero"`
	UserMediaProgress      *MediaProgress            `json:"userMediaProgress,omitempty"`
}

LibraryItemExpanded is the "LibraryItemExpanded" schema.

func (LibraryItemExpanded) IsPodcast ¶ added in v0.7.1

func (i LibraryItemExpanded) IsPodcast() bool

IsPodcast is whether the item is a podcast rather than a book.

func (LibraryItemExpanded) Minified ¶ added in v0.7.1

Minified is the item as a library's list sends it. The server writes the whole item by spreading the short one and adding to it, so every field of the short form is here to copy; the list's own additions, the series it was filtered by and the collapsed series, are not.

func (LibraryItemExpanded) Title ¶ added in v0.7.1

func (i LibraryItemExpanded) Title() string

Title is the book's or podcast's title, empty when the server sent no metadata.

type LibraryItemExpandedMedia ¶ added in v0.7.1

type LibraryItemExpandedMedia struct {
	AudioFiles               []AudioFile                       `json:"audioFiles,omitzero"`
	AutoDownloadEpisodes     *bool                             `json:"autoDownloadEpisodes,omitempty"`
	AutoDownloadSchedule     string                            `json:"autoDownloadSchedule,omitempty"`
	Chapters                 []Chapter                         `json:"chapters,omitzero"`
	CoverPath                string                            `json:"coverPath,omitempty"`
	Duration                 float64                           `json:"duration,omitempty"`
	EbookFile                *EBookFile                        `json:"ebookFile,omitempty"`
	EbookFormat              string                            `json:"ebookFormat,omitempty"`
	Episodes                 []PodcastEpisode                  `json:"episodes,omitzero"`
	Id                       string                            `json:"id,omitempty"`
	LastEpisodeCheck         UnixMilli                         `json:"lastEpisodeCheck,omitzero"`
	LibraryItemId            LibraryItemID                     `json:"libraryItemId,omitempty"`
	MaxEpisodesToKeep        int                               `json:"maxEpisodesToKeep,omitempty"`
	MaxNewEpisodesToDownload int                               `json:"maxNewEpisodesToDownload,omitempty"`
	Metadata                 *LibraryItemExpandedMediaMetadata `json:"metadata,omitempty"`
	NumAudioFiles            int                               `json:"numAudioFiles,omitempty"`
	NumChapters              int                               `json:"numChapters,omitempty"`
	NumEpisodes              int                               `json:"numEpisodes,omitempty"`
	NumTracks                int                               `json:"numTracks,omitempty"`
	Size                     float64                           `json:"size,omitempty"`
	Tags                     []string                          `json:"tags,omitzero"`
	Tracks                   []AudioTrack                      `json:"tracks,omitzero"`
}

LibraryItemExpandedMedia is an object the document declares inline.

type LibraryItemExpandedMediaMetadata ¶ added in v0.7.1

type LibraryItemExpandedMediaMetadata struct {
	Abridged          *bool           `json:"abridged,omitempty"`
	Asin              string          `json:"asin,omitempty"`
	Author            string          `json:"author,omitempty"`
	AuthorName        string          `json:"authorName,omitempty"`
	AuthorNameLF      string          `json:"authorNameLF,omitempty"`
	Authors           []AuthorMinimal `json:"authors,omitzero"`
	Description       string          `json:"description,omitempty"`
	DescriptionPlain  string          `json:"descriptionPlain,omitempty"`
	Explicit          *bool           `json:"explicit,omitempty"`
	FeedUrl           string          `json:"feedUrl,omitempty"`
	Genres            []string        `json:"genres,omitzero"`
	ImageUrl          string          `json:"imageUrl,omitempty"`
	Isbn              string          `json:"isbn,omitempty"`
	ItunesArtistId    string          `json:"itunesArtistId,omitempty"`
	ItunesId          string          `json:"itunesId,omitempty"`
	ItunesPageUrl     string          `json:"itunesPageUrl,omitempty"`
	Language          string          `json:"language,omitempty"`
	NarratorName      string          `json:"narratorName,omitempty"`
	Narrators         []string        `json:"narrators,omitzero"`
	PublishedDate     string          `json:"publishedDate,omitempty"`
	PublishedYear     string          `json:"publishedYear,omitempty"`
	Publisher         string          `json:"publisher,omitempty"`
	ReleaseDate       string          `json:"releaseDate,omitempty"`
	Series            []SeriesMinimal `json:"series,omitzero"`
	SeriesName        string          `json:"seriesName,omitempty"`
	Subtitle          string          `json:"subtitle,omitempty"`
	Title             string          `json:"title,omitempty"`
	TitleIgnorePrefix string          `json:"titleIgnorePrefix,omitempty"`
	Type              string          `json:"type,omitempty"`
}

LibraryItemExpandedMediaMetadata is an object the document declares inline.

func (LibraryItemExpandedMediaMetadata) AuthorDisplay ¶ added in v0.7.1

func (m LibraryItemExpandedMediaMetadata) AuthorDisplay() string

AuthorDisplay is the author as one line: a book's authors, or a podcast's author.

func (LibraryItemExpandedMediaMetadata) NarratorDisplay ¶ added in v0.7.1

func (m LibraryItemExpandedMediaMetadata) NarratorDisplay() string

NarratorDisplay is a book's narrators as one line.

func (LibraryItemExpandedMediaMetadata) SeriesDisplay ¶ added in v0.7.1

func (m LibraryItemExpandedMediaMetadata) SeriesDisplay() []string

SeriesDisplay is a book's series, each as its name and, when it has one, its number in the series: "Discworld #3".

type LibraryItemFindOneOptions ¶ added in v0.7.1

type LibraryItemFindOneOptions struct {
	Episode  string
	Expanded string
	Include  string
}

LibraryItemFindOneOptions holds the query and header parameters of LibraryItemFindOne.

func (LibraryItemFindOneOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryItemFindOneOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryItemFindOneOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryItemFindOneResponse ¶ added in v0.7.1

type LibraryItemFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemExpanded
	*LibraryItemExpanded
}

LibraryItemFindOneResponse is the result of LibraryItemFindOne.

Answer is the LibraryItemExpanded answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemFindOneResponse) Answered ¶ added in v0.7.1

func (r LibraryItemFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemFindOneResponse) Record ¶ added in v0.7.1

Record is the LibraryItemExpanded answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemGetCoverOptions ¶ added in v0.7.1

type LibraryItemGetCoverOptions struct {
	Format string
	Height string
	Raw    string
	Ts     string
	Width  string
}

LibraryItemGetCoverOptions holds the query and header parameters of LibraryItemGetCover.

func (LibraryItemGetCoverOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryItemGetCoverOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryItemGetCoverOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryItemGetCoverResponse ¶ added in v0.7.1

type LibraryItemGetCoverResponse struct {
	HttpResponse *http.Response
}

LibraryItemGetCoverResponse is the result of LibraryItemGetCover.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryItemGetCoverResponse) Bytes ¶ added in v0.7.1

func (r LibraryItemGetCoverResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryItemGetCoverResponse) ContentLength ¶ added in v0.7.1

func (r LibraryItemGetCoverResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryItemGetCoverResponse) Filename ¶ added in v0.7.1

func (r LibraryItemGetCoverResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryItemGetCoverResponse) Reader ¶ added in v0.7.1

func (r LibraryItemGetCoverResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryItemGetCoverResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryItemGetEBookFile2Response ¶ added in v0.7.1

type LibraryItemGetEBookFile2Response struct {
	HttpResponse *http.Response
}

LibraryItemGetEBookFile2Response is the result of LibraryItemGetEBookFile2.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryItemGetEBookFile2Response) Bytes ¶ added in v0.7.1

func (r LibraryItemGetEBookFile2Response) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryItemGetEBookFile2Response) ContentLength ¶ added in v0.7.1

func (r LibraryItemGetEBookFile2Response) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryItemGetEBookFile2Response) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryItemGetEBookFile2Response) Reader ¶ added in v0.7.1

func (r LibraryItemGetEBookFile2Response) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryItemGetEBookFile2Response) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryItemGetEBookFileResponse ¶ added in v0.7.1

type LibraryItemGetEBookFileResponse struct {
	HttpResponse *http.Response
}

LibraryItemGetEBookFileResponse is the result of LibraryItemGetEBookFile.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryItemGetEBookFileResponse) Bytes ¶ added in v0.7.1

func (r LibraryItemGetEBookFileResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryItemGetEBookFileResponse) ContentLength ¶ added in v0.7.1

func (r LibraryItemGetEBookFileResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryItemGetEBookFileResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryItemGetEBookFileResponse) Reader ¶ added in v0.7.1

func (r LibraryItemGetEBookFileResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryItemGetEBookFileResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryItemGetFFprobeDataAnswer ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswer struct {
	Chapters []LibraryItemGetFFprobeDataAnswerChapters `json:"chapters,omitzero"`
	Format   *LibraryItemGetFFprobeDataAnswerFormat    `json:"format,omitempty"`
	Programs []any                                     `json:"programs,omitzero"`
	Streams  []LibraryItemGetFFprobeDataAnswerStreams  `json:"streams,omitzero"`
}

LibraryItemGetFFprobeDataAnswer is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerChapters ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerChapters struct {
	End       float64                                      `json:"end,omitempty"`
	EndTime   string                                       `json:"end_time,omitempty"`
	Id        int                                          `json:"id,omitempty"`
	Start     float64                                      `json:"start,omitempty"`
	StartTime string                                       `json:"start_time,omitempty"`
	Tags      *LibraryItemGetFFprobeDataAnswerChaptersTags `json:"tags,omitempty"`
	TimeBase  string                                       `json:"time_base,omitempty"`
}

LibraryItemGetFFprobeDataAnswerChapters is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerChaptersTags ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerChaptersTags struct {
	Title string `json:"title,omitempty"`
}

LibraryItemGetFFprobeDataAnswerChaptersTags is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerFormat ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerFormat struct {
	BitRate        string                                     `json:"bit_rate,omitempty"`
	Duration       string                                     `json:"duration,omitempty"`
	Filename       string                                     `json:"filename,omitempty"`
	FormatLongName string                                     `json:"format_long_name,omitempty"`
	FormatName     string                                     `json:"format_name,omitempty"`
	NbPrograms     float64                                    `json:"nb_programs,omitempty"`
	NbStreamGroups float64                                    `json:"nb_stream_groups,omitempty"`
	NbStreams      float64                                    `json:"nb_streams,omitempty"`
	ProbeScore     float64                                    `json:"probe_score,omitempty"`
	Size           string                                     `json:"size,omitempty"`
	StartTime      string                                     `json:"start_time,omitempty"`
	Tags           *LibraryItemGetFFprobeDataAnswerFormatTags `json:"tags,omitempty"`
}

LibraryItemGetFFprobeDataAnswerFormat is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerFormatTags ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerFormatTags struct {
	TIT3        string `json:"TIT3,omitempty"`
	TRACKTOTAL  string `json:"TRACKTOTAL,omitempty"`
	Album       string `json:"album,omitempty"`
	AlbumArtist string `json:"album_artist,omitempty"`
	Artist      string `json:"artist,omitempty"`
	Comment     string `json:"comment,omitempty"`
	Composer    string `json:"composer,omitempty"`
	Copyright   string `json:"copyright,omitempty"`
	Date        string `json:"date,omitempty"`
	Description string `json:"description,omitempty"`
	Encoder     string `json:"encoder,omitempty"`
	Genre       string `json:"genre,omitempty"`
	Grouping    string `json:"grouping,omitempty"`
	Publisher   string `json:"publisher,omitempty"`
	Title       string `json:"title,omitempty"`
	Track       string `json:"track,omitempty"`
}

LibraryItemGetFFprobeDataAnswerFormatTags is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerStreams ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerStreams struct {
	AvgFrameRate       string                                             `json:"avg_frame_rate,omitempty"`
	BitRate            string                                             `json:"bit_rate,omitempty"`
	BitsPerRawSample   string                                             `json:"bits_per_raw_sample,omitempty"`
	BitsPerSample      float64                                            `json:"bits_per_sample,omitempty"`
	ChannelLayout      string                                             `json:"channel_layout,omitempty"`
	Channels           int                                                `json:"channels,omitempty"`
	ChromaLocation     string                                             `json:"chroma_location,omitempty"`
	CodecLongName      string                                             `json:"codec_long_name,omitempty"`
	CodecName          string                                             `json:"codec_name,omitempty"`
	CodecTag           string                                             `json:"codec_tag,omitempty"`
	CodecTagString     string                                             `json:"codec_tag_string,omitempty"`
	CodecType          string                                             `json:"codec_type,omitempty"`
	CodedHeight        float64                                            `json:"coded_height,omitempty"`
	CodedWidth         float64                                            `json:"coded_width,omitempty"`
	ColorRange         string                                             `json:"color_range,omitempty"`
	ColorSpace         string                                             `json:"color_space,omitempty"`
	DisplayAspectRatio string                                             `json:"display_aspect_ratio,omitempty"`
	Disposition        *LibraryItemGetFFprobeDataAnswerStreamsDisposition `json:"disposition,omitempty"`
	Duration           string                                             `json:"duration,omitempty"`
	DurationTs         float64                                            `json:"duration_ts,omitempty"`
	HasBFrames         float64                                            `json:"has_b_frames,omitempty"`
	Height             float64                                            `json:"height,omitempty"`
	Index              int                                                `json:"index,omitempty"`
	InitialPadding     float64                                            `json:"initial_padding,omitempty"`
	Level              float64                                            `json:"level,omitempty"`
	MimeCodecString    string                                             `json:"mime_codec_string,omitempty"`
	PixFmt             string                                             `json:"pix_fmt,omitempty"`
	Profile            string                                             `json:"profile,omitempty"`
	RFrameRate         string                                             `json:"r_frame_rate,omitempty"`
	SampleAspectRatio  string                                             `json:"sample_aspect_ratio,omitempty"`
	SampleFmt          string                                             `json:"sample_fmt,omitempty"`
	SampleRate         string                                             `json:"sample_rate,omitempty"`
	StartPts           float64                                            `json:"start_pts,omitempty"`
	StartTime          string                                             `json:"start_time,omitempty"`
	Tags               *LibraryItemGetFFprobeDataAnswerStreamsTags        `json:"tags,omitempty"`
	TimeBase           string                                             `json:"time_base,omitempty"`
	Width              float64                                            `json:"width,omitempty"`
}

LibraryItemGetFFprobeDataAnswerStreams is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerStreamsDisposition ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerStreamsDisposition struct {
	AttachedPic     float64 `json:"attached_pic,omitempty"`
	Captions        float64 `json:"captions,omitempty"`
	CleanEffects    float64 `json:"clean_effects,omitempty"`
	Comment         float64 `json:"comment,omitempty"`
	Default         float64 `json:"default,omitempty"`
	Dependent       float64 `json:"dependent,omitempty"`
	Descriptions    float64 `json:"descriptions,omitempty"`
	Dub             float64 `json:"dub,omitempty"`
	Forced          float64 `json:"forced,omitempty"`
	HearingImpaired float64 `json:"hearing_impaired,omitempty"`
	Karaoke         float64 `json:"karaoke,omitempty"`
	Lyrics          float64 `json:"lyrics,omitempty"`
	Metadata        float64 `json:"metadata,omitempty"`
	Multilayer      float64 `json:"multilayer,omitempty"`
	NonDiegetic     float64 `json:"non_diegetic,omitempty"`
	Original        float64 `json:"original,omitempty"`
	StillImage      float64 `json:"still_image,omitempty"`
	TimedThumbnails float64 `json:"timed_thumbnails,omitempty"`
	VisualImpaired  float64 `json:"visual_impaired,omitempty"`
}

LibraryItemGetFFprobeDataAnswerStreamsDisposition is an object the document declares inline.

type LibraryItemGetFFprobeDataAnswerStreamsTags ¶ added in v0.7.1

type LibraryItemGetFFprobeDataAnswerStreamsTags struct {
	Comment string `json:"comment,omitempty"`
	Title   string `json:"title,omitempty"`
}

LibraryItemGetFFprobeDataAnswerStreamsTags is an object the document declares inline.

type LibraryItemGetFFprobeDataResponse ¶ added in v0.7.1

type LibraryItemGetFFprobeDataResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemGetFFprobeDataAnswer
	*LibraryItemGetFFprobeDataAnswer
}

LibraryItemGetFFprobeDataResponse is the result of LibraryItemGetFFprobeData.

Answer is the LibraryItemGetFFprobeDataAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemGetFFprobeDataResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemGetFFprobeDataResponse) Record ¶ added in v0.7.1

Record is the LibraryItemGetFFprobeDataAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemGetLibraryFileOptions ¶ added in v0.7.1

type LibraryItemGetLibraryFileOptions struct {
	Range string
}

LibraryItemGetLibraryFileOptions holds the query and header parameters of LibraryItemGetLibraryFile.

func (LibraryItemGetLibraryFileOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryItemGetLibraryFileOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryItemGetLibraryFileResponse ¶ added in v0.7.1

type LibraryItemGetLibraryFileResponse struct {
	HttpResponse *http.Response
}

LibraryItemGetLibraryFileResponse is the result of LibraryItemGetLibraryFile.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (LibraryItemGetLibraryFileResponse) Bytes ¶ added in v0.7.1

func (r LibraryItemGetLibraryFileResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (LibraryItemGetLibraryFileResponse) ContentLength ¶ added in v0.7.1

func (r LibraryItemGetLibraryFileResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (LibraryItemGetLibraryFileResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (LibraryItemGetLibraryFileResponse) Reader ¶ added in v0.7.1

func (r LibraryItemGetLibraryFileResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (LibraryItemGetLibraryFileResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type LibraryItemGetMetadataObjectAnswer ¶ added in v0.7.1

type LibraryItemGetMetadataObjectAnswer struct {
	TIT3        string `json:"TIT3,omitempty"`
	TRACKTOTAL  string `json:"TRACKTOTAL,omitempty"`
	Album       string `json:"album,omitempty"`
	AlbumArtist string `json:"album_artist,omitempty"`
	Artist      string `json:"artist,omitempty"`
	Comment     string `json:"comment,omitempty"`
	Composer    string `json:"composer,omitempty"`
	Copyright   string `json:"copyright,omitempty"`
	Date        string `json:"date,omitempty"`
	Description string `json:"description,omitempty"`
	Genre       string `json:"genre,omitempty"`
	Grouping    string `json:"grouping,omitempty"`
	Publisher   string `json:"publisher,omitempty"`
	Title       string `json:"title,omitempty"`
}

LibraryItemGetMetadataObjectAnswer is an object the document declares inline.

type LibraryItemGetMetadataObjectResponse ¶ added in v0.7.1

type LibraryItemGetMetadataObjectResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemGetMetadataObjectAnswer
	*LibraryItemGetMetadataObjectAnswer
}

LibraryItemGetMetadataObjectResponse is the result of LibraryItemGetMetadataObject.

Answer is the LibraryItemGetMetadataObjectAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemGetMetadataObjectResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemGetMetadataObjectResponse) Record ¶ added in v0.7.1

Record is the LibraryItemGetMetadataObjectAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemID ¶ added in v0.7.1

type LibraryItemID string

LibraryItemID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and LibraryItemID(n) convert one value, client.StringIDs a list.

type LibraryItemMatchAnswer ¶ added in v0.7.1

type LibraryItemMatchAnswer struct {
	LibraryItem *LibraryItemExpanded `json:"libraryItem,omitempty"`
	Updated     bool                 `json:"updated"`
	Warning     string               `json:"warning,omitempty"`
}

LibraryItemMatchAnswer is an object the document declares inline.

type LibraryItemMatchRequest ¶ added in v0.7.1

type LibraryItemMatchRequest struct {
	Asin            string `json:"asin,omitempty"`
	Author          string `json:"author,omitempty"`
	Isbn            string `json:"isbn,omitempty"`
	OverrideCover   *bool  `json:"overrideCover,omitempty"`
	OverrideDetails *bool  `json:"overrideDetails,omitempty"`
	Provider        string `json:"provider,omitempty"`
	Title           string `json:"title,omitempty"`
}

LibraryItemMatchRequest is an object the document declares inline.

type LibraryItemMatchResponse ¶ added in v0.7.1

type LibraryItemMatchResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemMatchAnswer
	*LibraryItemMatchAnswer
}

LibraryItemMatchResponse is the result of LibraryItemMatch.

Answer is the LibraryItemMatchAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemMatchResponse) Answered ¶ added in v0.7.1

func (r LibraryItemMatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemMatchResponse) Record ¶ added in v0.7.1

Record is the LibraryItemMatchAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemMedia ¶ added in v0.7.1

type LibraryItemMedia struct {
	AudioFiles               []AudioFile      `json:"audioFiles,omitzero"`
	AutoDownloadEpisodes     *bool            `json:"autoDownloadEpisodes,omitempty"`
	AutoDownloadSchedule     string           `json:"autoDownloadSchedule,omitempty"`
	Chapters                 []Chapter        `json:"chapters,omitzero"`
	CoverPath                string           `json:"coverPath,omitempty"`
	EbookFile                *EBookFile       `json:"ebookFile,omitempty"`
	Episodes                 []PodcastEpisode `json:"episodes,omitzero"`
	Id                       string           `json:"id,omitempty"`
	LastEpisodeCheck         UnixMilli        `json:"lastEpisodeCheck,omitzero"`
	LibraryItemId            LibraryItemID    `json:"libraryItemId,omitempty"`
	MaxEpisodesToKeep        int              `json:"maxEpisodesToKeep,omitempty"`
	MaxNewEpisodesToDownload int              `json:"maxNewEpisodesToDownload,omitempty"`
	Metadata                 *MediaMetadata   `json:"metadata,omitempty"`
	Tags                     []string         `json:"tags,omitzero"`
}

LibraryItemMedia is an object the document declares inline.

type LibraryItemMinified ¶ added in v0.7.1

type LibraryItemMinified struct {
	AddedAt            UnixMilli                           `json:"addedAt,omitzero"`
	BirthtimeMs        UnixMilli                           `json:"birthtimeMs,omitzero"`
	CollapsedSeries    *LibraryItemMinifiedCollapsedSeries `json:"collapsedSeries,omitempty"`
	CtimeMs            UnixMilli                           `json:"ctimeMs,omitzero"`
	FolderId           FolderID                            `json:"folderId,omitempty"`
	Id                 LibraryItemID                       `json:"id,omitempty"`
	Ino                string                              `json:"ino,omitempty"`
	IsFile             *bool                               `json:"isFile,omitempty"`
	IsInvalid          bool                                `json:"isInvalid"`
	IsMissing          bool                                `json:"isMissing"`
	LibraryId          LibraryID                           `json:"libraryId,omitempty"`
	Media              *LibraryItemMinifiedMedia           `json:"media,omitempty"`
	MediaItemShare     any                                 `json:"mediaItemShare,omitempty"`
	MediaType          string                              `json:"mediaType,omitempty"`
	MtimeMs            UnixMilli                           `json:"mtimeMs,omitzero"`
	NumFiles           int                                 `json:"numFiles,omitempty"`
	OldLibraryItemId   any                                 `json:"oldLibraryItemId,omitempty"`
	Path               string                              `json:"path,omitempty"`
	ProgressLastUpdate UnixMilli                           `json:"progressLastUpdate,omitzero"`
	RecentEpisode      *PodcastEpisode                     `json:"recentEpisode,omitempty"`
	RelPath            string                              `json:"relPath,omitempty"`
	RssFeed            any                                 `json:"rssFeed,omitempty"`
	Size               int                                 `json:"size,omitempty"`
	UpdatedAt          UnixMilli                           `json:"updatedAt,omitzero"`
}

LibraryItemMinified is the "LibraryItemMinified" schema.

func (LibraryItemMinified) HasCover ¶ added in v0.7.1

func (i LibraryItemMinified) HasCover() bool

HasCover is whether the item has a cover image.

func (LibraryItemMinified) IsPodcast ¶ added in v0.7.1

func (i LibraryItemMinified) IsPodcast() bool

IsPodcast is whether the item is a podcast rather than a book.

func (LibraryItemMinified) SizeBytes ¶ added in v0.7.1

func (i LibraryItemMinified) SizeBytes() int64

SizeBytes is the item's size on disk: the item's own, or its media's when the server sent only that.

func (LibraryItemMinified) Title ¶ added in v0.7.1

func (i LibraryItemMinified) Title() string

Title is the book's or podcast's title, empty when the server sent no metadata.

type LibraryItemMinifiedCollapsedSeries ¶ added in v0.7.1

type LibraryItemMinifiedCollapsedSeries struct {
	Id               string `json:"id,omitempty"`
	LibraryItemIds   any    `json:"libraryItemIds,omitempty"`
	Name             string `json:"name,omitempty"`
	NameIgnorePrefix any    `json:"nameIgnorePrefix,omitempty"`
	NumBooks         int    `json:"numBooks,omitempty"`
}

LibraryItemMinifiedCollapsedSeries is an object the document declares inline.

func (LibraryItemMinifiedCollapsedSeries) GetId ¶ added in v0.7.1

GetId is the record's Id, for code that handles records of several types alike.

func (LibraryItemMinifiedCollapsedSeries) GetName ¶ added in v0.7.1

GetName is the record's Name, for code that handles records of several types alike.

type LibraryItemMinifiedMedia ¶ added in v0.7.1

type LibraryItemMinifiedMedia struct {
	AutoDownloadEpisodes     *bool                             `json:"autoDownloadEpisodes,omitempty"`
	AutoDownloadSchedule     string                            `json:"autoDownloadSchedule,omitempty"`
	CoverPath                string                            `json:"coverPath,omitempty"`
	Duration                 float64                           `json:"duration,omitempty"`
	EbookFormat              string                            `json:"ebookFormat,omitempty"`
	Id                       string                            `json:"id,omitempty"`
	LastEpisodeCheck         UnixMilli                         `json:"lastEpisodeCheck,omitzero"`
	MaxEpisodesToKeep        int                               `json:"maxEpisodesToKeep,omitempty"`
	MaxNewEpisodesToDownload int                               `json:"maxNewEpisodesToDownload,omitempty"`
	Metadata                 *LibraryItemMinifiedMediaMetadata `json:"metadata,omitempty"`
	NumAudioFiles            int                               `json:"numAudioFiles,omitempty"`
	NumChapters              int                               `json:"numChapters,omitempty"`
	NumEpisodes              int                               `json:"numEpisodes,omitempty"`
	NumTracks                int                               `json:"numTracks,omitempty"`
	Size                     float64                           `json:"size,omitempty"`
	Tags                     []string                          `json:"tags,omitzero"`
}

LibraryItemMinifiedMedia is an object the document declares inline.

type LibraryItemMinifiedMediaMetadata ¶ added in v0.7.1

type LibraryItemMinifiedMediaMetadata struct {
	Abridged          *bool          `json:"abridged,omitempty"`
	Asin              string         `json:"asin,omitempty"`
	Author            string         `json:"author,omitempty"`
	AuthorName        string         `json:"authorName,omitempty"`
	AuthorNameLF      string         `json:"authorNameLF,omitempty"`
	Description       string         `json:"description,omitempty"`
	Explicit          *bool          `json:"explicit,omitempty"`
	FeedUrl           string         `json:"feedUrl,omitempty"`
	Genres            []string       `json:"genres,omitzero"`
	ImageUrl          string         `json:"imageUrl,omitempty"`
	Isbn              string         `json:"isbn,omitempty"`
	ItunesArtistId    string         `json:"itunesArtistId,omitempty"`
	ItunesId          string         `json:"itunesId,omitempty"`
	ItunesPageUrl     string         `json:"itunesPageUrl,omitempty"`
	Language          string         `json:"language,omitempty"`
	NarratorName      string         `json:"narratorName,omitempty"`
	PublishedDate     string         `json:"publishedDate,omitempty"`
	PublishedYear     string         `json:"publishedYear,omitempty"`
	Publisher         string         `json:"publisher,omitempty"`
	ReleaseDate       string         `json:"releaseDate,omitempty"`
	Series            *SeriesMinimal `json:"series,omitempty"`
	SeriesName        string         `json:"seriesName,omitempty"`
	Subtitle          string         `json:"subtitle,omitempty"`
	Title             string         `json:"title,omitempty"`
	TitleIgnorePrefix string         `json:"titleIgnorePrefix,omitempty"`
	Type              string         `json:"type,omitempty"`
}

LibraryItemMinifiedMediaMetadata is an object the document declares inline.

func (LibraryItemMinifiedMediaMetadata) AuthorDisplay ¶ added in v0.7.1

func (m LibraryItemMinifiedMediaMetadata) AuthorDisplay() string

AuthorDisplay is the author as one line: a book's authors, or a podcast's author.

func (LibraryItemMinifiedMediaMetadata) NarratorDisplay ¶ added in v0.7.1

func (m LibraryItemMinifiedMediaMetadata) NarratorDisplay() string

NarratorDisplay is a book's narrators as one line.

func (LibraryItemMinifiedMediaMetadata) SeriesDisplay ¶ added in v0.7.1

func (m LibraryItemMinifiedMediaMetadata) SeriesDisplay() []string

SeriesDisplay is a book's series, each as its name and, when it has one, its number in the series: "Discworld #3".

type LibraryItemRemoveCoverResponse ¶ added in v0.7.1

type LibraryItemRemoveCoverResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemRemoveCoverResponse is the result of LibraryItemRemoveCover.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemRemoveCoverResponse) Answered ¶ added in v0.7.1

func (r LibraryItemRemoveCoverResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemScanAnswer ¶ added in v0.7.1

type LibraryItemScanAnswer struct {
	Result string `json:"result,omitempty"`
}

LibraryItemScanAnswer is an object the document declares inline.

type LibraryItemScanResponse ¶ added in v0.7.1

type LibraryItemScanResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemScanAnswer
	*LibraryItemScanAnswer
}

LibraryItemScanResponse is the result of LibraryItemScan.

Answer is the LibraryItemScanAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemScanResponse) Answered ¶ added in v0.7.1

func (r LibraryItemScanResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemScanResponse) Record ¶ added in v0.7.1

Record is the LibraryItemScanAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemStartEpisodePlaybackSessionRequest ¶ added in v0.7.1

type LibraryItemStartEpisodePlaybackSessionRequest struct {
	DeviceInfo         any `json:"deviceInfo,omitempty"`
	ForceDirectPlay    any `json:"forceDirectPlay,omitempty"`
	ForceTranscode     any `json:"forceTranscode,omitempty"`
	MediaPlayer        any `json:"mediaPlayer,omitempty"`
	SupportedMimeTypes any `json:"supportedMimeTypes,omitempty"`
}

LibraryItemStartEpisodePlaybackSessionRequest is an object the document declares inline.

type LibraryItemStartEpisodePlaybackSessionResponse ¶ added in v0.7.1

type LibraryItemStartEpisodePlaybackSessionResponse struct {
	HttpResponse *http.Response
	Answer       *PlaybackSessionForClient
	*PlaybackSessionForClient
}

LibraryItemStartEpisodePlaybackSessionResponse is the result of LibraryItemStartEpisodePlaybackSession.

Answer is the PlaybackSessionForClient answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemStartEpisodePlaybackSessionResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemStartEpisodePlaybackSessionResponse) Record ¶ added in v0.7.1

Record is the PlaybackSessionForClient answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemStartPlaybackSessionRequest ¶ added in v0.7.1

type LibraryItemStartPlaybackSessionRequest struct {
	DeviceInfo         *LibraryItemStartPlaybackSessionRequestDeviceInfo `json:"deviceInfo,omitempty"`
	ForceDirectPlay    *bool                                             `json:"forceDirectPlay,omitempty"`
	ForceTranscode     any                                               `json:"forceTranscode,omitempty"`
	MediaPlayer        string                                            `json:"mediaPlayer,omitempty"`
	SupportedMimeTypes []string                                          `json:"supportedMimeTypes,omitzero"`
}

LibraryItemStartPlaybackSessionRequest is an object the document declares inline.

type LibraryItemStartPlaybackSessionRequestDeviceInfo ¶ added in v0.7.1

type LibraryItemStartPlaybackSessionRequestDeviceInfo struct {
	ClientName string `json:"clientName,omitempty"`
	DeviceName string `json:"deviceName,omitempty"`
}

LibraryItemStartPlaybackSessionRequestDeviceInfo is an object the document declares inline.

type LibraryItemStartPlaybackSessionResponse ¶ added in v0.7.1

type LibraryItemStartPlaybackSessionResponse struct {
	HttpResponse *http.Response
	Answer       *PlaybackSessionForClient
	*PlaybackSessionForClient
}

LibraryItemStartPlaybackSessionResponse is the result of LibraryItemStartPlaybackSession.

Answer is the PlaybackSessionForClient answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemStartPlaybackSessionResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemStartPlaybackSessionResponse) Record ¶ added in v0.7.1

Record is the PlaybackSessionForClient answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemUpdateCoverAnswer ¶ added in v0.7.1

type LibraryItemUpdateCoverAnswer struct {
	Cover   string `json:"cover,omitempty"`
	Success bool   `json:"success"`
}

LibraryItemUpdateCoverAnswer is an object the document declares inline.

type LibraryItemUpdateCoverRequest ¶ added in v0.7.1

type LibraryItemUpdateCoverRequest struct {
	Cover string `json:"cover,omitempty"`
}

LibraryItemUpdateCoverRequest is an object the document declares inline.

type LibraryItemUpdateCoverResponse ¶ added in v0.7.1

type LibraryItemUpdateCoverResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemUpdateCoverAnswer
	*LibraryItemUpdateCoverAnswer
}

LibraryItemUpdateCoverResponse is the result of LibraryItemUpdateCover.

Answer is the LibraryItemUpdateCoverAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemUpdateCoverResponse) Answered ¶ added in v0.7.1

func (r LibraryItemUpdateCoverResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemUpdateCoverResponse) Record ¶ added in v0.7.1

Record is the LibraryItemUpdateCoverAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemUpdateEbookFileStatusResponse ¶ added in v0.7.1

type LibraryItemUpdateEbookFileStatusResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryItemUpdateEbookFileStatusResponse is the result of LibraryItemUpdateEbookFileStatus.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryItemUpdateEbookFileStatusResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryItemUpdateMediaAnswer ¶ added in v0.7.1

type LibraryItemUpdateMediaAnswer struct {
	LibraryItem *LibraryItem `json:"libraryItem,omitempty"`
	Updated     bool         `json:"updated"`
}

LibraryItemUpdateMediaAnswer is an object the document declares inline.

type LibraryItemUpdateMediaChaptersAnswer ¶ added in v0.7.1

type LibraryItemUpdateMediaChaptersAnswer struct {
	Success bool `json:"success"`
	Updated bool `json:"updated"`
}

LibraryItemUpdateMediaChaptersAnswer is an object the document declares inline.

type LibraryItemUpdateMediaChaptersRequest ¶ added in v0.7.1

type LibraryItemUpdateMediaChaptersRequest struct {
	Chapters []Chapter `json:"chapters,omitzero"`
}

LibraryItemUpdateMediaChaptersRequest is an object the document declares inline.

type LibraryItemUpdateMediaChaptersResponse ¶ added in v0.7.1

type LibraryItemUpdateMediaChaptersResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemUpdateMediaChaptersAnswer
	*LibraryItemUpdateMediaChaptersAnswer
}

LibraryItemUpdateMediaChaptersResponse is the result of LibraryItemUpdateMediaChapters.

Answer is the LibraryItemUpdateMediaChaptersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemUpdateMediaChaptersResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemUpdateMediaChaptersResponse) Record ¶ added in v0.7.1

Record is the LibraryItemUpdateMediaChaptersAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemUpdateMediaResponse ¶ added in v0.7.1

type LibraryItemUpdateMediaResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemUpdateMediaAnswer
	*LibraryItemUpdateMediaAnswer
}

LibraryItemUpdateMediaResponse is the result of LibraryItemUpdateMedia.

Answer is the LibraryItemUpdateMediaAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemUpdateMediaResponse) Answered ¶ added in v0.7.1

func (r LibraryItemUpdateMediaResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemUpdateMediaResponse) Record ¶ added in v0.7.1

Record is the LibraryItemUpdateMediaAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemUpdateTracksRequest ¶ added in v0.7.1

type LibraryItemUpdateTracksRequest struct {
	OrderedFileData []LibraryItemUpdateTracksRequestOrderedFileData `json:"orderedFileData,omitzero"`
}

LibraryItemUpdateTracksRequest is an object the document declares inline.

type LibraryItemUpdateTracksRequestOrderedFileData ¶ added in v0.7.1

type LibraryItemUpdateTracksRequestOrderedFileData struct {
	Exclude *bool  `json:"exclude,omitempty"`
	Ino     string `json:"ino,omitempty"`
}

LibraryItemUpdateTracksRequestOrderedFileData is an object the document declares inline.

type LibraryItemUpdateTracksResponse ¶ added in v0.7.1

type LibraryItemUpdateTracksResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItem
	*LibraryItem
}

LibraryItemUpdateTracksResponse is the result of LibraryItemUpdateTracks.

Answer is the LibraryItem answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemUpdateTracksResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemUpdateTracksResponse) Record ¶ added in v0.7.1

Record is the LibraryItem answered, as a value to change and write back, or an error when the server answered none.

type LibraryItemUploadCoverAnswer ¶ added in v0.7.1

type LibraryItemUploadCoverAnswer struct {
	Cover   string `json:"cover,omitempty"`
	Success bool   `json:"success"`
}

LibraryItemUploadCoverAnswer is an object the document declares inline.

type LibraryItemUploadCoverResponse ¶ added in v0.7.1

type LibraryItemUploadCoverResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemUploadCoverAnswer
	*LibraryItemUploadCoverAnswer
}

LibraryItemUploadCoverResponse is the result of LibraryItemUploadCover.

Answer is the LibraryItemUploadCoverAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryItemUploadCoverResponse) Answered ¶ added in v0.7.1

func (r LibraryItemUploadCoverResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryItemUploadCoverResponse) Record ¶ added in v0.7.1

Record is the LibraryItemUploadCoverAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryMatchAllOptions ¶ added in v0.7.1

type LibraryMatchAllOptions struct {
	Sort string
}

LibraryMatchAllOptions holds the query and header parameters of LibraryMatchAll.

func (LibraryMatchAllOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryMatchAllOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryMatchAllOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryMatchAllResponse ¶ added in v0.7.1

type LibraryMatchAllResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryMatchAllResponse is the result of LibraryMatchAll.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryMatchAllResponse) Answered ¶ added in v0.7.1

func (r LibraryMatchAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryRemoveAllMetadataFilesAnswer ¶ added in v0.7.1

type LibraryRemoveAllMetadataFilesAnswer struct {
	Found   int `json:"found,omitempty"`
	Removed int `json:"removed,omitempty"`
}

LibraryRemoveAllMetadataFilesAnswer is an object the document declares inline.

type LibraryRemoveAllMetadataFilesOptions ¶ added in v0.7.1

type LibraryRemoveAllMetadataFilesOptions struct {
	Ext string
}

LibraryRemoveAllMetadataFilesOptions holds the query and header parameters of LibraryRemoveAllMetadataFiles.

func (LibraryRemoveAllMetadataFilesOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (LibraryRemoveAllMetadataFilesOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibraryRemoveAllMetadataFilesResponse ¶ added in v0.7.1

type LibraryRemoveAllMetadataFilesResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryRemoveAllMetadataFilesAnswer
	*LibraryRemoveAllMetadataFilesAnswer
}

LibraryRemoveAllMetadataFilesResponse is the result of LibraryRemoveAllMetadataFiles.

Answer is the LibraryRemoveAllMetadataFilesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryRemoveAllMetadataFilesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryRemoveAllMetadataFilesResponse) Record ¶ added in v0.7.1

Record is the LibraryRemoveAllMetadataFilesAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryRemoveLibraryItemsWithIssuesResponse ¶ added in v0.7.1

type LibraryRemoveLibraryItemsWithIssuesResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryRemoveLibraryItemsWithIssuesResponse is the result of LibraryRemoveLibraryItemsWithIssues.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryRemoveLibraryItemsWithIssuesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibraryRemoveNarratorAnswer ¶ added in v0.7.1

type LibraryRemoveNarratorAnswer struct {
	Updated int `json:"updated,omitempty"`
}

LibraryRemoveNarratorAnswer is an object the document declares inline.

type LibraryRemoveNarratorResponse ¶ added in v0.7.1

type LibraryRemoveNarratorResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryRemoveNarratorAnswer
	*LibraryRemoveNarratorAnswer
}

LibraryRemoveNarratorResponse is the result of LibraryRemoveNarrator.

Answer is the LibraryRemoveNarratorAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryRemoveNarratorResponse) Answered ¶ added in v0.7.1

func (r LibraryRemoveNarratorResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryRemoveNarratorResponse) Record ¶ added in v0.7.1

Record is the LibraryRemoveNarratorAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryReorderAnswer ¶ added in v0.7.1

type LibraryReorderAnswer struct {
	Libraries []Library `json:"libraries,omitzero"`
}

LibraryReorderAnswer is an object the document declares inline.

type LibraryReorderRequest ¶ added in v0.7.1

type LibraryReorderRequest struct {
	Id       string  `json:"id,omitempty"`
	NewOrder float64 `json:"newOrder,omitempty"`
}

LibraryReorderRequest is an object the document declares inline.

type LibraryReorderResponse ¶ added in v0.7.1

type LibraryReorderResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryReorderAnswer
	*LibraryReorderAnswer
}

LibraryReorderResponse is the result of LibraryReorder.

Answer is the LibraryReorderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryReorderResponse) Answered ¶ added in v0.7.1

func (r LibraryReorderResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryReorderResponse) Record ¶ added in v0.7.1

Record is the LibraryReorderAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryScanOptions ¶ added in v0.7.1

type LibraryScanOptions struct {
	Force string
}

LibraryScanOptions holds the query and header parameters of LibraryScan.

func (LibraryScanOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryScanOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryScanOptions) ToQuery ¶ added in v0.7.1

func (o LibraryScanOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type LibraryScanResponse ¶ added in v0.7.1

type LibraryScanResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

LibraryScanResponse is the result of LibraryScan.

The operation answers text (text/plain), which Answer holds as it was sent.

func (LibraryScanResponse) Answered ¶ added in v0.7.1

func (r LibraryScanResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type LibrarySearchAnswer ¶ added in v0.7.1

type LibrarySearchAnswer struct {
	Authors   []Author                       `json:"authors,omitzero"`
	Book      []LibrarySearchMatch           `json:"book,omitzero"`
	Episodes  []LibrarySearchAnswerEpisodes  `json:"episodes,omitzero"`
	Genres    []LibrarySearchAnswerGenres    `json:"genres,omitzero"`
	Narrators []LibrarySearchAnswerNarrators `json:"narrators,omitzero"`
	Podcast   []LibrarySearchMatch           `json:"podcast,omitzero"`
	Series    []LibrarySearchAnswerSeries    `json:"series,omitzero"`
	Tags      []LibrarySearchAnswerTags      `json:"tags,omitzero"`
}

LibrarySearchAnswer is an object the document declares inline.

type LibrarySearchAnswerEpisodes ¶ added in v0.7.1

type LibrarySearchAnswerEpisodes struct {
	LibraryItem *LibraryItemExpanded `json:"libraryItem,omitempty"`
}

LibrarySearchAnswerEpisodes is an object the document declares inline.

type LibrarySearchAnswerGenres ¶ added in v0.7.1

type LibrarySearchAnswerGenres struct {
	Name     string `json:"name,omitempty"`
	NumItems int    `json:"numItems,omitempty"`
}

LibrarySearchAnswerGenres is an object the document declares inline.

type LibrarySearchAnswerNarrators ¶ added in v0.7.1

type LibrarySearchAnswerNarrators struct {
	Name     string `json:"name,omitempty"`
	NumBooks int    `json:"numBooks,omitempty"`
}

LibrarySearchAnswerNarrators is an object the document declares inline.

type LibrarySearchAnswerSeries ¶ added in v0.7.1

type LibrarySearchAnswerSeries struct {
	Books  []LibraryItem `json:"books,omitzero"`
	Series *Series       `json:"series,omitempty"`
}

LibrarySearchAnswerSeries is an object the document declares inline.

type LibrarySearchAnswerTags ¶ added in v0.7.1

type LibrarySearchAnswerTags struct {
	Name     string `json:"name,omitempty"`
	NumItems int    `json:"numItems,omitempty"`
}

LibrarySearchAnswerTags is an object the document declares inline.

type LibrarySearchMatch ¶ added in v0.7.1

type LibrarySearchMatch struct {
	LibraryItem *LibraryItemExpanded `json:"libraryItem,omitempty"`
}

LibrarySearchMatch is the "LibrarySearchMatch" schema.

type LibrarySearchOptions ¶ added in v0.7.1

type LibrarySearchOptions struct {
	Limit *int
	Q     string
	Sort  string
}

LibrarySearchOptions holds the query and header parameters of LibrarySearch.

func (LibrarySearchOptions) ToHeaders ¶ added in v0.7.1

func (o LibrarySearchOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibrarySearchOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type LibrarySearchResponse ¶ added in v0.7.1

type LibrarySearchResponse struct {
	HttpResponse *http.Response
	Answer       *LibrarySearchAnswer
	*LibrarySearchAnswer
}

LibrarySearchResponse is the result of LibrarySearch.

Answer is the LibrarySearchAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibrarySearchResponse) Answered ¶ added in v0.7.1

func (r LibrarySearchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibrarySearchResponse) Record ¶ added in v0.7.1

Record is the LibrarySearchAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibrarySettings ¶

type LibrarySettings struct {
	AudiobooksOnly                     bool     `json:"audiobooksOnly"`
	AutoScanCronExpression             any      `json:"autoScanCronExpression,omitempty"`
	CoverAspectRatio                   int      `json:"coverAspectRatio,omitempty"`
	DisableWatcher                     bool     `json:"disableWatcher"`
	EpubsAllowScriptedContent          bool     `json:"epubsAllowScriptedContent"`
	HideSingleBookSeries               bool     `json:"hideSingleBookSeries"`
	MarkAsFinishedPercentComplete      float64  `json:"markAsFinishedPercentComplete,omitempty"`
	MarkAsFinishedTimeRemaining        float64  `json:"markAsFinishedTimeRemaining,omitempty"`
	MetadataPrecedence                 []string `json:"metadataPrecedence,omitzero"`
	OnlyShowLaterBooksInContinueSeries bool     `json:"onlyShowLaterBooksInContinueSeries"`
	PodcastSearchRegion                string   `json:"podcastSearchRegion,omitempty"`
	SkipMatchingMediaWithAsin          bool     `json:"skipMatchingMediaWithAsin"`
	SkipMatchingMediaWithIsbn          bool     `json:"skipMatchingMediaWithIsbn"`
}

LibrarySettings is an object the document declares inline.

type LibraryStatsAnswer ¶ added in v0.7.1

type LibraryStatsAnswer struct {
	AuthorsWithCount []LibraryStatsAnswerAuthorsWithCount `json:"authorsWithCount,omitzero"`
	GenresWithCount  []LibraryStatsAnswerGenresWithCount  `json:"genresWithCount,omitzero"`
	LargestItems     []LibraryStatsAnswerLargestItems     `json:"largestItems,omitzero"`
	LongestItems     []LibraryStatsAnswerLongestItems     `json:"longestItems,omitzero"`
	NumAudioTracks   float64                              `json:"numAudioTracks,omitempty"`
	TotalAuthors     int                                  `json:"totalAuthors,omitempty"`
	TotalDuration    float64                              `json:"totalDuration,omitempty"`
	TotalGenres      int                                  `json:"totalGenres,omitempty"`
	TotalItems       float64                              `json:"totalItems,omitempty"`
	TotalSize        float64                              `json:"totalSize,omitempty"`
}

LibraryStatsAnswer is an object the document declares inline.

type LibraryStatsAnswerAuthorsWithCount ¶ added in v0.7.1

type LibraryStatsAnswerAuthorsWithCount struct {
	Count int    `json:"count,omitempty"`
	Id    string `json:"id,omitempty"`
	Name  string `json:"name,omitempty"`
}

LibraryStatsAnswerAuthorsWithCount is an object the document declares inline.

func (LibraryStatsAnswerAuthorsWithCount) GetId ¶ added in v0.7.1

GetId is the record's Id, for code that handles records of several types alike.

func (LibraryStatsAnswerAuthorsWithCount) GetName ¶ added in v0.7.1

GetName is the record's Name, for code that handles records of several types alike.

type LibraryStatsAnswerGenresWithCount ¶ added in v0.7.1

type LibraryStatsAnswerGenresWithCount struct {
	Count int    `json:"count,omitempty"`
	Genre string `json:"genre,omitempty"`
}

LibraryStatsAnswerGenresWithCount is an object the document declares inline.

type LibraryStatsAnswerLargestItems ¶ added in v0.7.1

type LibraryStatsAnswerLargestItems struct {
	Id    string `json:"id,omitempty"`
	Size  int    `json:"size,omitempty"`
	Title string `json:"title,omitempty"`
}

LibraryStatsAnswerLargestItems is an object the document declares inline.

type LibraryStatsAnswerLongestItems ¶ added in v0.7.1

type LibraryStatsAnswerLongestItems struct {
	Duration float64 `json:"duration,omitempty"`
	Id       string  `json:"id,omitempty"`
	Title    string  `json:"title,omitempty"`
}

LibraryStatsAnswerLongestItems is an object the document declares inline.

type LibraryStatsOptions ¶ added in v0.7.1

type LibraryStatsOptions struct {
	Sort string
}

LibraryStatsOptions holds the query and header parameters of LibraryStats.

func (LibraryStatsOptions) ToHeaders ¶ added in v0.7.1

func (o LibraryStatsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (LibraryStatsOptions) ToQuery ¶ added in v0.7.1

func (o LibraryStatsOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type LibraryStatsResponse ¶ added in v0.7.1

type LibraryStatsResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryStatsAnswer
	*LibraryStatsAnswer
}

LibraryStatsResponse is the result of LibraryStats.

Answer is the LibraryStatsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryStatsResponse) Answered ¶ added in v0.7.1

func (r LibraryStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryStatsResponse) Record ¶ added in v0.7.1

Record is the LibraryStatsAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryUpdateNarratorAnswer ¶ added in v0.7.1

type LibraryUpdateNarratorAnswer struct {
	Updated int `json:"updated,omitempty"`
}

LibraryUpdateNarratorAnswer is an object the document declares inline.

type LibraryUpdateNarratorRequest ¶ added in v0.7.1

type LibraryUpdateNarratorRequest struct {
	Name string `json:"name,omitempty"`
}

LibraryUpdateNarratorRequest is an object the document declares inline.

type LibraryUpdateNarratorResponse ¶ added in v0.7.1

type LibraryUpdateNarratorResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryUpdateNarratorAnswer
	*LibraryUpdateNarratorAnswer
}

LibraryUpdateNarratorResponse is the result of LibraryUpdateNarrator.

Answer is the LibraryUpdateNarratorAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryUpdateNarratorResponse) Answered ¶ added in v0.7.1

func (r LibraryUpdateNarratorResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryUpdateNarratorResponse) Record ¶ added in v0.7.1

Record is the LibraryUpdateNarratorAnswer answered, as a value to change and write back, or an error when the server answered none.

type LibraryUpdateRequest ¶ added in v0.7.1

type LibraryUpdateRequest struct {
	DisplayOrder any            `json:"displayOrder,omitempty"`
	Folders      any            `json:"folders,omitempty"`
	Icon         string         `json:"icon,omitempty"`
	MediaType    string         `json:"mediaType,omitempty"`
	Name         string         `json:"name,omitempty"`
	Provider     string         `json:"provider,omitempty"`
	Settings     map[string]any `json:"settings,omitzero"`
}

LibraryUpdateRequest is an object the document declares inline.

type LibraryUpdateResponse ¶ added in v0.7.1

type LibraryUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *Library
	*Library
}

LibraryUpdateResponse is the result of LibraryUpdate.

Answer is the Library answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (LibraryUpdateResponse) Answered ¶ added in v0.7.1

func (r LibraryUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (LibraryUpdateResponse) Record ¶ added in v0.7.1

func (r LibraryUpdateResponse) Record() (Library, error)

Record is the Library answered, as a value to change and write back, or an error when the server answered none.

type ListOrEmpty ¶ added in v0.7.1

type ListOrEmpty[T any] []T

ListOrEmpty is a list the server writes as empty text, rather than an empty list, when it has nothing in it: the day's log before its first line. It reads either as a list, and writes as one.

func (*ListOrEmpty[T]) UnmarshalJSON ¶ added in v0.7.1

func (l *ListOrEmpty[T]) UnmarshalJSON(data []byte) error

UnmarshalJSON reads a list, and empty text or null as an empty one.

type ListeningStats ¶

type ListeningStats struct {
	DayOfWeek      map[string]float64            `json:"dayOfWeek,omitzero"`
	Days           map[string]float64            `json:"days,omitzero"`
	Items          map[string]ListeningStatsItem `json:"items,omitzero"`
	RecentSessions []PlaybackSession             `json:"recentSessions,omitzero"`
	Today          float64                       `json:"today,omitempty"`
	TotalTime      float64                       `json:"totalTime,omitempty"`
}

ListeningStats is the "ListeningStats" schema.

type ListeningStatsItem ¶ added in v0.7.1

type ListeningStatsItem struct {
	Id            LibraryItemID  `json:"id,omitempty"`
	LastUpdate    any            `json:"lastUpdate,omitempty"`
	MediaMetadata *MediaMetadata `json:"mediaMetadata,omitempty"`
	TimeListening float64        `json:"timeListening,omitempty"`
}

ListeningStatsItem is the "ListeningStatsItem" schema.

type MeBatchUpdateMediaProgressResponse ¶ added in v0.7.1

type MeBatchUpdateMediaProgressResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MeBatchUpdateMediaProgressResponse is the result of MeBatchUpdateMediaProgress.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeBatchUpdateMediaProgressResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeCreateBookmarkRequest ¶ added in v0.7.1

type MeCreateBookmarkRequest struct {
	Time  float64 `json:"time"`
	Title string  `json:"title"`
}

MeCreateBookmarkRequest is an object the document declares inline.

type MeCreateBookmarkResponse ¶ added in v0.7.1

type MeCreateBookmarkResponse struct {
	HttpResponse *http.Response
	Answer       *AudioBookmark
	*AudioBookmark
}

MeCreateBookmarkResponse is the result of MeCreateBookmark.

Answer is the AudioBookmark answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeCreateBookmarkResponse) Answered ¶ added in v0.7.1

func (r MeCreateBookmarkResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeCreateBookmarkResponse) Record ¶ added in v0.7.1

Record is the AudioBookmark answered, as a value to change and write back, or an error when the server answered none.

type MeCreateUpdateMediaProgress2Response ¶ added in v0.7.1

type MeCreateUpdateMediaProgress2Response struct {
	HttpResponse *http.Response
	Answer       *string
}

MeCreateUpdateMediaProgress2Response is the result of MeCreateUpdateMediaProgress2.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeCreateUpdateMediaProgress2Response) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeCreateUpdateMediaProgressResponse ¶ added in v0.7.1

type MeCreateUpdateMediaProgressResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MeCreateUpdateMediaProgressResponse is the result of MeCreateUpdateMediaProgress.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeCreateUpdateMediaProgressResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeDeleteSessionResponse ¶ added in v0.7.1

type MeDeleteSessionResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MeDeleteSessionResponse is the result of MeDeleteSession.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeDeleteSessionResponse) Answered ¶ added in v0.7.1

func (r MeDeleteSessionResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeGetAllBookmarksAnswer ¶ added in v0.7.1

type MeGetAllBookmarksAnswer struct {
	Bookmarks []AudioBookmark `json:"bookmarks,omitzero"`
}

MeGetAllBookmarksAnswer is an object the document declares inline.

type MeGetAllBookmarksResponse ¶ added in v0.7.1

type MeGetAllBookmarksResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetAllBookmarksAnswer
	*MeGetAllBookmarksAnswer
}

MeGetAllBookmarksResponse is the result of MeGetAllBookmarks.

Answer is the MeGetAllBookmarksAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetAllBookmarksResponse) Answered ¶ added in v0.7.1

func (r MeGetAllBookmarksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetAllBookmarksResponse) Record ¶ added in v0.7.1

Record is the MeGetAllBookmarksAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetAllLibraryItemsInProgressAnswer ¶ added in v0.7.1

type MeGetAllLibraryItemsInProgressAnswer struct {
	LibraryItems []LibraryItemMinified `json:"libraryItems,omitzero"`
}

MeGetAllLibraryItemsInProgressAnswer is an object the document declares inline.

type MeGetAllLibraryItemsInProgressOptions ¶ added in v0.7.1

type MeGetAllLibraryItemsInProgressOptions struct {
	Limit *int
}

MeGetAllLibraryItemsInProgressOptions holds the query and header parameters of MeGetAllLibraryItemsInProgress.

func (MeGetAllLibraryItemsInProgressOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (MeGetAllLibraryItemsInProgressOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type MeGetAllLibraryItemsInProgressResponse ¶ added in v0.7.1

type MeGetAllLibraryItemsInProgressResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetAllLibraryItemsInProgressAnswer
	*MeGetAllLibraryItemsInProgressAnswer
}

MeGetAllLibraryItemsInProgressResponse is the result of MeGetAllLibraryItemsInProgress.

Answer is the MeGetAllLibraryItemsInProgressAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetAllLibraryItemsInProgressResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetAllLibraryItemsInProgressResponse) Record ¶ added in v0.7.1

Record is the MeGetAllLibraryItemsInProgressAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetAllMediaProgressAnswer ¶ added in v0.7.1

type MeGetAllMediaProgressAnswer struct {
	MediaProgress []MediaProgress `json:"mediaProgress,omitzero"`
}

MeGetAllMediaProgressAnswer is an object the document declares inline.

type MeGetAllMediaProgressResponse ¶ added in v0.7.1

type MeGetAllMediaProgressResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetAllMediaProgressAnswer
	*MeGetAllMediaProgressAnswer
}

MeGetAllMediaProgressResponse is the result of MeGetAllMediaProgress.

Answer is the MeGetAllMediaProgressAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetAllMediaProgressResponse) Answered ¶ added in v0.7.1

func (r MeGetAllMediaProgressResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetAllMediaProgressResponse) Record ¶ added in v0.7.1

Record is the MeGetAllMediaProgressAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetBookmarksForLibraryItemAnswer ¶ added in v0.7.1

type MeGetBookmarksForLibraryItemAnswer struct {
	Bookmarks []AudioBookmark `json:"bookmarks,omitzero"`
}

MeGetBookmarksForLibraryItemAnswer is an object the document declares inline.

type MeGetBookmarksForLibraryItemResponse ¶ added in v0.7.1

type MeGetBookmarksForLibraryItemResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetBookmarksForLibraryItemAnswer
	*MeGetBookmarksForLibraryItemAnswer
}

MeGetBookmarksForLibraryItemResponse is the result of MeGetBookmarksForLibraryItem.

Answer is the MeGetBookmarksForLibraryItemAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetBookmarksForLibraryItemResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetBookmarksForLibraryItemResponse) Record ¶ added in v0.7.1

Record is the MeGetBookmarksForLibraryItemAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetCurrentUserResponse ¶ added in v0.7.1

type MeGetCurrentUserResponse struct {
	HttpResponse *http.Response
	Answer       *UserForBrowser
	*UserForBrowser
}

MeGetCurrentUserResponse is the result of MeGetCurrentUser.

Answer is the UserForBrowser answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetCurrentUserResponse) Answered ¶ added in v0.7.1

func (r MeGetCurrentUserResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetCurrentUserResponse) Record ¶ added in v0.7.1

Record is the UserForBrowser answered, as a value to change and write back, or an error when the server answered none.

type MeGetItemListeningSessions2Answer ¶ added in v0.7.1

type MeGetItemListeningSessions2Answer struct {
	ItemsPerPage float64           `json:"itemsPerPage,omitempty"`
	NumPages     int               `json:"numPages,omitempty"`
	Page         float64           `json:"page,omitempty"`
	Sessions     []PlaybackSession `json:"sessions,omitzero"`
	Total        int               `json:"total,omitempty"`
}

MeGetItemListeningSessions2Answer is an object the document declares inline.

type MeGetItemListeningSessions2CompleteResult ¶ added in v0.7.1

type MeGetItemListeningSessions2CompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PlaybackSession
}

MeGetItemListeningSessions2CompleteResult is every result MeGetItemListeningSessions2Complete loaded.

type MeGetItemListeningSessions2Options ¶ added in v0.7.1

type MeGetItemListeningSessions2Options struct {
	ItemsPerPage *int
	Page         *int
}

MeGetItemListeningSessions2Options holds the query and header parameters of MeGetItemListeningSessions2.

func (MeGetItemListeningSessions2Options) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (MeGetItemListeningSessions2Options) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type MeGetItemListeningSessions2Response ¶ added in v0.7.1

type MeGetItemListeningSessions2Response struct {
	HttpResponse *http.Response
	Answer       *MeGetItemListeningSessions2Answer
	*MeGetItemListeningSessions2Answer
}

MeGetItemListeningSessions2Response is the result of MeGetItemListeningSessions2.

Answer is the MeGetItemListeningSessions2Answer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetItemListeningSessions2Response) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetItemListeningSessions2Response) Record ¶ added in v0.7.1

Record is the MeGetItemListeningSessions2Answer answered, as a value to change and write back, or an error when the server answered none.

type MeGetItemListeningSessionsAnswer ¶ added in v0.7.1

type MeGetItemListeningSessionsAnswer struct {
	ItemsPerPage float64           `json:"itemsPerPage,omitempty"`
	NumPages     int               `json:"numPages,omitempty"`
	Page         float64           `json:"page,omitempty"`
	Sessions     []PlaybackSession `json:"sessions,omitzero"`
	Total        int               `json:"total,omitempty"`
}

MeGetItemListeningSessionsAnswer is an object the document declares inline.

type MeGetItemListeningSessionsCompleteResult ¶ added in v0.7.1

type MeGetItemListeningSessionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PlaybackSession
}

MeGetItemListeningSessionsCompleteResult is every result MeGetItemListeningSessionsComplete loaded.

type MeGetItemListeningSessionsOptions ¶ added in v0.7.1

type MeGetItemListeningSessionsOptions struct {
	ItemsPerPage *int
	Page         *int
}

MeGetItemListeningSessionsOptions holds the query and header parameters of MeGetItemListeningSessions.

func (MeGetItemListeningSessionsOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (MeGetItemListeningSessionsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type MeGetItemListeningSessionsResponse ¶ added in v0.7.1

type MeGetItemListeningSessionsResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetItemListeningSessionsAnswer
	*MeGetItemListeningSessionsAnswer
}

MeGetItemListeningSessionsResponse is the result of MeGetItemListeningSessions.

Answer is the MeGetItemListeningSessionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetItemListeningSessionsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetItemListeningSessionsResponse) Record ¶ added in v0.7.1

Record is the MeGetItemListeningSessionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetListeningSessionsAnswer ¶ added in v0.7.1

type MeGetListeningSessionsAnswer struct {
	ItemsPerPage float64           `json:"itemsPerPage,omitempty"`
	NumPages     int               `json:"numPages,omitempty"`
	Page         float64           `json:"page,omitempty"`
	Sessions     []PlaybackSession `json:"sessions,omitzero"`
	Total        int               `json:"total,omitempty"`
}

MeGetListeningSessionsAnswer is an object the document declares inline.

type MeGetListeningSessionsCompleteResult ¶ added in v0.7.1

type MeGetListeningSessionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PlaybackSession
}

MeGetListeningSessionsCompleteResult is every result MeGetListeningSessionsComplete loaded.

type MeGetListeningSessionsOptions ¶ added in v0.7.1

type MeGetListeningSessionsOptions struct {
	ItemsPerPage *int
	Page         *int
}

MeGetListeningSessionsOptions holds the query and header parameters of MeGetListeningSessions.

func (MeGetListeningSessionsOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (MeGetListeningSessionsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type MeGetListeningSessionsResponse ¶ added in v0.7.1

type MeGetListeningSessionsResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetListeningSessionsAnswer
	*MeGetListeningSessionsAnswer
}

MeGetListeningSessionsResponse is the result of MeGetListeningSessions.

Answer is the MeGetListeningSessionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetListeningSessionsResponse) Answered ¶ added in v0.7.1

func (r MeGetListeningSessionsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetListeningSessionsResponse) Record ¶ added in v0.7.1

Record is the MeGetListeningSessionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetListeningStatsResponse ¶ added in v0.7.1

type MeGetListeningStatsResponse struct {
	HttpResponse *http.Response
	Answer       *ListeningStats
	*ListeningStats
}

MeGetListeningStatsResponse is the result of MeGetListeningStats.

Answer is the ListeningStats answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetListeningStatsResponse) Answered ¶ added in v0.7.1

func (r MeGetListeningStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetListeningStatsResponse) Record ¶ added in v0.7.1

Record is the ListeningStats answered, as a value to change and write back, or an error when the server answered none.

type MeGetMediaProgress2Response ¶ added in v0.7.1

type MeGetMediaProgress2Response struct {
	HttpResponse *http.Response
	Answer       *MediaProgress
	*MediaProgress
}

MeGetMediaProgress2Response is the result of MeGetMediaProgress2.

Answer is the MediaProgress answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetMediaProgress2Response) Answered ¶ added in v0.7.1

func (r MeGetMediaProgress2Response) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetMediaProgress2Response) Record ¶ added in v0.7.1

Record is the MediaProgress answered, as a value to change and write back, or an error when the server answered none.

type MeGetMediaProgressResponse ¶ added in v0.7.1

type MeGetMediaProgressResponse struct {
	HttpResponse *http.Response
	Answer       *MediaProgress
	*MediaProgress
}

MeGetMediaProgressResponse is the result of MeGetMediaProgress.

Answer is the MediaProgress answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetMediaProgressResponse) Answered ¶ added in v0.7.1

func (r MeGetMediaProgressResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetMediaProgressResponse) Record ¶ added in v0.7.1

Record is the MediaProgress answered, as a value to change and write back, or an error when the server answered none.

type MeGetSessionsAnswer ¶ added in v0.7.1

type MeGetSessionsAnswer struct {
	ItemsPerPage float64                       `json:"itemsPerPage,omitempty"`
	NumPages     int                           `json:"numPages,omitempty"`
	Page         float64                       `json:"page,omitempty"`
	Sessions     []MeGetSessionsAnswerSessions `json:"sessions,omitzero"`
	Total        int                           `json:"total,omitempty"`
}

MeGetSessionsAnswer is an object the document declares inline.

type MeGetSessionsAnswerSessions ¶ added in v0.7.1

type MeGetSessionsAnswerSessions struct {
	CreatedAt  UnixMilli                              `json:"createdAt,omitzero"`
	Current    bool                                   `json:"current"`
	DeviceInfo *MeGetSessionsAnswerSessionsDeviceInfo `json:"deviceInfo,omitempty"`
	Id         string                                 `json:"id,omitempty"`
	IpAddress  string                                 `json:"ipAddress,omitempty"`
	UpdatedAt  UnixMilli                              `json:"updatedAt,omitzero"`
	UserAgent  string                                 `json:"userAgent,omitempty"`
}

MeGetSessionsAnswerSessions is an object the document declares inline.

type MeGetSessionsAnswerSessionsDeviceInfo ¶ added in v0.7.1

type MeGetSessionsAnswerSessionsDeviceInfo struct {
	BrowserName    any `json:"browserName,omitempty"`
	BrowserVersion any `json:"browserVersion,omitempty"`
	DeviceType     any `json:"deviceType,omitempty"`
	Model          any `json:"model,omitempty"`
	OsName         any `json:"osName,omitempty"`
	OsVersion      any `json:"osVersion,omitempty"`
	Vendor         any `json:"vendor,omitempty"`
}

MeGetSessionsAnswerSessionsDeviceInfo is an object the document declares inline.

type MeGetSessionsCompleteResult ¶ added in v0.7.1

type MeGetSessionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MeGetSessionsAnswerSessions
}

MeGetSessionsCompleteResult is every result MeGetSessionsComplete loaded.

type MeGetSessionsOptions ¶ added in v0.7.1

type MeGetSessionsOptions struct {
	ItemsPerPage *int
	Page         *int
}

MeGetSessionsOptions holds the query and header parameters of MeGetSessions.

func (MeGetSessionsOptions) ToHeaders ¶ added in v0.7.1

func (o MeGetSessionsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (MeGetSessionsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type MeGetSessionsResponse ¶ added in v0.7.1

type MeGetSessionsResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetSessionsAnswer
	*MeGetSessionsAnswer
}

MeGetSessionsResponse is the result of MeGetSessions.

Answer is the MeGetSessionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetSessionsResponse) Answered ¶ added in v0.7.1

func (r MeGetSessionsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetSessionsResponse) Record ¶ added in v0.7.1

Record is the MeGetSessionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeGetStatsForYearAnswer ¶ added in v0.7.1

type MeGetStatsForYearAnswer struct {
	BooksWithCovers           []string                                         `json:"booksWithCovers,omitzero"`
	FinishedBooksWithCovers   []string                                         `json:"finishedBooksWithCovers,omitzero"`
	LongestAudiobookFinished  *MeGetStatsForYearAnswerLongestAudiobookFinished `json:"longestAudiobookFinished,omitempty"`
	MostListenedMonth         *MeGetStatsForYearAnswerMostListenedMonth        `json:"mostListenedMonth,omitempty"`
	MostListenedNarrator      *MeGetStatsForYearAnswerMostListenedNarrator     `json:"mostListenedNarrator,omitempty"`
	NumBooksFinished          int                                              `json:"numBooksFinished,omitempty"`
	NumBooksListened          int                                              `json:"numBooksListened,omitempty"`
	TopAuthors                []MeGetStatsForYearAnswerTopAuthors              `json:"topAuthors,omitzero"`
	TopGenres                 []MeGetStatsForYearAnswerTopGenres               `json:"topGenres,omitzero"`
	TotalBookListeningTime    int                                              `json:"totalBookListeningTime,omitempty"`
	TotalListeningSessions    int                                              `json:"totalListeningSessions,omitempty"`
	TotalListeningTime        int                                              `json:"totalListeningTime,omitempty"`
	TotalPodcastListeningTime int                                              `json:"totalPodcastListeningTime,omitempty"`
}

MeGetStatsForYearAnswer is an object the document declares inline.

type MeGetStatsForYearAnswerLongestAudiobookFinished ¶ added in v0.7.1

type MeGetStatsForYearAnswerLongestAudiobookFinished struct {
	Duration   int    `json:"duration,omitempty"`
	FinishedAt string `json:"finishedAt,omitempty"`
	Id         string `json:"id,omitempty"`
	Title      string `json:"title,omitempty"`
}

MeGetStatsForYearAnswerLongestAudiobookFinished is an object the document declares inline.

type MeGetStatsForYearAnswerMostListenedMonth ¶ added in v0.7.1

type MeGetStatsForYearAnswerMostListenedMonth struct {
	Month float64 `json:"month,omitempty"`
	Time  int     `json:"time,omitempty"`
}

MeGetStatsForYearAnswerMostListenedMonth is an object the document declares inline.

type MeGetStatsForYearAnswerMostListenedNarrator ¶ added in v0.7.1

type MeGetStatsForYearAnswerMostListenedNarrator struct {
	Name string `json:"name,omitempty"`
	Time int    `json:"time,omitempty"`
}

MeGetStatsForYearAnswerMostListenedNarrator is an object the document declares inline.

type MeGetStatsForYearAnswerTopAuthors ¶ added in v0.7.1

type MeGetStatsForYearAnswerTopAuthors struct {
	Name string `json:"name,omitempty"`
	Time int    `json:"time,omitempty"`
}

MeGetStatsForYearAnswerTopAuthors is an object the document declares inline.

type MeGetStatsForYearAnswerTopGenres ¶ added in v0.7.1

type MeGetStatsForYearAnswerTopGenres struct {
	Genre string `json:"genre,omitempty"`
	Time  int    `json:"time,omitempty"`
}

MeGetStatsForYearAnswerTopGenres is an object the document declares inline.

type MeGetStatsForYearResponse ¶ added in v0.7.1

type MeGetStatsForYearResponse struct {
	HttpResponse *http.Response
	Answer       *MeGetStatsForYearAnswer
	*MeGetStatsForYearAnswer
}

MeGetStatsForYearResponse is the result of MeGetStatsForYear.

Answer is the MeGetStatsForYearAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeGetStatsForYearResponse) Answered ¶ added in v0.7.1

func (r MeGetStatsForYearResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeGetStatsForYearResponse) Record ¶ added in v0.7.1

Record is the MeGetStatsForYearAnswer answered, as a value to change and write back, or an error when the server answered none.

type MeReaddSeriesFromContinueListeningResponse ¶ added in v0.7.1

type MeReaddSeriesFromContinueListeningResponse struct {
	HttpResponse *http.Response
	Answer       *UserForBrowser
	*UserForBrowser
}

MeReaddSeriesFromContinueListeningResponse is the result of MeReaddSeriesFromContinueListening.

Answer is the UserForBrowser answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeReaddSeriesFromContinueListeningResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeReaddSeriesFromContinueListeningResponse) Record ¶ added in v0.7.1

Record is the UserForBrowser answered, as a value to change and write back, or an error when the server answered none.

type MeRemoveBookmarkResponse ¶ added in v0.7.1

type MeRemoveBookmarkResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MeRemoveBookmarkResponse is the result of MeRemoveBookmark.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeRemoveBookmarkResponse) Answered ¶ added in v0.7.1

func (r MeRemoveBookmarkResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeRemoveItemFromContinueListeningResponse ¶ added in v0.7.1

type MeRemoveItemFromContinueListeningResponse struct {
	HttpResponse *http.Response
	Answer       *UserForBrowser
	*UserForBrowser
}

MeRemoveItemFromContinueListeningResponse is the result of MeRemoveItemFromContinueListening.

Answer is the UserForBrowser answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeRemoveItemFromContinueListeningResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeRemoveItemFromContinueListeningResponse) Record ¶ added in v0.7.1

Record is the UserForBrowser answered, as a value to change and write back, or an error when the server answered none.

type MeRemoveMediaProgressResponse ¶ added in v0.7.1

type MeRemoveMediaProgressResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MeRemoveMediaProgressResponse is the result of MeRemoveMediaProgress.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeRemoveMediaProgressResponse) Answered ¶ added in v0.7.1

func (r MeRemoveMediaProgressResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeRemoveSeriesFromContinueListeningResponse ¶ added in v0.7.1

type MeRemoveSeriesFromContinueListeningResponse struct {
	HttpResponse *http.Response
	Answer       *UserForBrowser
	*UserForBrowser
}

MeRemoveSeriesFromContinueListeningResponse is the result of MeRemoveSeriesFromContinueListening.

Answer is the UserForBrowser answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeRemoveSeriesFromContinueListeningResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeRemoveSeriesFromContinueListeningResponse) Record ¶ added in v0.7.1

Record is the UserForBrowser answered, as a value to change and write back, or an error when the server answered none.

type MeUpdateBookmarkRequest ¶ added in v0.7.1

type MeUpdateBookmarkRequest struct {
	Time  float64 `json:"time"`
	Title string  `json:"title"`
}

MeUpdateBookmarkRequest is an object the document declares inline.

type MeUpdateBookmarkResponse ¶ added in v0.7.1

type MeUpdateBookmarkResponse struct {
	HttpResponse *http.Response
	Answer       *AudioBookmark
	*AudioBookmark
}

MeUpdateBookmarkResponse is the result of MeUpdateBookmark.

Answer is the AudioBookmark answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeUpdateBookmarkResponse) Answered ¶ added in v0.7.1

func (r MeUpdateBookmarkResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeUpdateBookmarkResponse) Record ¶ added in v0.7.1

Record is the AudioBookmark answered, as a value to change and write back, or an error when the server answered none.

type MeUpdatePasswordRequest ¶ added in v0.7.1

type MeUpdatePasswordRequest struct {
	NewPassword string `json:"newPassword,omitempty"`
	Password    string `json:"password,omitempty"`
}

MeUpdatePasswordRequest is an object the document declares inline.

type MeUpdatePasswordResponse ¶ added in v0.7.1

type MeUpdatePasswordResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MeUpdatePasswordResponse is the result of MeUpdatePassword.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MeUpdatePasswordResponse) Answered ¶ added in v0.7.1

func (r MeUpdatePasswordResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MeUpdateUserEReaderDevicesAnswer ¶ added in v0.7.1

type MeUpdateUserEReaderDevicesAnswer struct {
	EreaderDevices []EreaderDevice `json:"ereaderDevices,omitzero"`
}

MeUpdateUserEReaderDevicesAnswer is an object the document declares inline.

type MeUpdateUserEReaderDevicesRequest ¶ added in v0.7.1

type MeUpdateUserEReaderDevicesRequest struct {
	EreaderDevices []EreaderDevice `json:"ereaderDevices,omitzero"`
}

MeUpdateUserEReaderDevicesRequest is an object the document declares inline.

type MeUpdateUserEReaderDevicesResponse ¶ added in v0.7.1

type MeUpdateUserEReaderDevicesResponse struct {
	HttpResponse *http.Response
	Answer       *MeUpdateUserEReaderDevicesAnswer
	*MeUpdateUserEReaderDevicesAnswer
}

MeUpdateUserEReaderDevicesResponse is the result of MeUpdateUserEReaderDevices.

Answer is the MeUpdateUserEReaderDevicesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MeUpdateUserEReaderDevicesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MeUpdateUserEReaderDevicesResponse) Record ¶ added in v0.7.1

Record is the MeUpdateUserEReaderDevicesAnswer answered, as a value to change and write back, or an error when the server answered none.

type MediaItemShareForClient ¶ added in v0.7.1

type MediaItemShareForClient struct {
	CreatedAt       string                    `json:"createdAt,omitempty"`
	ExpiresAt       string                    `json:"expiresAt,omitempty"`
	Id              string                    `json:"id,omitempty"`
	IsDownloadable  *bool                     `json:"isDownloadable,omitempty"`
	MediaItemId     string                    `json:"mediaItemId,omitempty"`
	MediaItemType   string                    `json:"mediaItemType,omitempty"`
	PlaybackSession *PlaybackSessionForClient `json:"playbackSession,omitempty"`
	Slug            string                    `json:"slug,omitempty"`
	UpdatedAt       string                    `json:"updatedAt,omitempty"`
}

MediaItemShareForClient is the "MediaItemShareForClient" schema.

type MediaItemType ¶ added in v0.7.1

type MediaItemType string

MediaItemType is the "MediaItemType" enum.

const (
	MediaItemTypeBook           MediaItemType = "book"
	MediaItemTypePodcastEpisode MediaItemType = "podcastEpisode"
)

Values of MediaItemType.

func (MediaItemType) Known ¶ added in v0.7.1

func (v MediaItemType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type MediaMetadata ¶ added in v0.7.1

type MediaMetadata struct {
	Abridged       *bool           `json:"abridged,omitempty"`
	Asin           string          `json:"asin,omitempty"`
	Author         string          `json:"author,omitempty"`
	Authors        []AuthorMinimal `json:"authors,omitzero"`
	Description    string          `json:"description,omitempty"`
	Explicit       *bool           `json:"explicit,omitempty"`
	FeedUrl        string          `json:"feedUrl,omitempty"`
	Genres         []string        `json:"genres,omitzero"`
	ImageUrl       string          `json:"imageUrl,omitempty"`
	Isbn           string          `json:"isbn,omitempty"`
	ItunesArtistId string          `json:"itunesArtistId,omitempty"`
	ItunesId       string          `json:"itunesId,omitempty"`
	ItunesPageUrl  string          `json:"itunesPageUrl,omitempty"`
	Language       string          `json:"language,omitempty"`
	Narrators      []string        `json:"narrators,omitzero"`
	PublishedDate  string          `json:"publishedDate,omitempty"`
	PublishedYear  string          `json:"publishedYear,omitempty"`
	Publisher      string          `json:"publisher,omitempty"`
	ReleaseDate    string          `json:"releaseDate,omitempty"`
	Series         []SeriesMinimal `json:"series,omitzero"`
	Subtitle       string          `json:"subtitle,omitempty"`
	Title          string          `json:"title,omitempty"`
	Type           string          `json:"type,omitempty"`
}

MediaMetadata is the "MediaMetadata" schema.

func (MediaMetadata) AuthorDisplay ¶ added in v0.7.1

func (m MediaMetadata) AuthorDisplay() string

AuthorDisplay is the author as one line: a book's authors, or a podcast's author.

type MediaProgress ¶

type MediaProgress struct {
	CoverPath                 string        `json:"coverPath,omitempty"`
	CurrentTime               float64       `json:"currentTime,omitempty"`
	DisplaySubtitle           string        `json:"displaySubtitle,omitempty"`
	DisplayTitle              string        `json:"displayTitle,omitempty"`
	Duration                  float64       `json:"duration,omitempty"`
	EbookLocation             string        `json:"ebookLocation,omitempty"`
	EbookProgress             float64       `json:"ebookProgress,omitempty"`
	EpisodeId                 EpisodeID     `json:"episodeId,omitempty"`
	FinishedAt                UnixMilli     `json:"finishedAt,omitzero"`
	HideFromContinueListening bool          `json:"hideFromContinueListening"`
	Id                        string        `json:"id,omitempty"`
	IsFinished                bool          `json:"isFinished"`
	LastUpdate                UnixMilli     `json:"lastUpdate,omitzero"`
	LibraryItemId             LibraryItemID `json:"libraryItemId,omitempty"`
	MediaItemId               string        `json:"mediaItemId,omitempty"`
	MediaItemType             string        `json:"mediaItemType,omitempty"`
	MediaUpdatedAt            string        `json:"mediaUpdatedAt,omitempty"`
	Progress                  float64       `json:"progress,omitempty"`
	StartedAt                 UnixMilli     `json:"startedAt,omitzero"`
	UserId                    UserID        `json:"userId,omitempty"`
}

MediaProgress is the "MediaProgress" schema.

type MediaUpdate ¶

type MediaUpdate struct {
	AutoDownloadEpisodes     *bool                `json:"autoDownloadEpisodes,omitempty"`
	AutoDownloadSchedule     string               `json:"autoDownloadSchedule,omitempty"`
	LastEpisodeCheck         any                  `json:"lastEpisodeCheck,omitempty"`
	MaxEpisodesToKeep        *int                 `json:"maxEpisodesToKeep,omitempty"`
	MaxNewEpisodesToDownload *int                 `json:"maxNewEpisodesToDownload,omitempty"`
	Metadata                 *MediaUpdateMetadata `json:"metadata,omitempty"`
	Tags                     []string             `json:"tags,omitzero"`
	Url                      any                  `json:"url,omitempty"`
}

MediaUpdate is the "MediaUpdate" schema.

type MediaUpdateMetadata ¶ added in v0.7.1

type MediaUpdateMetadata struct {
	Abridged       *bool           `json:"abridged,omitempty"`
	Asin           *string         `json:"asin,omitempty"`
	Author         *string         `json:"author,omitempty"`
	Authors        []AuthorMinimal `json:"authors,omitzero"`
	Description    *string         `json:"description,omitempty"`
	Explicit       *bool           `json:"explicit,omitempty"`
	FeedUrl        *string         `json:"feedUrl,omitempty"`
	Genres         []string        `json:"genres,omitzero"`
	ImageUrl       *string         `json:"imageUrl,omitempty"`
	Isbn           *string         `json:"isbn,omitempty"`
	ItunesArtistId *string         `json:"itunesArtistId,omitempty"`
	ItunesId       *string         `json:"itunesId,omitempty"`
	ItunesPageUrl  *string         `json:"itunesPageUrl,omitempty"`
	Language       *string         `json:"language,omitempty"`
	Narrators      []string        `json:"narrators,omitzero"`
	PublishedDate  *string         `json:"publishedDate,omitempty"`
	PublishedYear  *string         `json:"publishedYear,omitempty"`
	Publisher      *string         `json:"publisher,omitempty"`
	ReleaseDate    *string         `json:"releaseDate,omitempty"`
	Series         []SeriesMinimal `json:"series,omitzero"`
	Subtitle       *string         `json:"subtitle,omitempty"`
	Title          *string         `json:"title,omitempty"`
	Type           *string         `json:"type,omitempty"`
}

MediaUpdateMetadata is an object the document declares inline.

type MiscAuthorizeAnswer ¶ added in v0.7.1

type MiscAuthorizeAnswer struct {
	Source               string          `json:"Source,omitempty"`
	EreaderDevices       []EreaderDevice `json:"ereaderDevices,omitzero"`
	ServerSettings       *ServerSettings `json:"serverSettings,omitempty"`
	User                 *UserForBrowser `json:"user,omitempty"`
	UserDefaultLibraryId LibraryID       `json:"userDefaultLibraryId,omitempty"`
}

MiscAuthorizeAnswer is an object the document declares inline.

type MiscAuthorizeResponse ¶ added in v0.7.1

type MiscAuthorizeResponse struct {
	HttpResponse *http.Response
	Answer       *MiscAuthorizeAnswer
	*MiscAuthorizeAnswer
}

MiscAuthorizeResponse is the result of MiscAuthorize.

Answer is the MiscAuthorizeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscAuthorizeResponse) Answered ¶ added in v0.7.1

func (r MiscAuthorizeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscAuthorizeResponse) Record ¶ added in v0.7.1

Record is the MiscAuthorizeAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscDeleteGenreAnswer ¶ added in v0.7.1

type MiscDeleteGenreAnswer struct {
	NumItemsUpdated int `json:"numItemsUpdated,omitempty"`
}

MiscDeleteGenreAnswer is an object the document declares inline.

type MiscDeleteGenreResponse ¶ added in v0.7.1

type MiscDeleteGenreResponse struct {
	HttpResponse *http.Response
	Answer       *MiscDeleteGenreAnswer
	*MiscDeleteGenreAnswer
}

MiscDeleteGenreResponse is the result of MiscDeleteGenre.

Answer is the MiscDeleteGenreAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscDeleteGenreResponse) Answered ¶ added in v0.7.1

func (r MiscDeleteGenreResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscDeleteGenreResponse) Record ¶ added in v0.7.1

Record is the MiscDeleteGenreAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscDeleteTagAnswer ¶ added in v0.7.1

type MiscDeleteTagAnswer struct {
	NumItemsUpdated int `json:"numItemsUpdated,omitempty"`
}

MiscDeleteTagAnswer is an object the document declares inline.

type MiscDeleteTagResponse ¶ added in v0.7.1

type MiscDeleteTagResponse struct {
	HttpResponse *http.Response
	Answer       *MiscDeleteTagAnswer
	*MiscDeleteTagAnswer
}

MiscDeleteTagResponse is the result of MiscDeleteTag.

Answer is the MiscDeleteTagAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscDeleteTagResponse) Answered ¶ added in v0.7.1

func (r MiscDeleteTagResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscDeleteTagResponse) Record ¶ added in v0.7.1

Record is the MiscDeleteTagAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscGetAllGenresAnswer ¶ added in v0.7.1

type MiscGetAllGenresAnswer struct {
	Genres []string `json:"genres,omitzero"`
}

MiscGetAllGenresAnswer is an object the document declares inline.

type MiscGetAllGenresResponse ¶ added in v0.7.1

type MiscGetAllGenresResponse struct {
	HttpResponse *http.Response
	Answer       *MiscGetAllGenresAnswer
	*MiscGetAllGenresAnswer
}

MiscGetAllGenresResponse is the result of MiscGetAllGenres.

Answer is the MiscGetAllGenresAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscGetAllGenresResponse) Answered ¶ added in v0.7.1

func (r MiscGetAllGenresResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscGetAllGenresResponse) Record ¶ added in v0.7.1

Record is the MiscGetAllGenresAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscGetAllTagsAnswer ¶ added in v0.7.1

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

MiscGetAllTagsAnswer is an object the document declares inline.

type MiscGetAllTagsResponse ¶ added in v0.7.1

type MiscGetAllTagsResponse struct {
	HttpResponse *http.Response
	Answer       *MiscGetAllTagsAnswer
	*MiscGetAllTagsAnswer
}

MiscGetAllTagsResponse is the result of MiscGetAllTags.

Answer is the MiscGetAllTagsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscGetAllTagsResponse) Answered ¶ added in v0.7.1

func (r MiscGetAllTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscGetAllTagsResponse) Record ¶ added in v0.7.1

Record is the MiscGetAllTagsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscGetAuthSettingsAnswer ¶ added in v0.7.1

type MiscGetAuthSettingsAnswer struct {
	AuthActiveAuthMethods              []string `json:"authActiveAuthMethods,omitzero"`
	AuthLoginCustomMessage             string   `json:"authLoginCustomMessage,omitempty"`
	AuthOpenIDAdvancedPermsClaim       string   `json:"authOpenIDAdvancedPermsClaim,omitempty"`
	AuthOpenIDAuthorizationURL         any      `json:"authOpenIDAuthorizationURL,omitempty"`
	AuthOpenIDAutoLaunch               bool     `json:"authOpenIDAutoLaunch"`
	AuthOpenIDAutoRegister             bool     `json:"authOpenIDAutoRegister"`
	AuthOpenIDButtonText               string   `json:"authOpenIDButtonText,omitempty"`
	AuthOpenIDClientID                 any      `json:"authOpenIDClientID,omitempty"`
	AuthOpenIDClientSecret             any      `json:"authOpenIDClientSecret,omitempty"`
	AuthOpenIDGroupClaim               string   `json:"authOpenIDGroupClaim,omitempty"`
	AuthOpenIDIssuerURL                any      `json:"authOpenIDIssuerURL,omitempty"`
	AuthOpenIDJwksURL                  any      `json:"authOpenIDJwksURL,omitempty"`
	AuthOpenIDLogoutURL                any      `json:"authOpenIDLogoutURL,omitempty"`
	AuthOpenIDMatchExistingBy          any      `json:"authOpenIDMatchExistingBy,omitempty"`
	AuthOpenIDMobileRedirectURIs       []string `json:"authOpenIDMobileRedirectURIs,omitzero"`
	AuthOpenIDSamplePermissions        string   `json:"authOpenIDSamplePermissions,omitempty"`
	AuthOpenIDSubfolderForRedirectURLs any      `json:"authOpenIDSubfolderForRedirectURLs,omitempty"`
	AuthOpenIDTokenSigningAlgorithm    string   `json:"authOpenIDTokenSigningAlgorithm,omitempty"`
	AuthOpenIDTokenURL                 any      `json:"authOpenIDTokenURL,omitempty"`
	AuthOpenIDUserInfoURL              any      `json:"authOpenIDUserInfoURL,omitempty"`
}

MiscGetAuthSettingsAnswer is an object the document declares inline.

type MiscGetAuthSettingsResponse ¶ added in v0.7.1

type MiscGetAuthSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *MiscGetAuthSettingsAnswer
	*MiscGetAuthSettingsAnswer
}

MiscGetAuthSettingsResponse is the result of MiscGetAuthSettings.

Answer is the MiscGetAuthSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscGetAuthSettingsResponse) Answered ¶ added in v0.7.1

func (r MiscGetAuthSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscGetAuthSettingsResponse) Record ¶ added in v0.7.1

Record is the MiscGetAuthSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscGetLoggerDataAnswer ¶ added in v0.7.1

type MiscGetLoggerDataAnswer struct {
	CurrentDailyLogs ListOrEmpty[MiscGetLoggerDataAnswerCurrentDailyLogs] `json:"currentDailyLogs,omitzero"`
}

MiscGetLoggerDataAnswer is an object the document declares inline.

type MiscGetLoggerDataAnswerCurrentDailyLogs ¶ added in v0.7.1

type MiscGetLoggerDataAnswerCurrentDailyLogs struct {
	Level     float64 `json:"level,omitempty"`
	LevelName string  `json:"levelName,omitempty"`
	Message   string  `json:"message,omitempty"`
	Source    string  `json:"source,omitempty"`
	Timestamp string  `json:"timestamp,omitempty"`
}

MiscGetLoggerDataAnswerCurrentDailyLogs is an object the document declares inline.

type MiscGetLoggerDataResponse ¶ added in v0.7.1

type MiscGetLoggerDataResponse struct {
	HttpResponse *http.Response
	Answer       *MiscGetLoggerDataAnswer
	*MiscGetLoggerDataAnswer
}

MiscGetLoggerDataResponse is the result of MiscGetLoggerData.

Answer is the MiscGetLoggerDataAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscGetLoggerDataResponse) Answered ¶ added in v0.7.1

func (r MiscGetLoggerDataResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscGetLoggerDataResponse) Record ¶ added in v0.7.1

Record is the MiscGetLoggerDataAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscGetTasksAnswer ¶ added in v0.7.1

type MiscGetTasksAnswer struct {
	QueuedTaskData *MiscGetTasksAnswerQueuedTaskData `json:"queuedTaskData,omitempty"`
	Tasks          []MiscGetTasksAnswerTasks         `json:"tasks,omitzero"`
}

MiscGetTasksAnswer is an object the document declares inline.

type MiscGetTasksAnswerQueuedTaskData ¶ added in v0.7.1

type MiscGetTasksAnswerQueuedTaskData struct {
	EmbedMetadata []MiscGetTasksAnswerQueuedTaskDataEmbedMetadata `json:"embedMetadata,omitzero"`
}

MiscGetTasksAnswerQueuedTaskData is an object the document declares inline.

type MiscGetTasksAnswerQueuedTaskDataEmbedMetadata ¶ added in v0.7.1

type MiscGetTasksAnswerQueuedTaskDataEmbedMetadata struct {
	LibraryItemId LibraryItemID `json:"libraryItemId,omitempty"`
}

MiscGetTasksAnswerQueuedTaskDataEmbedMetadata is an object the document declares inline.

type MiscGetTasksAnswerTasks ¶ added in v0.7.1

type MiscGetTasksAnswerTasks struct {
	Action          string                       `json:"action,omitempty"`
	Data            *MiscGetTasksAnswerTasksData `json:"data,omitempty"`
	Description     string                       `json:"description,omitempty"`
	DescriptionKey  string                       `json:"descriptionKey,omitempty"`
	DescriptionSubs []string                     `json:"descriptionSubs,omitzero"`
	Error           string                       `json:"error,omitempty"`
	ErrorKey        string                       `json:"errorKey,omitempty"`
	ErrorSubs       any                          `json:"errorSubs,omitempty"`
	FinishedAt      UnixMilli                    `json:"finishedAt,omitzero"`
	Id              string                       `json:"id,omitempty"`
	IsFailed        bool                         `json:"isFailed"`
	IsFinished      bool                         `json:"isFinished"`
	ShowSuccess     bool                         `json:"showSuccess"`
	StartedAt       UnixMilli                    `json:"startedAt,omitzero"`
	Title           string                       `json:"title,omitempty"`
	TitleKey        string                       `json:"titleKey,omitempty"`
	TitleSubs       []string                     `json:"titleSubs,omitzero"`
}

MiscGetTasksAnswerTasks is an object the document declares inline.

type MiscGetTasksAnswerTasksData ¶ added in v0.7.1

type MiscGetTasksAnswerTasksData struct {
	AudioFiles         []MiscGetTasksAnswerTasksDataAudioFiles      `json:"audioFiles,omitzero"`
	Chapters           []MiscGetTasksAnswerTasksDataChapters        `json:"chapters,omitzero"`
	CoverPath          string                                       `json:"coverPath,omitempty"`
	Duration           float64                                      `json:"duration,omitempty"`
	EncodeOptions      *MiscGetTasksAnswerTasksDataEncodeOptions    `json:"encodeOptions,omitempty"`
	FfmetadataObject   *MiscGetTasksAnswerTasksDataFfmetadataObject `json:"ffmetadataObject,omitempty"`
	FfmetadataPath     string                                       `json:"ffmetadataPath,omitempty"`
	Ffmpeg             *MiscGetTasksAnswerTasksDataFfmpeg           `json:"ffmpeg,omitempty"`
	Inos               []string                                     `json:"inos,omitzero"`
	ItemCachePath      string                                       `json:"itemCachePath,omitempty"`
	LibraryId          LibraryID                                    `json:"libraryId,omitempty"`
	LibraryItemDir     string                                       `json:"libraryItemDir,omitempty"`
	LibraryItemId      LibraryItemID                                `json:"libraryItemId,omitempty"`
	LibraryMediaType   string                                       `json:"libraryMediaType,omitempty"`
	LibraryName        string                                       `json:"libraryName,omitempty"`
	MetadataObject     *MiscGetTasksAnswerTasksDataMetadataObject   `json:"metadataObject,omitempty"`
	MimeType           string                                       `json:"mimeType,omitempty"`
	Options            *MiscGetTasksAnswerTasksDataOptions          `json:"options,omitempty"`
	OriginalTrackPaths []string                                     `json:"originalTrackPaths,omitzero"`
	TargetFilename     string                                       `json:"targetFilename,omitempty"`
	TargetFilepath     string                                       `json:"targetFilepath,omitempty"`
	TempFilepath       string                                       `json:"tempFilepath,omitempty"`
	UserId             UserID                                       `json:"userId,omitempty"`
}

MiscGetTasksAnswerTasksData is an object the document declares inline.

type MiscGetTasksAnswerTasksDataAudioFiles ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataAudioFiles struct {
	CachePath string  `json:"cachePath,omitempty"`
	Duration  float64 `json:"duration,omitempty"`
	Filename  string  `json:"filename,omitempty"`
	Index     int     `json:"index,omitempty"`
	Ino       string  `json:"ino,omitempty"`
	Path      string  `json:"path,omitempty"`
}

MiscGetTasksAnswerTasksDataAudioFiles is an object the document declares inline.

type MiscGetTasksAnswerTasksDataChapters ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataChapters struct {
	End   float64 `json:"end,omitempty"`
	Id    int     `json:"id,omitempty"`
	Start float64 `json:"start,omitempty"`
	Title string  `json:"title,omitempty"`
}

MiscGetTasksAnswerTasksDataChapters is an object the document declares inline.

type MiscGetTasksAnswerTasksDataEncodeOptions ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataEncodeOptions struct {
	Bitrate  string `json:"bitrate,omitempty"`
	Channels string `json:"channels,omitempty"`
}

MiscGetTasksAnswerTasksDataEncodeOptions is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmetadataObject ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmetadataObject struct {
	TRACKTOTAL  string `json:"TRACKTOTAL,omitempty"`
	Album       string `json:"album,omitempty"`
	AlbumArtist string `json:"album_artist,omitempty"`
	Artist      string `json:"artist,omitempty"`
	Title       string `json:"title,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmetadataObject is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpeg ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpeg struct {
	FfmpegProc    *MiscGetTasksAnswerTasksDataFfmpegFfmpegProc    `json:"ffmpegProc,omitempty"`
	Logger        map[string]any                                  `json:"logger,omitzero"`
	Options       *MiscGetTasksAnswerTasksDataFfmpegOptions       `json:"options,omitempty"`
	CurrentInput  *MiscGetTasksAnswerTasksDataFfmpegCurrentInput  `json:"_currentInput,omitempty"`
	CurrentOutput *MiscGetTasksAnswerTasksDataFfmpegCurrentOutput `json:"_currentOutput,omitempty"`
	Events        map[string]any                                  `json:"_events,omitzero"`
	EventsCount   float64                                         `json:"_eventsCount,omitempty"`
	Inputs        []MiscGetTasksAnswerTasksDataFfmpegInputs       `json:"_inputs,omitzero"`
	Outputs       []MiscGetTasksAnswerTasksDataFfmpegOutputs      `json:"_outputs,omitzero"`
}

MiscGetTasksAnswerTasksDataFfmpeg is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegCurrentInput ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegCurrentInput struct {
	IsFile   bool   `json:"isFile"`
	IsStream bool   `json:"isStream"`
	Source   string `json:"source,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegCurrentInput is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegCurrentOutput ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegCurrentOutput struct {
	Flags    map[string]any `json:"flags,omitzero"`
	IsFile   bool           `json:"isFile"`
	Pipeopts map[string]any `json:"pipeopts,omitzero"`
	Target   string         `json:"target,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegCurrentOutput is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProc ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProc struct {
	Connected    bool                                               `json:"connected"`
	ExitCode     any                                                `json:"exitCode,omitempty"`
	Killed       bool                                               `json:"killed"`
	Pid          float64                                            `json:"pid,omitempty"`
	SignalCode   any                                                `json:"signalCode,omitempty"`
	Spawnargs    []string                                           `json:"spawnargs,omitzero"`
	Spawnfile    string                                             `json:"spawnfile,omitempty"`
	Stderr       *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderr `json:"stderr,omitempty"`
	Stdin        *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdin  `json:"stdin,omitempty"`
	Stdio        []MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdio `json:"stdio,omitzero"`
	Stdout       *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdout `json:"stdout,omitempty"`
	ClosesGot    float64                                            `json:"_closesGot,omitempty"`
	ClosesNeeded float64                                            `json:"_closesNeeded,omitempty"`
	Events       map[string]any                                     `json:"_events,omitzero"`
	EventsCount  float64                                            `json:"_eventsCount,omitempty"`
	Handle       *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcHandle `json:"_handle,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProc is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcHandle ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcHandle struct {
	Pid float64 `json:"pid,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcHandle is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderr ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderr struct {
	AllowHalfOpen           bool                                                            `json:"allowHalfOpen"`
	Connecting              bool                                                            `json:"connecting"`
	Server                  any                                                             `json:"server,omitempty"`
	CloseAfterHandlingError bool                                                            `json:"_closeAfterHandlingError"`
	Events                  *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrEvents        `json:"_events,omitempty"`
	EventsCount             float64                                                         `json:"_eventsCount,omitempty"`
	HadError                bool                                                            `json:"_hadError"`
	Host                    any                                                             `json:"_host,omitempty"`
	Parent                  any                                                             `json:"_parent,omitempty"`
	PendingData             any                                                             `json:"_pendingData,omitempty"`
	PendingEncoding         string                                                          `json:"_pendingEncoding,omitempty"`
	ReadableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrReadableState `json:"_readableState,omitempty"`
	UnderscoreServer        any                                                             `json:"_server,omitempty"`
	Sockname                any                                                             `json:"_sockname,omitempty"`
	WritableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrWritableState `json:"_writableState,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderr is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrEvents ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrEvents struct {
	Close []any `json:"close,omitzero"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrEvents is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrReadableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrReadableState struct {
	AwaitDrainWriters any     `json:"awaitDrainWriters,omitempty"`
	Buffer            []any   `json:"buffer,omitzero"`
	BufferIndex       float64 `json:"bufferIndex,omitempty"`
	HighWaterMark     float64 `json:"highWaterMark,omitempty"`
	Length            float64 `json:"length,omitempty"`
	Pipes             []any   `json:"pipes,omitzero"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrReadableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrWritableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrWritableState struct {
	BufferedIndex float64 `json:"bufferedIndex,omitempty"`
	Corked        float64 `json:"corked,omitempty"`
	HighWaterMark float64 `json:"highWaterMark,omitempty"`
	Length        float64 `json:"length,omitempty"`
	Pendingcb     float64 `json:"pendingcb,omitempty"`
	Writelen      float64 `json:"writelen,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStderrWritableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdin ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdin struct {
	AllowHalfOpen           bool                                                           `json:"allowHalfOpen"`
	Connecting              bool                                                           `json:"connecting"`
	Server                  any                                                            `json:"server,omitempty"`
	CloseAfterHandlingError bool                                                           `json:"_closeAfterHandlingError"`
	Events                  map[string]any                                                 `json:"_events,omitzero"`
	EventsCount             float64                                                        `json:"_eventsCount,omitempty"`
	HadError                bool                                                           `json:"_hadError"`
	Host                    any                                                            `json:"_host,omitempty"`
	Parent                  any                                                            `json:"_parent,omitempty"`
	PendingData             any                                                            `json:"_pendingData,omitempty"`
	PendingEncoding         string                                                         `json:"_pendingEncoding,omitempty"`
	ReadableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinReadableState `json:"_readableState,omitempty"`
	UnderscoreServer        any                                                            `json:"_server,omitempty"`
	Sockname                any                                                            `json:"_sockname,omitempty"`
	WritableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinWritableState `json:"_writableState,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdin is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinReadableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinReadableState struct {
	AwaitDrainWriters any     `json:"awaitDrainWriters,omitempty"`
	Buffer            []any   `json:"buffer,omitzero"`
	BufferIndex       float64 `json:"bufferIndex,omitempty"`
	HighWaterMark     float64 `json:"highWaterMark,omitempty"`
	Length            float64 `json:"length,omitempty"`
	Pipes             []any   `json:"pipes,omitzero"`
	Readable          bool    `json:"readable"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinReadableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinWritableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinWritableState struct {
	BufferedIndex float64 `json:"bufferedIndex,omitempty"`
	Corked        float64 `json:"corked,omitempty"`
	HighWaterMark float64 `json:"highWaterMark,omitempty"`
	Length        float64 `json:"length,omitempty"`
	Pendingcb     float64 `json:"pendingcb,omitempty"`
	Writelen      float64 `json:"writelen,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdinWritableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdio ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdio struct {
	AllowHalfOpen           bool                                                           `json:"allowHalfOpen"`
	Connecting              bool                                                           `json:"connecting"`
	Server                  any                                                            `json:"server,omitempty"`
	CloseAfterHandlingError bool                                                           `json:"_closeAfterHandlingError"`
	Events                  *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioEvents        `json:"_events,omitempty"`
	EventsCount             float64                                                        `json:"_eventsCount,omitempty"`
	HadError                bool                                                           `json:"_hadError"`
	Host                    any                                                            `json:"_host,omitempty"`
	Parent                  any                                                            `json:"_parent,omitempty"`
	PendingData             any                                                            `json:"_pendingData,omitempty"`
	PendingEncoding         string                                                         `json:"_pendingEncoding,omitempty"`
	ReadableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioReadableState `json:"_readableState,omitempty"`
	UnderscoreServer        any                                                            `json:"_server,omitempty"`
	Sockname                any                                                            `json:"_sockname,omitempty"`
	WritableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioWritableState `json:"_writableState,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdio is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioEvents ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioEvents struct {
	Close []any `json:"close,omitzero"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioEvents is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioReadableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioReadableState struct {
	AwaitDrainWriters any     `json:"awaitDrainWriters,omitempty"`
	Buffer            []any   `json:"buffer,omitzero"`
	BufferIndex       float64 `json:"bufferIndex,omitempty"`
	HighWaterMark     float64 `json:"highWaterMark,omitempty"`
	Length            float64 `json:"length,omitempty"`
	Pipes             []any   `json:"pipes,omitzero"`
	Readable          bool    `json:"readable"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioReadableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioWritableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioWritableState struct {
	BufferedIndex float64 `json:"bufferedIndex,omitempty"`
	Corked        float64 `json:"corked,omitempty"`
	HighWaterMark float64 `json:"highWaterMark,omitempty"`
	Length        float64 `json:"length,omitempty"`
	Pendingcb     float64 `json:"pendingcb,omitempty"`
	Writelen      float64 `json:"writelen,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdioWritableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdout ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdout struct {
	AllowHalfOpen           bool                                                            `json:"allowHalfOpen"`
	Connecting              bool                                                            `json:"connecting"`
	Server                  any                                                             `json:"server,omitempty"`
	CloseAfterHandlingError bool                                                            `json:"_closeAfterHandlingError"`
	Events                  *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutEvents        `json:"_events,omitempty"`
	EventsCount             float64                                                         `json:"_eventsCount,omitempty"`
	HadError                bool                                                            `json:"_hadError"`
	Host                    any                                                             `json:"_host,omitempty"`
	Parent                  any                                                             `json:"_parent,omitempty"`
	PendingData             any                                                             `json:"_pendingData,omitempty"`
	PendingEncoding         string                                                          `json:"_pendingEncoding,omitempty"`
	ReadableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutReadableState `json:"_readableState,omitempty"`
	UnderscoreServer        any                                                             `json:"_server,omitempty"`
	Sockname                any                                                             `json:"_sockname,omitempty"`
	WritableState           *MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutWritableState `json:"_writableState,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdout is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutEvents ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutEvents struct {
	Close []any `json:"close,omitzero"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutEvents is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutReadableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutReadableState struct {
	AwaitDrainWriters any     `json:"awaitDrainWriters,omitempty"`
	Buffer            []any   `json:"buffer,omitzero"`
	BufferIndex       float64 `json:"bufferIndex,omitempty"`
	HighWaterMark     float64 `json:"highWaterMark,omitempty"`
	Length            float64 `json:"length,omitempty"`
	Pipes             []any   `json:"pipes,omitzero"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutReadableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutWritableState ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutWritableState struct {
	BufferedIndex float64 `json:"bufferedIndex,omitempty"`
	Corked        float64 `json:"corked,omitempty"`
	HighWaterMark float64 `json:"highWaterMark,omitempty"`
	Length        float64 `json:"length,omitempty"`
	Pendingcb     float64 `json:"pendingcb,omitempty"`
	Writelen      float64 `json:"writelen,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegFfmpegProcStdoutWritableState is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegInputs ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegInputs struct {
	IsFile   bool   `json:"isFile"`
	IsStream bool   `json:"isStream"`
	Source   string `json:"source,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegInputs is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegOptions ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegOptions struct {
	Niceness    float64 `json:"niceness,omitempty"`
	Presets     string  `json:"presets,omitempty"`
	StdoutLines float64 `json:"stdoutLines,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegOptions is an object the document declares inline.

type MiscGetTasksAnswerTasksDataFfmpegOutputs ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataFfmpegOutputs struct {
	Flags    map[string]any `json:"flags,omitzero"`
	IsFile   bool           `json:"isFile"`
	Pipeopts map[string]any `json:"pipeopts,omitzero"`
	Target   string         `json:"target,omitempty"`
}

MiscGetTasksAnswerTasksDataFfmpegOutputs is an object the document declares inline.

type MiscGetTasksAnswerTasksDataMetadataObject ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataMetadataObject struct {
	TIT3        string `json:"TIT3,omitempty"`
	TRACKTOTAL  string `json:"TRACKTOTAL,omitempty"`
	Album       string `json:"album,omitempty"`
	AlbumArtist string `json:"album_artist,omitempty"`
	Artist      string `json:"artist,omitempty"`
	Comment     string `json:"comment,omitempty"`
	Composer    string `json:"composer,omitempty"`
	Copyright   string `json:"copyright,omitempty"`
	Date        string `json:"date,omitempty"`
	Description string `json:"description,omitempty"`
	Genre       string `json:"genre,omitempty"`
	Grouping    string `json:"grouping,omitempty"`
	Publisher   string `json:"publisher,omitempty"`
	Title       string `json:"title,omitempty"`
}

MiscGetTasksAnswerTasksDataMetadataObject is an object the document declares inline.

type MiscGetTasksAnswerTasksDataOptions ¶ added in v0.7.1

type MiscGetTasksAnswerTasksDataOptions struct {
	BackupFiles        bool `json:"backupFiles"`
	ForceEmbedChapters bool `json:"forceEmbedChapters"`
}

MiscGetTasksAnswerTasksDataOptions is an object the document declares inline.

type MiscGetTasksOptions ¶ added in v0.7.1

type MiscGetTasksOptions struct {
	Include string
}

MiscGetTasksOptions holds the query and header parameters of MiscGetTasks.

func (MiscGetTasksOptions) ToHeaders ¶ added in v0.7.1

func (o MiscGetTasksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (MiscGetTasksOptions) ToQuery ¶ added in v0.7.1

func (o MiscGetTasksOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type MiscGetTasksResponse ¶ added in v0.7.1

type MiscGetTasksResponse struct {
	HttpResponse *http.Response
	Answer       *MiscGetTasksAnswer
	*MiscGetTasksAnswer
}

MiscGetTasksResponse is the result of MiscGetTasks.

Answer is the MiscGetTasksAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscGetTasksResponse) Answered ¶ added in v0.7.1

func (r MiscGetTasksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscGetTasksResponse) Record ¶ added in v0.7.1

Record is the MiscGetTasksAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscHandleUploadResponse ¶ added in v0.7.1

type MiscHandleUploadResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MiscHandleUploadResponse is the result of MiscHandleUpload.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MiscHandleUploadResponse) Answered ¶ added in v0.7.1

func (r MiscHandleUploadResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MiscRenameGenreAnswer ¶ added in v0.7.1

type MiscRenameGenreAnswer struct {
	GenreMerged     bool `json:"genreMerged"`
	NumItemsUpdated int  `json:"numItemsUpdated,omitempty"`
}

MiscRenameGenreAnswer is an object the document declares inline.

type MiscRenameGenreRequest ¶ added in v0.7.1

type MiscRenameGenreRequest struct {
	Genre    string `json:"genre,omitempty"`
	NewGenre string `json:"newGenre,omitempty"`
}

MiscRenameGenreRequest is an object the document declares inline.

type MiscRenameGenreResponse ¶ added in v0.7.1

type MiscRenameGenreResponse struct {
	HttpResponse *http.Response
	Answer       *MiscRenameGenreAnswer
	*MiscRenameGenreAnswer
}

MiscRenameGenreResponse is the result of MiscRenameGenre.

Answer is the MiscRenameGenreAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscRenameGenreResponse) Answered ¶ added in v0.7.1

func (r MiscRenameGenreResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscRenameGenreResponse) Record ¶ added in v0.7.1

Record is the MiscRenameGenreAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscRenameTagAnswer ¶ added in v0.7.1

type MiscRenameTagAnswer struct {
	NumItemsUpdated int  `json:"numItemsUpdated,omitempty"`
	TagMerged       bool `json:"tagMerged"`
}

MiscRenameTagAnswer is an object the document declares inline.

type MiscRenameTagRequest ¶ added in v0.7.1

type MiscRenameTagRequest struct {
	NewTag string `json:"newTag,omitempty"`
	Tag    string `json:"tag,omitempty"`
}

MiscRenameTagRequest is an object the document declares inline.

type MiscRenameTagResponse ¶ added in v0.7.1

type MiscRenameTagResponse struct {
	HttpResponse *http.Response
	Answer       *MiscRenameTagAnswer
	*MiscRenameTagAnswer
}

MiscRenameTagResponse is the result of MiscRenameTag.

Answer is the MiscRenameTagAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscRenameTagResponse) Answered ¶ added in v0.7.1

func (r MiscRenameTagResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscRenameTagResponse) Record ¶ added in v0.7.1

Record is the MiscRenameTagAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscUpdateAuthSettingsAnswer ¶ added in v0.7.1

type MiscUpdateAuthSettingsAnswer struct {
	ServerSettings *ServerSettings `json:"serverSettings,omitempty"`
	Updated        bool            `json:"updated"`
}

MiscUpdateAuthSettingsAnswer is an object the document declares inline.

type MiscUpdateAuthSettingsRequest ¶ added in v0.7.1

type MiscUpdateAuthSettingsRequest struct {
	AuthActiveAuthMethods []string `json:"authActiveAuthMethods,omitzero"`
}

MiscUpdateAuthSettingsRequest is an object the document declares inline.

type MiscUpdateAuthSettingsResponse ¶ added in v0.7.1

type MiscUpdateAuthSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *MiscUpdateAuthSettingsAnswer
	*MiscUpdateAuthSettingsAnswer
}

MiscUpdateAuthSettingsResponse is the result of MiscUpdateAuthSettings.

Answer is the MiscUpdateAuthSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscUpdateAuthSettingsResponse) Answered ¶ added in v0.7.1

func (r MiscUpdateAuthSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscUpdateAuthSettingsResponse) Record ¶ added in v0.7.1

Record is the MiscUpdateAuthSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscUpdateServerSettingsAnswer ¶ added in v0.7.1

type MiscUpdateServerSettingsAnswer struct {
	ServerSettings *ServerSettings `json:"serverSettings,omitempty"`
}

MiscUpdateServerSettingsAnswer is an object the document declares inline.

type MiscUpdateServerSettingsRequest ¶ added in v0.7.1

type MiscUpdateServerSettingsRequest struct {
	AllowIframe       any   `json:"allowIframe,omitempty"`
	ScannerFindCovers *bool `json:"scannerFindCovers,omitempty"`
}

MiscUpdateServerSettingsRequest is an object the document declares inline.

type MiscUpdateServerSettingsResponse ¶ added in v0.7.1

type MiscUpdateServerSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *MiscUpdateServerSettingsAnswer
	*MiscUpdateServerSettingsAnswer
}

MiscUpdateServerSettingsResponse is the result of MiscUpdateServerSettings.

Answer is the MiscUpdateServerSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscUpdateServerSettingsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscUpdateServerSettingsResponse) Record ¶ added in v0.7.1

Record is the MiscUpdateServerSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscUpdateSortingPrefixesAnswer ¶ added in v0.7.1

type MiscUpdateSortingPrefixesAnswer struct {
	RowsUpdated    int             `json:"rowsUpdated,omitempty"`
	ServerSettings *ServerSettings `json:"serverSettings,omitempty"`
}

MiscUpdateSortingPrefixesAnswer is an object the document declares inline.

type MiscUpdateSortingPrefixesRequest ¶ added in v0.7.1

type MiscUpdateSortingPrefixesRequest struct {
	SortingPrefixes []string `json:"sortingPrefixes,omitzero"`
}

MiscUpdateSortingPrefixesRequest is an object the document declares inline.

type MiscUpdateSortingPrefixesResponse ¶ added in v0.7.1

type MiscUpdateSortingPrefixesResponse struct {
	HttpResponse *http.Response
	Answer       *MiscUpdateSortingPrefixesAnswer
	*MiscUpdateSortingPrefixesAnswer
}

MiscUpdateSortingPrefixesResponse is the result of MiscUpdateSortingPrefixes.

Answer is the MiscUpdateSortingPrefixesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (MiscUpdateSortingPrefixesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (MiscUpdateSortingPrefixesResponse) Record ¶ added in v0.7.1

Record is the MiscUpdateSortingPrefixesAnswer answered, as a value to change and write back, or an error when the server answered none.

type MiscUpdateWatchedPathRequest ¶ added in v0.7.1

type MiscUpdateWatchedPathRequest struct {
	LibraryId LibraryID `json:"libraryId,omitempty"`
	OldPath   any       `json:"oldPath,omitempty"`
	Path      any       `json:"path,omitempty"`
	Type      any       `json:"type,omitempty"`
}

MiscUpdateWatchedPathRequest is an object the document declares inline.

type MiscUpdateWatchedPathResponse ¶ added in v0.7.1

type MiscUpdateWatchedPathResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MiscUpdateWatchedPathResponse is the result of MiscUpdateWatchedPath.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MiscUpdateWatchedPathResponse) Answered ¶ added in v0.7.1

func (r MiscUpdateWatchedPathResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type MiscValidateCronExpressionRequest ¶ added in v0.7.1

type MiscValidateCronExpressionRequest struct {
	Expression string `json:"expression,omitempty"`
}

MiscValidateCronExpressionRequest is an object the document declares inline.

type MiscValidateCronExpressionResponse ¶ added in v0.7.1

type MiscValidateCronExpressionResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

MiscValidateCronExpressionResponse is the result of MiscValidateCronExpression.

The operation answers text (text/plain), which Answer holds as it was sent.

func (MiscValidateCronExpressionResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type Notification ¶

type Notification struct {
	BodyTemplate                 string    `json:"bodyTemplate,omitempty"`
	CreatedAt                    UnixMilli `json:"createdAt,omitzero"`
	Enabled                      bool      `json:"enabled"`
	EventName                    string    `json:"eventName,omitempty"`
	Id                           string    `json:"id,omitempty"`
	LastAttemptFailed            bool      `json:"lastAttemptFailed"`
	LastFiredAt                  int       `json:"lastFiredAt,omitempty"`
	LibraryId                    LibraryID `json:"libraryId,omitempty"`
	NumConsecutiveFailedAttempts float64   `json:"numConsecutiveFailedAttempts,omitempty"`
	NumTimesFired                float64   `json:"numTimesFired,omitempty"`
	TitleTemplate                string    `json:"titleTemplate,omitempty"`
	Type                         string    `json:"type,omitempty"`
	Urls                         []string  `json:"urls,omitzero"`
}

Notification is the "Notification" schema.

type NotificationCreateNotificationRequest ¶ added in v0.7.1

type NotificationCreateNotificationRequest struct {
	BodyTemplate  string   `json:"bodyTemplate,omitempty"`
	Enabled       *bool    `json:"enabled,omitempty"`
	EventName     string   `json:"eventName,omitempty"`
	TitleTemplate string   `json:"titleTemplate,omitempty"`
	Type          string   `json:"type,omitempty"`
	Urls          []string `json:"urls,omitzero"`
}

NotificationCreateNotificationRequest is an object the document declares inline.

type NotificationCreateNotificationResponse ¶ added in v0.7.1

type NotificationCreateNotificationResponse struct {
	HttpResponse *http.Response
	Answer       *NotificationSettings
	*NotificationSettings
}

NotificationCreateNotificationResponse is the result of NotificationCreateNotification.

Answer is the NotificationSettings answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (NotificationCreateNotificationResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (NotificationCreateNotificationResponse) Record ¶ added in v0.7.1

Record is the NotificationSettings answered, as a value to change and write back, or an error when the server answered none.

type NotificationDeleteNotificationResponse ¶ added in v0.7.1

type NotificationDeleteNotificationResponse struct {
	HttpResponse *http.Response
	Answer       *NotificationSettings
	*NotificationSettings
}

NotificationDeleteNotificationResponse is the result of NotificationDeleteNotification.

Answer is the NotificationSettings answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (NotificationDeleteNotificationResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (NotificationDeleteNotificationResponse) Record ¶ added in v0.7.1

Record is the NotificationSettings answered, as a value to change and write back, or an error when the server answered none.

type NotificationEvent ¶ added in v0.7.1

type NotificationEvent string

NotificationEvent is the "NotificationEvent" enum.

const (
	NotificationEventOnBackupCompleted          NotificationEvent = "onBackupCompleted"
	NotificationEventOnBackupFailed             NotificationEvent = "onBackupFailed"
	NotificationEventOnPodcastEpisodeDownloaded NotificationEvent = "onPodcastEpisodeDownloaded"
	NotificationEventOnRSSFeedDisabled          NotificationEvent = "onRSSFeedDisabled"
	NotificationEventOnRSSFeedFailed            NotificationEvent = "onRSSFeedFailed"
	NotificationEventOnTest                     NotificationEvent = "onTest"
)

Values of NotificationEvent.

func (NotificationEvent) Known ¶ added in v0.7.1

func (v NotificationEvent) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type NotificationEventDescriptionKey ¶ added in v0.7.1

type NotificationEventDescriptionKey string

NotificationEventDescriptionKey is the "NotificationEventDescriptionKey" enum.

const (
	NotificationEventDescriptionKeyNotificationOnBackupCompletedDescription   NotificationEventDescriptionKey = "NotificationOnBackupCompletedDescription"
	NotificationEventDescriptionKeyNotificationOnBackupFailedDescription      NotificationEventDescriptionKey = "NotificationOnBackupFailedDescription"
	NotificationEventDescriptionKeyNotificationOnEpisodeDownloadedDescription NotificationEventDescriptionKey = "NotificationOnEpisodeDownloadedDescription"
	NotificationEventDescriptionKeyNotificationOnRSSFeedDisabledDescription   NotificationEventDescriptionKey = "NotificationOnRSSFeedDisabledDescription"
	NotificationEventDescriptionKeyNotificationOnRSSFeedFailedDescription     NotificationEventDescriptionKey = "NotificationOnRSSFeedFailedDescription"
	NotificationEventDescriptionKeyNotificationOnTestDescription              NotificationEventDescriptionKey = "NotificationOnTestDescription"
)

Values of NotificationEventDescriptionKey.

func (NotificationEventDescriptionKey) Known ¶ added in v0.7.1

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type NotificationFireTestEventOptions ¶ added in v0.7.1

type NotificationFireTestEventOptions struct {
	Fail string
}

NotificationFireTestEventOptions holds the query and header parameters of NotificationFireTestEvent.

func (NotificationFireTestEventOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (NotificationFireTestEventOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type NotificationFireTestEventResponse ¶ added in v0.7.1

type NotificationFireTestEventResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

NotificationFireTestEventResponse is the result of NotificationFireTestEvent.

The operation answers text (text/plain), which Answer holds as it was sent.

func (NotificationFireTestEventResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type NotificationGetAnswer ¶ added in v0.7.1

type NotificationGetAnswer struct {
	Data     *NotificationGetAnswerData `json:"data,omitempty"`
	Settings *NotificationSettings      `json:"settings,omitempty"`
}

NotificationGetAnswer is an object the document declares inline.

type NotificationGetAnswerData ¶ added in v0.7.1

type NotificationGetAnswerData struct {
	Events []NotificationGetAnswerDataEvents `json:"events,omitzero"`
}

NotificationGetAnswerData is an object the document declares inline.

type NotificationGetAnswerDataEvents ¶ added in v0.7.1

type NotificationGetAnswerDataEvents struct {
	Defaults         *NotificationGetAnswerDataEventsDefaults `json:"defaults,omitempty"`
	Description      string                                   `json:"description,omitempty"`
	DescriptionKey   NotificationEventDescriptionKey          `json:"descriptionKey,omitempty"`
	LibraryMediaType string                                   `json:"libraryMediaType,omitempty"`
	Name             NotificationEvent                        `json:"name,omitempty"`
	RequiresLibrary  bool                                     `json:"requiresLibrary"`
	TestData         *NotificationGetAnswerDataEventsTestData `json:"testData,omitempty"`
	Variables        []string                                 `json:"variables,omitzero"`
}

NotificationGetAnswerDataEvents is an object the document declares inline.

type NotificationGetAnswerDataEventsDefaults ¶ added in v0.7.1

type NotificationGetAnswerDataEventsDefaults struct {
	Body  string `json:"body,omitempty"`
	Title string `json:"title,omitempty"`
}

NotificationGetAnswerDataEventsDefaults is an object the document declares inline.

type NotificationGetAnswerDataEventsTestData ¶ added in v0.7.1

type NotificationGetAnswerDataEventsTestData struct {
	BackupCount        string        `json:"backupCount,omitempty"`
	BackupPath         string        `json:"backupPath,omitempty"`
	BackupSize         string        `json:"backupSize,omitempty"`
	CompletionTime     string        `json:"completionTime,omitempty"`
	EpisodeDescription string        `json:"episodeDescription,omitempty"`
	EpisodeId          EpisodeID     `json:"episodeId,omitempty"`
	EpisodeSubtitle    string        `json:"episodeSubtitle,omitempty"`
	EpisodeTitle       string        `json:"episodeTitle,omitempty"`
	ErrorMsg           string        `json:"errorMsg,omitempty"`
	FeedUrl            string        `json:"feedUrl,omitempty"`
	LibraryId          LibraryID     `json:"libraryId,omitempty"`
	LibraryItemId      LibraryItemID `json:"libraryItemId,omitempty"`
	LibraryName        string        `json:"libraryName,omitempty"`
	MediaTags          string        `json:"mediaTags,omitempty"`
	NumFailed          int           `json:"numFailed,omitempty"`
	PodcastAuthor      string        `json:"podcastAuthor,omitempty"`
	PodcastDescription string        `json:"podcastDescription,omitempty"`
	PodcastGenres      string        `json:"podcastGenres,omitempty"`
	PodcastTitle       string        `json:"podcastTitle,omitempty"`
	RemovedOldest      string        `json:"removedOldest,omitempty"`
	Title              string        `json:"title,omitempty"`
	Version            string        `json:"version,omitempty"`
}

NotificationGetAnswerDataEventsTestData is an object the document declares inline.

type NotificationGetDataAnswer ¶ added in v0.7.1

type NotificationGetDataAnswer struct {
	Events []NotificationGetDataAnswerEvents `json:"events,omitzero"`
}

NotificationGetDataAnswer is an object the document declares inline.

type NotificationGetDataAnswerEvents ¶ added in v0.7.1

type NotificationGetDataAnswerEvents struct {
	Defaults         *NotificationGetDataAnswerEventsDefaults `json:"defaults,omitempty"`
	Description      string                                   `json:"description,omitempty"`
	DescriptionKey   NotificationEventDescriptionKey          `json:"descriptionKey,omitempty"`
	LibraryMediaType string                                   `json:"libraryMediaType,omitempty"`
	Name             NotificationEvent                        `json:"name,omitempty"`
	RequiresLibrary  bool                                     `json:"requiresLibrary"`
	TestData         *NotificationGetDataAnswerEventsTestData `json:"testData,omitempty"`
	Variables        []string                                 `json:"variables,omitzero"`
}

NotificationGetDataAnswerEvents is an object the document declares inline.

type NotificationGetDataAnswerEventsDefaults ¶ added in v0.7.1

type NotificationGetDataAnswerEventsDefaults struct {
	Body  string `json:"body,omitempty"`
	Title string `json:"title,omitempty"`
}

NotificationGetDataAnswerEventsDefaults is an object the document declares inline.

type NotificationGetDataAnswerEventsTestData ¶ added in v0.7.1

type NotificationGetDataAnswerEventsTestData struct {
	BackupCount        string        `json:"backupCount,omitempty"`
	BackupPath         string        `json:"backupPath,omitempty"`
	BackupSize         string        `json:"backupSize,omitempty"`
	CompletionTime     string        `json:"completionTime,omitempty"`
	EpisodeDescription string        `json:"episodeDescription,omitempty"`
	EpisodeId          EpisodeID     `json:"episodeId,omitempty"`
	EpisodeSubtitle    string        `json:"episodeSubtitle,omitempty"`
	EpisodeTitle       string        `json:"episodeTitle,omitempty"`
	ErrorMsg           string        `json:"errorMsg,omitempty"`
	FeedUrl            string        `json:"feedUrl,omitempty"`
	LibraryId          LibraryID     `json:"libraryId,omitempty"`
	LibraryItemId      LibraryItemID `json:"libraryItemId,omitempty"`
	LibraryName        string        `json:"libraryName,omitempty"`
	MediaTags          string        `json:"mediaTags,omitempty"`
	NumFailed          int           `json:"numFailed,omitempty"`
	PodcastAuthor      string        `json:"podcastAuthor,omitempty"`
	PodcastDescription string        `json:"podcastDescription,omitempty"`
	PodcastGenres      string        `json:"podcastGenres,omitempty"`
	PodcastTitle       string        `json:"podcastTitle,omitempty"`
	RemovedOldest      string        `json:"removedOldest,omitempty"`
	Title              string        `json:"title,omitempty"`
	Version            string        `json:"version,omitempty"`
}

NotificationGetDataAnswerEventsTestData is an object the document declares inline.

type NotificationGetDataResponse ¶ added in v0.7.1

type NotificationGetDataResponse struct {
	HttpResponse *http.Response
	Answer       *NotificationGetDataAnswer
	*NotificationGetDataAnswer
}

NotificationGetDataResponse is the result of NotificationGetData.

Answer is the NotificationGetDataAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (NotificationGetDataResponse) Answered ¶ added in v0.7.1

func (r NotificationGetDataResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (NotificationGetDataResponse) Record ¶ added in v0.7.1

Record is the NotificationGetDataAnswer answered, as a value to change and write back, or an error when the server answered none.

type NotificationGetResponse ¶ added in v0.7.1

type NotificationGetResponse struct {
	HttpResponse *http.Response
	Answer       *NotificationGetAnswer
	*NotificationGetAnswer
}

NotificationGetResponse is the result of NotificationGet.

Answer is the NotificationGetAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (NotificationGetResponse) Answered ¶ added in v0.7.1

func (r NotificationGetResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (NotificationGetResponse) Record ¶ added in v0.7.1

Record is the NotificationGetAnswer answered, as a value to change and write back, or an error when the server answered none.

type NotificationSendNotificationTestResponse ¶ added in v0.7.1

type NotificationSendNotificationTestResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

NotificationSendNotificationTestResponse is the result of NotificationSendNotificationTest.

The operation answers text (text/plain), which Answer holds as it was sent.

func (NotificationSendNotificationTestResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type NotificationSettings ¶

type NotificationSettings struct {
	AppriseApiUrl        string         `json:"appriseApiUrl,omitempty"`
	AppriseType          string         `json:"appriseType,omitempty"`
	Id                   string         `json:"id,omitempty"`
	MaxFailedAttempts    float64        `json:"maxFailedAttempts,omitempty"`
	MaxNotificationQueue float64        `json:"maxNotificationQueue,omitempty"`
	NotificationDelay    float64        `json:"notificationDelay,omitempty"`
	Notifications        []Notification `json:"notifications,omitzero"`
}

NotificationSettings is the "NotificationSettings" schema.

type NotificationUpdateNotificationRequest ¶ added in v0.7.1

type NotificationUpdateNotificationRequest struct {
	Enabled   *bool  `json:"enabled,omitempty"`
	EventName string `json:"eventName,omitempty"`
	Id        string `json:"id,omitempty"`
}

NotificationUpdateNotificationRequest is an object the document declares inline.

type NotificationUpdateNotificationResponse ¶ added in v0.7.1

type NotificationUpdateNotificationResponse struct {
	HttpResponse *http.Response
	Answer       *NotificationSettings
	*NotificationSettings
}

NotificationUpdateNotificationResponse is the result of NotificationUpdateNotification.

Answer is the NotificationSettings answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (NotificationUpdateNotificationResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (NotificationUpdateNotificationResponse) Record ¶ added in v0.7.1

Record is the NotificationSettings answered, as a value to change and write back, or an error when the server answered none.

type NotificationUpdateRequest ¶ added in v0.7.1

type NotificationUpdateRequest struct {
	AppriseApiUrl        any     `json:"appriseApiUrl,omitempty"`
	MaxFailedAttempts    float64 `json:"maxFailedAttempts,omitempty"`
	MaxNotificationQueue any     `json:"maxNotificationQueue,omitempty"`
}

NotificationUpdateRequest is an object the document declares inline.

type NotificationUpdateResponse ¶ added in v0.7.1

type NotificationUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

NotificationUpdateResponse is the result of NotificationUpdate.

The operation answers text (text/plain), which Answer holds as it was sent.

func (NotificationUpdateResponse) Answered ¶ added in v0.7.1

func (r NotificationUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type OperationInfo ¶ added in v0.7.1

type OperationInfo struct {
	Name   string
	Method string
	Path   string
	Group  string
	Read   bool
	Job    bool
	Form   string
	File   string
}

OperationInfo is one operation of the package, as a program goes by it: Name is the operation's name, which its method, response type and test carry; Method and Path its HTTP method and path, or Method the server's method for a call; Group the tag whose client has it; Read whether it changes nothing on the server (a GET, or a call that may be made by a read-only role); Job whether the server runs a call as a job; Form the one-record ("get") or count ("count") form of a query; and File "download" for an operation whose answer is a file or "upload" for one that takes one.

type PlaybackSession ¶ added in v0.7.1

type PlaybackSession struct {
	BookId        string               `json:"bookId,omitempty"`
	Chapters      []Chapter            `json:"chapters,omitzero"`
	CoverPath     string               `json:"coverPath,omitempty"`
	CurrentTime   float64              `json:"currentTime,omitempty"`
	Date          string               `json:"date,omitempty"`
	DayOfWeek     string               `json:"dayOfWeek,omitempty"`
	DeviceInfo    *DeviceInfo          `json:"deviceInfo,omitempty"`
	DisplayAuthor string               `json:"displayAuthor,omitempty"`
	DisplayTitle  string               `json:"displayTitle,omitempty"`
	Duration      float64              `json:"duration,omitempty"`
	EpisodeId     EpisodeID            `json:"episodeId,omitempty"`
	Id            string               `json:"id,omitempty"`
	LibraryId     LibraryID            `json:"libraryId,omitempty"`
	LibraryItemId LibraryItemID        `json:"libraryItemId,omitempty"`
	MediaMetadata *MediaMetadata       `json:"mediaMetadata,omitempty"`
	MediaPlayer   string               `json:"mediaPlayer,omitempty"`
	MediaType     string               `json:"mediaType,omitempty"`
	PlayMethod    int                  `json:"playMethod,omitempty"`
	ServerVersion string               `json:"serverVersion,omitempty"`
	StartTime     float64              `json:"startTime,omitempty"`
	StartedAt     UnixMilli            `json:"startedAt,omitzero"`
	TimeListening float64              `json:"timeListening,omitempty"`
	UpdatedAt     UnixMilli            `json:"updatedAt,omitzero"`
	User          *PlaybackSessionUser `json:"user,omitempty"`
	UserId        UserID               `json:"userId,omitempty"`
}

PlaybackSession is the "PlaybackSession" schema.

type PlaybackSessionForClient ¶ added in v0.7.1

type PlaybackSessionForClient struct {
	AudioTracks      []AudioTrack         `json:"audioTracks,omitzero"`
	BookId           string               `json:"bookId,omitempty"`
	Chapters         []Chapter            `json:"chapters,omitzero"`
	CoverAspectRatio int                  `json:"coverAspectRatio,omitempty"`
	CoverPath        string               `json:"coverPath,omitempty"`
	CurrentTime      float64              `json:"currentTime,omitempty"`
	Date             string               `json:"date,omitempty"`
	DayOfWeek        string               `json:"dayOfWeek,omitempty"`
	DeviceInfo       *DeviceInfo          `json:"deviceInfo,omitempty"`
	DisplayAuthor    string               `json:"displayAuthor,omitempty"`
	DisplayTitle     string               `json:"displayTitle,omitempty"`
	Duration         float64              `json:"duration,omitempty"`
	EpisodeId        string               `json:"episodeId,omitempty"`
	Id               string               `json:"id,omitempty"`
	LastSave         float64              `json:"lastSave,omitempty"`
	LibraryId        LibraryID            `json:"libraryId,omitempty"`
	LibraryItem      *LibraryItemExpanded `json:"libraryItem,omitempty"`
	LibraryItemId    LibraryItemID        `json:"libraryItemId,omitempty"`
	MediaItemShareId any                  `json:"mediaItemShareId,omitempty"`
	MediaMetadata    *MediaMetadata       `json:"mediaMetadata,omitempty"`
	MediaPlayer      string               `json:"mediaPlayer,omitempty"`
	MediaType        string               `json:"mediaType,omitempty"`
	PlayMethod       int                  `json:"playMethod,omitempty"`
	ServerVersion    string               `json:"serverVersion,omitempty"`
	ShareSessionId   any                  `json:"shareSessionId,omitempty"`
	StartTime        float64              `json:"startTime,omitempty"`
	StartedAt        UnixMilli            `json:"startedAt,omitzero"`
	Stream           any                  `json:"stream,omitempty"`
	TimeListening    float64              `json:"timeListening,omitempty"`
	UpdatedAt        UnixMilli            `json:"updatedAt,omitzero"`
	User             *PlaybackSessionUser `json:"user,omitempty"`
	UserId           UserID               `json:"userId,omitempty"`
}

PlaybackSessionForClient is the "PlaybackSessionForClient" schema.

func (PlaybackSessionForClient) Session ¶ added in v0.7.1

Session is the session as a list of a user's own sessions sends it. A client's form is the same session with what playing it needs added, the tracks, the whole item and the stream, which are left out here.

type PlaybackSessionUser ¶ added in v0.7.1

type PlaybackSessionUser struct {
	Id       UserID `json:"id,omitempty"`
	Username string `json:"username,omitempty"`
}

PlaybackSessionUser is the "PlaybackSessionUser" schema.

type Playlist ¶

type Playlist struct {
	CreatedAt   UnixMilli       `json:"createdAt,omitzero"`
	Description string          `json:"description,omitempty"`
	Id          PlaylistID      `json:"id,omitempty"`
	Items       []PlaylistItems `json:"items,omitzero"`
	LastUpdate  UnixMilli       `json:"lastUpdate,omitzero"`
	LibraryId   LibraryID       `json:"libraryId,omitempty"`
	Name        string          `json:"name,omitempty"`
	UserId      UserID          `json:"userId,omitempty"`
}

Playlist is the "Playlist" schema.

func (Playlist) GetId ¶ added in v0.7.1

func (m Playlist) GetId() PlaylistID

GetId is the record's Id, for code that handles records of several types alike.

func (Playlist) GetName ¶ added in v0.7.1

func (m Playlist) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PlaylistAddBatchRequest ¶ added in v0.7.1

type PlaylistAddBatchRequest struct {
	Items []PlaylistEntry `json:"items,omitzero"`
}

PlaylistAddBatchRequest is an object the document declares inline.

type PlaylistAddBatchResponse ¶ added in v0.7.1

type PlaylistAddBatchResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistAddBatchResponse is the result of PlaylistAddBatch.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistAddBatchResponse) Answered ¶ added in v0.7.1

func (r PlaylistAddBatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistAddBatchResponse) Record ¶ added in v0.7.1

func (r PlaylistAddBatchResponse) Record() (Playlist, error)

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistAddItemResponse ¶ added in v0.7.1

type PlaylistAddItemResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistAddItemResponse is the result of PlaylistAddItem.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistAddItemResponse) Answered ¶ added in v0.7.1

func (r PlaylistAddItemResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistAddItemResponse) Record ¶ added in v0.7.1

func (r PlaylistAddItemResponse) Record() (Playlist, error)

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistCreateFromCollectionResponse ¶ added in v0.7.1

type PlaylistCreateFromCollectionResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistCreateFromCollectionResponse is the result of PlaylistCreateFromCollection.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistCreateFromCollectionResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistCreateFromCollectionResponse) Record ¶ added in v0.7.1

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistCreateRequest ¶ added in v0.7.1

type PlaylistCreateRequest struct {
	Description string          `json:"description,omitempty"`
	Items       []PlaylistEntry `json:"items,omitzero"`
	LibraryId   LibraryID       `json:"libraryId,omitempty"`
	Name        string          `json:"name,omitempty"`
}

PlaylistCreateRequest is an object the document declares inline.

type PlaylistCreateResponse ¶ added in v0.7.1

type PlaylistCreateResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistCreateResponse is the result of PlaylistCreate.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistCreateResponse) Answered ¶ added in v0.7.1

func (r PlaylistCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistCreateResponse) Record ¶ added in v0.7.1

func (r PlaylistCreateResponse) Record() (Playlist, error)

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistDeleteResponse ¶ added in v0.7.1

type PlaylistDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

PlaylistDeleteResponse is the result of PlaylistDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (PlaylistDeleteResponse) Answered ¶ added in v0.7.1

func (r PlaylistDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type PlaylistEntry ¶

type PlaylistEntry struct {
	EpisodeId     EpisodeID     `json:"episodeId,omitempty"`
	LibraryItemId LibraryItemID `json:"libraryItemId,omitempty"`
}

PlaylistEntry is the "PlaylistEntry" schema.

type PlaylistFindAllForUserAnswer ¶ added in v0.7.1

type PlaylistFindAllForUserAnswer struct {
	Playlists []Playlist `json:"playlists,omitzero"`
}

PlaylistFindAllForUserAnswer is an object the document declares inline.

type PlaylistFindAllForUserResponse ¶ added in v0.7.1

type PlaylistFindAllForUserResponse struct {
	HttpResponse *http.Response
	Answer       *PlaylistFindAllForUserAnswer
	*PlaylistFindAllForUserAnswer
}

PlaylistFindAllForUserResponse is the result of PlaylistFindAllForUser.

Answer is the PlaylistFindAllForUserAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistFindAllForUserResponse) Answered ¶ added in v0.7.1

func (r PlaylistFindAllForUserResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistFindAllForUserResponse) Record ¶ added in v0.7.1

Record is the PlaylistFindAllForUserAnswer answered, as a value to change and write back, or an error when the server answered none.

type PlaylistFindOneResponse ¶ added in v0.7.1

type PlaylistFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistFindOneResponse is the result of PlaylistFindOne.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistFindOneResponse) Answered ¶ added in v0.7.1

func (r PlaylistFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistFindOneResponse) Record ¶ added in v0.7.1

func (r PlaylistFindOneResponse) Record() (Playlist, error)

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistID ¶ added in v0.7.1

type PlaylistID string

PlaylistID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and PlaylistID(n) convert one value, client.StringIDs a list.

type PlaylistItems ¶ added in v0.7.1

type PlaylistItems struct {
	Episode       *PodcastEpisode      `json:"episode,omitempty"`
	EpisodeId     EpisodeID            `json:"episodeId,omitempty"`
	LibraryItem   *LibraryItemExpanded `json:"libraryItem,omitempty"`
	LibraryItemId LibraryItemID        `json:"libraryItemId,omitempty"`
}

PlaylistItems is an object the document declares inline.

type PlaylistRemoveBatchRequest ¶ added in v0.7.1

type PlaylistRemoveBatchRequest struct {
	Items []PlaylistEntry `json:"items,omitzero"`
}

PlaylistRemoveBatchRequest is an object the document declares inline.

type PlaylistRemoveBatchResponse ¶ added in v0.7.1

type PlaylistRemoveBatchResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistRemoveBatchResponse is the result of PlaylistRemoveBatch.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistRemoveBatchResponse) Answered ¶ added in v0.7.1

func (r PlaylistRemoveBatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistRemoveBatchResponse) Record ¶ added in v0.7.1

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistRemoveItem2Response ¶ added in v0.7.1

type PlaylistRemoveItem2Response struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistRemoveItem2Response is the result of PlaylistRemoveItem2.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistRemoveItem2Response) Answered ¶ added in v0.7.1

func (r PlaylistRemoveItem2Response) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistRemoveItem2Response) Record ¶ added in v0.7.1

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistRemoveItemResponse ¶ added in v0.7.1

type PlaylistRemoveItemResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistRemoveItemResponse is the result of PlaylistRemoveItem.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistRemoveItemResponse) Answered ¶ added in v0.7.1

func (r PlaylistRemoveItemResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistRemoveItemResponse) Record ¶ added in v0.7.1

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PlaylistUpdateRequest ¶ added in v0.7.1

type PlaylistUpdateRequest struct {
	Description string          `json:"description,omitempty"`
	Items       []PlaylistEntry `json:"items,omitzero"`
	LibraryId   any             `json:"libraryId,omitempty"`
	Name        string          `json:"name,omitempty"`
	UserId      any             `json:"userId,omitempty"`
}

PlaylistUpdateRequest is an object the document declares inline.

type PlaylistUpdateResponse ¶ added in v0.7.1

type PlaylistUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *Playlist
	*Playlist
}

PlaylistUpdateResponse is the result of PlaylistUpdate.

Answer is the Playlist answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PlaylistUpdateResponse) Answered ¶ added in v0.7.1

func (r PlaylistUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PlaylistUpdateResponse) Record ¶ added in v0.7.1

func (r PlaylistUpdateResponse) Record() (Playlist, error)

Record is the Playlist answered, as a value to change and write back, or an error when the server answered none.

type PodcastBulkCreatePodcastsFromOpmlFeedUrlsRequest ¶ added in v0.7.1

type PodcastBulkCreatePodcastsFromOpmlFeedUrlsRequest struct {
	AutoDownloadEpisodes *bool     `json:"autoDownloadEpisodes,omitempty"`
	Feeds                []string  `json:"feeds,omitzero"`
	FolderId             FolderID  `json:"folderId,omitempty"`
	LibraryId            LibraryID `json:"libraryId,omitempty"`
}

PodcastBulkCreatePodcastsFromOpmlFeedUrlsRequest is an object the document declares inline.

type PodcastBulkCreatePodcastsFromOpmlFeedUrlsResponse ¶ added in v0.7.1

type PodcastBulkCreatePodcastsFromOpmlFeedUrlsResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

PodcastBulkCreatePodcastsFromOpmlFeedUrlsResponse is the result of PodcastBulkCreatePodcastsFromOpmlFeedUrls.

The operation answers text (text/plain), which Answer holds as it was sent.

func (PodcastBulkCreatePodcastsFromOpmlFeedUrlsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type PodcastCheckNewEpisodesAnswer ¶ added in v0.7.1

type PodcastCheckNewEpisodesAnswer struct {
	Episodes []RssPodcastEpisode `json:"episodes,omitzero"`
}

PodcastCheckNewEpisodesAnswer is an object the document declares inline.

type PodcastCheckNewEpisodesOptions ¶ added in v0.7.1

type PodcastCheckNewEpisodesOptions struct {
	Limit *int
}

PodcastCheckNewEpisodesOptions holds the query and header parameters of PodcastCheckNewEpisodes.

func (PodcastCheckNewEpisodesOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (PodcastCheckNewEpisodesOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type PodcastCheckNewEpisodesResponse ¶ added in v0.7.1

type PodcastCheckNewEpisodesResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastCheckNewEpisodesAnswer
	*PodcastCheckNewEpisodesAnswer
}

PodcastCheckNewEpisodesResponse is the result of PodcastCheckNewEpisodes.

Answer is the PodcastCheckNewEpisodesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastCheckNewEpisodesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastCheckNewEpisodesResponse) Record ¶ added in v0.7.1

Record is the PodcastCheckNewEpisodesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PodcastClearEpisodeDownloadQueueResponse ¶ added in v0.7.1

type PodcastClearEpisodeDownloadQueueResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

PodcastClearEpisodeDownloadQueueResponse is the result of PodcastClearEpisodeDownloadQueue.

The operation answers text (text/plain), which Answer holds as it was sent.

func (PodcastClearEpisodeDownloadQueueResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type PodcastCreateRequest ¶ added in v0.7.1

type PodcastCreateRequest struct {
	FolderId  FolderID                   `json:"folderId,omitempty"`
	LibraryId LibraryID                  `json:"libraryId,omitempty"`
	Media     *PodcastCreateRequestMedia `json:"media,omitempty"`
	Path      string                     `json:"path,omitempty"`
}

PodcastCreateRequest is an object the document declares inline.

type PodcastCreateRequestMedia ¶ added in v0.7.1

type PodcastCreateRequestMedia struct {
	AutoDownloadEpisodes *bool                              `json:"autoDownloadEpisodes,omitempty"`
	Metadata             *PodcastCreateRequestMediaMetadata `json:"metadata,omitempty"`
}

PodcastCreateRequestMedia is an object the document declares inline.

type PodcastCreateRequestMediaMetadata ¶ added in v0.7.1

type PodcastCreateRequestMediaMetadata struct {
	Author        string   `json:"author,omitempty"`
	Description   string   `json:"description,omitempty"`
	Explicit      *bool    `json:"explicit,omitempty"`
	FeedUrl       string   `json:"feedUrl,omitempty"`
	Genres        []string `json:"genres,omitzero"`
	ImageUrl      string   `json:"imageUrl,omitempty"`
	ItunesPageUrl string   `json:"itunesPageUrl,omitempty"`
	Language      string   `json:"language,omitempty"`
	ReleaseDate   string   `json:"releaseDate,omitempty"`
	Title         string   `json:"title,omitempty"`
	Type          string   `json:"type,omitempty"`
}

PodcastCreateRequestMediaMetadata is an object the document declares inline.

type PodcastCreateResponse ¶ added in v0.7.1

type PodcastCreateResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemExpanded
	*LibraryItemExpanded
}

PodcastCreateResponse is the result of PodcastCreate.

Answer is the LibraryItemExpanded answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastCreateResponse) Answered ¶ added in v0.7.1

func (r PodcastCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastCreateResponse) Record ¶ added in v0.7.1

Record is the LibraryItemExpanded answered, as a value to change and write back, or an error when the server answered none.

type PodcastDownloadEpisodesResponse ¶ added in v0.7.1

type PodcastDownloadEpisodesResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

PodcastDownloadEpisodesResponse is the result of PodcastDownloadEpisodes.

The operation answers text (text/plain), which Answer holds as it was sent.

func (PodcastDownloadEpisodesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type PodcastEpisode ¶ added in v0.7.1

type PodcastEpisode struct {
	AddedAt       UnixMilli                `json:"addedAt,omitzero"`
	AudioFile     *AudioFile               `json:"audioFile,omitempty"`
	AudioTrack    *AudioTrack              `json:"audioTrack,omitempty"`
	Chapters      []Chapter                `json:"chapters,omitzero"`
	Description   string                   `json:"description,omitempty"`
	Duration      float64                  `json:"duration,omitempty"`
	Enclosure     *PodcastEpisodeEnclosure `json:"enclosure,omitempty"`
	Episode       string                   `json:"episode,omitempty"`
	EpisodeType   string                   `json:"episodeType,omitempty"`
	Guid          string                   `json:"guid,omitempty"`
	Id            EpisodeID                `json:"id,omitempty"`
	Index         int                      `json:"index,omitempty"`
	LibraryId     LibraryID                `json:"libraryId,omitempty"`
	LibraryItemId LibraryItemID            `json:"libraryItemId,omitempty"`
	OldEpisodeId  any                      `json:"oldEpisodeId,omitempty"`
	Podcast       *PodcastEpisodePodcast   `json:"podcast,omitempty"`
	PodcastId     string                   `json:"podcastId,omitempty"`
	PubDate       string                   `json:"pubDate,omitempty"`
	PublishedAt   UnixMilli                `json:"publishedAt,omitzero"`
	Season        string                   `json:"season,omitempty"`
	Size          float64                  `json:"size,omitempty"`
	Subtitle      string                   `json:"subtitle,omitempty"`
	Title         string                   `json:"title,omitempty"`
	UpdatedAt     UnixMilli                `json:"updatedAt,omitzero"`
}

PodcastEpisode is the "PodcastEpisode" schema.

type PodcastEpisodeDownload ¶ added in v0.7.1

type PodcastEpisodeDownload struct {
	AppendRandomId      bool          `json:"appendRandomId"`
	CreatedAt           UnixMilli     `json:"createdAt,omitzero"`
	Episode             string        `json:"episode,omitempty"`
	EpisodeDisplayTitle string        `json:"episodeDisplayTitle,omitempty"`
	EpisodeType         string        `json:"episodeType,omitempty"`
	Failed              bool          `json:"failed"`
	FinishedAt          UnixMilli     `json:"finishedAt,omitzero"`
	Guid                string        `json:"guid,omitempty"`
	Id                  string        `json:"id,omitempty"`
	IsFinished          bool          `json:"isFinished"`
	LibraryId           LibraryID     `json:"libraryId,omitempty"`
	LibraryItemId       LibraryItemID `json:"libraryItemId,omitempty"`
	PodcastExplicit     bool          `json:"podcastExplicit"`
	PodcastTitle        string        `json:"podcastTitle,omitempty"`
	PublishedAt         UnixMilli     `json:"publishedAt,omitzero"`
	Season              string        `json:"season,omitempty"`
	StartedAt           UnixMilli     `json:"startedAt,omitzero"`
	Url                 string        `json:"url,omitempty"`
}

PodcastEpisodeDownload is the "PodcastEpisodeDownload" schema.

type PodcastEpisodeEnclosure ¶ added in v0.7.1

type PodcastEpisodeEnclosure struct {
	Length string `json:"length,omitempty"`
	Type   string `json:"type,omitempty"`
	Url    string `json:"url,omitempty"`
}

PodcastEpisodeEnclosure is the "PodcastEpisodeEnclosure" schema.

type PodcastEpisodePodcast ¶ added in v0.7.1

type PodcastEpisodePodcast struct {
	AutoDownloadEpisodes     bool                           `json:"autoDownloadEpisodes"`
	AutoDownloadSchedule     string                         `json:"autoDownloadSchedule,omitempty"`
	CoverPath                any                            `json:"coverPath,omitempty"`
	Episodes                 []any                          `json:"episodes,omitzero"`
	Id                       string                         `json:"id,omitempty"`
	LastEpisodeCheck         any                            `json:"lastEpisodeCheck,omitempty"`
	LibraryItemId            LibraryItemID                  `json:"libraryItemId,omitempty"`
	MaxEpisodesToKeep        int                            `json:"maxEpisodesToKeep,omitempty"`
	MaxNewEpisodesToDownload int                            `json:"maxNewEpisodesToDownload,omitempty"`
	Metadata                 *PodcastEpisodePodcastMetadata `json:"metadata,omitempty"`
	Tags                     []any                          `json:"tags,omitzero"`
}

PodcastEpisodePodcast is an object the document declares inline.

type PodcastEpisodePodcastMetadata ¶ added in v0.7.1

type PodcastEpisodePodcastMetadata struct {
	Author         any    `json:"author,omitempty"`
	Description    any    `json:"description,omitempty"`
	Explicit       bool   `json:"explicit"`
	FeedUrl        any    `json:"feedUrl,omitempty"`
	Genres         []any  `json:"genres,omitzero"`
	ImageUrl       any    `json:"imageUrl,omitempty"`
	ItunesArtistId any    `json:"itunesArtistId,omitempty"`
	ItunesId       any    `json:"itunesId,omitempty"`
	ItunesPageUrl  any    `json:"itunesPageUrl,omitempty"`
	Language       any    `json:"language,omitempty"`
	ReleaseDate    any    `json:"releaseDate,omitempty"`
	Title          string `json:"title,omitempty"`
	Type           string `json:"type,omitempty"`
}

PodcastEpisodePodcastMetadata is an object the document declares inline.

type PodcastFindEpisodeAnswer ¶ added in v0.7.1

type PodcastFindEpisodeAnswer struct {
	Episodes []PodcastFindEpisodeAnswerEpisodes `json:"episodes,omitzero"`
}

PodcastFindEpisodeAnswer is an object the document declares inline.

type PodcastFindEpisodeAnswerEpisodes ¶ added in v0.7.1

type PodcastFindEpisodeAnswerEpisodes struct {
	Episode *RssPodcastEpisode `json:"episode,omitempty"`
}

PodcastFindEpisodeAnswerEpisodes is an object the document declares inline.

type PodcastFindEpisodeOptions ¶ added in v0.7.1

type PodcastFindEpisodeOptions struct {
	Title string
}

PodcastFindEpisodeOptions holds the query and header parameters of PodcastFindEpisode.

func (PodcastFindEpisodeOptions) ToHeaders ¶ added in v0.7.1

func (o PodcastFindEpisodeOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PodcastFindEpisodeOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type PodcastFindEpisodeResponse ¶ added in v0.7.1

type PodcastFindEpisodeResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastFindEpisodeAnswer
	*PodcastFindEpisodeAnswer
}

PodcastFindEpisodeResponse is the result of PodcastFindEpisode.

Answer is the PodcastFindEpisodeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastFindEpisodeResponse) Answered ¶ added in v0.7.1

func (r PodcastFindEpisodeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastFindEpisodeResponse) Record ¶ added in v0.7.1

Record is the PodcastFindEpisodeAnswer answered, as a value to change and write back, or an error when the server answered none.

type PodcastGetEpisodeDownloadsAnswer ¶ added in v0.7.1

type PodcastGetEpisodeDownloadsAnswer struct {
	Downloads []PodcastEpisodeDownload `json:"downloads,omitzero"`
}

PodcastGetEpisodeDownloadsAnswer is an object the document declares inline.

type PodcastGetEpisodeDownloadsResponse ¶ added in v0.7.1

type PodcastGetEpisodeDownloadsResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastGetEpisodeDownloadsAnswer
	*PodcastGetEpisodeDownloadsAnswer
}

PodcastGetEpisodeDownloadsResponse is the result of PodcastGetEpisodeDownloads.

Answer is the PodcastGetEpisodeDownloadsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastGetEpisodeDownloadsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastGetEpisodeDownloadsResponse) Record ¶ added in v0.7.1

Record is the PodcastGetEpisodeDownloadsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PodcastGetEpisodeResponse ¶ added in v0.7.1

type PodcastGetEpisodeResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastEpisode
	*PodcastEpisode
}

PodcastGetEpisodeResponse is the result of PodcastGetEpisode.

Answer is the PodcastEpisode answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastGetEpisodeResponse) Answered ¶ added in v0.7.1

func (r PodcastGetEpisodeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastGetEpisodeResponse) Record ¶ added in v0.7.1

Record is the PodcastEpisode answered, as a value to change and write back, or an error when the server answered none.

type PodcastGetFeedsFromOPMLTextAnswer ¶ added in v0.7.1

type PodcastGetFeedsFromOPMLTextAnswer struct {
	Feeds []PodcastGetFeedsFromOPMLTextAnswerFeeds `json:"feeds,omitzero"`
}

PodcastGetFeedsFromOPMLTextAnswer is an object the document declares inline.

type PodcastGetFeedsFromOPMLTextAnswerFeeds ¶ added in v0.7.1

type PodcastGetFeedsFromOPMLTextAnswerFeeds struct {
	FeedUrl string `json:"feedUrl,omitempty"`
	Title   string `json:"title,omitempty"`
}

PodcastGetFeedsFromOPMLTextAnswerFeeds is an object the document declares inline.

type PodcastGetFeedsFromOPMLTextRequest ¶ added in v0.7.1

type PodcastGetFeedsFromOPMLTextRequest struct {
	OpmlText string `json:"opmlText,omitempty"`
}

PodcastGetFeedsFromOPMLTextRequest is an object the document declares inline.

type PodcastGetFeedsFromOPMLTextResponse ¶ added in v0.7.1

type PodcastGetFeedsFromOPMLTextResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastGetFeedsFromOPMLTextAnswer
	*PodcastGetFeedsFromOPMLTextAnswer
}

PodcastGetFeedsFromOPMLTextResponse is the result of PodcastGetFeedsFromOPMLText.

Answer is the PodcastGetFeedsFromOPMLTextAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastGetFeedsFromOPMLTextResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastGetFeedsFromOPMLTextResponse) Record ¶ added in v0.7.1

Record is the PodcastGetFeedsFromOPMLTextAnswer answered, as a value to change and write back, or an error when the server answered none.

type PodcastGetPodcastFeedAnswer ¶ added in v0.7.1

type PodcastGetPodcastFeedAnswer struct {
	Podcast *PodcastGetPodcastFeedAnswerPodcast `json:"podcast,omitempty"`
}

PodcastGetPodcastFeedAnswer is an object the document declares inline.

type PodcastGetPodcastFeedAnswerPodcast ¶ added in v0.7.1

type PodcastGetPodcastFeedAnswerPodcast struct {
	Episodes    []RssPodcastEpisode                         `json:"episodes,omitzero"`
	Metadata    *PodcastGetPodcastFeedAnswerPodcastMetadata `json:"metadata,omitempty"`
	NumEpisodes int                                         `json:"numEpisodes,omitempty"`
}

PodcastGetPodcastFeedAnswerPodcast is an object the document declares inline.

type PodcastGetPodcastFeedAnswerPodcastMetadata ¶ added in v0.7.1

type PodcastGetPodcastFeedAnswerPodcastMetadata struct {
	Author           string   `json:"author,omitempty"`
	Categories       []string `json:"categories,omitzero"`
	Description      string   `json:"description,omitempty"`
	DescriptionPlain string   `json:"descriptionPlain,omitempty"`
	Explicit         string   `json:"explicit,omitempty"`
	FeedUrl          string   `json:"feedUrl,omitempty"`
	Image            string   `json:"image,omitempty"`
	Language         string   `json:"language,omitempty"`
	Link             string   `json:"link,omitempty"`
	PubDate          string   `json:"pubDate,omitempty"`
	Title            string   `json:"title,omitempty"`
	Type             string   `json:"type,omitempty"`
}

PodcastGetPodcastFeedAnswerPodcastMetadata is an object the document declares inline.

type PodcastGetPodcastFeedRequest ¶ added in v0.7.1

type PodcastGetPodcastFeedRequest struct {
	RssFeed string `json:"rssFeed,omitempty"`
}

PodcastGetPodcastFeedRequest is an object the document declares inline.

type PodcastGetPodcastFeedResponse ¶ added in v0.7.1

type PodcastGetPodcastFeedResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastGetPodcastFeedAnswer
	*PodcastGetPodcastFeedAnswer
}

PodcastGetPodcastFeedResponse is the result of PodcastGetPodcastFeed.

Answer is the PodcastGetPodcastFeedAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastGetPodcastFeedResponse) Answered ¶ added in v0.7.1

func (r PodcastGetPodcastFeedResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastGetPodcastFeedResponse) Record ¶ added in v0.7.1

Record is the PodcastGetPodcastFeedAnswer answered, as a value to change and write back, or an error when the server answered none.

type PodcastQuickMatchEpisodesAnswer ¶ added in v0.7.1

type PodcastQuickMatchEpisodesAnswer struct {
	NumEpisodesUpdated int `json:"numEpisodesUpdated,omitempty"`
}

PodcastQuickMatchEpisodesAnswer is an object the document declares inline.

type PodcastQuickMatchEpisodesOptions ¶ added in v0.7.1

type PodcastQuickMatchEpisodesOptions struct {
	Override string
}

PodcastQuickMatchEpisodesOptions holds the query and header parameters of PodcastQuickMatchEpisodes.

func (PodcastQuickMatchEpisodesOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (PodcastQuickMatchEpisodesOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type PodcastQuickMatchEpisodesResponse ¶ added in v0.7.1

type PodcastQuickMatchEpisodesResponse struct {
	HttpResponse *http.Response
	Answer       *PodcastQuickMatchEpisodesAnswer
	*PodcastQuickMatchEpisodesAnswer
}

PodcastQuickMatchEpisodesResponse is the result of PodcastQuickMatchEpisodes.

Answer is the PodcastQuickMatchEpisodesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastQuickMatchEpisodesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastQuickMatchEpisodesResponse) Record ¶ added in v0.7.1

Record is the PodcastQuickMatchEpisodesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PodcastRemoveEpisodeOptions ¶ added in v0.7.1

type PodcastRemoveEpisodeOptions struct {
	Hard string
}

PodcastRemoveEpisodeOptions holds the query and header parameters of PodcastRemoveEpisode.

func (PodcastRemoveEpisodeOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (PodcastRemoveEpisodeOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type PodcastRemoveEpisodeResponse ¶ added in v0.7.1

type PodcastRemoveEpisodeResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItem
	*LibraryItem
}

PodcastRemoveEpisodeResponse is the result of PodcastRemoveEpisode.

Answer is the LibraryItem answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastRemoveEpisodeResponse) Answered ¶ added in v0.7.1

func (r PodcastRemoveEpisodeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastRemoveEpisodeResponse) Record ¶ added in v0.7.1

Record is the LibraryItem answered, as a value to change and write back, or an error when the server answered none.

type PodcastUpdateEpisodeRequest ¶ added in v0.7.1

type PodcastUpdateEpisodeRequest struct {
	Description string    `json:"description,omitempty"`
	Enclosure   any       `json:"enclosure,omitempty"`
	Episode     string    `json:"episode,omitempty"`
	EpisodeType string    `json:"episodeType,omitempty"`
	PubDate     string    `json:"pubDate,omitempty"`
	PublishedAt UnixMilli `json:"publishedAt,omitzero"`
	Season      string    `json:"season,omitempty"`
	Subtitle    string    `json:"subtitle,omitempty"`
	Title       string    `json:"title,omitempty"`
}

PodcastUpdateEpisodeRequest is an object the document declares inline.

type PodcastUpdateEpisodeResponse ¶ added in v0.7.1

type PodcastUpdateEpisodeResponse struct {
	HttpResponse *http.Response
	Answer       *LibraryItemExpanded
	*LibraryItemExpanded
}

PodcastUpdateEpisodeResponse is the result of PodcastUpdateEpisode.

Answer is the LibraryItemExpanded answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PodcastUpdateEpisodeResponse) Answered ¶ added in v0.7.1

func (r PodcastUpdateEpisodeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PodcastUpdateEpisodeResponse) Record ¶ added in v0.7.1

Record is the LibraryItemExpanded answered, as a value to change and write back, or an error when the server answered none.

type ProgressUpdatePayload ¶ added in v0.7.1

type ProgressUpdatePayload struct {
	CurrentTime               *float64      `json:"currentTime,omitempty"`
	Duration                  *float64      `json:"duration,omitempty"`
	EbookLocation             *string       `json:"ebookLocation,omitempty"`
	EbookProgress             *float64      `json:"ebookProgress,omitempty"`
	EpisodeId                 EpisodeID     `json:"episodeId,omitempty"`
	FinishedAt                UnixMilli     `json:"finishedAt,omitzero"`
	HideFromContinueListening *bool         `json:"hideFromContinueListening,omitempty"`
	IsFinished                *bool         `json:"isFinished,omitempty"`
	LastUpdate                UnixMilli     `json:"lastUpdate,omitzero"`
	LibraryItemId             LibraryItemID `json:"libraryItemId,omitempty"`
	Progress                  *float64      `json:"progress,omitempty"`
}

ProgressUpdatePayload is the "ProgressUpdatePayload" schema.

type ProviderID ¶ added in v0.7.1

type ProviderID string

ProviderID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and ProviderID(n) convert one value, client.StringIDs a list.

type ProviderOption ¶ added in v0.7.1

type ProviderOption struct {
	Text  string `json:"text,omitempty"`
	Value string `json:"value,omitempty"`
}

ProviderOption is the "ProviderOption" schema.

type RSSFeedCloseRSSFeedResponse ¶ added in v0.7.1

type RSSFeedCloseRSSFeedResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

RSSFeedCloseRSSFeedResponse is the result of RSSFeedCloseRSSFeed.

The operation answers text (text/plain), which Answer holds as it was sent.

func (RSSFeedCloseRSSFeedResponse) Answered ¶ added in v0.7.1

func (r RSSFeedCloseRSSFeedResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type RSSFeedGetAllAnswer ¶ added in v0.7.1

type RSSFeedGetAllAnswer struct {
	Feeds    []Feed         `json:"feeds,omitzero"`
	Minified []FeedMinified `json:"minified,omitzero"`
}

RSSFeedGetAllAnswer is an object the document declares inline.

type RSSFeedGetAllResponse ¶ added in v0.7.1

type RSSFeedGetAllResponse struct {
	HttpResponse *http.Response
	Answer       *RSSFeedGetAllAnswer
	*RSSFeedGetAllAnswer
}

RSSFeedGetAllResponse is the result of RSSFeedGetAll.

Answer is the RSSFeedGetAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (RSSFeedGetAllResponse) Answered ¶ added in v0.7.1

func (r RSSFeedGetAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (RSSFeedGetAllResponse) Record ¶ added in v0.7.1

Record is the RSSFeedGetAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type RSSFeedOpenRSSFeedForCollectionAnswer ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForCollectionAnswer struct {
	Feed *FeedMinified `json:"feed,omitempty"`
}

RSSFeedOpenRSSFeedForCollectionAnswer is an object the document declares inline.

type RSSFeedOpenRSSFeedForCollectionRequest ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForCollectionRequest struct {
	ServerAddress string `json:"serverAddress,omitempty"`
	Slug          string `json:"slug,omitempty"`
}

RSSFeedOpenRSSFeedForCollectionRequest is an object the document declares inline.

type RSSFeedOpenRSSFeedForCollectionResponse ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForCollectionResponse struct {
	HttpResponse *http.Response
	Answer       *RSSFeedOpenRSSFeedForCollectionAnswer
	*RSSFeedOpenRSSFeedForCollectionAnswer
}

RSSFeedOpenRSSFeedForCollectionResponse is the result of RSSFeedOpenRSSFeedForCollection.

Answer is the RSSFeedOpenRSSFeedForCollectionAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (RSSFeedOpenRSSFeedForCollectionResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (RSSFeedOpenRSSFeedForCollectionResponse) Record ¶ added in v0.7.1

Record is the RSSFeedOpenRSSFeedForCollectionAnswer answered, as a value to change and write back, or an error when the server answered none.

type RSSFeedOpenRSSFeedForItemAnswer ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForItemAnswer struct {
	Feed *FeedMinified `json:"feed,omitempty"`
}

RSSFeedOpenRSSFeedForItemAnswer is an object the document declares inline.

type RSSFeedOpenRSSFeedForItemRequest ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForItemRequest struct {
	ServerAddress string `json:"serverAddress,omitempty"`
	Slug          string `json:"slug,omitempty"`
}

RSSFeedOpenRSSFeedForItemRequest is an object the document declares inline.

type RSSFeedOpenRSSFeedForItemResponse ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForItemResponse struct {
	HttpResponse *http.Response
	Answer       *RSSFeedOpenRSSFeedForItemAnswer
	*RSSFeedOpenRSSFeedForItemAnswer
}

RSSFeedOpenRSSFeedForItemResponse is the result of RSSFeedOpenRSSFeedForItem.

Answer is the RSSFeedOpenRSSFeedForItemAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (RSSFeedOpenRSSFeedForItemResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (RSSFeedOpenRSSFeedForItemResponse) Record ¶ added in v0.7.1

Record is the RSSFeedOpenRSSFeedForItemAnswer answered, as a value to change and write back, or an error when the server answered none.

type RSSFeedOpenRSSFeedForSeriesAnswer ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForSeriesAnswer struct {
	Feed *FeedMinified `json:"feed,omitempty"`
}

RSSFeedOpenRSSFeedForSeriesAnswer is an object the document declares inline.

type RSSFeedOpenRSSFeedForSeriesRequest ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForSeriesRequest struct {
	MetadataDetails any    `json:"metadataDetails,omitempty"`
	ServerAddress   string `json:"serverAddress,omitempty"`
	Slug            string `json:"slug,omitempty"`
}

RSSFeedOpenRSSFeedForSeriesRequest is an object the document declares inline.

type RSSFeedOpenRSSFeedForSeriesResponse ¶ added in v0.7.1

type RSSFeedOpenRSSFeedForSeriesResponse struct {
	HttpResponse *http.Response
	Answer       *RSSFeedOpenRSSFeedForSeriesAnswer
	*RSSFeedOpenRSSFeedForSeriesAnswer
}

RSSFeedOpenRSSFeedForSeriesResponse is the result of RSSFeedOpenRSSFeedForSeries.

Answer is the RSSFeedOpenRSSFeedForSeriesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (RSSFeedOpenRSSFeedForSeriesResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (RSSFeedOpenRSSFeedForSeriesResponse) Record ¶ added in v0.7.1

Record is the RSSFeedOpenRSSFeedForSeriesAnswer answered, as a value to change and write back, or an error when the server answered none.

type RssPodcastEpisode ¶ added in v0.7.1

type RssPodcastEpisode struct {
	Author           string                   `json:"author,omitempty"`
	Chapters         []any                    `json:"chapters,omitzero"`
	ChaptersType     string                   `json:"chaptersType,omitempty"`
	ChaptersUrl      string                   `json:"chaptersUrl,omitempty"`
	Description      string                   `json:"description,omitempty"`
	DescriptionPlain string                   `json:"descriptionPlain,omitempty"`
	Duration         string                   `json:"duration,omitempty"`
	DurationSeconds  float64                  `json:"durationSeconds,omitempty"`
	Enclosure        *PodcastEpisodeEnclosure `json:"enclosure,omitempty"`
	Episode          string                   `json:"episode,omitempty"`
	EpisodeType      string                   `json:"episodeType,omitempty"`
	Explicit         string                   `json:"explicit,omitempty"`
	Guid             string                   `json:"guid,omitempty"`
	PubDate          string                   `json:"pubDate,omitempty"`
	PublishedAt      UnixMilli                `json:"publishedAt,omitzero"`
	Season           string                   `json:"season,omitempty"`
	Subtitle         string                   `json:"subtitle,omitempty"`
	Title            string                   `json:"title,omitempty"`
}

RssPodcastEpisode is the "RssPodcastEpisode" schema.

type SearchFindAuthorAnswer ¶ added in v0.7.1

type SearchFindAuthorAnswer struct {
	Asin        string `json:"asin,omitempty"`
	Description string `json:"description,omitempty"`
	Error       any    `json:"error,omitempty"`
	Image       string `json:"image,omitempty"`
	Name        string `json:"name,omitempty"`
}

SearchFindAuthorAnswer is an object the document declares inline.

type SearchFindAuthorOptions ¶ added in v0.7.1

type SearchFindAuthorOptions struct {
	Q string
}

SearchFindAuthorOptions holds the query and header parameters of SearchFindAuthor.

func (SearchFindAuthorOptions) ToHeaders ¶ added in v0.7.1

func (o SearchFindAuthorOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (SearchFindAuthorOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SearchFindAuthorResponse ¶ added in v0.7.1

type SearchFindAuthorResponse struct {
	HttpResponse *http.Response
	Answer       *SearchFindAuthorAnswer
	*SearchFindAuthorAnswer
}

SearchFindAuthorResponse is the result of SearchFindAuthor.

Answer is the SearchFindAuthorAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SearchFindAuthorResponse) Answered ¶ added in v0.7.1

func (r SearchFindAuthorResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SearchFindAuthorResponse) Record ¶ added in v0.7.1

Record is the SearchFindAuthorAnswer answered, as a value to change and write back, or an error when the server answered none.

type SearchFindBooksAnswer ¶ added in v0.7.1

type SearchFindBooksAnswer struct {
	Abridged         bool                          `json:"abridged"`
	Asin             string                        `json:"asin,omitempty"`
	Author           string                        `json:"author,omitempty"`
	Cover            string                        `json:"cover,omitempty"`
	Description      string                        `json:"description,omitempty"`
	DescriptionPlain string                        `json:"descriptionPlain,omitempty"`
	Duration         float64                       `json:"duration,omitempty"`
	Explicit         bool                          `json:"explicit"`
	Genres           []string                      `json:"genres,omitzero"`
	Id               TextOrNumber                  `json:"id,omitzero"`
	Isbn             string                        `json:"isbn,omitempty"`
	Language         string                        `json:"language,omitempty"`
	MatchConfidence  float64                       `json:"matchConfidence,omitempty"`
	Narrator         string                        `json:"narrator,omitempty"`
	PublishedYear    TextOrNumber                  `json:"publishedYear,omitzero"`
	Publisher        string                        `json:"publisher,omitempty"`
	Rating           string                        `json:"rating,omitempty"`
	Region           string                        `json:"region,omitempty"`
	Series           []SearchFindBooksAnswerSeries `json:"series,omitzero"`
	Subtitle         string                        `json:"subtitle,omitempty"`
	Tags             []string                      `json:"tags,omitzero"`
	Title            string                        `json:"title,omitempty"`
}

SearchFindBooksAnswer is an object the document declares inline.

type SearchFindBooksAnswerSeries ¶ added in v0.7.1

type SearchFindBooksAnswerSeries struct {
	Sequence string `json:"sequence,omitempty"`
	Series   string `json:"series,omitempty"`
}

SearchFindBooksAnswerSeries is an object the document declares inline.

type SearchFindBooksOptions ¶ added in v0.7.1

type SearchFindBooksOptions struct {
	Author   string
	Id       string
	Provider string
	Title    string
}

SearchFindBooksOptions holds the query and header parameters of SearchFindBooks.

func (SearchFindBooksOptions) ToHeaders ¶ added in v0.7.1

func (o SearchFindBooksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (SearchFindBooksOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SearchFindBooksResponse ¶ added in v0.7.1

type SearchFindBooksResponse struct {
	HttpResponse *http.Response
	Answer       []SearchFindBooksAnswer
}

SearchFindBooksResponse is the result of SearchFindBooks.

func (SearchFindBooksResponse) Answered ¶ added in v0.7.1

func (r SearchFindBooksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type SearchFindChaptersAnswer ¶ added in v0.7.1

type SearchFindChaptersAnswer struct {
	Asin                 string                             `json:"asin,omitempty"`
	BrandIntroDurationMs float64                            `json:"brandIntroDurationMs,omitempty"`
	BrandOutroDurationMs float64                            `json:"brandOutroDurationMs,omitempty"`
	Chapters             []SearchFindChaptersAnswerChapters `json:"chapters,omitzero"`
	Error                string                             `json:"error,omitempty"`
	IsAccurate           bool                               `json:"isAccurate"`
	Region               string                             `json:"region,omitempty"`
	RuntimeLengthMs      float64                            `json:"runtimeLengthMs,omitempty"`
	RuntimeLengthSec     float64                            `json:"runtimeLengthSec,omitempty"`
	StringKey            ChapterSearchErrorKey              `json:"stringKey,omitempty"`
}

SearchFindChaptersAnswer is an object the document declares inline.

type SearchFindChaptersAnswerChapters ¶ added in v0.7.1

type SearchFindChaptersAnswerChapters struct {
	LengthMs       int     `json:"lengthMs,omitempty"`
	StartOffsetMs  int     `json:"startOffsetMs,omitempty"`
	StartOffsetSec float64 `json:"startOffsetSec,omitempty"`
	Title          string  `json:"title,omitempty"`
}

SearchFindChaptersAnswerChapters is an object the document declares inline.

type SearchFindChaptersOptions ¶ added in v0.7.1

type SearchFindChaptersOptions struct {
	Asin   string
	Region string
}

SearchFindChaptersOptions holds the query and header parameters of SearchFindChapters.

func (SearchFindChaptersOptions) ToHeaders ¶ added in v0.7.1

func (o SearchFindChaptersOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (SearchFindChaptersOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SearchFindChaptersResponse ¶ added in v0.7.1

type SearchFindChaptersResponse struct {
	HttpResponse *http.Response
	Answer       *SearchFindChaptersAnswer
	*SearchFindChaptersAnswer
}

SearchFindChaptersResponse is the result of SearchFindChapters.

Answer is the SearchFindChaptersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SearchFindChaptersResponse) Answered ¶ added in v0.7.1

func (r SearchFindChaptersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SearchFindChaptersResponse) Record ¶ added in v0.7.1

Record is the SearchFindChaptersAnswer answered, as a value to change and write back, or an error when the server answered none.

type SearchFindCoversAnswer ¶ added in v0.7.1

type SearchFindCoversAnswer struct {
	Error   any      `json:"error,omitempty"`
	Results []string `json:"results,omitzero"`
}

SearchFindCoversAnswer is an object the document declares inline.

type SearchFindCoversOptions ¶ added in v0.7.1

type SearchFindCoversOptions struct {
	Author   string
	Podcast  string
	Provider string
	Title    string
}

SearchFindCoversOptions holds the query and header parameters of SearchFindCovers.

func (SearchFindCoversOptions) ToHeaders ¶ added in v0.7.1

func (o SearchFindCoversOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (SearchFindCoversOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SearchFindCoversResponse ¶ added in v0.7.1

type SearchFindCoversResponse struct {
	HttpResponse *http.Response
	Answer       *SearchFindCoversAnswer
	*SearchFindCoversAnswer
}

SearchFindCoversResponse is the result of SearchFindCovers.

Answer is the SearchFindCoversAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SearchFindCoversResponse) Answered ¶ added in v0.7.1

func (r SearchFindCoversResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SearchFindCoversResponse) Record ¶ added in v0.7.1

Record is the SearchFindCoversAnswer answered, as a value to change and write back, or an error when the server answered none.

type SearchFindPodcastsAnswer ¶ added in v0.7.1

type SearchFindPodcastsAnswer struct {
	ArtistId         any      `json:"artistId,omitempty"`
	ArtistName       string   `json:"artistName,omitempty"`
	Cover            string   `json:"cover,omitempty"`
	Description      string   `json:"description,omitempty"`
	DescriptionPlain string   `json:"descriptionPlain,omitempty"`
	Explicit         bool     `json:"explicit"`
	FeedUrl          string   `json:"feedUrl,omitempty"`
	Genres           []string `json:"genres,omitzero"`
	Id               int      `json:"id,omitempty"`
	PageUrl          string   `json:"pageUrl,omitempty"`
	ReleaseDate      string   `json:"releaseDate,omitempty"`
	Title            string   `json:"title,omitempty"`
	TrackCount       int      `json:"trackCount,omitempty"`
}

SearchFindPodcastsAnswer is an object the document declares inline.

type SearchFindPodcastsOptions ¶ added in v0.7.1

type SearchFindPodcastsOptions struct {
	Country string
	Term    string
}

SearchFindPodcastsOptions holds the query and header parameters of SearchFindPodcasts.

func (SearchFindPodcastsOptions) ToHeaders ¶ added in v0.7.1

func (o SearchFindPodcastsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (SearchFindPodcastsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SearchFindPodcastsResponse ¶ added in v0.7.1

type SearchFindPodcastsResponse struct {
	HttpResponse *http.Response
	Answer       []SearchFindPodcastsAnswer
}

SearchFindPodcastsResponse is the result of SearchFindPodcasts.

func (SearchFindPodcastsResponse) Answered ¶ added in v0.7.1

func (r SearchFindPodcastsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type SearchGetAllProvidersAnswer ¶ added in v0.7.1

type SearchGetAllProvidersAnswer struct {
	Providers *SearchGetAllProvidersAnswerProviders `json:"providers,omitempty"`
}

SearchGetAllProvidersAnswer is an object the document declares inline.

type SearchGetAllProvidersAnswerProviders ¶ added in v0.7.1

type SearchGetAllProvidersAnswerProviders struct {
	Books       []ProviderOption `json:"books,omitzero"`
	BooksCovers []ProviderOption `json:"booksCovers,omitzero"`
	Podcasts    []ProviderOption `json:"podcasts,omitzero"`
}

SearchGetAllProvidersAnswerProviders is an object the document declares inline.

type SearchGetAllProvidersResponse ¶ added in v0.7.1

type SearchGetAllProvidersResponse struct {
	HttpResponse *http.Response
	Answer       *SearchGetAllProvidersAnswer
	*SearchGetAllProvidersAnswer
}

SearchGetAllProvidersResponse is the result of SearchGetAllProviders.

Answer is the SearchGetAllProvidersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SearchGetAllProvidersResponse) Answered ¶ added in v0.7.1

func (r SearchGetAllProvidersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SearchGetAllProvidersResponse) Record ¶ added in v0.7.1

Record is the SearchGetAllProvidersAnswer answered, as a value to change and write back, or an error when the server answered none.

type Series ¶

type Series struct {
	AddedAt          UnixMilli             `json:"addedAt,omitzero"`
	Books            []LibraryItemMinified `json:"books,omitzero"`
	Description      string                `json:"description,omitempty"`
	Id               SeriesID              `json:"id,omitempty"`
	LibraryId        LibraryID             `json:"libraryId,omitempty"`
	Name             string                `json:"name,omitempty"`
	NameIgnorePrefix string                `json:"nameIgnorePrefix,omitempty"`
	Progress         *SeriesProgress       `json:"progress,omitempty"`
	RssFeed          *FeedMinified         `json:"rssFeed,omitempty"`
	TotalDuration    float64               `json:"totalDuration,omitempty"`
	UpdatedAt        UnixMilli             `json:"updatedAt,omitzero"`
}

Series is the "Series" schema.

func (Series) GetId ¶ added in v0.7.1

func (m Series) GetId() SeriesID

GetId is the record's Id, for code that handles records of several types alike.

func (Series) GetName ¶ added in v0.7.1

func (m Series) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type SeriesFindOneOptions ¶ added in v0.7.1

type SeriesFindOneOptions struct {
	Include string
}

SeriesFindOneOptions holds the query and header parameters of SeriesFindOne.

func (SeriesFindOneOptions) ToHeaders ¶ added in v0.7.1

func (o SeriesFindOneOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (SeriesFindOneOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SeriesFindOneResponse ¶ added in v0.7.1

type SeriesFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *Series
	*Series
}

SeriesFindOneResponse is the result of SeriesFindOne.

Answer is the Series answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SeriesFindOneResponse) Answered ¶ added in v0.7.1

func (r SeriesFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SeriesFindOneResponse) Record ¶ added in v0.7.1

func (r SeriesFindOneResponse) Record() (Series, error)

Record is the Series answered, as a value to change and write back, or an error when the server answered none.

type SeriesID ¶ added in v0.7.1

type SeriesID string

SeriesID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and SeriesID(n) convert one value, client.StringIDs a list.

type SeriesMinimal ¶ added in v0.7.1

type SeriesMinimal struct {
	Id       SeriesID `json:"id,omitempty"`
	Name     string   `json:"name,omitempty"`
	Sequence string   `json:"sequence,omitempty"`
}

SeriesMinimal is the "SeriesMinimal" schema.

func (SeriesMinimal) GetId ¶ added in v0.7.1

func (m SeriesMinimal) GetId() SeriesID

GetId is the record's Id, for code that handles records of several types alike.

func (SeriesMinimal) GetName ¶ added in v0.7.1

func (m SeriesMinimal) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type SeriesProgress ¶

type SeriesProgress struct {
	IsFinished             bool            `json:"isFinished"`
	LibraryItemIds         []LibraryItemID `json:"libraryItemIds,omitzero"`
	LibraryItemIdsFinished []string        `json:"libraryItemIdsFinished,omitzero"`
}

SeriesProgress is an object the document declares inline.

type SeriesShelf ¶ added in v0.7.1

type SeriesShelf struct {
	Entities       []Series      `json:"entities,omitzero"`
	Id             ShelfID       `json:"id,omitempty"`
	Label          string        `json:"label,omitempty"`
	LabelStringKey ShelfLabelKey `json:"labelStringKey,omitempty"`
	Total          float64       `json:"total,omitempty"`
	Type           ShelfType     `json:"type,omitempty"`
}

SeriesShelf is the "SeriesShelf" schema.

type SeriesUpdateRequest ¶ added in v0.7.1

type SeriesUpdateRequest struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
}

SeriesUpdateRequest is an object the document declares inline.

type SeriesUpdateResponse ¶ added in v0.7.1

type SeriesUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *Series
	*Series
}

SeriesUpdateResponse is the result of SeriesUpdate.

Answer is the Series answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SeriesUpdateResponse) Answered ¶ added in v0.7.1

func (r SeriesUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SeriesUpdateResponse) Record ¶ added in v0.7.1

func (r SeriesUpdateResponse) Record() (Series, error)

Record is the Series answered, as a value to change and write back, or an error when the server answered none.

type ServerGetFeedResponse ¶ added in v0.7.1

type ServerGetFeedResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ServerGetFeedResponse is the result of ServerGetFeed.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ServerGetFeedResponse) Answered ¶ added in v0.7.1

func (r ServerGetFeedResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ServerGetHealthcheckResponse ¶ added in v0.7.1

type ServerGetHealthcheckResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ServerGetHealthcheckResponse is the result of ServerGetHealthcheck.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ServerGetHealthcheckResponse) Answered ¶ added in v0.7.1

func (r ServerGetHealthcheckResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ServerGetPingAnswer ¶ added in v0.7.1

type ServerGetPingAnswer struct {
	Success bool `json:"success"`
}

ServerGetPingAnswer is an object the document declares inline.

type ServerGetPingResponse ¶ added in v0.7.1

type ServerGetPingResponse struct {
	HttpResponse *http.Response
	Answer       *ServerGetPingAnswer
	*ServerGetPingAnswer
}

ServerGetPingResponse is the result of ServerGetPing.

Answer is the ServerGetPingAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ServerGetPingResponse) Answered ¶ added in v0.7.1

func (r ServerGetPingResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ServerGetPingResponse) Record ¶ added in v0.7.1

Record is the ServerGetPingAnswer answered, as a value to change and write back, or an error when the server answered none.

type ServerGetStatusAnswer ¶ added in v0.7.1

type ServerGetStatusAnswer struct {
	ConfigPath    any                                `json:"ConfigPath,omitempty"`
	MetadataPath  any                                `json:"MetadataPath,omitempty"`
	App           string                             `json:"app,omitempty"`
	AuthFormData  *ServerGetStatusAnswerAuthFormData `json:"authFormData,omitempty"`
	AuthMethods   []string                           `json:"authMethods,omitzero"`
	IsInit        bool                               `json:"isInit"`
	Language      string                             `json:"language,omitempty"`
	ServerVersion string                             `json:"serverVersion,omitempty"`
}

ServerGetStatusAnswer is an object the document declares inline.

type ServerGetStatusAnswerAuthFormData ¶ added in v0.7.1

type ServerGetStatusAnswerAuthFormData struct {
	AuthLoginCustomMessage string `json:"authLoginCustomMessage,omitempty"`
	AuthOpenIDAutoLaunch   bool   `json:"authOpenIDAutoLaunch"`
	AuthOpenIDButtonText   string `json:"authOpenIDButtonText,omitempty"`
}

ServerGetStatusAnswerAuthFormData is an object the document declares inline.

type ServerGetStatusResponse ¶ added in v0.7.1

type ServerGetStatusResponse struct {
	HttpResponse *http.Response
	Answer       *ServerGetStatusAnswer
	*ServerGetStatusAnswer
}

ServerGetStatusResponse is the result of ServerGetStatus.

Answer is the ServerGetStatusAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ServerGetStatusResponse) Answered ¶ added in v0.7.1

func (r ServerGetStatusResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ServerGetStatusResponse) Record ¶ added in v0.7.1

Record is the ServerGetStatusAnswer answered, as a value to change and write back, or an error when the server answered none.

type ServerPostInitRequest ¶ added in v0.7.1

type ServerPostInitRequest struct {
	NewRoot any `json:"newRoot,omitempty"`
}

ServerPostInitRequest is an object the document declares inline.

type ServerPostInitResponse ¶ added in v0.7.1

type ServerPostInitResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ServerPostInitResponse is the result of ServerPostInit.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ServerPostInitResponse) Answered ¶ added in v0.7.1

func (r ServerPostInitResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ServerSettings ¶ added in v0.7.1

type ServerSettings struct {
	AllowIframe                        bool     `json:"allowIframe"`
	AllowedOrigins                     []any    `json:"allowedOrigins,omitzero"`
	AuthActiveAuthMethods              []string `json:"authActiveAuthMethods,omitzero"`
	AuthLoginCustomMessage             string   `json:"authLoginCustomMessage,omitempty"`
	AuthOpenIDAdvancedPermsClaim       string   `json:"authOpenIDAdvancedPermsClaim,omitempty"`
	AuthOpenIDAuthorizationURL         any      `json:"authOpenIDAuthorizationURL,omitempty"`
	AuthOpenIDAutoLaunch               bool     `json:"authOpenIDAutoLaunch"`
	AuthOpenIDAutoRegister             bool     `json:"authOpenIDAutoRegister"`
	AuthOpenIDButtonText               string   `json:"authOpenIDButtonText,omitempty"`
	AuthOpenIDClientID                 any      `json:"authOpenIDClientID,omitempty"`
	AuthOpenIDClientSecret             any      `json:"authOpenIDClientSecret,omitempty"`
	AuthOpenIDGroupClaim               string   `json:"authOpenIDGroupClaim,omitempty"`
	AuthOpenIDIssuerURL                any      `json:"authOpenIDIssuerURL,omitempty"`
	AuthOpenIDJwksURL                  any      `json:"authOpenIDJwksURL,omitempty"`
	AuthOpenIDLogoutURL                any      `json:"authOpenIDLogoutURL,omitempty"`
	AuthOpenIDMatchExistingBy          any      `json:"authOpenIDMatchExistingBy,omitempty"`
	AuthOpenIDMobileRedirectURIs       []string `json:"authOpenIDMobileRedirectURIs,omitzero"`
	AuthOpenIDSubfolderForRedirectURLs any      `json:"authOpenIDSubfolderForRedirectURLs,omitempty"`
	AuthOpenIDTokenSigningAlgorithm    string   `json:"authOpenIDTokenSigningAlgorithm,omitempty"`
	AuthOpenIDTokenURL                 any      `json:"authOpenIDTokenURL,omitempty"`
	AuthOpenIDUserInfoURL              any      `json:"authOpenIDUserInfoURL,omitempty"`
	BackupPath                         string   `json:"backupPath,omitempty"`
	BackupSchedule                     bool     `json:"backupSchedule"`
	BackupsToKeep                      float64  `json:"backupsToKeep,omitempty"`
	BookshelfView                      float64  `json:"bookshelfView,omitempty"`
	BuildNumber                        float64  `json:"buildNumber,omitempty"`
	ChromecastEnabled                  bool     `json:"chromecastEnabled"`
	DateFormat                         string   `json:"dateFormat,omitempty"`
	HomeBookshelfView                  float64  `json:"homeBookshelfView,omitempty"`
	Id                                 string   `json:"id,omitempty"`
	Language                           string   `json:"language,omitempty"`
	LogLevel                           float64  `json:"logLevel,omitempty"`
	LoggerDailyLogsToKeep              float64  `json:"loggerDailyLogsToKeep,omitempty"`
	LoggerScannerLogsToKeep            float64  `json:"loggerScannerLogsToKeep,omitempty"`
	MaxBackupSize                      float64  `json:"maxBackupSize,omitempty"`
	MetadataFileFormat                 string   `json:"metadataFileFormat,omitempty"`
	PodcastEpisodeSchedule             string   `json:"podcastEpisodeSchedule,omitempty"`
	RateLimitLoginRequests             float64  `json:"rateLimitLoginRequests,omitempty"`
	RateLimitLoginWindow               float64  `json:"rateLimitLoginWindow,omitempty"`
	ScannerCoverProvider               string   `json:"scannerCoverProvider,omitempty"`
	ScannerDisableWatcher              bool     `json:"scannerDisableWatcher"`
	ScannerFindCovers                  bool     `json:"scannerFindCovers"`
	ScannerParseSubtitle               bool     `json:"scannerParseSubtitle"`
	ScannerPreferMatchedMetadata       bool     `json:"scannerPreferMatchedMetadata"`
	SortingIgnorePrefix                bool     `json:"sortingIgnorePrefix"`
	SortingPrefixes                    []string `json:"sortingPrefixes,omitzero"`
	StoreCoverWithItem                 bool     `json:"storeCoverWithItem"`
	StoreMetadataWithItem              bool     `json:"storeMetadataWithItem"`
	TimeFormat                         string   `json:"timeFormat,omitempty"`
	TimeZone                           string   `json:"timeZone,omitempty"`
	TokenSecret                        any      `json:"tokenSecret,omitempty"`
	Version                            string   `json:"version,omitempty"`
}

ServerSettings is the "ServerSettings" schema.

type SessionBatchDeleteRequest ¶ added in v0.7.1

type SessionBatchDeleteRequest struct {
	Sessions []string `json:"sessions,omitzero"`
}

SessionBatchDeleteRequest is an object the document declares inline.

type SessionBatchDeleteResponse ¶ added in v0.7.1

type SessionBatchDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

SessionBatchDeleteResponse is the result of SessionBatchDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (SessionBatchDeleteResponse) Answered ¶ added in v0.7.1

func (r SessionBatchDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type SessionCloseRequest ¶ added in v0.7.1

type SessionCloseRequest struct {
	CurrentTime  float64 `json:"currentTime,omitempty"`
	TimeListened float64 `json:"timeListened,omitempty"`
}

SessionCloseRequest is an object the document declares inline.

type SessionCloseResponse ¶ added in v0.7.1

type SessionCloseResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

SessionCloseResponse is the result of SessionClose.

The operation answers text (text/plain), which Answer holds as it was sent.

func (SessionCloseResponse) Answered ¶ added in v0.7.1

func (r SessionCloseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type SessionDeleteResponse ¶ added in v0.7.1

type SessionDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

SessionDeleteResponse is the result of SessionDelete.

The operation answers text (text/plain), which Answer holds as it was sent.

func (SessionDeleteResponse) Answered ¶ added in v0.7.1

func (r SessionDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type SessionGetAllWithUserDataAnswer ¶ added in v0.7.1

type SessionGetAllWithUserDataAnswer struct {
	ItemsPerPage float64                    `json:"itemsPerPage,omitempty"`
	NumPages     int                        `json:"numPages,omitempty"`
	Page         float64                    `json:"page,omitempty"`
	Sessions     []PlaybackSessionForClient `json:"sessions,omitzero"`
	Total        int                        `json:"total,omitempty"`
	UserId       UserID                     `json:"userId,omitempty"`
}

SessionGetAllWithUserDataAnswer is an object the document declares inline.

type SessionGetAllWithUserDataCompleteResult ¶ added in v0.7.1

type SessionGetAllWithUserDataCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PlaybackSessionForClient
}

SessionGetAllWithUserDataCompleteResult is every result SessionGetAllWithUserDataComplete loaded.

type SessionGetAllWithUserDataOptions ¶ added in v0.7.1

type SessionGetAllWithUserDataOptions struct {
	Desc         string
	ItemsPerPage *int
	Page         *int
	Sort         SessionSort
	User         string
}

SessionGetAllWithUserDataOptions holds the query and header parameters of SessionGetAllWithUserData.

func (SessionGetAllWithUserDataOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (SessionGetAllWithUserDataOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type SessionGetAllWithUserDataResponse ¶ added in v0.7.1

type SessionGetAllWithUserDataResponse struct {
	HttpResponse *http.Response
	Answer       *SessionGetAllWithUserDataAnswer
	*SessionGetAllWithUserDataAnswer
}

SessionGetAllWithUserDataResponse is the result of SessionGetAllWithUserData.

Answer is the SessionGetAllWithUserDataAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SessionGetAllWithUserDataResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SessionGetAllWithUserDataResponse) Record ¶ added in v0.7.1

Record is the SessionGetAllWithUserDataAnswer answered, as a value to change and write back, or an error when the server answered none.

type SessionGetOpenSessionResponse ¶ added in v0.7.1

type SessionGetOpenSessionResponse struct {
	HttpResponse *http.Response
	Answer       *PlaybackSessionForClient
	*PlaybackSessionForClient
}

SessionGetOpenSessionResponse is the result of SessionGetOpenSession.

Answer is the PlaybackSessionForClient answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SessionGetOpenSessionResponse) Answered ¶ added in v0.7.1

func (r SessionGetOpenSessionResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SessionGetOpenSessionResponse) Record ¶ added in v0.7.1

Record is the PlaybackSessionForClient answered, as a value to change and write back, or an error when the server answered none.

type SessionGetOpenSessionsAnswer ¶ added in v0.7.1

type SessionGetOpenSessionsAnswer struct {
	Sessions      []PlaybackSession `json:"sessions,omitzero"`
	ShareSessions []PlaybackSession `json:"shareSessions,omitzero"`
}

SessionGetOpenSessionsAnswer is an object the document declares inline.

type SessionGetOpenSessionsResponse ¶ added in v0.7.1

type SessionGetOpenSessionsResponse struct {
	HttpResponse *http.Response
	Answer       *SessionGetOpenSessionsAnswer
	*SessionGetOpenSessionsAnswer
}

SessionGetOpenSessionsResponse is the result of SessionGetOpenSessions.

Answer is the SessionGetOpenSessionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SessionGetOpenSessionsResponse) Answered ¶ added in v0.7.1

func (r SessionGetOpenSessionsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SessionGetOpenSessionsResponse) Record ¶ added in v0.7.1

Record is the SessionGetOpenSessionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type SessionGetTrackResponse ¶ added in v0.7.1

type SessionGetTrackResponse struct {
	HttpResponse *http.Response
}

SessionGetTrackResponse is the result of SessionGetTrack.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (SessionGetTrackResponse) Bytes ¶ added in v0.7.1

func (r SessionGetTrackResponse) Bytes(limit int64) ([]byte, error)

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (SessionGetTrackResponse) ContentLength ¶ added in v0.7.1

func (r SessionGetTrackResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (SessionGetTrackResponse) Filename ¶ added in v0.7.1

func (r SessionGetTrackResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (SessionGetTrackResponse) Reader ¶ added in v0.7.1

func (r SessionGetTrackResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (SessionGetTrackResponse) WriteTo ¶ added in v0.7.1

func (r SessionGetTrackResponse) WriteTo(w io.Writer) (int64, error)

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type SessionSort ¶ added in v0.7.1

type SessionSort string

SessionSort is the "SessionSort" enum.

const (
	SessionSortCreatedAt     SessionSort = "createdAt"
	SessionSortCurrentTime   SessionSort = "currentTime"
	SessionSortDisplayTitle  SessionSort = "displayTitle"
	SessionSortDuration      SessionSort = "duration"
	SessionSortPlayMethod    SessionSort = "playMethod"
	SessionSortStartTime     SessionSort = "startTime"
	SessionSortTimeListening SessionSort = "timeListening"
	SessionSortUpdatedAt     SessionSort = "updatedAt"
)

Values of SessionSort.

func (SessionSort) Known ¶ added in v0.7.1

func (v SessionSort) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type SessionSyncLocalRequest ¶ added in v0.7.1

type SessionSyncLocalRequest struct {
	BookId        any       `json:"bookId,omitempty"`
	CurrentTime   float64   `json:"currentTime,omitempty"`
	Date          string    `json:"date,omitempty"`
	DayOfWeek     string    `json:"dayOfWeek,omitempty"`
	DeviceInfo    any       `json:"deviceInfo,omitempty"`
	DisplayAuthor string    `json:"displayAuthor,omitempty"`
	DisplayTitle  string    `json:"displayTitle,omitempty"`
	Duration      float64   `json:"duration,omitempty"`
	EpisodeId     any       `json:"episodeId,omitempty"`
	Id            string    `json:"id,omitempty"`
	LibraryId     string    `json:"libraryId,omitempty"`
	LibraryItemId string    `json:"libraryItemId,omitempty"`
	MediaPlayer   string    `json:"mediaPlayer,omitempty"`
	MediaType     string    `json:"mediaType,omitempty"`
	PlayMethod    int       `json:"playMethod,omitempty"`
	ServerVersion any       `json:"serverVersion,omitempty"`
	StartTime     float64   `json:"startTime,omitempty"`
	StartedAt     UnixMilli `json:"startedAt,omitzero"`
	TimeListening float64   `json:"timeListening,omitempty"`
	UpdatedAt     UnixMilli `json:"updatedAt,omitzero"`
	UserId        any       `json:"userId,omitempty"`
}

SessionSyncLocalRequest is an object the document declares inline.

type SessionSyncLocalResponse ¶ added in v0.7.1

type SessionSyncLocalResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

SessionSyncLocalResponse is the result of SessionSyncLocal.

The operation answers text (text/plain), which Answer holds as it was sent.

func (SessionSyncLocalResponse) Answered ¶ added in v0.7.1

func (r SessionSyncLocalResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type SessionSyncLocalSessionsAnswer ¶ added in v0.7.1

type SessionSyncLocalSessionsAnswer struct {
	Results []SessionSyncLocalSessionsAnswerResults `json:"results,omitzero"`
}

SessionSyncLocalSessionsAnswer is an object the document declares inline.

type SessionSyncLocalSessionsAnswerResults ¶ added in v0.7.1

type SessionSyncLocalSessionsAnswerResults struct {
	Error          string `json:"error,omitempty"`
	Id             any    `json:"id,omitempty"`
	ProgressSynced bool   `json:"progressSynced"`
	Success        bool   `json:"success"`
}

SessionSyncLocalSessionsAnswerResults is an object the document declares inline.

type SessionSyncLocalSessionsRequest ¶ added in v0.7.1

type SessionSyncLocalSessionsRequest struct {
	DeviceInfo any              `json:"deviceInfo,omitempty"`
	Sessions   []map[string]any `json:"sessions,omitzero"`
}

SessionSyncLocalSessionsRequest is an object the document declares inline.

type SessionSyncLocalSessionsResponse ¶ added in v0.7.1

type SessionSyncLocalSessionsResponse struct {
	HttpResponse *http.Response
	Answer       *SessionSyncLocalSessionsAnswer
	*SessionSyncLocalSessionsAnswer
}

SessionSyncLocalSessionsResponse is the result of SessionSyncLocalSessions.

Answer is the SessionSyncLocalSessionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (SessionSyncLocalSessionsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (SessionSyncLocalSessionsResponse) Record ¶ added in v0.7.1

Record is the SessionSyncLocalSessionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type SessionSyncRequest ¶ added in v0.7.1

type SessionSyncRequest struct {
	CurrentTime  float64 `json:"currentTime,omitempty"`
	TimeListened float64 `json:"timeListened,omitempty"`
}

SessionSyncRequest is an object the document declares inline.

type SessionSyncResponse ¶ added in v0.7.1

type SessionSyncResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

SessionSyncResponse is the result of SessionSync.

The operation answers text (text/plain), which Answer holds as it was sent.

func (SessionSyncResponse) Answered ¶ added in v0.7.1

func (r SessionSyncResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ShareCreateMediaItemShareRequest ¶ added in v0.7.1

type ShareCreateMediaItemShareRequest struct {
	ExpiresAt      int           `json:"expiresAt"`
	IsDownloadable *bool         `json:"isDownloadable,omitempty"`
	MediaItemId    string        `json:"mediaItemId"`
	MediaItemType  MediaItemType `json:"mediaItemType"`
	Slug           string        `json:"slug"`
}

ShareCreateMediaItemShareRequest is an object the document declares inline.

type ShareCreateMediaItemShareResponse ¶ added in v0.7.1

type ShareCreateMediaItemShareResponse struct {
	HttpResponse *http.Response
	Answer       *MediaItemShareForClient
	*MediaItemShareForClient
}

ShareCreateMediaItemShareResponse is the result of ShareCreateMediaItemShare.

Answer is the MediaItemShareForClient answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ShareCreateMediaItemShareResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ShareCreateMediaItemShareResponse) Record ¶ added in v0.7.1

Record is the MediaItemShareForClient answered, as a value to change and write back, or an error when the server answered none.

type ShareDeleteMediaItemShareResponse ¶ added in v0.7.1

type ShareDeleteMediaItemShareResponse struct {
	HttpResponse *http.Response
}

ShareDeleteMediaItemShareResponse is the result of ShareDeleteMediaItemShare.

type ShareDownloadMediaItemShareResponse ¶ added in v0.7.1

type ShareDownloadMediaItemShareResponse struct {
	HttpResponse *http.Response
}

ShareDownloadMediaItemShareResponse is the result of ShareDownloadMediaItemShare.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (ShareDownloadMediaItemShareResponse) Bytes ¶ added in v0.7.1

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (ShareDownloadMediaItemShareResponse) ContentLength ¶ added in v0.7.1

func (r ShareDownloadMediaItemShareResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (ShareDownloadMediaItemShareResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (ShareDownloadMediaItemShareResponse) Reader ¶ added in v0.7.1

func (r ShareDownloadMediaItemShareResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (ShareDownloadMediaItemShareResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type ShareGetMediaItemShareAudioTrackResponse ¶ added in v0.7.1

type ShareGetMediaItemShareAudioTrackResponse struct {
	HttpResponse *http.Response
}

ShareGetMediaItemShareAudioTrackResponse is the result of ShareGetMediaItemShareAudioTrack.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (ShareGetMediaItemShareAudioTrackResponse) Bytes ¶ added in v0.7.1

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (ShareGetMediaItemShareAudioTrackResponse) ContentLength ¶ added in v0.7.1

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (ShareGetMediaItemShareAudioTrackResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (ShareGetMediaItemShareAudioTrackResponse) Reader ¶ added in v0.7.1

func (r ShareGetMediaItemShareAudioTrackResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (ShareGetMediaItemShareAudioTrackResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type ShareGetMediaItemShareBySlugOptions ¶ added in v0.7.1

type ShareGetMediaItemShareBySlugOptions struct {
	T *int
}

ShareGetMediaItemShareBySlugOptions holds the query and header parameters of ShareGetMediaItemShareBySlug.

func (ShareGetMediaItemShareBySlugOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (ShareGetMediaItemShareBySlugOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type ShareGetMediaItemShareBySlugResponse ¶ added in v0.7.1

type ShareGetMediaItemShareBySlugResponse struct {
	HttpResponse *http.Response
	Answer       *MediaItemShareForClient
	*MediaItemShareForClient
}

ShareGetMediaItemShareBySlugResponse is the result of ShareGetMediaItemShareBySlug.

Answer is the MediaItemShareForClient answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (ShareGetMediaItemShareBySlugResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (ShareGetMediaItemShareBySlugResponse) Record ¶ added in v0.7.1

Record is the MediaItemShareForClient answered, as a value to change and write back, or an error when the server answered none.

type ShareGetMediaItemShareCoverImageResponse ¶ added in v0.7.1

type ShareGetMediaItemShareCoverImageResponse struct {
	HttpResponse *http.Response
}

ShareGetMediaItemShareCoverImageResponse is the result of ShareGetMediaItemShareCoverImage.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (ShareGetMediaItemShareCoverImageResponse) Bytes ¶ added in v0.7.1

Bytes reads the file whole, up to limit bytes, and closes the body: a file over the limit is a client.TooLargeError rather than cut short without a word.

func (ShareGetMediaItemShareCoverImageResponse) ContentLength ¶ added in v0.7.1

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (ShareGetMediaItemShareCoverImageResponse) Filename ¶ added in v0.7.1

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (ShareGetMediaItemShareCoverImageResponse) Reader ¶ added in v0.7.1

func (r ShareGetMediaItemShareCoverImageResponse) Reader() (body io.ReadCloser, contentType string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (ShareGetMediaItemShareCoverImageResponse) WriteTo ¶ added in v0.7.1

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type ShareUpdateMediaItemShareProgressRequest ¶ added in v0.7.1

type ShareUpdateMediaItemShareProgressRequest struct {
	CurrentTime any `json:"currentTime,omitempty"`
}

ShareUpdateMediaItemShareProgressRequest is an object the document declares inline.

type ShareUpdateMediaItemShareProgressResponse ¶ added in v0.7.1

type ShareUpdateMediaItemShareProgressResponse struct {
	HttpResponse *http.Response
}

ShareUpdateMediaItemShareProgressResponse is the result of ShareUpdateMediaItemShareProgress.

type Shelf ¶

type Shelf struct {
	client.Union
}

Shelf is one of several records, held as it came: ItemShelf (type "book", "episode", "podcast"), SeriesShelf (type "series"), AuthorShelf (type "authors"). Kind is the "type" the record names itself by, and each As method hands the record over as that member, or an error for a record of another kind. One is built from a member with client.UnionOf.

func (Shelf) AsAuthorShelf ¶ added in v0.7.1

func (u Shelf) AsAuthorShelf() (AuthorShelf, error)

AsAuthorShelf hands the record over as a AuthorShelf.

func (Shelf) AsItemShelf ¶ added in v0.7.1

func (u Shelf) AsItemShelf() (ItemShelf, error)

AsItemShelf hands the record over as a ItemShelf.

func (Shelf) AsSeriesShelf ¶ added in v0.7.1

func (u Shelf) AsSeriesShelf() (SeriesShelf, error)

AsSeriesShelf hands the record over as a SeriesShelf.

func (Shelf) Kind ¶ added in v0.7.1

func (u Shelf) Kind() string

Kind is the "type" the record names itself by, "" for a union holding nothing.

type ShelfID ¶ added in v0.7.1

type ShelfID string

ShelfID is the "ShelfID" enum.

const (
	ShelfIDContinueListening ShelfID = "continue-listening"
	ShelfIDContinueReading   ShelfID = "continue-reading"
	ShelfIDContinueSeries    ShelfID = "continue-series"
	ShelfIDDiscover          ShelfID = "discover"
	ShelfIDListenAgain       ShelfID = "listen-again"
	ShelfIDNewestAuthors     ShelfID = "newest-authors"
	ShelfIDNewestEpisodes    ShelfID = "newest-episodes"
	ShelfIDReadAgain         ShelfID = "read-again"
	ShelfIDRecentSeries      ShelfID = "recent-series"
	ShelfIDRecentlyAdded     ShelfID = "recently-added"
)

Values of ShelfID.

func (ShelfID) Known ¶ added in v0.7.1

func (v ShelfID) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type ShelfLabelKey ¶ added in v0.7.1

type ShelfLabelKey string

ShelfLabelKey is the "ShelfLabelKey" enum.

const (
	ShelfLabelKeyLabelContinueListening ShelfLabelKey = "LabelContinueListening"
	ShelfLabelKeyLabelContinueReading   ShelfLabelKey = "LabelContinueReading"
	ShelfLabelKeyLabelContinueSeries    ShelfLabelKey = "LabelContinueSeries"
	ShelfLabelKeyLabelDiscover          ShelfLabelKey = "LabelDiscover"
	ShelfLabelKeyLabelListenAgain       ShelfLabelKey = "LabelListenAgain"
	ShelfLabelKeyLabelNewestAuthors     ShelfLabelKey = "LabelNewestAuthors"
	ShelfLabelKeyLabelNewestEpisodes    ShelfLabelKey = "LabelNewestEpisodes"
	ShelfLabelKeyLabelReadAgain         ShelfLabelKey = "LabelReadAgain"
	ShelfLabelKeyLabelRecentSeries      ShelfLabelKey = "LabelRecentSeries"
	ShelfLabelKeyLabelRecentlyAdded     ShelfLabelKey = "LabelRecentlyAdded"
)

Values of ShelfLabelKey.

func (ShelfLabelKey) Known ¶ added in v0.7.1

func (v ShelfLabelKey) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type ShelfType ¶ added in v0.7.1

type ShelfType string

ShelfType is the "ShelfType" enum.

const (
	ShelfTypeAuthors ShelfType = "authors"
	ShelfTypeBook    ShelfType = "book"
	ShelfTypeEpisode ShelfType = "episode"
	ShelfTypePodcast ShelfType = "podcast"
	ShelfTypeSeries  ShelfType = "series"
)

Values of ShelfType.

func (ShelfType) Known ¶ added in v0.7.1

func (v ShelfType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type StatsGetAdminStatsForYearAnswer ¶ added in v0.7.1

type StatsGetAdminStatsForYearAnswer struct {
	BooksAddedWithCovers    []string                                      `json:"booksAddedWithCovers,omitzero"`
	NumAuthorsAdded         int                                           `json:"numAuthorsAdded,omitempty"`
	NumBooks                float64                                       `json:"numBooks,omitempty"`
	NumBooksAdded           int                                           `json:"numBooksAdded,omitempty"`
	NumListeningSessions    int                                           `json:"numListeningSessions,omitempty"`
	TopAuthors              []StatsGetAdminStatsForYearAnswerTopAuthors   `json:"topAuthors,omitzero"`
	TopGenres               []StatsGetAdminStatsForYearAnswerTopGenres    `json:"topGenres,omitzero"`
	TopNarrators            []StatsGetAdminStatsForYearAnswerTopNarrators `json:"topNarrators,omitzero"`
	TotalBooksAddedDuration int                                           `json:"totalBooksAddedDuration,omitempty"`
	TotalBooksAddedSize     float64                                       `json:"totalBooksAddedSize,omitempty"`
	TotalBooksDuration      float64                                       `json:"totalBooksDuration,omitempty"`
	TotalBooksSize          float64                                       `json:"totalBooksSize,omitempty"`
	TotalListeningTime      float64                                       `json:"totalListeningTime,omitempty"`
}

StatsGetAdminStatsForYearAnswer is an object the document declares inline.

type StatsGetAdminStatsForYearAnswerTopAuthors ¶ added in v0.7.1

type StatsGetAdminStatsForYearAnswerTopAuthors struct {
	Name string `json:"name,omitempty"`
	Time int    `json:"time,omitempty"`
}

StatsGetAdminStatsForYearAnswerTopAuthors is an object the document declares inline.

type StatsGetAdminStatsForYearAnswerTopGenres ¶ added in v0.7.1

type StatsGetAdminStatsForYearAnswerTopGenres struct {
	Genre string `json:"genre,omitempty"`
	Time  int    `json:"time,omitempty"`
}

StatsGetAdminStatsForYearAnswerTopGenres is an object the document declares inline.

type StatsGetAdminStatsForYearAnswerTopNarrators ¶ added in v0.7.1

type StatsGetAdminStatsForYearAnswerTopNarrators struct {
	Name string `json:"name,omitempty"`
	Time int    `json:"time,omitempty"`
}

StatsGetAdminStatsForYearAnswerTopNarrators is an object the document declares inline.

type StatsGetAdminStatsForYearResponse ¶ added in v0.7.1

type StatsGetAdminStatsForYearResponse struct {
	HttpResponse *http.Response
	Answer       *StatsGetAdminStatsForYearAnswer
	*StatsGetAdminStatsForYearAnswer
}

StatsGetAdminStatsForYearResponse is the result of StatsGetAdminStatsForYear.

Answer is the StatsGetAdminStatsForYearAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (StatsGetAdminStatsForYearResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (StatsGetAdminStatsForYearResponse) Record ¶ added in v0.7.1

Record is the StatsGetAdminStatsForYearAnswer answered, as a value to change and write back, or an error when the server answered none.

type StatsGetServerStatsAnswer ¶ added in v0.7.1

type StatsGetServerStatsAnswer struct {
	Books    *StatsGetServerStatsAnswerBooks    `json:"books,omitempty"`
	Podcasts *StatsGetServerStatsAnswerPodcasts `json:"podcasts,omitempty"`
	Total    *StatsGetServerStatsAnswerTotal    `json:"total,omitempty"`
}

StatsGetServerStatsAnswer is an object the document declares inline.

type StatsGetServerStatsAnswerBooks ¶ added in v0.7.1

type StatsGetServerStatsAnswerBooks struct {
	NumAudioFiles float64 `json:"numAudioFiles,omitempty"`
	NumItems      float64 `json:"numItems,omitempty"`
	TotalSize     float64 `json:"totalSize,omitempty"`
}

StatsGetServerStatsAnswerBooks is an object the document declares inline.

type StatsGetServerStatsAnswerPodcasts ¶ added in v0.7.1

type StatsGetServerStatsAnswerPodcasts struct {
	NumAudioFiles int     `json:"numAudioFiles,omitempty"`
	NumItems      float64 `json:"numItems,omitempty"`
	TotalSize     float64 `json:"totalSize,omitempty"`
}

StatsGetServerStatsAnswerPodcasts is an object the document declares inline.

type StatsGetServerStatsAnswerTotal ¶ added in v0.7.1

type StatsGetServerStatsAnswerTotal struct {
	NumAudioFiles float64 `json:"numAudioFiles,omitempty"`
	NumItems      float64 `json:"numItems,omitempty"`
	TotalSize     float64 `json:"totalSize,omitempty"`
}

StatsGetServerStatsAnswerTotal is an object the document declares inline.

type StatsGetServerStatsResponse ¶ added in v0.7.1

type StatsGetServerStatsResponse struct {
	HttpResponse *http.Response
	Answer       *StatsGetServerStatsAnswer
	*StatsGetServerStatsAnswer
}

StatsGetServerStatsResponse is the result of StatsGetServerStats.

Answer is the StatsGetServerStatsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (StatsGetServerStatsResponse) Answered ¶ added in v0.7.1

func (r StatsGetServerStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (StatsGetServerStatsResponse) Record ¶ added in v0.7.1

Record is the StatsGetServerStatsAnswer answered, as a value to change and write back, or an error when the server answered none.

type TextOrNumber ¶ added in v0.7.1

type TextOrNumber string

TextOrNumber is text the server passes on from elsewhere as it came, which may be a number: FantLab's year for a book in a provider search. It reads either as text, a number as it was written, and writes as text.

func (*TextOrNumber) UnmarshalJSON ¶ added in v0.7.1

func (t *TextOrNumber) UnmarshalJSON(data []byte) error

UnmarshalJSON reads text, a number as its digits, and null as empty.

type ToolsBatchEmbedMetadataOptions ¶ added in v0.7.1

type ToolsBatchEmbedMetadataOptions struct {
	Backup             string
	ForceEmbedChapters string
}

ToolsBatchEmbedMetadataOptions holds the query and header parameters of ToolsBatchEmbedMetadata.

func (ToolsBatchEmbedMetadataOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (ToolsBatchEmbedMetadataOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type ToolsBatchEmbedMetadataRequest ¶ added in v0.7.1

type ToolsBatchEmbedMetadataRequest struct {
	LibraryItemIds []LibraryItemID `json:"libraryItemIds,omitzero"`
}

ToolsBatchEmbedMetadataRequest is an object the document declares inline.

type ToolsBatchEmbedMetadataResponse ¶ added in v0.7.1

type ToolsBatchEmbedMetadataResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ToolsBatchEmbedMetadataResponse is the result of ToolsBatchEmbedMetadata.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ToolsBatchEmbedMetadataResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ToolsCancelM4bEncodeResponse ¶ added in v0.7.1

type ToolsCancelM4bEncodeResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ToolsCancelM4bEncodeResponse is the result of ToolsCancelM4bEncode.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ToolsCancelM4bEncodeResponse) Answered ¶ added in v0.7.1

func (r ToolsCancelM4bEncodeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ToolsEmbedAudioFileMetadataOptions ¶ added in v0.7.1

type ToolsEmbedAudioFileMetadataOptions struct {
	Backup             string
	ForceEmbedChapters string
}

ToolsEmbedAudioFileMetadataOptions holds the query and header parameters of ToolsEmbedAudioFileMetadata.

func (ToolsEmbedAudioFileMetadataOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (ToolsEmbedAudioFileMetadataOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type ToolsEmbedAudioFileMetadataResponse ¶ added in v0.7.1

type ToolsEmbedAudioFileMetadataResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ToolsEmbedAudioFileMetadataResponse is the result of ToolsEmbedAudioFileMetadata.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ToolsEmbedAudioFileMetadataResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type ToolsEncodeM4bOptions ¶ added in v0.7.1

type ToolsEncodeM4bOptions struct {
	Bitrate  string
	Channels string
	Codec    string
}

ToolsEncodeM4bOptions holds the query and header parameters of ToolsEncodeM4b.

func (ToolsEncodeM4bOptions) ToHeaders ¶ added in v0.7.1

func (o ToolsEncodeM4bOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (ToolsEncodeM4bOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type ToolsEncodeM4bResponse ¶ added in v0.7.1

type ToolsEncodeM4bResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

ToolsEncodeM4bResponse is the result of ToolsEncodeM4b.

The operation answers text (text/plain), which Answer holds as it was sent.

func (ToolsEncodeM4bResponse) Answered ¶ added in v0.7.1

func (r ToolsEncodeM4bResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type UnixMilli ¶ added in v0.7.1

type UnixMilli struct{ time.Time }

UnixMilli is a date and time Audiobookshelf API writes as milliseconds since 1970: read from a number, or a string of digits, written as a number, and left out of a body or a query when zero, which is what null and 0 read as.

func (UnixMilli) MarshalJSON ¶ added in v0.7.1

func (t UnixMilli) MarshalJSON() ([]byte, error)

MarshalJSON writes the date as milliseconds since 1970, or null when zero.

func (UnixMilli) String ¶ added in v0.7.1

func (t UnixMilli) String() string

String is the date as milliseconds since 1970, which is how a query carries it.

func (*UnixMilli) UnmarshalJSON ¶ added in v0.7.1

func (t *UnixMilli) UnmarshalJSON(data []byte) error

UnmarshalJSON reads a number of milliseconds since 1970; null and 0 are zero.

type UserCreateAnswer ¶ added in v0.7.1

type UserCreateAnswer struct {
	User *UserForBrowser `json:"user,omitempty"`
}

UserCreateAnswer is an object the document declares inline.

type UserCreateRequest ¶ added in v0.7.1

type UserCreateRequest struct {
	Email               string           `json:"email,omitempty"`
	IsActive            *bool            `json:"isActive,omitempty"`
	ItemTagsSelected    []string         `json:"itemTagsSelected,omitzero"`
	LibrariesAccessible []string         `json:"librariesAccessible,omitzero"`
	Password            string           `json:"password,omitempty"`
	Permissions         *UserPermissions `json:"permissions,omitempty"`
	Type                string           `json:"type,omitempty"`
	Username            string           `json:"username,omitempty"`
}

UserCreateRequest is an object the document declares inline.

type UserCreateResponse ¶ added in v0.7.1

type UserCreateResponse struct {
	HttpResponse *http.Response
	Answer       *UserCreateAnswer
	*UserCreateAnswer
}

UserCreateResponse is the result of UserCreate.

Answer is the UserCreateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserCreateResponse) Answered ¶ added in v0.7.1

func (r UserCreateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserCreateResponse) Record ¶ added in v0.7.1

Record is the UserCreateAnswer answered, as a value to change and write back, or an error when the server answered none.

type UserDeleteAnswer ¶ added in v0.7.1

type UserDeleteAnswer struct {
	Success bool `json:"success"`
}

UserDeleteAnswer is an object the document declares inline.

type UserDeleteResponse ¶ added in v0.7.1

type UserDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *UserDeleteAnswer
	*UserDeleteAnswer
}

UserDeleteResponse is the result of UserDelete.

Answer is the UserDeleteAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserDeleteResponse) Answered ¶ added in v0.7.1

func (r UserDeleteResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserDeleteResponse) Record ¶ added in v0.7.1

Record is the UserDeleteAnswer answered, as a value to change and write back, or an error when the server answered none.

type UserFindAllAnswer ¶ added in v0.7.1

type UserFindAllAnswer struct {
	Users []UserForBrowser `json:"users,omitzero"`
}

UserFindAllAnswer is an object the document declares inline.

type UserFindAllOptions ¶ added in v0.7.1

type UserFindAllOptions struct {
	Include string
}

UserFindAllOptions holds the query and header parameters of UserFindAll.

func (UserFindAllOptions) ToHeaders ¶ added in v0.7.1

func (o UserFindAllOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (UserFindAllOptions) ToQuery ¶ added in v0.7.1

func (o UserFindAllOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type UserFindAllResponse ¶ added in v0.7.1

type UserFindAllResponse struct {
	HttpResponse *http.Response
	Answer       *UserFindAllAnswer
	*UserFindAllAnswer
}

UserFindAllResponse is the result of UserFindAll.

Answer is the UserFindAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserFindAllResponse) Answered ¶ added in v0.7.1

func (r UserFindAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserFindAllResponse) Record ¶ added in v0.7.1

Record is the UserFindAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type UserFindOneResponse ¶ added in v0.7.1

type UserFindOneResponse struct {
	HttpResponse *http.Response
	Answer       *UserForBrowser
	*UserForBrowser
}

UserFindOneResponse is the result of UserFindOne.

Answer is the UserForBrowser answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserFindOneResponse) Answered ¶ added in v0.7.1

func (r UserFindOneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserFindOneResponse) Record ¶ added in v0.7.1

Record is the UserForBrowser answered, as a value to change and write back, or an error when the server answered none.

type UserForBrowser ¶ added in v0.7.1

type UserForBrowser struct {
	Bookmarks                       []AudioBookmark  `json:"bookmarks,omitzero"`
	CreatedAt                       UnixMilli        `json:"createdAt,omitzero"`
	Email                           string           `json:"email,omitempty"`
	HasOpenIDLink                   bool             `json:"hasOpenIDLink"`
	Id                              UserID           `json:"id,omitempty"`
	IsActive                        *bool            `json:"isActive,omitempty"`
	IsLocked                        *bool            `json:"isLocked,omitempty"`
	IsOldToken                      any              `json:"isOldToken,omitempty"`
	ItemTagsSelected                []string         `json:"itemTagsSelected,omitzero"`
	LastSeen                        UnixMilli        `json:"lastSeen,omitzero"`
	LatestSession                   *PlaybackSession `json:"latestSession,omitempty"`
	LibrariesAccessible             []string         `json:"librariesAccessible,omitzero"`
	MediaProgress                   []MediaProgress  `json:"mediaProgress,omitzero"`
	Permissions                     *UserPermissions `json:"permissions,omitempty"`
	SeriesHideFromContinueListening []string         `json:"seriesHideFromContinueListening,omitzero"`
	Token                           string           `json:"token,omitempty"`
	Type                            string           `json:"type,omitempty"`
	Username                        string           `json:"username,omitempty"`
}

UserForBrowser is the "UserForBrowser" schema.

type UserGetListeningSessionsAnswer ¶ added in v0.7.1

type UserGetListeningSessionsAnswer struct {
	ItemsPerPage float64                    `json:"itemsPerPage,omitempty"`
	NumPages     int                        `json:"numPages,omitempty"`
	Page         float64                    `json:"page,omitempty"`
	Sessions     []PlaybackSessionForClient `json:"sessions,omitzero"`
	Total        int                        `json:"total,omitempty"`
}

UserGetListeningSessionsAnswer is an object the document declares inline.

type UserGetListeningSessionsCompleteResult ¶ added in v0.7.1

type UserGetListeningSessionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PlaybackSessionForClient
}

UserGetListeningSessionsCompleteResult is every result UserGetListeningSessionsComplete loaded.

type UserGetListeningSessionsOptions ¶ added in v0.7.1

type UserGetListeningSessionsOptions struct {
	ItemsPerPage *int
	Page         *int
}

UserGetListeningSessionsOptions holds the query and header parameters of UserGetListeningSessions.

func (UserGetListeningSessionsOptions) ToHeaders ¶ added in v0.7.1

ToHeaders returns the header parameters the options set.

func (UserGetListeningSessionsOptions) ToQuery ¶ added in v0.7.1

ToQuery returns the query parameters the options set.

type UserGetListeningSessionsResponse ¶ added in v0.7.1

type UserGetListeningSessionsResponse struct {
	HttpResponse *http.Response
	Answer       *UserGetListeningSessionsAnswer
	*UserGetListeningSessionsAnswer
}

UserGetListeningSessionsResponse is the result of UserGetListeningSessions.

Answer is the UserGetListeningSessionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserGetListeningSessionsResponse) Answered ¶ added in v0.7.1

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserGetListeningSessionsResponse) Record ¶ added in v0.7.1

Record is the UserGetListeningSessionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type UserGetListeningStatsResponse ¶ added in v0.7.1

type UserGetListeningStatsResponse struct {
	HttpResponse *http.Response
	Answer       *ListeningStats
	*ListeningStats
}

UserGetListeningStatsResponse is the result of UserGetListeningStats.

Answer is the ListeningStats answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserGetListeningStatsResponse) Answered ¶ added in v0.7.1

func (r UserGetListeningStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserGetListeningStatsResponse) Record ¶ added in v0.7.1

Record is the ListeningStats answered, as a value to change and write back, or an error when the server answered none.

type UserGetOnlineUsersAnswer ¶ added in v0.7.1

type UserGetOnlineUsersAnswer struct {
	OpenSessions []PlaybackSession                     `json:"openSessions,omitzero"`
	UsersOnline  []UserGetOnlineUsersAnswerUsersOnline `json:"usersOnline,omitzero"`
}

UserGetOnlineUsersAnswer is an object the document declares inline.

type UserGetOnlineUsersAnswerUsersOnline ¶ added in v0.7.1

type UserGetOnlineUsersAnswerUsersOnline struct {
	Connections int                       `json:"connections,omitempty"`
	CreatedAt   UnixMilli                 `json:"createdAt,omitzero"`
	Id          string                    `json:"id,omitempty"`
	LastSeen    UnixMilli                 `json:"lastSeen,omitzero"`
	Session     *PlaybackSessionForClient `json:"session,omitempty"`
	Type        string                    `json:"type,omitempty"`
	Username    string                    `json:"username,omitempty"`
}

UserGetOnlineUsersAnswerUsersOnline is an object the document declares inline.

type UserGetOnlineUsersResponse ¶ added in v0.7.1

type UserGetOnlineUsersResponse struct {
	HttpResponse *http.Response
	Answer       *UserGetOnlineUsersAnswer
	*UserGetOnlineUsersAnswer
}

UserGetOnlineUsersResponse is the result of UserGetOnlineUsers.

Answer is the UserGetOnlineUsersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserGetOnlineUsersResponse) Answered ¶ added in v0.7.1

func (r UserGetOnlineUsersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserGetOnlineUsersResponse) Record ¶ added in v0.7.1

Record is the UserGetOnlineUsersAnswer answered, as a value to change and write back, or an error when the server answered none.

type UserID ¶ added in v0.7.1

type UserID string

UserID is a kind of id the service tells apart, which the compiler keeps from every other kind; string(id) and UserID(n) convert one value, client.StringIDs a list.

type UserPermissions ¶ added in v0.7.1

type UserPermissions struct {
	AccessAllLibraries        *bool `json:"accessAllLibraries,omitempty"`
	AccessAllTags             *bool `json:"accessAllTags,omitempty"`
	AccessExplicitContent     *bool `json:"accessExplicitContent,omitempty"`
	CreateEreader             *bool `json:"createEreader,omitempty"`
	Delete                    *bool `json:"delete,omitempty"`
	Download                  *bool `json:"download,omitempty"`
	SelectedTagsNotAccessible *bool `json:"selectedTagsNotAccessible,omitempty"`
	Update                    *bool `json:"update,omitempty"`
	Upload                    *bool `json:"upload,omitempty"`
}

UserPermissions is the "UserPermissions" schema.

type UserUnlinkFromOpenIDResponse ¶ added in v0.7.1

type UserUnlinkFromOpenIDResponse struct {
	HttpResponse *http.Response
	Answer       *string
}

UserUnlinkFromOpenIDResponse is the result of UserUnlinkFromOpenID.

The operation answers text (text/plain), which Answer holds as it was sent.

func (UserUnlinkFromOpenIDResponse) Answered ¶ added in v0.7.1

func (r UserUnlinkFromOpenIDResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type UserUpdateAnswer ¶ added in v0.7.1

type UserUpdateAnswer struct {
	Success bool            `json:"success"`
	User    *UserForBrowser `json:"user,omitempty"`
}

UserUpdateAnswer is an object the document declares inline.

type UserUpdateRequest ¶ added in v0.7.1

type UserUpdateRequest struct {
	Email               string           `json:"email,omitempty"`
	IsActive            *bool            `json:"isActive,omitempty"`
	ItemTagsSelected    []string         `json:"itemTagsSelected,omitzero"`
	LastSeen            any              `json:"lastSeen,omitempty"`
	LibrariesAccessible []string         `json:"librariesAccessible,omitzero"`
	Password            string           `json:"password,omitempty"`
	Permissions         *UserPermissions `json:"permissions,omitempty"`
	Type                string           `json:"type,omitempty"`
	Username            string           `json:"username,omitempty"`
}

UserUpdateRequest is an object the document declares inline.

type UserUpdateResponse ¶ added in v0.7.1

type UserUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *UserUpdateAnswer
	*UserUpdateAnswer
}

UserUpdateResponse is the result of UserUpdate.

Answer is the UserUpdateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (UserUpdateResponse) Answered ¶ added in v0.7.1

func (r UserUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (UserUpdateResponse) Record ¶ added in v0.7.1

Record is the UserUpdateAnswer answered, as a value to change and write back, or an error when the server answered none.

Source Files ¶

Jump to

Keyboard shortcuts

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