signwell-sdk-python 0.1.0__py3-none-any.whl

signwell_sdk/models/document_response_fields_inner_inner.py

@@ -0,0 +1,268 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+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, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from signwell_sdk.models.date_format import DateFormat
+from signwell_sdk.models.document_response_fields_inner_inner_options_inner import (
+    DocumentResponseFieldsInnerInnerOptionsInner,
+)
+from signwell_sdk.models.document_response_fields_inner_inner_recipient import DocumentResponseFieldsInnerInnerRecipient
+from signwell_sdk.models.document_response_fields_inner_inner_value import DocumentResponseFieldsInnerInnerValue
+from signwell_sdk.models.field_type import FieldType
+from signwell_sdk.models.text_validation import TextValidation
+from pydantic import model_validator
+from typing import Any, Optional, Set, get_args
+from typing_extensions import Self
+
+
+class DocumentResponseFieldsInnerInner(BaseModel):
+    """
+    DocumentResponseFieldsInnerInner
+    """  # noqa: E501
+
+    x: Union[StrictFloat, StrictInt]
+    y: Union[StrictFloat, StrictInt]
+    page: StrictInt
+    recipient: DocumentResponseFieldsInnerInnerRecipient | None = None
+    api_id: StrictStr | None = None
+    name: StrictStr | None = None
+    date_format: DateFormat | None = None
+    fixed_width: StrictBool | None = None
+    formula: StrictStr | None = None
+    label: StrictStr | None = None
+    lock_sign_date: StrictBool | None = None
+    required: StrictBool | None = None
+    type: FieldType | None = None
+    validation: TextValidation | None = None
+    value: DocumentResponseFieldsInnerInnerValue | None = None
+    height: StrictStr | None = None
+    width: StrictStr | None = None
+    recipient_id: StrictStr | None = None
+    signing_elements_group_id: StrictStr | None = None
+    placeholder_name: StrictStr | None = None
+    options: List[DocumentResponseFieldsInnerInnerOptionsInner] | None = Field(
+        default=None, description="Dropdown options (for dropdown/select fields)"
+    )
+    default_option: StrictStr | None = Field(default=None, description="Default selected option")
+    allow_other: StrictBool | None = Field(default=None, description='Whether "Other" option is allowed')
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "x",
+        "y",
+        "page",
+        "recipient",
+        "api_id",
+        "name",
+        "date_format",
+        "fixed_width",
+        "formula",
+        "label",
+        "lock_sign_date",
+        "required",
+        "type",
+        "validation",
+        "value",
+        "height",
+        "width",
+        "recipient_id",
+        "signing_elements_group_id",
+        "placeholder_name",
+        "options",
+        "default_option",
+        "allow_other",
+    ]
+
+    @model_validator(mode="before")
+    @classmethod
+    def normalize_checkbox_value_input(cls, data: Any) -> Any:
+        if not isinstance(data, dict):
+            return data
+        if cls._field_type_value(data.get("type")) != "checkbox":
+            return data
+        if data.get("value") is None:
+            return data
+
+        normalized = dict(data)
+        normalized["value"] = cls._build_value_model(cls._normalize_checkbox_value(data["value"]))
+        return normalized
+
+    @model_validator(mode="after")
+    def normalize_checkbox_value(self) -> Self:
+        field_type = getattr(self.type, "value", self.type)
+        if field_type == "checkbox" and self.value is not None:
+            self.value.actual_instance = self._normalize_checkbox_value(self.value)
+        return self
+
+    @classmethod
+    def _build_value_model(cls, value: str) -> Any:
+        value_field = cls.model_fields.get("value")
+        if value_field is None:
+            return value
+
+        annotation = value_field.annotation
+        candidates = get_args(annotation) or (annotation,)
+        for candidate in candidates:
+            if candidate is type(None):
+                continue
+            value_model: Any = candidate
+            if callable(value_model):
+                return value_model(value)
+        return value
+
+    @staticmethod
+    def _field_type_value(value: Any) -> Any:
+        return getattr(value, "value", value)
+
+    @staticmethod
+    def _normalize_checkbox_value(value: Any) -> str:
+        actual_value = getattr(value, "actual_instance", value)
+        if isinstance(actual_value, bool):
+            return "t" if actual_value else "f"
+        if isinstance(actual_value, str):
+            normalized = actual_value.strip().lower()
+            if normalized in {"true", "t"}:
+                return "t"
+            if normalized in {"false", "f"}:
+                return "f"
+        raise ValueError('Checkbox field values must be boolean or one of "true", "false", "t", or "f"')
+
+    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 DocumentResponseFieldsInnerInner 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of recipient
+        if self.recipient:
+            _dict["recipient"] = self.recipient.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of value
+        if self.value:
+            _dict["value"] = self.value.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in options (list)
+        _items_options: list[Any] = []
+        if self.options:
+            for _item_options in self.options:
+                if _item_options:
+                    _items_options.append(_item_options.to_dict())
+            _dict["options"] = _items_options
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # 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 value (nullable) is None
+        # and model_fields_set contains the field
+        if self.value is None and "value" in self.model_fields_set:
+            _dict["value"] = None
+
+        # set to None if recipient_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.recipient_id is None and "recipient_id" in self.model_fields_set:
+            _dict["recipient_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of DocumentResponseFieldsInnerInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "x": obj.get("x"),
+                "y": obj.get("y"),
+                "page": obj.get("page"),
+                "recipient": DocumentResponseFieldsInnerInnerRecipient.from_dict(obj["recipient"])
+                if obj.get("recipient") is not None
+                else None,
+                "api_id": obj.get("api_id"),
+                "name": obj.get("name"),
+                "date_format": obj.get("date_format"),
+                "fixed_width": obj.get("fixed_width"),
+                "formula": obj.get("formula"),
+                "label": obj.get("label"),
+                "lock_sign_date": obj.get("lock_sign_date"),
+                "required": obj.get("required"),
+                "type": obj.get("type"),
+                "validation": obj.get("validation"),
+                "value": DocumentResponseFieldsInnerInnerValue.from_dict(obj["value"])
+                if obj.get("value") is not None
+                else None,
+                "height": obj.get("height"),
+                "width": obj.get("width"),
+                "recipient_id": obj.get("recipient_id"),
+                "signing_elements_group_id": obj.get("signing_elements_group_id"),
+                "placeholder_name": obj.get("placeholder_name"),
+                "options": [DocumentResponseFieldsInnerInnerOptionsInner.from_dict(_item) for _item in obj["options"]]
+                if obj.get("options") is not None
+                else None,
+                "default_option": obj.get("default_option"),
+                "allow_other": obj.get("allow_other"),
+            }
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/document_response_fields_inner_inner_options_inner.py

@@ -0,0 +1,101 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class DocumentResponseFieldsInnerInnerOptionsInner(BaseModel):
+    """
+    DocumentResponseFieldsInnerInnerOptionsInner
+    """  # noqa: E501
+
+    name: StrictStr | None = None
+    api_id: StrictStr | None = None
+    is_other: StrictBool | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["name", "api_id", "is_other"]
+
+    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 DocumentResponseFieldsInnerInnerOptionsInner 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of DocumentResponseFieldsInnerInnerOptionsInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"name": obj.get("name"), "api_id": obj.get("api_id"), "is_other": obj.get("is_other")}
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/document_response_fields_inner_inner_recipient.py

@@ -0,0 +1,98 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+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
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class DocumentResponseFieldsInnerInnerRecipient(BaseModel):
+    """
+    DocumentResponseFieldsInnerInnerRecipient
+    """  # noqa: E501
+
+    email: StrictStr
+    name: StrictStr
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["email", "name"]
+
+    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 DocumentResponseFieldsInnerInnerRecipient 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of DocumentResponseFieldsInnerInnerRecipient from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"email": obj.get("email"), "name": obj.get("name")})
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/document_response_fields_inner_inner_value.py

@@ -0,0 +1,195 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictBool,
+    StrictFloat,
+    StrictInt,
+    StrictStr,
+    ValidationError,
+    field_validator,
+)
+from typing import Any, List, Optional, Union
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict, cast
+from typing_extensions import Literal, Self
+
+DOCUMENTRESPONSEFIELDSINNERINNERVALUE_ONE_OF_SCHEMAS = ["bool", "float", "str"]
+
+
+class DocumentResponseFieldsInnerInnerValue(BaseModel):
+    """
+    DocumentResponseFieldsInnerInnerValue
+    """
+
+    # data type: str
+    oneof_schema_1_validator: StrictStr | None = None
+    # data type: bool
+    oneof_schema_2_validator: StrictBool | None = None
+    # data type: float
+    oneof_schema_3_validator: Union[StrictFloat, StrictInt] | None = None
+    actual_instance: Union[bool, float, str] | None = None
+    one_of_schemas: Set[str] = {"bool", "float", "str"}
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=(),
+    )
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_oneof(cls, v):
+        if v is None:
+            return v
+
+        instance = DocumentResponseFieldsInnerInnerValue.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: str
+        try:
+            instance.oneof_schema_1_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: bool
+        try:
+            instance.oneof_schema_2_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: float
+        try:
+            instance.oneof_schema_3_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in DocumentResponseFieldsInnerInnerValue with oneOf schemas: bool, float, str. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in DocumentResponseFieldsInnerInnerValue with oneOf schemas: bool, float, str. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str | None) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        if json_str is None:
+            return instance
+
+        error_messages = []
+        match = 0
+
+        # deserialize data into str
+        try:
+            # validation
+            instance.oneof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = cast(
+                Union[bool, float, str],
+                instance.oneof_schema_1_validator,
+            )
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into bool
+        try:
+            # validation
+            instance.oneof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = cast(
+                Union[bool, float, str],
+                instance.oneof_schema_2_validator,
+            )
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into float
+        try:
+            # validation
+            instance.oneof_schema_3_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = cast(
+                Union[bool, float, str],
+                instance.oneof_schema_3_validator,
+            )
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when deserializing the JSON string into DocumentResponseFieldsInnerInnerValue with oneOf schemas: bool, float, str. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into DocumentResponseFieldsInnerInnerValue with oneOf schemas: bool, float, str. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Union[Dict[str, Any], bool, float, str] | None:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())