Module wallabag_api::types

All types used by the client. Some are returned by the client and shouldn't need to be created manually, while others are designed to be created and passed to client methods (eg. creating new entries).

Structs

Annotation	Represents an annotation as returned from the API.
Config	configuration to use to init a Client.
DeletedTag	Represents a deleted tag, since deleted tags don't come with IDs.
EntriesFilter	Represents possible filters to apply to get_entries_filtered. To use the default for a filter, set the value to None.
EntriesPage	Represents a page of Entries returned. Includes both the payload and metadata about the page.
Entry	A struct representing an entry from wallabag (a full saved article including all annotations and tags; annotations and tags do not need to be requested separately).
ID	The type used as an ID for all data structures. Declared for clarity.
NewAnnotation	Represents an annotation to be created (hence no ID yet). Fields are defined as in a full annotation.
NewEntry	A struct representing an entry to be created. At least url must be provided. If you wish to provide the HTML content you must also provide content and title to prevent the wallabag server from fetching it from the url.
NewlyRegisteredInfo	A struct representing a newly created user and associated client info.
PatchEntry	A struct representing an entry to be changed. Fields here are the only fields that can be modified directly via the api.
Range	Range as used in an Annotation. Shows where the annotation is in the content. Part of Annotationjs annotation format. I quote from their docs for the field descriptions.
RegisterInfo	A struct representing a user to be registered. Includes the name for the client to be registered along with.
Tag	Represents a tag from the API.
TagString	Represents a valid tag name for tags when sent to the API as a comma separated string. (eg. "tag1,tag2") Only client methods that need to format a list of tags in this way will use this.
User	A struct representing a user. (ie. you) Fields should be self-explanatory.

Enums

Format	Use to represent a format to export to.
SortBy	Used in EntriesFilter for sorting results.
SortOrder	Used in EntriesFilter for ordering results.

Type Definitions

Annotations	Type alias for clarity.
Entries	type alias: a list of entries as returned from some endpoints
ExistsInfo	The type returned from check_exists. The format is URL: ID. If ID is None, then that url doesn't exist in the db.
Tags	List of tags declared for clarity.