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

signwell_sdk/models/document_template_update_request.py

@@ -0,0 +1,208 @@
+"""
+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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from signwell_sdk.models.label_request import LabelRequest
+from signwell_sdk.models.template_checkbox_groups_inner import TemplateCheckboxGroupsInner
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class DocumentTemplateUpdateRequest(BaseModel):
+    """
+    DocumentTemplateUpdateRequest
+    """  # noqa: E501
+
+    name: StrictStr | None = Field(default=None, description="The name of the template.")
+    subject: StrictStr | None = Field(
+        default=None,
+        description="Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template).",
+    )
+    message: StrictStr | None = Field(
+        default=None,
+        description="Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template).",
+    )
+    draft: StrictBool | None = Field(
+        default=False,
+        description="Whether the template can still be updated before it is ready for usage. If set to `false` the template is marked as `Available` and it will be ready for use. Defaults to `false`.",
+    )
+    expires_in: Annotated[int, Field(strict=True, ge=1)] | None = Field(
+        default=None,
+        description="Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template).",
+    )
+    reminders: StrictBool | None = Field(
+        default=True,
+        description="Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to `true`. Defaults to `true`.",
+    )
+    apply_signing_order: StrictBool | None = Field(
+        default=False,
+        description="When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request.",
+    )
+    api_application_id: StrictStr | None = Field(
+        default=None,
+        description="Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings",
+    )
+    redirect_url: StrictStr | None = Field(
+        default=None, description="A URL that recipients are redirected to after successfully signing a document."
+    )
+    allow_decline: StrictBool | None = Field(
+        default=True,
+        description="Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign.",
+    )
+    allow_reassign: StrictBool | None = Field(
+        default=True,
+        description="In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else.",
+    )
+    decline_redirect_url: StrictStr | None = Field(
+        default=None, description="A URL that recipients are redirected to if the document is declined."
+    )
+    metadata: Dict[str, StrictStr] | None = Field(
+        default=None,
+        description="Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned.",
+    )
+    labels: List[LabelRequest] | None = Field(
+        default=None,
+        description="Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels. Updating labels on a document will replace any existing labels for that document.",
+    )
+    checkbox_groups: List[TemplateCheckboxGroupsInner] | None = Field(
+        default=None,
+        description="Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient.",
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "name",
+        "subject",
+        "message",
+        "draft",
+        "expires_in",
+        "reminders",
+        "apply_signing_order",
+        "api_application_id",
+        "redirect_url",
+        "allow_decline",
+        "allow_reassign",
+        "decline_redirect_url",
+        "metadata",
+        "labels",
+        "checkbox_groups",
+    ]
+
+    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 DocumentTemplateUpdateRequest 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 each item in labels (list)
+        _items_labels: list[Any] = []
+        if self.labels:
+            for _item_labels in self.labels:
+                if _item_labels:
+                    _items_labels.append(_item_labels.to_dict())
+            _dict["labels"] = _items_labels
+        # override the default output from pydantic by calling `to_dict()` of each item in checkbox_groups (list)
+        _items_checkbox_groups: list[Any] = []
+        if self.checkbox_groups:
+            for _item_checkbox_groups in self.checkbox_groups:
+                if _item_checkbox_groups:
+                    _items_checkbox_groups.append(_item_checkbox_groups.to_dict())
+            _dict["checkbox_groups"] = _items_checkbox_groups
+        # 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 DocumentTemplateUpdateRequest 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"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "draft": obj.get("draft") if obj.get("draft") is not None else False,
+                "expires_in": obj.get("expires_in"),
+                "reminders": obj.get("reminders") if obj.get("reminders") is not None else True,
+                "apply_signing_order": obj.get("apply_signing_order")
+                if obj.get("apply_signing_order") is not None
+                else False,
+                "api_application_id": obj.get("api_application_id"),
+                "redirect_url": obj.get("redirect_url"),
+                "allow_decline": obj.get("allow_decline") if obj.get("allow_decline") is not None else True,
+                "allow_reassign": obj.get("allow_reassign") if obj.get("allow_reassign") is not None else True,
+                "decline_redirect_url": obj.get("decline_redirect_url"),
+                "metadata": obj.get("metadata"),
+                "labels": [LabelRequest.from_dict(_item) for _item in obj["labels"]]
+                if obj.get("labels") is not None
+                else None,
+                "checkbox_groups": [TemplateCheckboxGroupsInner.from_dict(_item) for _item in obj["checkbox_groups"]]
+                if obj.get("checkbox_groups") is not None
+                else None,
+            }
+        )
+        # 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/dropdown_option.py

@@ -0,0 +1,153 @@
+"""
+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, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from signwell_sdk.models.detailed_option import DetailedOption
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict, cast
+from typing_extensions import Literal, Self
+
+DROPDOWNOPTION_ONE_OF_SCHEMAS = ["DetailedOption", "str"]
+
+
+class DropdownOption(BaseModel):
+    """
+    A dropdown option - either a simple string or a detailed object with name and optional api_id
+    """
+
+    # data type: str
+    oneof_schema_1_validator: StrictStr | None = Field(default=None, description="Simple string option")
+    # data type: DetailedOption
+    oneof_schema_2_validator: DetailedOption | None = None
+    actual_instance: Union[DetailedOption, str] | None = None
+    one_of_schemas: Set[str] = {"DetailedOption", "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):
+        instance = DropdownOption.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: DetailedOption
+        if not isinstance(v, DetailedOption):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `DetailedOption`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in DropdownOption with oneOf schemas: DetailedOption, str. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in DropdownOption with oneOf schemas: DetailedOption, 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) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        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[DetailedOption, str],
+                instance.oneof_schema_1_validator,
+            )
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into DetailedOption
+        try:
+            instance.actual_instance = DetailedOption.from_json(json_str)
+            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 DropdownOption with oneOf schemas: DetailedOption, str. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into DropdownOption with oneOf schemas: DetailedOption, 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], DetailedOption, 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())

signwell_sdk/models/error_response.py

@@ -0,0 +1,107 @@
+"""
+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 signwell_sdk.models.error_response_meta import ErrorResponseMeta
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class ErrorResponse(BaseModel):
+    """
+    Standard error response
+    """  # noqa: E501
+
+    message: StrictStr | None = Field(default=None, description="Human-readable error message")
+    meta: ErrorResponseMeta | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["message", "meta"]
+
+    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 ErrorResponse 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 meta
+        if self.meta:
+            _dict["meta"] = self.meta.to_dict()
+        # 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 ErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message": obj.get("message"),
+                "meta": ErrorResponseMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None,
+            }
+        )
+        # 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/error_response_meta.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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class ErrorResponseMeta(BaseModel):
+    """
+    ErrorResponseMeta
+    """  # noqa: E501
+
+    error: StrictStr = Field(description="Error code identifier")
+    message: StrictStr = Field(description="Detailed error message")
+    messages: List[StrictStr] | None = Field(default=None, description="List of error messages")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["error", "message", "messages"]
+
+    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 ErrorResponseMeta 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 ErrorResponseMeta from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"error": obj.get("error"), "message": obj.get("message"), "messages": obj.get("messages")}
+        )
+        # 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/field_type.py

@@ -0,0 +1,46 @@
+"""
+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 FieldType(str, Enum):
+    """
+    Type of signing field
+    """
+
+    """
+    allowed enum values
+    """
+    INITIALS = "initials"
+    SIGNATURE = "signature"
+    CHECKBOX = "checkbox"
+    DATE = "date"
+    SELECT = "select"
+    TEXT = "text"
+    DROPDOWN = "dropdown"
+    AUTOFILL_COMPANY = "autofill_company"
+    AUTOFILL_EMAIL = "autofill_email"
+    AUTOFILL_FIRST_NAME = "autofill_first_name"
+    AUTOFILL_LAST_NAME = "autofill_last_name"
+    AUTOFILL_NAME = "autofill_name"
+    AUTOFILL_PHONE = "autofill_phone"
+    AUTOFILL_TITLE = "autofill_title"
+    AUTOFILL_DATE_SIGNED = "autofill_date_signed"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FieldType from a JSON string"""
+        return cls(json.loads(json_str))