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

signwell_sdk/models/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.additional_fields_inner_inner_value import AdditionalFieldsInnerInnerValue
+from signwell_sdk.models.date_format import DateFormat
+from signwell_sdk.models.dropdown_option import DropdownOption
+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 FieldsInnerInner(BaseModel):
+    """
+    FieldsInnerInner
+    """  # noqa: E501
+
+    x: Union[StrictFloat, StrictInt] = Field(
+        description="Horizontal value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."
+    )
+    y: Union[StrictFloat, StrictInt] = Field(
+        description="Vertical value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."
+    )
+    page: StrictInt = Field(
+        description="The page number within the file. If the page does not exist within the file then the field won't be created."
+    )
+    recipient_id: StrictStr = Field(
+        description="Unique identifier of the recipient assigned to the field. Recipients assigned to fields will be the only ones that will see and be able to complete those fields."
+    )
+    type: FieldType
+    required: StrictBool | None = Field(
+        default=True,
+        description="Whether the field must be completed by the recipient. Defaults to `true` except for checkbox type fields.",
+    )
+    label: StrictStr | None = Field(
+        default=None, description="Text and Date fields only: label that is displayed when the field is empty."
+    )
+    value: AdditionalFieldsInnerInnerValue | None = None
+    api_id: StrictStr | None = Field(
+        default=None,
+        description="Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields.",
+    )
+    name: StrictStr | None = Field(
+        default=None,
+        description="Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements.",
+    )
+    validation: TextValidation | None = None
+    fixed_width: StrictBool | None = Field(
+        default=False,
+        description="Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`.",
+    )
+    lock_sign_date: StrictBool | None = Field(
+        default=False,
+        description="Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to `false`.",
+    )
+    date_format: DateFormat | None = None
+    height: Union[StrictFloat, StrictInt] | None = Field(
+        default=None,
+        description="Height of the field (in pixels). Maximum height varies by field type: Signature/Initials (200px), others (74px). When using text tags if the height is greater than the maximum height, the height will be set to the maximum height.",
+    )
+    width: Union[StrictFloat, StrictInt] | None = Field(
+        default=None,
+        description="Width of the field (in pixels). For text fields, width will auto-grow unless `fixed_width` is true.",
+    )
+    options: List[DropdownOption] | None = Field(
+        default=None, description="Array of dropdown options (for dropdown/select fields only)"
+    )
+    default_option: StrictStr | None = Field(
+        default=None, description="Default selected option (for dropdown/select fields only)"
+    )
+    allow_other: StrictBool | None = Field(
+        default=False, description='Whether to allow "Other" option with text input (for dropdown/select fields only)'
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "x",
+        "y",
+        "page",
+        "recipient_id",
+        "type",
+        "required",
+        "label",
+        "value",
+        "api_id",
+        "name",
+        "validation",
+        "fixed_width",
+        "lock_sign_date",
+        "date_format",
+        "height",
+        "width",
+        "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 FieldsInnerInner 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 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of FieldsInnerInner 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_id": obj.get("recipient_id"),
+                "type": obj.get("type"),
+                "required": obj.get("required") if obj.get("required") is not None else True,
+                "label": obj.get("label"),
+                "value": AdditionalFieldsInnerInnerValue.from_dict(obj["value"])
+                if obj.get("value") is not None
+                else None,
+                "api_id": obj.get("api_id"),
+                "name": obj.get("name"),
+                "validation": obj.get("validation"),
+                "fixed_width": obj.get("fixed_width") if obj.get("fixed_width") is not None else False,
+                "lock_sign_date": obj.get("lock_sign_date") if obj.get("lock_sign_date") is not None else False,
+                "date_format": obj.get("date_format"),
+                "height": obj.get("height"),
+                "width": obj.get("width"),
+                "options": [DropdownOption.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") if obj.get("allow_other") is not None else False,
+            }
+        )
+        # 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/file_format.py

@@ -0,0 +1,33 @@
+"""
+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
+from enum import Enum
+from typing_extensions import Self
+
+
+class FileFormat(str, Enum):
+    """
+    Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+    """
+
+    """
+    allowed enum values
+    """
+    PDF = "pdf"
+    ZIP = "zip"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FileFormat from a JSON string"""
+        return cls(json.loads(json_str))

signwell_sdk/models/file_info.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, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class FileInfo(BaseModel):
+    """
+    File information
+    """  # noqa: E501
+
+    name: StrictStr = Field(description="File name")
+    pages_number: StrictInt = Field(description="Number of pages in the file")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["name", "pages_number"]
+
+    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 FileInfo 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 FileInfo 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"), "pages_number": obj.get("pages_number")})
+        # 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/files_inner.py

@@ -0,0 +1,103 @@
+"""
+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, StrictBytes, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class FilesInner(BaseModel):
+    """
+    FilesInner
+    """  # noqa: E501
+
+    name: StrictStr = Field(description="Name of the file that will be uploaded.")
+    file_url: StrictStr | None = Field(default=None, description="Publicly available URL of the file to be uploaded.")
+    file_base64: Union[StrictBytes, StrictStr] | None = Field(
+        default=None, description="A RFC 4648 base64 string of the file to be uploaded."
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["name", "file_url", "file_base64"]
+
+    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 FilesInner 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 FilesInner 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"), "file_url": obj.get("file_url"), "file_base64": obj.get("file_base64")}
+        )
+        # 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/label_info.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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class LabelInfo(BaseModel):
+    """
+    Label information
+    """  # noqa: E501
+
+    id: StrictStr | None = Field(default=None, description="Label ID")
+    name: StrictStr | None = Field(default=None, description="Label name")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "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 LabelInfo 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 LabelInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"id": obj.get("id"), "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