dapla-toolbelt-metadata 0.3.0__py3-none-any.whl → 0.4.1__py3-none-any.whl

dapla_metadata/variable_definitions/generated/vardef_client/models/update_draft.py

@@ -0,0 +1,307 @@
+"""Variable Definitions
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+import pprint
+import re
+from datetime import date
+from typing import Annotated
+from typing import Any
+from typing import ClassVar
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import Field
+from pydantic import StrictBool
+from pydantic import StrictStr
+from pydantic import field_validator
+from typing_extensions import Self
+
+from ..models.contact import Contact
+from ..models.language_string_type import LanguageStringType
+from ..models.owner import Owner
+from ..models.variable_status import VariableStatus
+
+
+class UpdateDraft(BaseModel):
+    """Update variable definition Data structure with all fields optional for updating a Draft Variable Definition."""
+
+    name: LanguageStringType | None = Field(
+        default=None,
+        description="Name of the variable. Must be unique for a given Unit Type and Owner combination.",
+    )
+    short_name: Annotated[str, Field(strict=True)] | None = Field(
+        default=None,
+        description="Recommended short name. Must be unique within an organization.",
+    )
+    definition: LanguageStringType | None = Field(
+        default=None, description="Definition of the variable."
+    )
+    classification_reference: StrictStr | None = Field(
+        default=None,
+        description="ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable.",
+    )
+    unit_types: list[StrictStr] | None = Field(
+        default=None,
+        description="A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702.",
+    )
+    subject_fields: list[StrictStr] | None = Field(
+        default=None,
+        description="A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618.",
+    )
+    contains_special_categories_of_personal_data: StrictBool | None = Field(
+        default=None,
+        description="True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation",
+    )
+    variable_status: VariableStatus | None = Field(
+        default=None, description="Status of the life cycle of the variable"
+    )
+    measurement_type: StrictStr | None = Field(
+        default=None,
+        description="Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303",
+    )
+    valid_from: date | None = Field(
+        default=None,
+        description="The variable definition is valid from this date inclusive",
+    )
+    external_reference_uri: StrictStr | None = Field(
+        default=None, description="A link (URI) to an external definition/documentation"
+    )
+    comment: LanguageStringType | None = Field(
+        default=None,
+        description="Optional comment to explain the definition or communicate potential changes.",
+    )
+    related_variable_definition_uris: list[StrictStr] | None = Field(
+        default=None,
+        description="Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc.",
+    )
+    owner: Owner | None = Field(
+        default=None,
+        description="Owner of the definition, i.e. responsible Dapla team (statistics team) and information about access management groups.",
+    )
+    contact: Contact | None = Field(default=None, description="Contact details")
+    __properties: ClassVar[list[str]] = [
+        "name",
+        "short_name",
+        "definition",
+        "classification_reference",
+        "unit_types",
+        "subject_fields",
+        "contains_special_categories_of_personal_data",
+        "variable_status",
+        "measurement_type",
+        "valid_from",
+        "external_reference_uri",
+        "comment",
+        "related_variable_definition_uris",
+        "owner",
+        "contact",
+    ]
+
+    @field_validator("short_name")
+    def short_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-z0-9_]{2,}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9_]{2,}$/")
+        return value
+
+    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) -> Self | None:
+        """Create an instance of UpdateDraft 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 name
+        if self.name:
+            _dict["name"] = self.name.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of definition
+        if self.definition:
+            _dict["definition"] = self.definition.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of comment
+        if self.comment:
+            _dict["comment"] = self.comment.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of owner
+        if self.owner:
+            _dict["owner"] = self.owner.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of contact
+        if self.contact:
+            _dict["contact"] = self.contact.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict["name"] = None
+
+        # set to None if short_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.short_name is None and "short_name" in self.model_fields_set:
+            _dict["short_name"] = None
+
+        # set to None if definition (nullable) is None
+        # and model_fields_set contains the field
+        if self.definition is None and "definition" in self.model_fields_set:
+            _dict["definition"] = None
+
+        # set to None if classification_reference (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.classification_reference is None
+            and "classification_reference" in self.model_fields_set
+        ):
+            _dict["classification_reference"] = None
+
+        # set to None if unit_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.unit_types is None and "unit_types" in self.model_fields_set:
+            _dict["unit_types"] = None
+
+        # set to None if subject_fields (nullable) is None
+        # and model_fields_set contains the field
+        if self.subject_fields is None and "subject_fields" in self.model_fields_set:
+            _dict["subject_fields"] = None
+
+        # set to None if contains_special_categories_of_personal_data (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.contains_special_categories_of_personal_data is None
+            and "contains_special_categories_of_personal_data" in self.model_fields_set
+        ):
+            _dict["contains_special_categories_of_personal_data"] = None
+
+        # set to None if variable_status (nullable) is None
+        # and model_fields_set contains the field
+        if self.variable_status is None and "variable_status" in self.model_fields_set:
+            _dict["variable_status"] = None
+
+        # set to None if measurement_type (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.measurement_type is None
+            and "measurement_type" in self.model_fields_set
+        ):
+            _dict["measurement_type"] = None
+
+        # set to None if valid_from (nullable) is None
+        # and model_fields_set contains the field
+        if self.valid_from is None and "valid_from" in self.model_fields_set:
+            _dict["valid_from"] = None
+
+        # set to None if external_reference_uri (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.external_reference_uri is None
+            and "external_reference_uri" in self.model_fields_set
+        ):
+            _dict["external_reference_uri"] = None
+
+        # set to None if comment (nullable) is None
+        # and model_fields_set contains the field
+        if self.comment is None and "comment" in self.model_fields_set:
+            _dict["comment"] = None
+
+        # set to None if related_variable_definition_uris (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.related_variable_definition_uris is None
+            and "related_variable_definition_uris" in self.model_fields_set
+        ):
+            _dict["related_variable_definition_uris"] = None
+
+        # set to None if owner (nullable) is None
+        # and model_fields_set contains the field
+        if self.owner is None and "owner" in self.model_fields_set:
+            _dict["owner"] = None
+
+        # set to None if contact (nullable) is None
+        # and model_fields_set contains the field
+        if self.contact is None and "contact" in self.model_fields_set:
+            _dict["contact"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of UpdateDraft from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": LanguageStringType.from_dict(obj["name"])
+                if obj.get("name") is not None
+                else None,
+                "short_name": obj.get("short_name"),
+                "definition": LanguageStringType.from_dict(obj["definition"])
+                if obj.get("definition") is not None
+                else None,
+                "classification_reference": obj.get("classification_reference"),
+                "unit_types": obj.get("unit_types"),
+                "subject_fields": obj.get("subject_fields"),
+                "contains_special_categories_of_personal_data": obj.get(
+                    "contains_special_categories_of_personal_data"
+                ),
+                "variable_status": obj.get("variable_status"),
+                "measurement_type": obj.get("measurement_type"),
+                "valid_from": obj.get("valid_from"),
+                "external_reference_uri": obj.get("external_reference_uri"),
+                "comment": LanguageStringType.from_dict(obj["comment"])
+                if obj.get("comment") is not None
+                else None,
+                "related_variable_definition_uris": obj.get(
+                    "related_variable_definition_uris"
+                ),
+                "owner": Owner.from_dict(obj["owner"])
+                if obj.get("owner") is not None
+                else None,
+                "contact": Contact.from_dict(obj["contact"])
+                if obj.get("contact") is not None
+                else None,
+            }
+        )
+        return _obj

dapla_metadata/variable_definitions/generated/vardef_client/models/validity_period.py

@@ -0,0 +1,259 @@
+"""Variable Definitions
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from datetime import date
+from typing import Any
+from typing import ClassVar
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import Field
+from pydantic import StrictBool
+from pydantic import StrictStr
+from typing_extensions import Self
+
+from ..models.contact import Contact
+from ..models.language_string_type import LanguageStringType
+from ..models.variable_status import VariableStatus
+
+
+class ValidityPeriod(BaseModel):
+    """Create a new Validity Period on a Published Variable Definition."""
+
+    name: LanguageStringType | None = Field(
+        default=None,
+        description="Name of the variable. Must be unique for a given Unit Type and Owner combination.",
+    )
+    definition: LanguageStringType = Field(description="Definition of the variable.")
+    classification_reference: StrictStr | None = Field(
+        default=None,
+        description="ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable.",
+    )
+    unit_types: list[StrictStr] | None = Field(
+        default=None,
+        description="A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702.",
+    )
+    subject_fields: list[StrictStr] | None = Field(
+        default=None,
+        description="A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618.",
+    )
+    contains_special_categories_of_personal_data: StrictBool | None = Field(
+        default=None,
+        description="True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation",
+    )
+    variable_status: VariableStatus | None = Field(
+        default=None, description="Status of the life cycle of the variable"
+    )
+    measurement_type: StrictStr | None = Field(
+        default=None,
+        description="Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303",
+    )
+    valid_from: date = Field(
+        description="The variable definition is valid from this date inclusive"
+    )
+    external_reference_uri: StrictStr | None = Field(
+        default=None, description="A link (URI) to an external definition/documentation"
+    )
+    comment: LanguageStringType | None = Field(
+        default=None,
+        description="Optional comment to explain the definition or communicate potential changes.",
+    )
+    related_variable_definition_uris: list[StrictStr] | None = Field(
+        default=None,
+        description="Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc.",
+    )
+    contact: Contact | None = Field(default=None, description="Contact details")
+    __properties: ClassVar[list[str]] = [
+        "name",
+        "definition",
+        "classification_reference",
+        "unit_types",
+        "subject_fields",
+        "contains_special_categories_of_personal_data",
+        "variable_status",
+        "measurement_type",
+        "valid_from",
+        "external_reference_uri",
+        "comment",
+        "related_variable_definition_uris",
+        "contact",
+    ]
+
+    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) -> Self | None:
+        """Create an instance of ValidityPeriod 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: set[str] = set(
+            [
+                "variable_status",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of name
+        if self.name:
+            _dict["name"] = self.name.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of definition
+        if self.definition:
+            _dict["definition"] = self.definition.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of comment
+        if self.comment:
+            _dict["comment"] = self.comment.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of contact
+        if self.contact:
+            _dict["contact"] = self.contact.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict["name"] = None
+
+        # set to None if classification_reference (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.classification_reference is None
+            and "classification_reference" in self.model_fields_set
+        ):
+            _dict["classification_reference"] = None
+
+        # set to None if unit_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.unit_types is None and "unit_types" in self.model_fields_set:
+            _dict["unit_types"] = None
+
+        # set to None if subject_fields (nullable) is None
+        # and model_fields_set contains the field
+        if self.subject_fields is None and "subject_fields" in self.model_fields_set:
+            _dict["subject_fields"] = None
+
+        # set to None if contains_special_categories_of_personal_data (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.contains_special_categories_of_personal_data is None
+            and "contains_special_categories_of_personal_data" in self.model_fields_set
+        ):
+            _dict["contains_special_categories_of_personal_data"] = None
+
+        # set to None if variable_status (nullable) is None
+        # and model_fields_set contains the field
+        if self.variable_status is None and "variable_status" in self.model_fields_set:
+            _dict["variable_status"] = None
+
+        # set to None if measurement_type (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.measurement_type is None
+            and "measurement_type" in self.model_fields_set
+        ):
+            _dict["measurement_type"] = None
+
+        # set to None if external_reference_uri (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.external_reference_uri is None
+            and "external_reference_uri" in self.model_fields_set
+        ):
+            _dict["external_reference_uri"] = None
+
+        # set to None if comment (nullable) is None
+        # and model_fields_set contains the field
+        if self.comment is None and "comment" in self.model_fields_set:
+            _dict["comment"] = None
+
+        # set to None if related_variable_definition_uris (nullable) is None
+        # and model_fields_set contains the field
+        if (
+            self.related_variable_definition_uris is None
+            and "related_variable_definition_uris" in self.model_fields_set
+        ):
+            _dict["related_variable_definition_uris"] = None
+
+        # set to None if contact (nullable) is None
+        # and model_fields_set contains the field
+        if self.contact is None and "contact" in self.model_fields_set:
+            _dict["contact"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of ValidityPeriod from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": LanguageStringType.from_dict(obj["name"])
+                if obj.get("name") is not None
+                else None,
+                "definition": LanguageStringType.from_dict(obj["definition"])
+                if obj.get("definition") is not None
+                else None,
+                "classification_reference": obj.get("classification_reference"),
+                "unit_types": obj.get("unit_types"),
+                "subject_fields": obj.get("subject_fields"),
+                "contains_special_categories_of_personal_data": obj.get(
+                    "contains_special_categories_of_personal_data"
+                ),
+                "variable_status": obj.get("variable_status"),
+                "measurement_type": obj.get("measurement_type"),
+                "valid_from": obj.get("valid_from"),
+                "external_reference_uri": obj.get("external_reference_uri"),
+                "comment": LanguageStringType.from_dict(obj["comment"])
+                if obj.get("comment") is not None
+                else None,
+                "related_variable_definition_uris": obj.get(
+                    "related_variable_definition_uris"
+                ),
+                "contact": Contact.from_dict(obj["contact"])
+                if obj.get("contact") is not None
+                else None,
+            }
+        )
+        return _obj

dapla_metadata/variable_definitions/generated/vardef_client/models/variable_status.py

@@ -0,0 +1,33 @@
+"""Variable Definitions
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class VariableStatus(str, Enum):
+    """Life cycle status of a variable definition."""
+
+    """
+    allowed enum values
+    """
+    DRAFT = "DRAFT"
+    PUBLISHED_INTERNAL = "PUBLISHED_INTERNAL"
+    PUBLISHED_EXTERNAL = "PUBLISHED_EXTERNAL"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of VariableStatus from a JSON string"""
+        return cls(json.loads(json_str))