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

signwell_sdk/models/copied_placeholders_inner.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class CopiedPlaceholdersInner(BaseModel):
+    """
+    CopiedPlaceholdersInner
+    """  # noqa: E501
+
+    name: StrictStr = Field(description="Name of the placeholder.")
+    preassigned_recipient_name: StrictStr | None = Field(
+        default=None,
+        description="In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name.",
+    )
+    preassigned_recipient_email: StrictStr | None = Field(
+        default=None,
+        description="In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the email.",
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["name", "preassigned_recipient_name", "preassigned_recipient_email"]
+
+    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 CopiedPlaceholdersInner 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 CopiedPlaceholdersInner 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"),
+                "preassigned_recipient_name": obj.get("preassigned_recipient_name"),
+                "preassigned_recipient_email": obj.get("preassigned_recipient_email"),
+            }
+        )
+        # 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/create_bulk_send_request.py

@@ -0,0 +1,155 @@
+"""
+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 import Any, Optional, Set
+from typing_extensions import Self
+
+
+class CreateBulkSendRequest(BaseModel):
+    """
+    CreateBulkSendRequest
+    """  # noqa: E501
+
+    template_ids: List[StrictStr] = Field(description="Unique identifiers for a list of templates.")
+    bulk_send_csv: StrictStr = Field(description="A RFC 4648 base64 string of the template CSV file to be validated.")
+    skip_row_errors: StrictBool | None = Field(
+        default=False, description="Whether to skip errors in the rows. Defaults to `false`."
+    )
+    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",
+    )
+    name: StrictStr | None = Field(
+        default=None,
+        description="The name of the Bulk Send. Will be used as the document name for each of the documents.",
+    )
+    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.",
+    )
+    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.",
+    )
+    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.",
+    )
+    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.",
+    )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "template_ids",
+        "bulk_send_csv",
+        "skip_row_errors",
+        "api_application_id",
+        "name",
+        "subject",
+        "message",
+        "apply_signing_order",
+        "custom_requester_name",
+        "custom_requester_email",
+    ]
+
+    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 CreateBulkSendRequest 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 CreateBulkSendRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "template_ids": obj.get("template_ids"),
+                "bulk_send_csv": obj.get("bulk_send_csv"),
+                "skip_row_errors": obj.get("skip_row_errors") if obj.get("skip_row_errors") is not None else False,
+                "api_application_id": obj.get("api_application_id"),
+                "name": obj.get("name"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "apply_signing_order": obj.get("apply_signing_order")
+                if obj.get("apply_signing_order") is not None
+                else False,
+                "custom_requester_name": obj.get("custom_requester_name"),
+                "custom_requester_email": obj.get("custom_requester_email"),
+            }
+        )
+        # 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/create_webhook_request.py

@@ -0,0 +1,100 @@
+"""
+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 CreateWebhookRequest(BaseModel):
+    """
+    CreateWebhookRequest
+    """  # noqa: E501
+
+    callback_url: StrictStr = Field(description="URL that we will post document events to.")
+    api_application_id: StrictStr | None = Field(default=None, description="Unique identifier for the API Application.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["callback_url", "api_application_id"]
+
+    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 CreateWebhookRequest 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 CreateWebhookRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"callback_url": obj.get("callback_url"), "api_application_id": obj.get("api_application_id")}
+        )
+        # 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/date_format.py

@@ -0,0 +1,36 @@
+"""
+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 DateFormat(str, Enum):
+    """
+    Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, MM/DD/YYYY hh:mm:ss a. Default: MM/DD/YYYY
+    """
+
+    """
+    allowed enum values
+    """
+    MM_SLASH_DD_SLASH_YYYY = "MM/DD/YYYY"
+    DD_SLASH_MM_SLASH_YYYY = "DD/MM/YYYY"
+    YYYY_SLASH_MM_SLASH_DD = "YYYY/MM/DD"
+    MONTH_DD_COMMA__YYYY = "Month DD, YYYY"
+    MM_SLASH_DD_SLASH_YYYY_HH_COLON_MM_COLON_SS_A = "MM/DD/YYYY hh:mm:ss a"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DateFormat from a JSON string"""
+        return cls(json.loads(json_str))

signwell_sdk/models/detailed_option.py

@@ -0,0 +1,105 @@
+"""
+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 import Any, Optional, Set
+from typing_extensions import Self
+
+
+class DetailedOption(BaseModel):
+    """
+    Detailed option object
+    """  # noqa: E501
+
+    name: StrictStr = Field(description="Option display name")
+    api_id: StrictStr | None = Field(default=None, description="Unique identifier for the option")
+    is_other: StrictBool | None = Field(default=False, description='Whether this is the special "Other" option')
+    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 DetailedOption 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 DetailedOption 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") if obj.get("is_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