Data classes

fathomnet-py uses native Python dataclasses to model FathomNet entities.

---

class fathomnet.dto.ABoundingBoxDTO(*, id: int | None = None, uuid: str | None = None, userDefinedKey: str | None = None, concept: str | None = None, altConcept: str | None = None, image: AImageDTO | None = None, groupOf: bool | None = None, height: int | None = None, occluded: bool | None = None, observer: str | None = None, truncated: bool | None = None, width: int | None = None, x: int | None = None, y: int | None = None, rejected: bool | None = None, reviewState: ReviewState | None = None, reviewer: str | None = None, lastReviewedTimestamp: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

altConcept: str | None

concept: str | None

createdTimestamp: str | None

groupOf: bool | None

height: int | None

id: int | None

image: AImageDTO | None

lastReviewedTimestamp: str | None

lastUpdatedTimestamp: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

observer: str | None

occluded: bool | None

rejected: bool | None

reviewState: ReviewState | None

reviewer: str | None

truncated: bool | None

userDefinedKey: str | None

uuid: str | None

width: int | None

x: int | None

y: int | None

class fathomnet.dto.AImageDTO

altitude: float | None

boundingBoxes: List[ABoundingBoxDTO] | None

contributorsEmail: str | None

createdTimestamp: str | None

depthMeters: float | None

height: int | None

id: int | None

imagingType: str | None

lastUpdatedTimestamp: str | None

lastValidation: str | None

latitude: float | None

longitude: float | None

mediaType: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

modified: str | None

oxygenMlL: float | None

pressureDbar: float | None

salinity: float | None

sha256: str | None

tags: List[ATagDTO] | None

temperatureCelsius: float | None

timestamp: str | None

to_pascal_voc(path: str | None = None, pretty_print: bool = False) → str

Convert to a Pascal VOC.

Parameters:

• path (Optional[str], optional) – Path to the image file, defaults to using the image URL if available

• pretty_print (bool, optional) – Set true to add indentation and newlines in XML, defaults to False

Raises:

ValueError – Raised if both the path and image URL are unspecified

Returns:

Pascal VOC encoded string

Return type:

str

url: str | None

uuid: str | None

valid: bool | None

width: int | None

class fathomnet.dto.ATagDTO

createdTimestamp: str | None

id: int | None

image: AImageDTO | None

key: str | None

lastUpdatedTimestamp: str | None

mediaType: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uuid: str | None

value: str | None

class fathomnet.dto.Activity(*, topic: Topic | None = None, attributedTo: str | None = None, lastUpdated: str | None = None, content: str | None = None, data: dict | None = None)

attributedTo: str | None

content: str | None

data: dict | None

lastUpdated: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

topic: Topic | None

class fathomnet.dto.ApiKey(*, uuid: str | None = None, apiKey: str | None = None)

apiKey: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uuid: str | None

class fathomnet.dto.AuthHeader(*, type: str | None = None, token: str | None = None)

property auth_dict

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

token: str | None

type: str | None

class fathomnet.dto.Authentication(*, attributes: object | None = None)

attributes: object | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.BDarwinCore(*, uuid: str | None = None, recordType: str | None = None, basisOfRecord: str | None = None, datasetID: str | None = None, recordLanguage: str | None = None, license: str | None = None, modified: str | None = None, ownerInstitutionCode: str | None = None, accessRights: str | None = None, bibliographicCitation: str | None = None, collectionCode: str | None = None, collectionID: str | None = None, dataGeneralizations: str | None = None, datasetName: str | None = None, dynamicProperties: str | None = None, informationWithheld: str | None = None, institutionCode: str | None = None, institutionID: str | None = None, recordReferences: str | None = None, rightsHolder: str | None = None)

accessRights: str | None

basisOfRecord: str | None

bibliographicCitation: str | None

collectionCode: str | None

collectionID: str | None

dataGeneralizations: str | None

datasetID: str | None

datasetName: str | None

dynamicProperties: str | None

informationWithheld: str | None

institutionCode: str | None

institutionID: str | None

license: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

modified: str | None

ownerInstitutionCode: str | None

recordLanguage: str | None

recordReferences: str | None

recordType: str | None

rightsHolder: str | None

uuid: str | None

class fathomnet.dto.BImageSetUploadDTO

contributorsEmail: str | None

createdTimestamp: str | None

darwinCore: BDarwinCore | None

format: ImageSetUpload.UploadFormat | None

lastUpdatedTimestamp: str | None

localPath: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rejectionDetails: str | None

rejectionReason: str | None

remoteUri: str | None

sha256: str | None

status: ImageSetUpload.Status | None

statusUpdateTimestamp: str | None

statusUpdaterEmail: str | None

uuid: str | None

class fathomnet.dto.Badge(*, name: str | None = None, since: str | None = None, data: dict | None = None)

data: dict | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

since: str | None

class fathomnet.dto.BoundingBox

altConcept: str | None

concept: str | None

createdTimestamp: str | None

groupOf: bool | None

height: int | None

id: int | None

image: Image | None

lastReviewedTimestamp: str | None

lastUpdatedTimestamp: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

observer: str | None

occluded: bool | None

reviewState: ReviewState | None

reviewer: str | None

truncated: bool | None

userDefinedKey: str | None

uuid: str | None

width: int | None

x: int | None

y: int | None

class fathomnet.dto.BoundingBoxComment(*, uuid: str | None = None, boundingBoxUuid: str | None = None, email: str | None = None, text: str | None = None, alternateConcept: str | None = None, flagged: bool | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

alternateConcept: str | None

boundingBoxUuid: str | None

createdTimestamp: str | None

email: str | None

flagged: bool | None

lastUpdatedTimestamp: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: str | None

uuid: str | None

class fathomnet.dto.BoundingBoxCommentContent(*, text: str | None = None, alternateConcept: str | None = None)

alternateConcept: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: str | None

class fathomnet.dto.BoundingBoxConstraintsDTO(*, concept: str | None = None, taxaProviderName: str | None = None, contributorsEmails: List[str] | None = None, startTimestamp: str | None = None, endTimestamp: str | None = None, includeUnverified: bool | None = None, includeVerified: bool | None = None, includeRejected: bool | None = None, includeUnknown: bool | None = None, minLongitude: float | None = None, maxLongitude: float | None = None, minLatitude: float | None = None, maxLatitude: float | None = None, minDepth: float | None = None, maxDepth: float | None = None, ownerInstitutionCodes: List[str] | None = None, tagKeys: List[str] | None = None, limit: int | None = None, offset: int | None = None, sort: BoundingBoxSort | None = None)

concept: str | None

contributorsEmails: List[str] | None

endTimestamp: str | None

includeRejected: bool | None

includeUnknown: bool | None

includeUnverified: bool | None

includeVerified: bool | None

limit: int | None

maxDepth: float | None

maxLatitude: float | None

maxLongitude: float | None

minDepth: float | None

minLatitude: float | None

minLongitude: float | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: int | None

ownerInstitutionCodes: List[str] | None

sort: BoundingBoxSort | None

startTimestamp: str | None

tagKeys: List[str] | None

taxaProviderName: str | None

class fathomnet.dto.BoundingBoxDTO(*, id: int | None = None, uuid: str | None = None, userDefinedKey: str | None = None, concept: str | None = None, altConcept: str | None = None, image: AImageDTO | None = None, groupOf: bool | None = None, height: int | None = None, occluded: bool | None = None, observer: str | None = None, truncated: bool | None = None, width: int | None = None, x: int | None = None, y: int | None = None, rejected: bool | None = None, reviewState: ReviewState | None = None, reviewer: str | None = None, lastReviewedTimestamp: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, imageUuid: str | None = None)

imageUuid: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.BoundingBoxSort(*, field: Field | None = None, direction: Direction | None = None)

class Direction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ASC = 'ASC'

DESC = 'DESC'

class Field(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

CONCEPT = 'CONCEPT'

CREATED_AT = 'CREATED_AT'

IMAGE_URL = 'IMAGE_URL'

REVIEWED = 'REVIEWED'

ROI_SIZE = 'ROI_SIZE'

UPDATED = 'UPDATED'

UUID = 'UUID'

direction: Direction | None

field: Field | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.ByConceptCount(*, concept: str | None = None, count: int | None = None)

concept: str | None

count: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.ByContributorCount(*, contributorsEmail: str | None = None, count: int | None = None)

contributorsEmail: str | None

count: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.ByObserverCount(*, observer: str | None = None, count: int | None = None)

count: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

observer: str | None

class fathomnet.dto.ByReviewerCount(*, reviewer: str | None = None, count: int | None = None)

count: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reviewer: str | None

class fathomnet.dto.ContributionStats(*, ownerInstitutionCode: str | None = None, totalUploads: int | None = None, totalImages: int | None = None)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

ownerInstitutionCode: str | None

totalImages: int | None

totalUploads: int | None

class fathomnet.dto.Count(*, objectType: str | None = None, count: int | None = None)

count: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

objectType: str | None

class fathomnet.dto.DTO

classmethod from_dict(d: Dict[str, Any]) → DTO

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any]

class fathomnet.dto.DarwinCore

accessRights: str | None

basisOfRecord: str | None

bibliographicCitation: str | None

collectionCode: str | None

collectionID: str | None

dataGeneralizations: str | None

datasetID: str | None

datasetName: str | None

dynamicProperties: str | None

id: int | None

imageSetUpload: ImageSetUpload | None

informationWithheld: str | None

institutionCode: str | None

institutionID: str | None

license: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

modified: str | None

ownerInstitutionCode: str | None

recordLanguage: str | None

recordReferences: str | None

recordType: str | None

rightsHolder: str | None

uuid: str | None

class fathomnet.dto.FathomnetIdAdminMutation(*, disabled: bool | None = None, expertiseRank: str | None = None, roleData: str | None = None, organization: str | None = None)

disabled: bool | None

expertiseRank: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization: str | None

roleData: str | None

class fathomnet.dto.FathomnetIdMutation(*, jobTitle: str | None = None, organization: str | None = None, profile: str | None = None, displayName: str | None = None)

displayName: str | None

jobTitle: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization: str | None

profile: str | None

class fathomnet.dto.FathomnetIdentity

apiKey: str | None

avatarUrl: str | None

createdTimestamp: str | None

disabled: bool | None

displayName: str | None

email: str | None

expertiseRank: str | None

firebaseUid: str | None

id: int | None

jobTitle: str | None

lastUpdatedTimestamp: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notificationFrequency: str | None

orcid: str | None

organization: str | None

profile: str | None

roleData: str | None

roles: List[Roles] | None

uuid: str | None

class fathomnet.dto.FollowedTopic(*, topic: str | None = None, target: str | None = None, notification: bool | None = None, uuid: str | None = None, email: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

createdTimestamp: str | None

email: str | None

lastUpdatedTimestamp: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uuid: str | None

class fathomnet.dto.GeoImage(*, uuid: str | None = None, url: str | None = None, latitude: float | None = None, longitude: float | None = None, depthMeters: float | None = None, contributorsEmail: str | None = None, timestamp: str | None = None, valid: bool | None = None, lastValidation: str | None = None)

contributorsEmail: str | None

depthMeters: float | None

lastValidation: str | None

latitude: float | None

longitude: float | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: str | None

url: str | None

uuid: str | None

valid: bool | None

class fathomnet.dto.GeoImageConstraints(*, concept: str | None = None, taxaProviderName: str | None = None, contributorsEmail: str | None = None, startTimestamp: str | None = None, endTimestamp: str | None = None, imagingTypes: List[str] | None = None, includeUnverified: bool | None = None, includeVerified: bool | None = None, minLongitude: float | None = None, maxLongitude: float | None = None, minLatitude: float | None = None, maxLatitude: float | None = None, minDepth: float | None = None, maxDepth: float | None = None, ownerInstitutionCodes: List[str] | None = None, limit: int | None = None, offset: int | None = None)

concept: str | None

contributorsEmail: str | None

endTimestamp: str | None

imagingTypes: List[str] | None

includeUnverified: bool | None

includeVerified: bool | None

limit: int | None

maxDepth: float | None

maxLatitude: float | None

maxLongitude: float | None

minDepth: float | None

minLatitude: float | None

minLongitude: float | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: int | None

ownerInstitutionCodes: List[str] | None

startTimestamp: str | None

taxaProviderName: str | None

class fathomnet.dto.GeoImageConstraintsCount(*, constraints: GeoImageConstraints | None = None, count: int | None = None)

constraints: GeoImageConstraints | None

count: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.Image

altitude: float | None

boundingBoxes: List[BoundingBox] | None

contributorsEmail: str | None

createdTimestamp: str | None

depthMeters: float | None

height: int | None

id: int | None

imageSetUploads: List[ImageSetUpload] | None

imagingType: str | None

lastUpdatedTimestamp: str | None

lastValidation: str | None

latitude: float | None

longitude: float | None

mediaType: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

modified: str | None

oxygenMlL: float | None

pressureDbar: float | None

salinity: float | None

sha256: str | None

tags: List[Tag] | None

temperatureCelsius: float | None

timestamp: str | None

url: str | None

uuid: str | None

valid: bool | None

width: int | None

class fathomnet.dto.ImageSetUpload

class Status(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ACCEPTED = 'ACCEPTED'

PENDING = 'PENDING'

REJECTED = 'REJECTED'

class UploadFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

CSV = 'CSV'

UNSUPPORTED = 'UNSUPPORTED'

contributorsEmail: str | None

createdTimestamp: str | None

darwinCore: DarwinCore | None

format: UploadFormat | None

id: int | None

images: List[Image] | None

lastUpdatedTimestamp: str | None

localPath: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rejectionDetails: str | None

rejectionReason: str | None

remoteUri: str | None

sha256: str | None

status: Status | None

statusUpdateTimestamp: str | None

statusUpdaterEmail: str | None

uuid: str | None

class fathomnet.dto.ImageSetUploadPosition(*, latitude: float | None = None, longitude: float | None = None, imageSetUploadUuid: str | None = None)

imageSetUploadUuid: str | None

latitude: float | None

longitude: float | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.ImageSetUploadStats(*, imageSetUploadUuid: str | None = None, imageCount: int | None = None, boundingBoxCount: int | None = None, verifiedBoundingBoxCount: int | None = None)

boundingBoxCount: int | None

imageCount: int | None

imageSetUploadUuid: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

verifiedBoundingBoxCount: int | None

class fathomnet.dto.MarineRegion(*, id: int | None = None, MRGID: int | None = None, name: str | None = None, minLatitude: float | None = None, maxLatitude: float | None = None, minLongitude: float | None = None, maxLongitude: float | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

MRGID: int | None

createdTimestamp: str | None

id: int | None

lastUpdatedTimestamp: str | None

maxLatitude: float | None

maxLongitude: float | None

minLatitude: float | None

minLongitude: float | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class fathomnet.dto.Message(*, message: str | None = None)

message: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.Pageable(*, number: int | None = None, size: int | None = None, offset: int | None = None, sort: Sort | None = None, sorted: bool | None = None)

classmethod from_params(size: int | None = None, page: int | None = None, sort_keys: List[str] | None = None)

Make a Pageable instance from paging parameters.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: int | None

offset: int | None

size: int | None

sort: Sort | None

sorted: bool | None

to_params() → List[tuple]

Make a list of paging parameters to be passed into a request.

class fathomnet.dto.ReviewState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

REJECTED = 'REJECTED'

UNKNOWN = 'UNKNOWN'

UNVERIFIED = 'UNVERIFIED'

VERIFIED = 'VERIFIED'

class fathomnet.dto.Roles(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ADMIN = 'ADMIN'

MODERATOR = 'MODERATOR'

READ = 'READ'

UNKNOWN = 'UNKNOWN'

UPDATE = 'UPDATE'

WRITE = 'WRITE'

class fathomnet.dto.Sort(*, sorted: bool | None = None, orderBy: List[Order] | None = None)

class Order(*, ignoreCase: bool | None = None, direction: Direction | None = None, property: str | None = None, ascending: bool | None = None)

class Direction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ASC = 'ASC'

DESC = 'DESC'

ascending: bool | None

direction: Direction | None

ignoreCase: bool | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

orderBy: List[Order] | None

sorted: bool | None

class fathomnet.dto.Tag(*, uuid: str | None = None, id: int | None = None, key: str | None = None, mediaType: str | None = None, value: str | None = None, image: Image | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

createdTimestamp: str | None

id: int | None

image: Image | None

key: str | None

lastUpdatedTimestamp: str | None

mediaType: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uuid: str | None

value: str | None

class fathomnet.dto.TagDTO(*, id: int | None = None, uuid: str | None = None, key: str | None = None, mediaType: str | None = None, value: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, image: AImageDTO | None = None)

imageUuid: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fathomnet.dto.Taxa(*, name: str | None = None, rank: str | None = None)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

rank: str | None

class fathomnet.dto.Topic(*, topic: str | None = None, target: str | None = None, notification: bool | None = None)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notification: bool | None

target: str | None

topic: str | None

class fathomnet.dto.WormsNames(*, aphiaId: int | None = None, name: str | None = None, acceptedName: str | None = None, alternateNames: List[str] | None = None)

acceptedName: str | None

alternateNames: List[str] | None

aphiaId: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class fathomnet.dto.WormsNode(*, name: str | None = None, rank: str | None = None, aphiaId: int | None = None, acceptedAphiaId: int | None = None, alternateNames: List[str] | None = None, children: List[WormsNode] | None = None)

acceptedAphiaId: int | None

alternateNames: List[str] | None

aphiaId: int | None

children: List[WormsNode] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

rank: str | None