docket-client 0.3.2__py3-none-any.whl

docket/client.py

@@ -0,0 +1,272 @@
+import ssl
+from typing import Any
+
+from attrs import define, field, evolve
+import httpx
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    def with_headers(self, headers: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "Client":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "Client":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "Client":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+@define
+class AuthenticatedClient:
+    """A Client which has been authenticated for use on secured endpoints
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+        token: The token to use for authentication
+        prefix: The prefix to use for the Authorization header
+        auth_header_name: The name of the Authorization header
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    token: str
+    prefix: str = "Bearer"
+    auth_header_name: str = "Authorization"
+
+    def with_headers(self, headers: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._headers[self.auth_header_name] = (
+                f"{self.prefix} {self.token}" if self.prefix else self.token
+            )
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._headers[self.auth_header_name] = (
+                f"{self.prefix} {self.token}" if self.prefix else self.token
+            )
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)

docket/errors.py

@@ -0,0 +1,16 @@
+"""Contains shared errors types that can be raised from API functions"""
+
+
+class UnexpectedStatus(Exception):
+    """Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, content: bytes):
+        self.status_code = status_code
+        self.content = content
+
+        super().__init__(
+            f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
+        )
+
+
+__all__ = ["UnexpectedStatus"]

docket/models/__init__.py

@@ -0,0 +1,221 @@
+"""Contains all the data models used in inputs/outputs"""
+
+from .access_role import AccessRole
+from .access_role_nullable_type_1 import AccessRoleNullableType1
+from .access_role_nullable_type_2_type_1 import AccessRoleNullableType2Type1
+from .access_role_nullable_type_3_type_1 import AccessRoleNullableType3Type1
+from .acquisition_variable import AcquisitionVariable
+from .acquisition_warning import AcquisitionWarning
+from .add_principal_request import AddPrincipalRequest
+from .api_token_response import ApiTokenResponse
+from .api_token_status import ApiTokenStatus
+from .archive_recurring_acquisition_request import ArchiveRecurringAcquisitionRequest
+from .archive_recurring_acquisition_response import ArchiveRecurringAcquisitionResponse
+from .archive_scheduled_acquisition_request import ArchiveScheduledAcquisitionRequest
+from .archive_template_request import ArchiveTemplateRequest
+from .auth_mode import AuthMode
+from .behavior_curriculum_push_settings_request import BehaviorCurriculumPushSettingsRequest
+from .behavior_curriculum_settings import BehaviorCurriculumSettings
+from .behavior_curriculum_settings_preview_response import BehaviorCurriculumSettingsPreviewResponse
+from .behavior_curriculum_settings_preview_response_promoted import (
+    BehaviorCurriculumSettingsPreviewResponsePromoted,
+)
+from .behavior_curriculum_settings_version_response import BehaviorCurriculumSettingsVersionResponse
+from .behavior_curriculum_settings_version_response_promoted import (
+    BehaviorCurriculumSettingsVersionResponsePromoted,
+)
+from .caller_kind import CallerKind
+from .create_api_token_request import CreateApiTokenRequest
+from .create_application_principal_request import CreateApplicationPrincipalRequest
+from .create_personal_api_token_request import CreatePersonalApiTokenRequest
+from .create_recurring_acquisition_request import CreateRecurringAcquisitionRequest
+from .create_role_assignment_request import CreateRoleAssignmentRequest
+from .create_scheduled_acquisition_request import CreateScheduledAcquisitionRequest
+from .create_template_request import CreateTemplateRequest
+from .created_api_token_response import CreatedApiTokenResponse
+from .effective_status import EffectiveStatus
+from .fip_color import FipColor
+from .fip_fiber import FipFiber
+from .fip_mode import FipMode
+from .fip_push_settings_request import FipPushSettingsRequest
+from .fip_settings import FipSettings
+from .fip_settings_preview_response import FipSettingsPreviewResponse
+from .fip_settings_preview_response_promoted import FipSettingsPreviewResponsePromoted
+from .fip_settings_version_response import FipSettingsVersionResponse
+from .fip_settings_version_response_promoted import FipSettingsVersionResponsePromoted
+from .future_occurrences import FutureOccurrences
+from .get_resolved_settings_response_200 import GetResolvedSettingsResponse200
+from .held_role_response import HeldRoleResponse
+from .http_validation_problem_details import HttpValidationProblemDetails
+from .http_validation_problem_details_errors import HttpValidationProblemDetailsErrors
+from .instrument_response import InstrumentResponse
+from .kept_occurrence import KeptOccurrence
+from .kept_occurrence_reason import KeptOccurrenceReason
+from .list_active_acquisitions_effective_status_item import (
+    ListActiveAcquisitionsEffectiveStatusItem,
+)
+from .list_scheduled_acquisitions_planning_status import ListScheduledAcquisitionsPlanningStatus
+from .me_caller import MeCaller
+from .me_permission import MePermission
+from .me_response import MeResponse
+from .me_role import MeRole
+from .occurrence_preview import OccurrencePreview
+from .occurrence_summary import OccurrenceSummary
+from .occurrence_warnings import OccurrenceWarnings
+from .permission_action import PermissionAction
+from .person_assignment import PersonAssignment
+from .person_lookup_response import PersonLookupResponse
+from .person_response import PersonResponse
+from .person_role import PersonRole
+from .personal_token_limits import PersonalTokenLimits
+from .planning_status import PlanningStatus
+from .principal_kind import PrincipalKind
+from .principal_response import PrincipalResponse
+from .problem_details import ProblemDetails
+from .project_response import ProjectResponse
+from .recurrence_exception_kind import RecurrenceExceptionKind
+from .recurrence_exception_response import RecurrenceExceptionResponse
+from .recurrence_frequency import RecurrenceFrequency
+from .recurrence_preview_response import RecurrencePreviewResponse
+from .recurrence_rule import RecurrenceRule
+from .recurring_acquisition_created_response import RecurringAcquisitionCreatedResponse
+from .recurring_acquisition_detail_response import RecurringAcquisitionDetailResponse
+from .recurring_acquisition_response import RecurringAcquisitionResponse
+from .report_run_outcome_request import ReportRunOutcomeRequest
+from .resolution_mode import ResolutionMode
+from .resolved_settings import ResolvedSettings
+from .role_assignment_response import RoleAssignmentResponse
+from .role_origin import RoleOrigin
+from .role_source_kind import RoleSourceKind
+from .run_origin import RunOrigin
+from .run_outcome import RunOutcome
+from .run_response import RunResponse
+from .run_settings_snapshot import RunSettingsSnapshot
+from .run_start_response import RunStartResponse
+from .run_start_response_settings import RunStartResponseSettings
+from .run_status import RunStatus
+from .scheduled_acquisition_edit_preview_response import ScheduledAcquisitionEditPreviewResponse
+from .scheduled_acquisition_response import ScheduledAcquisitionResponse
+from .set_planning_status_request import SetPlanningStatusRequest
+from .settings_selector import SettingsSelector
+from .skipped_occurrence import SkippedOccurrence
+from .split_preview_response import SplitPreviewResponse
+from .split_recurring_acquisition_request import SplitRecurringAcquisitionRequest
+from .split_recurring_acquisition_response import SplitRecurringAcquisitionResponse
+from .start_run_request import StartRunRequest
+from .subject_lookup_response import SubjectLookupResponse
+from .subject_response import SubjectResponse
+from .sync_counts import SyncCounts
+from .sync_response import SyncResponse
+from .template_response import TemplateResponse
+from .update_scheduled_acquisition_request import UpdateScheduledAcquisitionRequest
+from .update_template_request import UpdateTemplateRequest
+from .weekday import Weekday
+
+__all__ = (
+    "AccessRole",
+    "AccessRoleNullableType1",
+    "AccessRoleNullableType2Type1",
+    "AccessRoleNullableType3Type1",
+    "AcquisitionVariable",
+    "AcquisitionWarning",
+    "AddPrincipalRequest",
+    "ApiTokenResponse",
+    "ApiTokenStatus",
+    "ArchiveRecurringAcquisitionRequest",
+    "ArchiveRecurringAcquisitionResponse",
+    "ArchiveScheduledAcquisitionRequest",
+    "ArchiveTemplateRequest",
+    "AuthMode",
+    "BehaviorCurriculumPushSettingsRequest",
+    "BehaviorCurriculumSettings",
+    "BehaviorCurriculumSettingsPreviewResponse",
+    "BehaviorCurriculumSettingsPreviewResponsePromoted",
+    "BehaviorCurriculumSettingsVersionResponse",
+    "BehaviorCurriculumSettingsVersionResponsePromoted",
+    "CallerKind",
+    "CreateApiTokenRequest",
+    "CreateApplicationPrincipalRequest",
+    "CreatedApiTokenResponse",
+    "CreatePersonalApiTokenRequest",
+    "CreateRecurringAcquisitionRequest",
+    "CreateRoleAssignmentRequest",
+    "CreateScheduledAcquisitionRequest",
+    "CreateTemplateRequest",
+    "EffectiveStatus",
+    "FipColor",
+    "FipFiber",
+    "FipMode",
+    "FipPushSettingsRequest",
+    "FipSettings",
+    "FipSettingsPreviewResponse",
+    "FipSettingsPreviewResponsePromoted",
+    "FipSettingsVersionResponse",
+    "FipSettingsVersionResponsePromoted",
+    "FutureOccurrences",
+    "GetResolvedSettingsResponse200",
+    "HeldRoleResponse",
+    "HttpValidationProblemDetails",
+    "HttpValidationProblemDetailsErrors",
+    "InstrumentResponse",
+    "KeptOccurrence",
+    "KeptOccurrenceReason",
+    "ListActiveAcquisitionsEffectiveStatusItem",
+    "ListScheduledAcquisitionsPlanningStatus",
+    "MeCaller",
+    "MePermission",
+    "MeResponse",
+    "MeRole",
+    "OccurrencePreview",
+    "OccurrenceSummary",
+    "OccurrenceWarnings",
+    "PermissionAction",
+    "PersonalTokenLimits",
+    "PersonAssignment",
+    "PersonLookupResponse",
+    "PersonResponse",
+    "PersonRole",
+    "PlanningStatus",
+    "PrincipalKind",
+    "PrincipalResponse",
+    "ProblemDetails",
+    "ProjectResponse",
+    "RecurrenceExceptionKind",
+    "RecurrenceExceptionResponse",
+    "RecurrenceFrequency",
+    "RecurrencePreviewResponse",
+    "RecurrenceRule",
+    "RecurringAcquisitionCreatedResponse",
+    "RecurringAcquisitionDetailResponse",
+    "RecurringAcquisitionResponse",
+    "ReportRunOutcomeRequest",
+    "ResolutionMode",
+    "ResolvedSettings",
+    "RoleAssignmentResponse",
+    "RoleOrigin",
+    "RoleSourceKind",
+    "RunOrigin",
+    "RunOutcome",
+    "RunResponse",
+    "RunSettingsSnapshot",
+    "RunStartResponse",
+    "RunStartResponseSettings",
+    "RunStatus",
+    "ScheduledAcquisitionEditPreviewResponse",
+    "ScheduledAcquisitionResponse",
+    "SetPlanningStatusRequest",
+    "SettingsSelector",
+    "SkippedOccurrence",
+    "SplitPreviewResponse",
+    "SplitRecurringAcquisitionRequest",
+    "SplitRecurringAcquisitionResponse",
+    "StartRunRequest",
+    "SubjectLookupResponse",
+    "SubjectResponse",
+    "SyncCounts",
+    "SyncResponse",
+    "TemplateResponse",
+    "UpdateScheduledAcquisitionRequest",
+    "UpdateTemplateRequest",
+    "Weekday",
+)

docket/models/access_role.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class AccessRole(str, Enum):
+    ACQUISITION_SETTINGS_MAINTAINER = "acquisition_settings_maintainer"
+    ADMIN = "admin"
+    MACHINE = "machine"
+    SCHEDULE_MAINTAINER = "schedule_maintainer"
+    USER = "user"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/access_role_nullable_type_1.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class AccessRoleNullableType1(str, Enum):
+    ACQUISITION_SETTINGS_MAINTAINER = "acquisition_settings_maintainer"
+    ADMIN = "admin"
+    MACHINE = "machine"
+    SCHEDULE_MAINTAINER = "schedule_maintainer"
+    USER = "user"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/access_role_nullable_type_2_type_1.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class AccessRoleNullableType2Type1(str, Enum):
+    ACQUISITION_SETTINGS_MAINTAINER = "acquisition_settings_maintainer"
+    ADMIN = "admin"
+    MACHINE = "machine"
+    SCHEDULE_MAINTAINER = "schedule_maintainer"
+    USER = "user"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/access_role_nullable_type_3_type_1.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class AccessRoleNullableType3Type1(str, Enum):
+    ACQUISITION_SETTINGS_MAINTAINER = "acquisition_settings_maintainer"
+    ADMIN = "admin"
+    MACHINE = "machine"
+    SCHEDULE_MAINTAINER = "schedule_maintainer"
+    USER = "user"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/acquisition_variable.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+T = TypeVar("T", bound="AcquisitionVariable")
+
+
+@_attrs_define
+class AcquisitionVariable:
+    """
+    Attributes:
+        key (str): Variable name; trimmed, unique per acquisition.
+        value (Any):
+    """
+
+    key: str
+    value: Any
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        key = self.key
+
+        value = self.value
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "key": key,
+                "value": value,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        key = d.pop("key")
+
+        value = d.pop("value")
+
+        acquisition_variable = cls(
+            key=key,
+            value=value,
+        )
+
+        acquisition_variable.additional_properties = d
+        return acquisition_variable
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties