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

signwell_sdk/models/template_recipients_inner.py

@@ -0,0 +1,146 @@
+"""
+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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class TemplateRecipientsInner(BaseModel):
+    """
+    TemplateRecipientsInner
+    """  # noqa: E501
+
+    id: StrictStr = Field(
+        description="A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more."
+    )
+    name: StrictStr | None = Field(default=None, description="Name of the recipient.")
+    email: StrictStr = Field(description="Email address for the recipient.")
+    placeholder_name: StrictStr | None = Field(
+        default=None, description="The name of the placeholder you want this recipient assigned to."
+    )
+    passcode: StrictStr | None = Field(
+        default=None,
+        description="If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document.",
+    )
+    subject: StrictStr | None = Field(
+        default=None,
+        description="Email subject for the signature request that the recipient will see. Overrides the general subject for the template.",
+    )
+    message: StrictStr | None = Field(
+        default=None,
+        description="Email message for the signature request that the recipient will see. Overrides the general message for the template.",
+    )
+    send_email: StrictBool | None = Field(
+        default=False,
+        description="Applies on when `embedded_signing` is `true`. By default, recipients are not notified through email to sign when doing embedded signing. Setting this to `true`  will send a notification email to the recipient. Default is `false`.",
+    )
+    send_email_delay: StrictInt | None = Field(
+        default=0,
+        description="If `send_email` is `true` recipients will receive a new document notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The email notification will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`.",
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "id",
+        "name",
+        "email",
+        "placeholder_name",
+        "passcode",
+        "subject",
+        "message",
+        "send_email",
+        "send_email_delay",
+    ]
+
+    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 TemplateRecipientsInner 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 TemplateRecipientsInner 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"),
+                "email": obj.get("email"),
+                "placeholder_name": obj.get("placeholder_name"),
+                "passcode": obj.get("passcode"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "send_email": obj.get("send_email") if obj.get("send_email") is not None else False,
+                "send_email_delay": obj.get("send_email_delay") if obj.get("send_email_delay") is not None else 0,
+            }
+        )
+        # 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/text_validation.py

@@ -0,0 +1,42 @@
+"""
+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 TextValidation(str, Enum):
+    """
+    Validation rule for text fields
+    """
+
+    """
+    allowed enum values
+    """
+    NO_TEXT_VALIDATION = "no_text_validation"
+    NUMBERS = "numbers"
+    LETTERS = "letters"
+    EMAIL_ADDRESS = "email_address"
+    US_PHONE_NUMBER = "us_phone_number"
+    US_ZIP_CODE = "us_zip_code"
+    US_SSN = "us_ssn"
+    US_AGE = "us_age"
+    ALPHANUMERIC = "alphanumeric"
+    US_BANK_ROUTING_NUMBER = "us_bank_routing_number"
+    US_BANK_ACCOUNT_NUMBER = "us_bank_account_number"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TextValidation from a JSON string"""
+        return cls(json.loads(json_str))

signwell_sdk/models/update_document_and_send_request.py

@@ -0,0 +1,234 @@
+"""
+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.checkbox_groups_inner import CheckboxGroupsInner
+from signwell_sdk.models.label_request import LabelRequest
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class UpdateDocumentAndSendRequest(BaseModel):
+    """
+    UpdateDocumentAndSendRequest
+    """  # noqa: E501
+
+    test_mode: StrictBool | None = Field(
+        default=False,
+        description="Set to `true` to enable Test Mode. Documents created with Test Mode do not count towards API billing and are not legally binding. Defaults to `false`",
+    )
+    name: StrictStr | None = Field(default=None, description="The name of the document.")
+    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).",
+    )
+    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",
+    )
+    embedded_signing: StrictBool | None = Field(
+        default=False,
+        description="When set to `true` it enables embedded signing in your website/web application. Embedded functionality works with an iFrame and email authentication is disabled. :embedded_signinig defaults to `false`.",
+    )
+    embedded_signing_notifications: StrictBool | None = Field(
+        default=False,
+        description="On embedding signing, document owners (and CC'd contacts) do not get a notification email when documents have been completed. Setting this param to `true` will send out those final completed notifications. Default is `false`",
+    )
+    custom_requester_name: StrictStr | None = Field(
+        default=None,
+        description="Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file.",
+    )
+    custom_requester_email: StrictStr | None = Field(
+        default=None,
+        description="Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file.",
+    )
+    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[CheckboxGroupsInner] | 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]] = [
+        "test_mode",
+        "name",
+        "subject",
+        "message",
+        "expires_in",
+        "reminders",
+        "apply_signing_order",
+        "api_application_id",
+        "embedded_signing",
+        "embedded_signing_notifications",
+        "custom_requester_name",
+        "custom_requester_email",
+        "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 UpdateDocumentAndSendRequest 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 UpdateDocumentAndSendRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "test_mode": obj.get("test_mode") if obj.get("test_mode") is not None else False,
+                "name": obj.get("name"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "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"),
+                "embedded_signing": obj.get("embedded_signing") if obj.get("embedded_signing") is not None else False,
+                "embedded_signing_notifications": obj.get("embedded_signing_notifications")
+                if obj.get("embedded_signing_notifications") is not None
+                else False,
+                "custom_requester_name": obj.get("custom_requester_name"),
+                "custom_requester_email": obj.get("custom_requester_email"),
+                "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": [CheckboxGroupsInner.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/update_recipients_map_inner.py

@@ -0,0 +1,118 @@
+"""
+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 UpdateRecipientsMapInner(BaseModel):
+    """
+    UpdateRecipientsMapInner
+    """  # noqa: E501
+
+    id: StrictStr = Field(description="The recipient's unique identifier from the Get Document response.")
+    name: StrictStr = Field(description="Updated name for the recipient.")
+    email: StrictStr = Field(description="Updated email address for the recipient.")
+    subject: StrictStr | None = Field(
+        default=None, description="Updated email subject for the signature request that this recipient will see."
+    )
+    message: StrictStr | None = Field(
+        default=None, description="Updated email message for the signature request that this recipient will see."
+    )
+    passcode: StrictStr | None = Field(
+        default=None,
+        description="Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document.",
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "name", "email", "subject", "message", "passcode"]
+
+    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 UpdateRecipientsMapInner 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 UpdateRecipientsMapInner 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"),
+                "email": obj.get("email"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "passcode": obj.get("passcode"),
+            }
+        )
+        # 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/update_recipients_request.py

@@ -0,0 +1,111 @@
+"""
+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
+from typing import Any, ClassVar, Dict, List
+from signwell_sdk.models.update_recipients_map_inner import UpdateRecipientsMapInner
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class UpdateRecipientsRequest(BaseModel):
+    """
+    UpdateRecipientsRequest
+    """  # noqa: E501
+
+    recipients: List[UpdateRecipientsMapInner] = Field(description="List of recipients to update on the document.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["recipients"]
+
+    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 UpdateRecipientsRequest 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 recipients (list)
+        _items_recipients: list[Any] = []
+        if self.recipients:
+            for _item_recipients in self.recipients:
+                if _item_recipients:
+                    _items_recipients.append(_item_recipients.to_dict())
+            _dict["recipients"] = _items_recipients
+        # 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 UpdateRecipientsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "recipients": [UpdateRecipientsMapInner.from_dict(_item) for _item in obj["recipients"]]
+                if obj.get("recipients") 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