Data Models

fathomnet-py uses dataclasses as native Python descriptions of the FathomNet data models.

---

class fathomnet.models.ABoundingBoxDTO(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, userDefinedKey: Union[str, NoneType] = None, concept: Union[str, NoneType] = None, altConcept: Union[str, NoneType] = None, image: Union[fathomnet.models.AImageDTO, NoneType] = None, groupOf: Union[bool, NoneType] = None, height: Union[int, NoneType] = None, occluded: Union[bool, NoneType] = None, observer: Union[str, NoneType] = None, truncated: Union[bool, NoneType] = None, width: Union[int, NoneType] = None, x: Union[int, NoneType] = None, y: Union[int, NoneType] = None, rejected: Union[bool, NoneType] = None, verified: Union[bool, NoneType] = None, verifier: Union[str, NoneType] = None, verificationTimestamp: Union[str, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None)

altConcept: Optional[str] = None

concept: Optional[str] = None

createdTimestamp: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

groupOf: Optional[bool] = None

height: Optional[int] = None

id: Optional[int] = None

image: Optional[fathomnet.models.AImageDTO] = None

lastUpdatedTimestamp: Optional[str] = None

observer: Optional[str] = None

occluded: Optional[bool] = None

rejected: Optional[bool] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

truncated: Optional[bool] = None

userDefinedKey: Optional[str] = None

uuid: Optional[str] = None

verificationTimestamp: Optional[str] = None

verified: Optional[bool] = None

verifier: Optional[str] = None

width: Optional[int] = None

x: Optional[int] = None

y: Optional[int] = None

class fathomnet.models.AImageDTO(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, url: Union[str, NoneType] = None, valid: Union[bool, NoneType] = None, imagingType: Union[str, NoneType] = None, depthMeters: Union[float, NoneType] = None, height: Union[int, NoneType] = None, lastValidation: Union[str, NoneType] = None, latitude: Union[float, NoneType] = None, longitude: Union[float, NoneType] = None, altitude: Union[float, NoneType] = None, salinity: Union[float, NoneType] = None, temperatureCelsius: Union[float, NoneType] = None, oxygenMlL: Union[float, NoneType] = None, pressureDbar: Union[float, NoneType] = None, mediaType: Union[str, NoneType] = None, modified: Union[str, NoneType] = None, sha256: Union[str, NoneType] = None, contributorsEmail: Union[str, NoneType] = None, tags: Union[List[ForwardRef('ATagDTO')], NoneType] = None, timestamp: Union[str, NoneType] = None, width: Union[int, NoneType] = None, boundingBoxes: Union[List[ForwardRef('ABoundingBoxDTO')], NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None)

altitude: Optional[float] = None

boundingBoxes: Optional[List[fathomnet.models.ABoundingBoxDTO]] = None

contributorsEmail: Optional[str] = None

createdTimestamp: Optional[str] = None

depthMeters: Optional[float] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

height: Optional[int] = None

id: Optional[int] = None

imagingType: Optional[str] = None

lastUpdatedTimestamp: Optional[str] = None

lastValidation: Optional[str] = None

latitude: Optional[float] = None

longitude: Optional[float] = None

mediaType: Optional[str] = None

modified: Optional[str] = None

oxygenMlL: Optional[float] = None

pressureDbar: Optional[float] = None

salinity: Optional[float] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

sha256: Optional[str] = None

tags: Optional[List[fathomnet.models.ATagDTO]] = None

temperatureCelsius: Optional[float] = None

timestamp: Optional[str] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

to_pascal_voc(path: Optional[str] = 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: Optional[str] = None

uuid: Optional[str] = None

valid: Optional[bool] = None

width: Optional[int] = None

class fathomnet.models.ATagDTO(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, key: Union[str, NoneType] = None, mediaType: Union[str, NoneType] = None, value: Union[str, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None, image: Union[fathomnet.models.AImageDTO, NoneType] = None)

createdTimestamp: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

id: Optional[int] = None

image: Optional[fathomnet.models.AImageDTO] = None

key: Optional[str] = None

lastUpdatedTimestamp: Optional[str] = None

mediaType: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

value: Optional[str] = None

class fathomnet.models.ApiKey(uuid: Union[str, NoneType] = None, apiKey: Union[str, NoneType] = None)

apiKey: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

class fathomnet.models.AuthHeader(type: Union[str, NoneType] = None, token: Union[str, NoneType] = None)

property auth_dict

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

token: Optional[str] = None

type: Optional[str] = None

class fathomnet.models.Authentication(attributes: Union[object, NoneType] = None)

attributes: Optional[object] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.BDarwinCore(uuid: Union[str, NoneType] = None, recordType: Union[str, NoneType] = None, basisOfRecord: Union[str, NoneType] = None, datasetID: Union[str, NoneType] = None, recordLanguage: Union[str, NoneType] = None, license: Union[str, NoneType] = None, modified: Union[str, NoneType] = None, ownerInstitutionCode: Union[str, NoneType] = None, accessRights: Union[str, NoneType] = None, bibliographicCitation: Union[str, NoneType] = None, collectionCode: Union[str, NoneType] = None, collectionID: Union[str, NoneType] = None, dataGeneralizations: Union[str, NoneType] = None, datasetName: Union[str, NoneType] = None, dynamicProperties: Union[str, NoneType] = None, informationWithheld: Union[str, NoneType] = None, institutionCode: Union[str, NoneType] = None, institutionID: Union[str, NoneType] = None, recordReferences: Union[str, NoneType] = None, rightsHolder: Union[str, NoneType] = None)

accessRights: Optional[str] = None

basisOfRecord: Optional[str] = None

bibliographicCitation: Optional[str] = None

collectionCode: Optional[str] = None

collectionID: Optional[str] = None

dataGeneralizations: Optional[str] = None

datasetID: Optional[str] = None

datasetName: Optional[str] = None

dynamicProperties: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

informationWithheld: Optional[str] = None

institutionCode: Optional[str] = None

institutionID: Optional[str] = None

license: Optional[str] = None

modified: Optional[str] = None

ownerInstitutionCode: Optional[str] = None

recordLanguage: Optional[str] = None

recordReferences: Optional[str] = None

recordType: Optional[str] = None

rightsHolder: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

class fathomnet.models.BImageSetUploadDTO(uuid: Union[str, NoneType] = None, localPath: Union[str, NoneType] = None, remoteUri: Union[str, NoneType] = None, sha256: Union[str, NoneType] = None, format: Union[ForwardRef('ImageSetUpload.UploadFormat'), NoneType] = None, contributorsEmail: Union[str, NoneType] = None, status: Union[ForwardRef('ImageSetUpload.Status'), NoneType] = None, statusUpdaterEmail: Union[str, NoneType] = None, statusUpdateTimestamp: Union[str, NoneType] = None, rejectionReason: Union[str, NoneType] = None, rejectionDetails: Union[str, NoneType] = None, darwinCore: Union[fathomnet.models.BDarwinCore, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None)

contributorsEmail: Optional[str] = None

createdTimestamp: Optional[str] = None

darwinCore: Optional[fathomnet.models.BDarwinCore] = None

format: Optional[fathomnet.models.ImageSetUpload.UploadFormat] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

lastUpdatedTimestamp: Optional[str] = None

localPath: Optional[str] = None

rejectionDetails: Optional[str] = None

rejectionReason: Optional[str] = None

remoteUri: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

sha256: Optional[str] = None

status: Optional[fathomnet.models.ImageSetUpload.Status] = None

statusUpdateTimestamp: Optional[str] = None

statusUpdaterEmail: Optional[str] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

class fathomnet.models.BoundingBox(uuid: Union[str, NoneType] = None, id: Union[int, NoneType] = None, userDefinedKey: Union[str, NoneType] = None, concept: Union[str, NoneType] = None, altConcept: Union[str, NoneType] = None, image: Union[ForwardRef('Image'), NoneType] = None, groupOf: Union[bool, NoneType] = None, height: Union[int, NoneType] = None, occluded: Union[bool, NoneType] = None, observer: Union[str, NoneType] = None, truncated: Union[bool, NoneType] = None, width: Union[int, NoneType] = None, x: Union[int, NoneType] = None, y: Union[int, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None, verified: Union[bool, NoneType] = None, verifier: Union[str, NoneType] = None, verificationTimestamp: Union[str, NoneType] = None)

altConcept: Optional[str] = None

concept: Optional[str] = None

createdTimestamp: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

groupOf: Optional[bool] = None

height: Optional[int] = None

id: Optional[int] = None

image: Optional[fathomnet.models.Image] = None

lastUpdatedTimestamp: Optional[str] = None

observer: Optional[str] = None

occluded: Optional[bool] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

truncated: Optional[bool] = None

userDefinedKey: Optional[str] = None

uuid: Optional[str] = None

verificationTimestamp: Optional[str] = None

verified: Optional[bool] = None

verifier: Optional[str] = None

width: Optional[int] = None

x: Optional[int] = None

y: Optional[int] = None

class fathomnet.models.BoundingBoxDTO(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, userDefinedKey: Union[str, NoneType] = None, concept: Union[str, NoneType] = None, altConcept: Union[str, NoneType] = None, image: Union[fathomnet.models.AImageDTO, NoneType] = None, groupOf: Union[bool, NoneType] = None, height: Union[int, NoneType] = None, occluded: Union[bool, NoneType] = None, observer: Union[str, NoneType] = None, truncated: Union[bool, NoneType] = None, width: Union[int, NoneType] = None, x: Union[int, NoneType] = None, y: Union[int, NoneType] = None, rejected: Union[bool, NoneType] = None, verified: Union[bool, NoneType] = None, verifier: Union[str, NoneType] = None, verificationTimestamp: Union[str, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None, imageUuid: Union[str, NoneType] = None)

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

imageUuid: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.ByConceptCount(concept: Union[str, NoneType] = None, count: Union[int, NoneType] = None)

concept: Optional[str] = None

count: Optional[int] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.ByContributorCount(contributorsEmail: Union[str, NoneType] = None, count: Union[int, NoneType] = None)

contributorsEmail: Optional[str] = None

count: Optional[int] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.Count(objectType: Union[str, NoneType] = None, count: Union[int, NoneType] = None)

count: Optional[int] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

objectType: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.DarwinCore(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, recordType: Union[str, NoneType] = None, basisOfRecord: Union[str, NoneType] = None, datasetID: Union[str, NoneType] = None, recordLanguage: Union[str, NoneType] = None, license: Union[str, NoneType] = None, modified: Union[str, NoneType] = None, ownerInstitutionCode: Union[str, NoneType] = None, accessRights: Union[str, NoneType] = None, bibliographicCitation: Union[str, NoneType] = None, collectionCode: Union[str, NoneType] = None, collectionID: Union[str, NoneType] = None, dataGeneralizations: Union[str, NoneType] = None, datasetName: Union[str, NoneType] = None, dynamicProperties: Union[str, NoneType] = None, informationWithheld: Union[str, NoneType] = None, institutionCode: Union[str, NoneType] = None, institutionID: Union[str, NoneType] = None, recordReferences: Union[str, NoneType] = None, rightsHolder: Union[str, NoneType] = None, imageSetUpload: Union[ForwardRef('ImageSetUpload'), NoneType] = None)

accessRights: Optional[str] = None

basisOfRecord: Optional[str] = None

bibliographicCitation: Optional[str] = None

collectionCode: Optional[str] = None

collectionID: Optional[str] = None

dataGeneralizations: Optional[str] = None

datasetID: Optional[str] = None

datasetName: Optional[str] = None

dynamicProperties: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

id: Optional[int] = None

imageSetUpload: Optional[fathomnet.models.ImageSetUpload] = None

informationWithheld: Optional[str] = None

institutionCode: Optional[str] = None

institutionID: Optional[str] = None

license: Optional[str] = None

modified: Optional[str] = None

ownerInstitutionCode: Optional[str] = None

recordLanguage: Optional[str] = None

recordReferences: Optional[str] = None

recordType: Optional[str] = None

rightsHolder: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

class fathomnet.models.FathomnetIdAdminMutation(disabled: Union[bool, NoneType] = None, expertiseRank: Union[str, NoneType] = None, roleData: Union[str, NoneType] = None, organization: Union[str, NoneType] = None)

disabled: Optional[bool] = None

expertiseRank: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

organization: Optional[str] = None

roleData: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.FathomnetIdMutation(jobTitle: Union[str, NoneType] = None, organization: Union[str, NoneType] = None, profile: Union[str, NoneType] = None, displayName: Union[str, NoneType] = None)

displayName: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

jobTitle: Optional[str] = None

organization: Optional[str] = None

profile: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.FathomnetIdentity(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, email: Union[str, NoneType] = None, firebaseUid: Union[str, NoneType] = None, roleData: Union[str, NoneType] = None, organization: Union[str, NoneType] = None, jobTitle: Union[str, NoneType] = None, profile: Union[str, NoneType] = None, apiKey: Union[str, NoneType] = None, avatarUrl: Union[str, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None, disabled: Union[bool, NoneType] = None, expertiseRank: Union[str, NoneType] = None, displayName: Union[str, NoneType] = None, roles: Union[List[ForwardRef('Roles')], NoneType] = None)

apiKey: Optional[str] = None

avatarUrl: Optional[str] = None

createdTimestamp: Optional[str] = None

disabled: Optional[bool] = None

displayName: Optional[str] = None

email: Optional[str] = None

expertiseRank: Optional[str] = None

firebaseUid: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

id: Optional[int] = None

jobTitle: Optional[str] = None

lastUpdatedTimestamp: Optional[str] = None

organization: Optional[str] = None

profile: Optional[str] = None

roleData: Optional[str] = None

roles: Optional[List[fathomnet.models.Roles]] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

class fathomnet.models.GeoImage(uuid: Union[str, NoneType] = None, url: Union[str, NoneType] = None, latitude: Union[float, NoneType] = None, longitude: Union[float, NoneType] = None, depthMeters: Union[float, NoneType] = None, contributorsEmail: Union[str, NoneType] = None, timestamp: Union[str, NoneType] = None, valid: Union[bool, NoneType] = None, lastValidation: Union[str, NoneType] = None)

contributorsEmail: Optional[str] = None

depthMeters: Optional[float] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

lastValidation: Optional[str] = None

latitude: Optional[float] = None

longitude: Optional[float] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

timestamp: Optional[str] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

url: Optional[str] = None

uuid: Optional[str] = None

valid: Optional[bool] = None

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

concept: Optional[str] = None

contributorsEmail: Optional[str] = None

endTimestamp: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

imagingTypes: Optional[List[str]] = None

includeUnverified: Optional[bool] = None

includeVerified: Optional[bool] = None

limit: Optional[int] = None

maxDepth: Optional[float] = None

maxLatitude: Optional[float] = None

maxLongitude: Optional[float] = None

minDepth: Optional[float] = None

minLatitude: Optional[float] = None

minLongitude: Optional[float] = None

offset: Optional[int] = None

ownerInstitutionCodes: Optional[List[str]] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

startTimestamp: Optional[str] = None

taxaProviderName: Optional[str] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.GeoImageConstraintsCount(constraints: Union[fathomnet.models.GeoImageConstraints, NoneType] = None, count: Union[int, NoneType] = None)

constraints: Optional[fathomnet.models.GeoImageConstraints] = None

count: Optional[int] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.Image(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, url: Union[str, NoneType] = None, valid: Union[bool, NoneType] = None, imagingType: Union[str, NoneType] = None, depthMeters: Union[float, NoneType] = None, height: Union[int, NoneType] = None, lastValidation: Union[str, NoneType] = None, latitude: Union[float, NoneType] = None, longitude: Union[float, NoneType] = None, altitude: Union[float, NoneType] = None, salinity: Union[float, NoneType] = None, temperatureCelsius: Union[float, NoneType] = None, oxygenMlL: Union[float, NoneType] = None, pressureDbar: Union[float, NoneType] = None, mediaType: Union[str, NoneType] = None, modified: Union[str, NoneType] = None, sha256: Union[str, NoneType] = None, contributorsEmail: Union[str, NoneType] = None, timestamp: Union[str, NoneType] = None, width: Union[int, NoneType] = None, tags: Union[List[ForwardRef('Tag')], NoneType] = None, boundingBoxes: Union[List[fathomnet.models.BoundingBox], NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None, imageSetUploads: Union[List[ForwardRef('ImageSetUpload')], NoneType] = None)

altitude: Optional[float] = None

boundingBoxes: Optional[List[fathomnet.models.BoundingBox]] = None

contributorsEmail: Optional[str] = None

createdTimestamp: Optional[str] = None

depthMeters: Optional[float] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

height: Optional[int] = None

id: Optional[int] = None

imageSetUploads: Optional[List[fathomnet.models.ImageSetUpload]] = None

imagingType: Optional[str] = None

lastUpdatedTimestamp: Optional[str] = None

lastValidation: Optional[str] = None

latitude: Optional[float] = None

longitude: Optional[float] = None

mediaType: Optional[str] = None

modified: Optional[str] = None

oxygenMlL: Optional[float] = None

pressureDbar: Optional[float] = None

salinity: Optional[float] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

sha256: Optional[str] = None

tags: Optional[List[fathomnet.models.Tag]] = None

temperatureCelsius: Optional[float] = None

timestamp: Optional[str] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

url: Optional[str] = None

uuid: Optional[str] = None

valid: Optional[bool] = None

width: Optional[int] = None

class fathomnet.models.ImageSetUpload(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, localPath: Union[str, NoneType] = None, remoteUri: Union[str, NoneType] = None, sha256: Union[str, NoneType] = None, contributorsEmail: Union[str, NoneType] = None, status: Union[fathomnet.models.ImageSetUpload.Status, NoneType] = None, rejectionReason: Union[str, NoneType] = None, rejectionDetails: Union[str, NoneType] = None, statusUpdaterEmail: Union[str, NoneType] = None, statusUpdateTimestamp: Union[str, NoneType] = None, format: Union[fathomnet.models.ImageSetUpload.UploadFormat, NoneType] = None, darwinCore: Union[fathomnet.models.DarwinCore, NoneType] = None, images: Union[List[fathomnet.models.Image], NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None)

class Status(value)

An enumeration.

ACCEPTED = 'ACCEPTED'

PENDING = 'PENDING'

REJECTED = 'REJECTED'

class UploadFormat(value)

An enumeration.

CSV = 'CSV'

UNSUPPORTED = 'UNSUPPORTED'

contributorsEmail: Optional[str] = None

createdTimestamp: Optional[str] = None

darwinCore: Optional[fathomnet.models.DarwinCore] = None

format: Optional[fathomnet.models.ImageSetUpload.UploadFormat] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

id: Optional[int] = None

images: Optional[List[fathomnet.models.Image]] = None

lastUpdatedTimestamp: Optional[str] = None

localPath: Optional[str] = None

rejectionDetails: Optional[str] = None

rejectionReason: Optional[str] = None

remoteUri: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

sha256: Optional[str] = None

status: Optional[fathomnet.models.ImageSetUpload.Status] = None

statusUpdateTimestamp: Optional[str] = None

statusUpdaterEmail: Optional[str] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

class fathomnet.models.ImageSetUploadStats(imageSetUploadUuid: Union[str, NoneType] = None, imageCount: Union[int, NoneType] = None, boundingBoxCount: Union[int, NoneType] = None, verifiedBoundingBoxCount: Union[int, NoneType] = None)

boundingBoxCount: Optional[int] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

imageCount: Optional[int] = None

imageSetUploadUuid: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

verifiedBoundingBoxCount: Optional[int] = None

class fathomnet.models.MarineRegion(id: Union[int, NoneType] = None, MRGID: Union[int, NoneType] = None, name: Union[str, NoneType] = None, minLatitude: Union[float, NoneType] = None, maxLatitude: Union[float, NoneType] = None, minLongitude: Union[float, NoneType] = None, maxLongitude: Union[float, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None)

MRGID: Optional[int] = None

createdTimestamp: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

id: Optional[int] = None

lastUpdatedTimestamp: Optional[str] = None

maxLatitude: Optional[float] = None

maxLongitude: Optional[float] = None

minLatitude: Optional[float] = None

minLongitude: Optional[float] = None

name: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.Message(message: Union[str, NoneType] = None)

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

message: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.Pageable(number: Union[int, NoneType] = None, size: Union[int, NoneType] = None, offset: Union[int, NoneType] = None, sort: Union[fathomnet.models.Sort, NoneType] = None, sorted: Union[bool, NoneType] = None)

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

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

Make a Pageable instance from paging parameters.

number: Optional[int] = None

offset: Optional[int] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

size: Optional[int] = None

sort: Optional[fathomnet.models.Sort] = None

sorted: Optional[bool] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

to_params() → List[tuple]

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

class fathomnet.models.Roles(value)

An enumeration.

ADMIN = 'ADMIN'

MODERATOR = 'MODERATOR'

READ = 'READ'

UNKNOWN = 'UNKNOWN'

UPDATE = 'UPDATE'

WRITE = 'WRITE'

class fathomnet.models.Sort(sorted: Union[bool, NoneType] = None, orderBy: Union[List[fathomnet.models.Sort.Order], NoneType] = None)

class Order(ignoreCase: Union[bool, NoneType] = None, direction: Union[fathomnet.models.Sort.Order.Direction, NoneType] = None, property: Union[str, NoneType] = None, ascending: Union[bool, NoneType] = None)

class Direction(value)

An enumeration.

ASC = 'ASC'

DESC = 'DESC'

ascending: Optional[bool] = None

direction: Optional[fathomnet.models.Sort.Order.Direction] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

ignoreCase: Optional[bool] = None

property: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

orderBy: Optional[List[fathomnet.models.Sort.Order]] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

sorted: Optional[bool] = None

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.Tag(uuid: Union[str, NoneType] = None, id: Union[int, NoneType] = None, key: Union[str, NoneType] = None, mediaType: Union[str, NoneType] = None, value: Union[str, NoneType] = None, image: Union[fathomnet.models.Image, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None)

createdTimestamp: Optional[str] = None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

id: Optional[int] = None

image: Optional[fathomnet.models.Image] = None

key: Optional[str] = None

lastUpdatedTimestamp: Optional[str] = None

mediaType: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

uuid: Optional[str] = None

value: Optional[str] = None

class fathomnet.models.TagDTO(id: Union[int, NoneType] = None, uuid: Union[str, NoneType] = None, key: Union[str, NoneType] = None, mediaType: Union[str, NoneType] = None, value: Union[str, NoneType] = None, createdTimestamp: Union[str, NoneType] = None, lastUpdatedTimestamp: Union[str, NoneType] = None, image: Union[fathomnet.models.AImageDTO, NoneType] = None, imageUuid: Union[str, NoneType] = None)

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

imageUuid: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class fathomnet.models.Taxa(name: Union[str, NoneType] = None, rank: Union[str, NoneType] = None)

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → dataclasses_json.api.A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → dataclasses_json.api.A

name: Optional[str] = None

rank: Optional[str] = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str