ncbi-datasets-pyclient 18.4.0__py3-none-any.whl → 18.13.0__py3-none-any.whl

ncbi/datasets/openapi/models/v2_organism_query_request_taxon_resource_filter.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_ortholog_request.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -29,7 +28,7 @@ class V2OrthologRequest(BaseModel):
     V2OrthologRequest
     """ # noqa: E501
     gene_id: Optional[StrictInt] = None
-    returned_content: Optional[V2OrthologRequestContentType] = None
+    returned_content: Optional[V2OrthologRequestContentType] = V2OrthologRequestContentType.COMPLETE
     taxon_filter: Optional[List[StrictStr]] = None
     page_size: Optional[StrictInt] = None
     page_token: Optional[StrictStr] = None
@@ -87,7 +86,7 @@ class V2OrthologRequest(BaseModel):
 
         _obj = cls.model_validate({
             "gene_id": obj.get("gene_id"),
-            "returned_content": obj.get("returned_content"),
+            "returned_content": obj.get("returned_content") if obj.get("returned_content") is not None else V2OrthologRequestContentType.COMPLETE,
             "taxon_filter": obj.get("taxon_filter"),
             "page_size": obj.get("page_size"),
             "page_token": obj.get("page_token")

ncbi/datasets/openapi/models/v2_ortholog_request_content_type.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_prokaryote_gene_request.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_prokaryote_gene_request_gene_flank_config.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_ref_gene_catalog_dataset_request.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    NCBI Datasets API
+
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
+
+    The version of the OpenAPI document: v2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ncbi.datasets.openapi.models.v2_element_flank_config import V2ElementFlankConfig
+from ncbi.datasets.openapi.models.v2_ref_gene_catalog_dataset_request_file_type import V2RefGeneCatalogDatasetRequestFileType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V2RefGeneCatalogDatasetRequest(BaseModel):
+    """
+    V2RefGeneCatalogDatasetRequest
+    """ # noqa: E501
+    opaque_solr_query: Optional[StrictStr] = None
+    files: Optional[List[V2RefGeneCatalogDatasetRequestFileType]] = None
+    element_flank_config: Optional[V2ElementFlankConfig] = None
+    __properties: ClassVar[List[str]] = ["opaque_solr_query", "files", "element_flank_config"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V2RefGeneCatalogDatasetRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of element_flank_config
+        if self.element_flank_config:
+            _dict['element_flank_config'] = self.element_flank_config.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V2RefGeneCatalogDatasetRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "opaque_solr_query": obj.get("opaque_solr_query"),
+            "files": obj.get("files"),
+            "element_flank_config": V2ElementFlankConfig.from_dict(obj["element_flank_config"]) if obj.get("element_flank_config") is not None else None
+        })
+        return _obj
+
+

ncbi/datasets/openapi/models/v2_ref_gene_catalog_dataset_request_file_type.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    NCBI Datasets API
+
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
+
+    The version of the OpenAPI document: v2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class V2RefGeneCatalogDatasetRequestFileType(str, Enum):
+    """
+    V2RefGeneCatalogDatasetRequestFileType
+    """
+
+    """
+    allowed enum values
+    """
+    FILE_TYPE_NUCLEOTIDE = 'FILE_TYPE_NUCLEOTIDE'
+    FILE_TYPE_NUCLEOTIDE_WITH_FLANK = 'FILE_TYPE_NUCLEOTIDE_WITH_FLANK'
+    FILE_TYPE_PROTEIN = 'FILE_TYPE_PROTEIN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of V2RefGeneCatalogDatasetRequestFileType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ncbi/datasets/openapi/models/v2_sars2_protein_dataset_request.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -45,7 +44,7 @@ class V2Sars2ProteinDatasetRequest(BaseModel):
     table_fields: Optional[List[V2VirusTableField]] = None
     include_sequence: Optional[List[V2ViralSequenceType]] = None
     aux_report: Optional[List[V2VirusDatasetReportType]] = None
-    format: Optional[V2TableFormat] = None
+    format: Optional[V2TableFormat] = V2TableFormat.TSV
     __properties: ClassVar[List[str]] = ["proteins", "refseq_only", "annotated_only", "released_since", "updated_since", "host", "pangolin_classification", "geo_location", "usa_state", "complete_only", "table_fields", "include_sequence", "aux_report", "format"]
 
     model_config = ConfigDict(
@@ -112,7 +111,7 @@ class V2Sars2ProteinDatasetRequest(BaseModel):
             "table_fields": obj.get("table_fields"),
             "include_sequence": obj.get("include_sequence"),
             "aux_report": obj.get("aux_report"),
-            "format": obj.get("format")
+            "format": obj.get("format") if obj.get("format") is not None else V2TableFormat.TSV
         })
         return _obj
 

ncbi/datasets/openapi/models/v2_sci_name_and_ids.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_sci_name_and_ids_sci_name_and_id.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -32,7 +31,7 @@ class V2SciNameAndIdsSciNameAndId(BaseModel):
     tax_id: Optional[StrictStr] = None
     common_name: Optional[StrictStr] = None
     matched_term: Optional[StrictStr] = None
-    rank: Optional[V2reportsRankType] = None
+    rank: Optional[V2reportsRankType] = V2reportsRankType.NO_RANK
     group_name: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["sci_name", "tax_id", "common_name", "matched_term", "rank", "group_name"]
 
@@ -91,7 +90,7 @@ class V2SciNameAndIdsSciNameAndId(BaseModel):
             "tax_id": obj.get("tax_id"),
             "common_name": obj.get("common_name"),
             "matched_term": obj.get("matched_term"),
-            "rank": obj.get("rank"),
+            "rank": obj.get("rank") if obj.get("rank") is not None else V2reportsRankType.NO_RANK,
             "group_name": obj.get("group_name")
         })
         return _obj

ncbi/datasets/openapi/models/v2_seq_range.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    NCBI Datasets API
+
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
+
+    The version of the OpenAPI document: v2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ncbi.datasets.openapi.models.v2reports_orientation import V2reportsOrientation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V2SeqRange(BaseModel):
+    """
+    V2SeqRange
+    """ # noqa: E501
+    accession: Optional[StrictStr] = None
+    begin: Optional[StrictStr] = None
+    end: Optional[StrictStr] = None
+    orientation: Optional[V2reportsOrientation] = V2reportsOrientation.NONE
+    __properties: ClassVar[List[str]] = ["accession", "begin", "end", "orientation"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V2SeqRange from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V2SeqRange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accession": obj.get("accession"),
+            "begin": obj.get("begin"),
+            "end": obj.get("end"),
+            "orientation": obj.get("orientation") if obj.get("orientation") is not None else V2reportsOrientation.NONE
+        })
+        return _obj
+
+

ncbi/datasets/openapi/models/v2_seq_reply.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    NCBI Datasets API
+
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
+
+    The version of the OpenAPI document: v2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ncbi.datasets.openapi.models.v2_mol_type import V2MolType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V2SeqReply(BaseModel):
+    """
+    V2SeqReply
+    """ # noqa: E501
+    accession: Optional[StrictStr] = None
+    seq_length: Optional[StrictStr] = None
+    mol_type: Optional[V2MolType] = V2MolType.MOL_UNSPECIFIED
+    defline: Optional[StrictStr] = None
+    sequence: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["accession", "seq_length", "mol_type", "defline", "sequence"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V2SeqReply from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V2SeqReply from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accession": obj.get("accession"),
+            "seq_length": obj.get("seq_length"),
+            "mol_type": obj.get("mol_type") if obj.get("mol_type") is not None else V2MolType.MOL_UNSPECIFIED,
+            "defline": obj.get("defline"),
+            "sequence": obj.get("sequence")
+        })
+        return _obj
+
+

ncbi/datasets/openapi/models/v2_sequence_accession_request.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_sequence_report_page.py

@@ -3,10 +3,9 @@
 """
     NCBI Datasets API
 
-    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. 
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
 
     The version of the OpenAPI document: v2
-    Contact: help@ncbi.nlm.nih.gov
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

ncbi/datasets/openapi/models/v2_sleep_reply.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    NCBI Datasets API
+
+    ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability. 
+
+    The version of the OpenAPI document: v2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V2SleepReply(BaseModel):
+    """
+    V2SleepReply
+    """ # noqa: E501
+    reply: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["reply"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V2SleepReply from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V2SleepReply from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "reply": obj.get("reply")
+        })
+        return _obj
+
+