clinvar_api.msg package

Submodules

clinvar_api.msg.query_response module

Data structures for the status update query communication.

class clinvar_api.msg.query_response.ErrorCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ALL_FAILURE = '2'

PARTIAL_SUCCESS = '1'

SUCCESS = '0'

class clinvar_api.msg.query_response.ProcessingStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ERROR = 'Error'

SUCCESS = 'Success'

class clinvar_api.msg.query_response.SubmissionStatus(*, actions: List[SubmissionStatusActions])

Bases: BaseModel

Representation of server’s response to a submission status query.

actions: List[SubmissionStatusActions]

The list of actions (one element only by the docs).

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'actions': FieldInfo(annotation=List[SubmissionStatusActions], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.query_response.SubmissionStatusActions(*, id: str, responses: List[SubmissionStatusResponse], status: str, targetDb: str, updated: datetime)

Bases: BaseModel

Type for SubmissionStatus entry actions[*].

id: str

Identifier of the submission

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True), 'responses': FieldInfo(annotation=List[SubmissionStatusResponse], required=True), 'status': FieldInfo(annotation=str, required=True), 'targetDb': FieldInfo(annotation=str, required=True), 'updated': FieldInfo(annotation=datetime, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

responses: List[SubmissionStatusResponse]

Entries in actions[*].responses, only one entry per the docs.

status: str

Status of the submission, one of “submitted”, “processing”, “processed”, “error”

targetDb: str

Target database, usually “clinvar”

updated: datetime

Last updated time

class clinvar_api.msg.query_response.SubmissionStatusFile(*, url: str)

Bases: BaseModel

Type for SubmissionStatus entry actions[*].response[*].files[*].

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'url': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

url: str

File URL

class clinvar_api.msg.query_response.SubmissionStatusObject(*, accession: str | None, content: SubmissionStatusObjectContent, targetDb: str)

Bases: BaseModel

Type for SubmissionStatusObject entry in actions[*].response[*].objects[*].

accession: str | None

Optional object accession.

content: SubmissionStatusObjectContent

Object content.

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'accession': FieldInfo(annotation=Union[str, NoneType], required=True), 'content': FieldInfo(annotation=SubmissionStatusObjectContent, required=True), 'targetDb': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

targetDb: str

Target database, usually “clinvar” per the docs.

class clinvar_api.msg.query_response.SubmissionStatusObjectContent(*, clinvarProcessingStatus: str, clinvarReleaseStatus: str)

Bases: BaseModel

type for SubmissionStatusObjectContent entry in actions[*].response[*].objects[*].content.

clinvarProcessingStatus: str

Processing status

clinvarReleaseStatus: str

Release status

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'clinvarProcessingStatus': FieldInfo(annotation=str, required=True), 'clinvarReleaseStatus': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.query_response.SubmissionStatusResponse(*, status: str, files: List[SubmissionStatusFile], message: SubmissionStatusResponseMessage | None, objects: List[SubmissionStatusObject])

Bases: BaseModel

Type for SubmissionStatus entry actions[*].response[*].

files: List[SubmissionStatusFile]

Files

message: SubmissionStatusResponseMessage | None

Message

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'files': FieldInfo(annotation=List[SubmissionStatusFile], required=True), 'message': FieldInfo(annotation=Union[SubmissionStatusResponseMessage, NoneType], required=True), 'objects': FieldInfo(annotation=List[SubmissionStatusObject], required=True), 'status': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

objects: List[SubmissionStatusObject]

Objects

status: str

Status, one of “processing”, “processed”, “error”,

class clinvar_api.msg.query_response.SubmissionStatusResponseMessage(*, errorCode: ErrorCode | None, severity: str, text: str)

Bases: BaseModel

Type for SubmissionStatusResponseMessage entry in actions[*].response[*].message.

errorCode: ErrorCode | None

The error code.

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'errorCode': FieldInfo(annotation=Union[ErrorCode, NoneType], required=True), 'severity': FieldInfo(annotation=str, required=True), 'text': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

severity: str

The message severity.

text: str

The message text.

clinvar_api.msg.sub_payload module

Data structures for encoding the submission payload.

class clinvar_api.msg.sub_payload.AffectedStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

NO = 'no'

NOT_APPLICABLE = 'not applicable'

NOT_PROVIDED = 'not provided'

UNKNOWN = 'unknown'

YES = 'yes'

class clinvar_api.msg.sub_payload.AlleleOrigin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

BIPARENTL = 'biparental'

DE_NOVO = 'de novo'

GERMLINE = 'germline'

INHERITED = 'inherited'

MATERNAL = 'maternal'

NOT_APPLICABLE = 'not applicable'

PATERNAL = 'paternal'

SOMATIC = 'somatic'

UNKNOWN = 'unknown'

class clinvar_api.msg.sub_payload.Assembly(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

GRCH37 = 'GRCh37'

GRCH38 = 'GRCh38'

HG18 = 'hg18'

HG19 = 'hg19'

HG38 = 'hg38'

NCBI36 = 'NCBI36'

class clinvar_api.msg.sub_payload.Chromosome(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

CHR1 = '1'

CHR10 = '10'

CHR11 = '11'

CHR12 = '12'

CHR13 = '13'

CHR14 = '14'

CHR15 = '15'

CHR16 = '16'

CHR17 = '17'

CHR18 = '18'

CHR19 = '19'

CHR2 = '2'

CHR20 = '20'

CHR21 = '21'

CHR22 = '22'

CHR3 = '3'

CHR4 = '4'

CHR5 = '5'

CHR6 = '6'

CHR7 = '7'

CHR8 = '8'

CHR9 = '9'

CHRMT = 'MT'

CHRX = 'X'

CHRY = 'Y'

class clinvar_api.msg.sub_payload.CitationDb(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Allowed values for a citation’s db field.

The values of the enumeration map to the values used by the ClinVar submission API.

BOOKSHELF = 'BookShelf'

DOI = 'DOI'

PMC = 'pmc'

PUBMED = 'PubMed'

class clinvar_api.msg.sub_payload.ClinicalFeaturesAffectedStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ABSENT = 'absent'

NOT_TESTED = 'not tested'

PRESENT = 'present'

class clinvar_api.msg.sub_payload.ClinicalFeaturesDb(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

HP = 'HP'

class clinvar_api.msg.sub_payload.ClinicalSignificanceDescription(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Allowed values for the clinicalSignificanceDescription.

The values of the enumeration map to the values used by the ClinVar submission API.

AFFECTED = 'affects'

ASSOCIATION = 'association'

BENIGN = 'Benign'

CONFERS_SENSITIVITY = 'confers sensitivity'

DRUG_RESPONSE = 'drug response'

ESTABLISHED_RISK_ALLELE = 'Established risk allele'

LIKELY_BENIGN = 'Likely benign'

LIKELY_PATHOGENIC = 'Likely pathogenic'

LIKELY_PATHOGENIC_LOW_PENETRANCE = 'Likely pathogenic, low penetrance'

LIKELY_RISK_ALLELE = 'Likely risk allele'

NOT_PROVIDED = 'not provided'

OTHER = 'other'

PATHOGENIC = 'Pathogenic'

PATHOGENIC_LOW_PENETRANCE = 'Pathogenic, low penetrance'

PROTECTIVE = 'protective'

UNCERTAIN_RISK_ALLELE = 'Uncertain risk allele'

UNCERTAIN_SIGNIFICANCE = 'Uncertain significance'

class clinvar_api.msg.sub_payload.CollectionMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

CASE_CONTROL = 'case-control'

CLINICAL_TESTING = 'clinical testing'

CURATION = 'curation'

IN_VITRO = 'in vitro'

IN_VIVO = 'in vivo'

LITERATURE_ONLY = 'literature only'

NOT_PROVIDED = 'not provided'

PHENOTYPING_ONLY = 'phenotyping only'

PROVIDER_INTERPRETATION = 'provider interpretation'

REFERENCE_POPULATION = 'reference population'

RESEARCH = 'research'

class clinvar_api.msg.sub_payload.ConditionDb(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

HP = 'HP'

MEDGEN = 'MedGen'

MESH = 'MeSH'

MONDO = 'MONDO'

OMIM = 'OMIM'

ORPHANET = 'Orphanet'

class clinvar_api.msg.sub_payload.ModeOfInheritance(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

AUTOSOMAL_DOMINANT_INHERITANCE = 'Autosomal dominant inheritance'

AUTOSOMAL_DOMINANT_INHERITANCE_WITH_MATERNAL_IMPRINTING = 'Autosomal dominant inheritance with maternal imprinting'

AUTOSOMAL_DOMINANT_INHERITANCE_WITH_PATERNAL_IMPRINTING = 'Autosomal dominant inheritance with paternal imprinting'

AUTOSOMAL_RECESSIVE_INHERITANCE = 'Autosomal recessive inheritance'

AUTOSOMAL_UNKNOWN = 'Autosomal unknown'

CODOMINANT = 'Codominant'

DEMIDOMINANT_INHERITANCE = 'Semidominant inheritance'

GENETIC_ANTICIPATION = 'Genetic anticipation'

MITOCHONDRIAL_INHERITANCE = 'Mitochondrial inheritance'

MULTIFACTORIAL_INHERITANCE = 'Multifactorial inheritance'

OLIGOGENIC_INHERITANCE = 'Oligogenic inheritance'

OTHER = 'Other'

SEX_LIMITED_AUTOSOMAL_DOMINANT = 'Sex-limited autosomal dominant'

SOMATIC_MUTATION = 'Somatic mutation'

SPORADIC = 'Sporadic'

UNKNOWN_MECHANISM = 'Unknown mechanism'

X_LINKED_DOMINANT_INHERITANCE = 'X-linked dominant inheritance'

X_LINKED_INHERITANCE = 'X-linked inheritance'

X_LINKED_RECESSIVE_INHERITANCE = 'X-linked recessive inheritance'

Y_LINKED_INHERITANCE = 'Y-linked inheritance'

class clinvar_api.msg.sub_payload.MultipleConditionExplanation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

CO_OCCURING = 'Co-occurring'

NOVEL_DISEASE = 'Novel disease'

UNCERTAIN = 'Uncertain'

class clinvar_api.msg.sub_payload.RecordStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

NOVEL = 'novel'

UPDATE = 'update'

class clinvar_api.msg.sub_payload.ReleaseStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

HOLD_UNTIL_PUBLISHED = 'hold until published'

PUBLIC = 'public'

class clinvar_api.msg.sub_payload.StructVarMethodType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

CURATED_PCR = 'Curated,PCR'

OLIGO_ARRAY = 'Oligo array'

ONE_END_ANCHORED_ASSEMBLY = 'One end anchored assembly'

OPTICAL_MAPPING = 'Optical mapping'

PAIRED_END_MAPPING = 'Paired-end mapping'

READ_DEPTH = 'Read depth'

SEQUENCE_ALIGNMENT = 'Sequence alignment'

SNP_ARRAY = 'SNP array'

class clinvar_api.msg.sub_payload.SubmissionAssertionCriteria(*, db: CitationDb | None = None, id: str | None = None, url: str | None = None)

Bases: BaseModel

db: CitationDb | None

id: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'db': FieldInfo(annotation=Union[CitationDb, NoneType], required=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False), 'url': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

url: str | None

class clinvar_api.msg.sub_payload.SubmissionChromosomeCoordinates(*, alternateAllele: str | None = None, accession: str | None = None, assembly: Assembly | None = None, chromosome: Chromosome | None = None, innerStart: int | None = None, innerStop: int | None = None, outerStart: int | None = None, outerStop: int | None = None, referenceAllele: str | None = None, start: int | None = None, stop: int | None = None, variantLength: int | None = None)

Bases: BaseModel

accession: str | None

alternateAllele: str | None

assembly: Assembly | None

chromosome: Chromosome | None

innerStart: int | None

innerStop: int | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'accession': FieldInfo(annotation=Union[str, NoneType], required=False), 'alternateAllele': FieldInfo(annotation=Union[str, NoneType], required=False), 'assembly': FieldInfo(annotation=Union[Assembly, NoneType], required=False), 'chromosome': FieldInfo(annotation=Union[Chromosome, NoneType], required=False), 'innerStart': FieldInfo(annotation=Union[int, NoneType], required=False), 'innerStop': FieldInfo(annotation=Union[int, NoneType], required=False), 'outerStart': FieldInfo(annotation=Union[int, NoneType], required=False), 'outerStop': FieldInfo(annotation=Union[int, NoneType], required=False), 'referenceAllele': FieldInfo(annotation=Union[str, NoneType], required=False), 'start': FieldInfo(annotation=Union[int, NoneType], required=False), 'stop': FieldInfo(annotation=Union[int, NoneType], required=False), 'variantLength': FieldInfo(annotation=Union[int, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

outerStart: int | None

outerStop: int | None

referenceAllele: str | None

start: int | None

stop: int | None

variantLength: int | None

class clinvar_api.msg.sub_payload.SubmissionCitation(*, db: CitationDb | None = None, id: str | None = None, url: str | None = None)

Bases: BaseModel

db: CitationDb | None

id: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'db': FieldInfo(annotation=Union[CitationDb, NoneType], required=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False), 'url': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

url: str | None

class clinvar_api.msg.sub_payload.SubmissionClinicalFeature(*, clinicalFeaturesAffectedStatus: ClinicalFeaturesAffectedStatus, db: ClinicalFeaturesDb | None = None, id: str | None = None, name: str | None = None)

Bases: BaseModel

clinicalFeaturesAffectedStatus: ClinicalFeaturesAffectedStatus

db: ClinicalFeaturesDb | None

id: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'clinicalFeaturesAffectedStatus': FieldInfo(annotation=ClinicalFeaturesAffectedStatus, required=True), 'db': FieldInfo(annotation=Union[ClinicalFeaturesDb, NoneType], required=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False), 'name': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

name: str | None

class clinvar_api.msg.sub_payload.SubmissionClinicalSignificance(*, clinicalSignificanceDescription: ClinicalSignificanceDescription, citation: List[SubmissionCitation] | None = None, comment: str | None = None, customAssertionScore: float | None = None, dateLastEvaluated: str | None = None, explanationOfDrugResponse: str | None = None, explanationOfOtherClinicalSignificance: str | None = None, modeOfInheritance: ModeOfInheritance | None = None)

Bases: BaseModel

citation: List[SubmissionCitation] | None

clinicalSignificanceDescription: ClinicalSignificanceDescription

comment: str | None

customAssertionScore: float | None

dateLastEvaluated: str | None

explanationOfDrugResponse: str | None

explanationOfOtherClinicalSignificance: str | None

modeOfInheritance: ModeOfInheritance | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'citation': FieldInfo(annotation=Union[List[SubmissionCitation], NoneType], required=False), 'clinicalSignificanceDescription': FieldInfo(annotation=ClinicalSignificanceDescription, required=True), 'comment': FieldInfo(annotation=Union[str, NoneType], required=False), 'customAssertionScore': FieldInfo(annotation=Union[float, NoneType], required=False), 'dateLastEvaluated': FieldInfo(annotation=Union[str, NoneType], required=False), 'explanationOfDrugResponse': FieldInfo(annotation=Union[str, NoneType], required=False), 'explanationOfOtherClinicalSignificance': FieldInfo(annotation=Union[str, NoneType], required=False), 'modeOfInheritance': FieldInfo(annotation=Union[ModeOfInheritance, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_payload.SubmissionClinvarDeletion(*, accessionSet: List[SubmissionClinvarDeletionAccessionSet])

Bases: BaseModel

accessionSet: List[SubmissionClinvarDeletionAccessionSet]

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'accessionSet': FieldInfo(annotation=List[SubmissionClinvarDeletionAccessionSet], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_payload.SubmissionClinvarDeletionAccessionSet(*, accession: str, reason: str | None = None)

Bases: BaseModel

accession: str

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'accession': FieldInfo(annotation=str, required=True), 'reason': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

reason: str | None

class clinvar_api.msg.sub_payload.SubmissionClinvarSubmission(*, clinicalSignificance: SubmissionClinicalSignificance, conditionSet: SubmissionConditionSet, observedIn: List[SubmissionObservedIn], recordStatus: RecordStatus, clinvarAccession: str | None = None, compoundHeterozygoteSet: SubmissionCompoundHeterozygoteSet | None = None, diplotypeSet: SubmissionDiplotypeSet | None = None, distinctChromosomesSet: SubmissionDistinctChromosomesSet | None = None, haplotypeSet: SubmissionHaplotypeSet | None = None, haplotypeSingleVariantSet: SubmissionHaplotypeSet | None = None, localID: str | None = None, localKey: str | None = None, phaseUnknownSet: SubmissionPhaseUnknownSet | None = None, variantSet: SubmissionVariantSet | None = None)

Bases: BaseModel

clinicalSignificance: SubmissionClinicalSignificance

clinvarAccession: str | None

compoundHeterozygoteSet: SubmissionCompoundHeterozygoteSet | None

conditionSet: SubmissionConditionSet

diplotypeSet: SubmissionDiplotypeSet | None

distinctChromosomesSet: SubmissionDistinctChromosomesSet | None

haplotypeSet: SubmissionHaplotypeSet | None

Has at least two elements in variants

haplotypeSingleVariantSet: SubmissionHaplotypeSet | None

Has exactly one elements in variants

localID: str | None

localKey: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'clinicalSignificance': FieldInfo(annotation=SubmissionClinicalSignificance, required=True), 'clinvarAccession': FieldInfo(annotation=Union[str, NoneType], required=False), 'compoundHeterozygoteSet': FieldInfo(annotation=Union[SubmissionCompoundHeterozygoteSet, NoneType], required=False), 'conditionSet': FieldInfo(annotation=SubmissionConditionSet, required=True), 'diplotypeSet': FieldInfo(annotation=Union[SubmissionDiplotypeSet, NoneType], required=False), 'distinctChromosomesSet': FieldInfo(annotation=Union[SubmissionDistinctChromosomesSet, NoneType], required=False), 'haplotypeSet': FieldInfo(annotation=Union[SubmissionHaplotypeSet, NoneType], required=False), 'haplotypeSingleVariantSet': FieldInfo(annotation=Union[SubmissionHaplotypeSet, NoneType], required=False), 'localID': FieldInfo(annotation=Union[str, NoneType], required=False), 'localKey': FieldInfo(annotation=Union[str, NoneType], required=False), 'observedIn': FieldInfo(annotation=List[SubmissionObservedIn], required=True), 'phaseUnknownSet': FieldInfo(annotation=Union[SubmissionPhaseUnknownSet, NoneType], required=False), 'recordStatus': FieldInfo(annotation=RecordStatus, required=True), 'variantSet': FieldInfo(annotation=Union[SubmissionVariantSet, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

observedIn: List[SubmissionObservedIn]

phaseUnknownSet: SubmissionPhaseUnknownSet | None

recordStatus: RecordStatus

variantSet: SubmissionVariantSet | None

class clinvar_api.msg.sub_payload.SubmissionCompoundHeterozygoteSet(*, hgvs: str, variantSets: List[SubmissionCompoundHeterozygoteSetVariantSet])

Bases: BaseModel

hgvs: str

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'hgvs': FieldInfo(annotation=str, required=True), 'variantSets': FieldInfo(annotation=List[SubmissionCompoundHeterozygoteSetVariantSet], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

variantSets: List[SubmissionCompoundHeterozygoteSetVariantSet]

class clinvar_api.msg.sub_payload.SubmissionCompoundHeterozygoteSetVariantSet(*, variantSet: SubmissionVariantSet | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'variantSet': FieldInfo(annotation=Union[SubmissionVariantSet, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

variantSet: SubmissionVariantSet | None

class clinvar_api.msg.sub_payload.SubmissionCondition(*, db: ConditionDb | None = None, id: str | None = None, name: str | None = None)

Bases: BaseModel

db: ConditionDb | None

id: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'db': FieldInfo(annotation=Union[ConditionDb, NoneType], required=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False), 'name': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

name: str | None

class clinvar_api.msg.sub_payload.SubmissionConditionSet(*, condition: List[SubmissionCondition] | None = None, drugResponse: List[SubmissionDrugResponse] | None = None, multipleConditionExplanation: MultipleConditionExplanation | None = None)

Bases: BaseModel

condition: List[SubmissionCondition] | None

drugResponse: List[SubmissionDrugResponse] | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'condition': FieldInfo(annotation=Union[List[SubmissionCondition], NoneType], required=False), 'drugResponse': FieldInfo(annotation=Union[List[SubmissionDrugResponse], NoneType], required=False), 'multipleConditionExplanation': FieldInfo(annotation=Union[MultipleConditionExplanation, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

multipleConditionExplanation: MultipleConditionExplanation | None

class clinvar_api.msg.sub_payload.SubmissionContainer(*, assertionCriteria: SubmissionAssertionCriteria | None = None, behalfOrgID: int | None = None, clinvarDeletion: SubmissionClinvarDeletion | None = None, clinvarSubmission: List[SubmissionClinvarSubmission] | None = None, clinvarSubmissionReleaseStatus: ReleaseStatus | None = None, submissionName: str | None = None)

Bases: BaseModel

Representation of the container for a submission.

assertionCriteria: SubmissionAssertionCriteria | None

behalfOrgID: int | None

clinvarDeletion: SubmissionClinvarDeletion | None

clinvarSubmission: List[SubmissionClinvarSubmission] | None

clinvarSubmissionReleaseStatus: ReleaseStatus | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'assertionCriteria': FieldInfo(annotation=Union[SubmissionAssertionCriteria, NoneType], required=False), 'behalfOrgID': FieldInfo(annotation=Union[int, NoneType], required=False), 'clinvarDeletion': FieldInfo(annotation=Union[SubmissionClinvarDeletion, NoneType], required=False), 'clinvarSubmission': FieldInfo(annotation=Union[List[SubmissionClinvarSubmission], NoneType], required=False), 'clinvarSubmissionReleaseStatus': FieldInfo(annotation=Union[ReleaseStatus, NoneType], required=False), 'submissionName': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

submissionName: str | None

class clinvar_api.msg.sub_payload.SubmissionDiplotypeSet(*, haplotypeSets: List[SubmissionHaplotypeSets], hgvs: str, starAlleleName: str | None = None)

Bases: BaseModel

haplotypeSets: List[SubmissionHaplotypeSets]

hgvs: str

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'haplotypeSets': FieldInfo(annotation=List[SubmissionHaplotypeSets], required=True), 'hgvs': FieldInfo(annotation=str, required=True), 'starAlleleName': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

starAlleleName: str | None

class clinvar_api.msg.sub_payload.SubmissionDistinctChromosomesSet(*, hgvs: str, variants: List[SubmissionVariant])

Bases: BaseModel

hgvs: str

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'hgvs': FieldInfo(annotation=str, required=True), 'variants': FieldInfo(annotation=List[SubmissionVariant], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

variants: List[SubmissionVariant]

Hast at least two elements

class clinvar_api.msg.sub_payload.SubmissionDrugResponse(*, db: ConditionDb | None = None, drugName: str | None = None, id: str | None = None, condition: List[SubmissionCondition] | None = None)

Bases: BaseModel

condition: List[SubmissionCondition] | None

db: ConditionDb | None

drugName: str | None

id: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'condition': FieldInfo(annotation=Union[List[SubmissionCondition], NoneType], required=False), 'db': FieldInfo(annotation=Union[ConditionDb, NoneType], required=False), 'drugName': FieldInfo(annotation=Union[str, NoneType], required=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_payload.SubmissionHaplotypeSet(*, hgvs: str, variants: List[SubmissionVariant], starAlleleName: str | None = None)

Bases: BaseModel

hgvs: str

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'hgvs': FieldInfo(annotation=str, required=True), 'starAlleleName': FieldInfo(annotation=Union[str, NoneType], required=False), 'variants': FieldInfo(annotation=List[SubmissionVariant], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

starAlleleName: str | None

variants: List[SubmissionVariant]

class clinvar_api.msg.sub_payload.SubmissionHaplotypeSets(*, haplotypeSet: SubmissionHaplotypeSet | None = None, haplotypeSingleVariantSet: SubmissionHaplotypeSet | None = None)

Bases: BaseModel

haplotypeSet: SubmissionHaplotypeSet | None

haplotypeSingleVariantSet: SubmissionHaplotypeSet | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'haplotypeSet': FieldInfo(annotation=Union[SubmissionHaplotypeSet, NoneType], required=False), 'haplotypeSingleVariantSet': FieldInfo(annotation=Union[SubmissionHaplotypeSet, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_payload.SubmissionObservedIn(*, affectedStatus: AffectedStatus, alleleOrigin: AlleleOrigin, collectionMethod: CollectionMethod, clinicalFeatures: List[SubmissionClinicalFeature] | None = None, clinicalFeaturesComment: str | None = None, numberOfIndividuals: int | None = None, structVarMethodType: StructVarMethodType | None = None)

Bases: BaseModel

affectedStatus: AffectedStatus

alleleOrigin: AlleleOrigin

clinicalFeatures: List[SubmissionClinicalFeature] | None

clinicalFeaturesComment: str | None

collectionMethod: CollectionMethod

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'affectedStatus': FieldInfo(annotation=AffectedStatus, required=True), 'alleleOrigin': FieldInfo(annotation=AlleleOrigin, required=True), 'clinicalFeatures': FieldInfo(annotation=Union[List[SubmissionClinicalFeature], NoneType], required=False), 'clinicalFeaturesComment': FieldInfo(annotation=Union[str, NoneType], required=False), 'collectionMethod': FieldInfo(annotation=CollectionMethod, required=True), 'numberOfIndividuals': FieldInfo(annotation=Union[int, NoneType], required=False), 'structVarMethodType': FieldInfo(annotation=Union[StructVarMethodType, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numberOfIndividuals: int | None

structVarMethodType: StructVarMethodType | None

class clinvar_api.msg.sub_payload.SubmissionPhaseUnknownSet(*, hgvs: str, variants: List[SubmissionVariant])

Bases: BaseModel

hgvs: str

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'hgvs': FieldInfo(annotation=str, required=True), 'variants': FieldInfo(annotation=List[SubmissionVariant], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

variants: List[SubmissionVariant]

class clinvar_api.msg.sub_payload.SubmissionVariant(*, chromosomeCoordinates: SubmissionChromosomeCoordinates | None = None, copyNumber: str | None = None, gene: List[SubmissionVariantGene] | None = None, hgvs: str | None = None, referenceCopyNumber: int | None = None, variantType: VariantType | None = None)

Bases: BaseModel

chromosomeCoordinates: SubmissionChromosomeCoordinates | None

copyNumber: str | None

gene: List[SubmissionVariantGene] | None

hgvs: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'chromosomeCoordinates': FieldInfo(annotation=Union[SubmissionChromosomeCoordinates, NoneType], required=False), 'copyNumber': FieldInfo(annotation=Union[str, NoneType], required=False), 'gene': FieldInfo(annotation=Union[List[SubmissionVariantGene], NoneType], required=False), 'hgvs': FieldInfo(annotation=Union[str, NoneType], required=False), 'referenceCopyNumber': FieldInfo(annotation=Union[int, NoneType], required=False), 'variantType': FieldInfo(annotation=Union[VariantType, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

referenceCopyNumber: int | None

variantType: VariantType | None

class clinvar_api.msg.sub_payload.SubmissionVariantGene(*, id: int | None = None, symbol: str | None = None)

Bases: BaseModel

id: int | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=Union[int, NoneType], required=False), 'symbol': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

symbol: str | None

class clinvar_api.msg.sub_payload.SubmissionVariantSet(*, variant: List[SubmissionVariant])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'variant': FieldInfo(annotation=List[SubmissionVariant], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

variant: List[SubmissionVariant]

class clinvar_api.msg.sub_payload.VariantType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

COMPLEX = 'Complex'

COPY_NUMBER_GAIN = 'copy number gain'

COPY_NUMBER_LOSS = 'copy number loss'

DELETION = 'Deletion'

DUPLICATION = 'Duplication'

INSERTION = 'Insertion'

INVERSION = 'Inversion'

TANDEM_DUPLICATIOn = 'Tandem duplication'

TRANSLOCATION = 'Translocation'

clinvar_api.msg.sub_response module

Data structures for parsing submission response.

class clinvar_api.msg.sub_response.BatchProcessingStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ERROR = 'Error'

IN_PROCESSING = 'In processing'

PARTIAL_SUCCESS = 'Partial success'

SUCCESS = 'Success'

class clinvar_api.msg.sub_response.BatchReleaseStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

NOT_RELEASED = 'Not released'

PARTIAL_RELEASED = 'Partial released'

RELEASED = 'Released'

class clinvar_api.msg.sub_response.Created(*, id: str)

Bases: BaseModel

Representation of successful creation.

id: str

The submission ID.

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_response.Error(*, message: str)

Bases: BaseModel

Representation of server’s response in case of failure.

message: str

The error response’s message.

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'message': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_response.SummaryResponse(*, batchProcessingStatus: BatchProcessingStatus, batchReleaseStatus: BatchReleaseStatus, submissionDate: str, submissionName: str, totalCount: int, totalErrors: int, totalPublic: int, totalSuccess: int, deletions: List[SummaryResponseDeletion] | None = None, submissions: List[SummaryResponseSubmission] | None = None, totalDeleteCount: int | None = None, totalDeleted: int | None = None, totalDeleteErrors: int | None = None, totalDeleteSuccess: int | None = None)

Bases: BaseModel

Represetation of server’s response to a submission.

batchProcessingStatus: BatchProcessingStatus

batchReleaseStatus: BatchReleaseStatus

deletions: List[SummaryResponseDeletion] | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'batchProcessingStatus': FieldInfo(annotation=BatchProcessingStatus, required=True), 'batchReleaseStatus': FieldInfo(annotation=BatchReleaseStatus, required=True), 'deletions': FieldInfo(annotation=Union[List[SummaryResponseDeletion], NoneType], required=False), 'submissionDate': FieldInfo(annotation=str, required=True), 'submissionName': FieldInfo(annotation=str, required=True), 'submissions': FieldInfo(annotation=Union[List[SummaryResponseSubmission], NoneType], required=False), 'totalCount': FieldInfo(annotation=int, required=True), 'totalDeleteCount': FieldInfo(annotation=Union[int, NoneType], required=False), 'totalDeleteErrors': FieldInfo(annotation=Union[int, NoneType], required=False), 'totalDeleteSuccess': FieldInfo(annotation=Union[int, NoneType], required=False), 'totalDeleted': FieldInfo(annotation=Union[int, NoneType], required=False), 'totalErrors': FieldInfo(annotation=int, required=True), 'totalPublic': FieldInfo(annotation=int, required=True), 'totalSuccess': FieldInfo(annotation=int, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

submissionDate: str

submissionName: str

submissions: List[SummaryResponseSubmission] | None

totalCount: int

totalDeleteCount: int | None

totalDeleteErrors: int | None

totalDeleteSuccess: int | None

totalDeleted: int | None

totalErrors: int

totalPublic: int

totalSuccess: int

class clinvar_api.msg.sub_response.SummaryResponseDeletion(*, identifiers: SummaryResponseDeletionIdentifier, processingStatus: str, deleteDate: str | None = None, deleteStatus: str | None = None, errors: List[SummaryResponseError] | None = None)

Bases: BaseModel

deleteDate: str | None

deleteStatus: str | None

errors: List[SummaryResponseError] | None

identifiers: SummaryResponseDeletionIdentifier

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'deleteDate': FieldInfo(annotation=Union[str, NoneType], required=False), 'deleteStatus': FieldInfo(annotation=Union[str, NoneType], required=False), 'errors': FieldInfo(annotation=Union[List[SummaryResponseError], NoneType], required=False), 'identifiers': FieldInfo(annotation=SummaryResponseDeletionIdentifier, required=True), 'processingStatus': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

processingStatus: str

class clinvar_api.msg.sub_response.SummaryResponseDeletionIdentifier(*, clinvarAccession: str, clinvarLocalKey: str | None = None)

Bases: BaseModel

clinvarAccession: str

clinvarLocalKey: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'clinvarAccession': FieldInfo(annotation=str, required=True), 'clinvarLocalKey': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_response.SummaryResponseError(*, input: List[SummaryResponseErrorInput], output: SummaryResponseErrorOutput)

Bases: BaseModel

input: List[SummaryResponseErrorInput]

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'input': FieldInfo(annotation=List[SummaryResponseErrorInput], required=True), 'output': FieldInfo(annotation=SummaryResponseErrorOutput, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

output: SummaryResponseErrorOutput

class clinvar_api.msg.sub_response.SummaryResponseErrorInput(*, value: str | None = None, field: str | None = None)

Bases: BaseModel

field: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'field': FieldInfo(annotation=Union[str, NoneType], required=False), 'value': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

value: str | None

class clinvar_api.msg.sub_response.SummaryResponseErrorOutput(*, errors: List[SummaryResponseErrorOutputError])

Bases: BaseModel

errors: List[SummaryResponseErrorOutputError]

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'errors': FieldInfo(annotation=List[SummaryResponseErrorOutputError], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class clinvar_api.msg.sub_response.SummaryResponseErrorOutputError(*, userMessage: str)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'userMessage': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

userMessage: str

class clinvar_api.msg.sub_response.SummaryResponseSubmission(*, identifiers: SummaryResponseSubmissionIdentifiers, processingStatus: str, clinvarAccessionVersion: str | None = None, errors: List[SummaryResponseError] | None = None, releaseDate: str | None = None, releaseStatus: str | None = None)

Bases: BaseModel

clinvarAccessionVersion: str | None

errors: List[SummaryResponseError] | None

identifiers: SummaryResponseSubmissionIdentifiers

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'clinvarAccessionVersion': FieldInfo(annotation=Union[str, NoneType], required=False), 'errors': FieldInfo(annotation=Union[List[SummaryResponseError], NoneType], required=False), 'identifiers': FieldInfo(annotation=SummaryResponseSubmissionIdentifiers, required=True), 'processingStatus': FieldInfo(annotation=str, required=True), 'releaseDate': FieldInfo(annotation=Union[str, NoneType], required=False), 'releaseStatus': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

processingStatus: str

releaseDate: str | None

releaseStatus: str | None

class clinvar_api.msg.sub_response.SummaryResponseSubmissionIdentifiers(*, clinvarLocalKey: str, clinvarAccession: str | None = None, localID: str | None = None, localKey: str | None = None)

Bases: BaseModel

clinvarAccession: str | None

clinvarLocalKey: str

localID: str | None

localKey: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'clinvarAccession': FieldInfo(annotation=Union[str, NoneType], required=False), 'clinvarLocalKey': FieldInfo(annotation=str, required=True), 'localID': FieldInfo(annotation=Union[str, NoneType], required=False), 'localKey': FieldInfo(annotation=Union[str, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Module contents

Data structures used for communicating with the server endpoints.

These data structures use the same case (camelCaseWithIDCase) as the ClinVar API JSON.