docspring 3.1.0__py3-none-any.whl

docspring/models/create_custom_file_response.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    DocSpring API
+
+    Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+    The version of the OpenAPI document: v1
+    Contact: support@docspring.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr, ValidationInfo, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from docspring.models.custom_file import CustomFile
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateCustomFileResponse(BaseModel):
+    """
+    CreateCustomFileResponse
+    """ # noqa: E501
+    status: StrictStr
+    custom_file: CustomFile
+    errors: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["status", "custom_file", "errors"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value, info: ValidationInfo):
+        """Validates the enum"""
+        # from_dict accepts enum values this client doesn't know about yet
+        if info.context and info.context.get("skip_enum_validation"):
+            return value
+
+        if value not in set(['success', 'error']):
+            raise ValueError("must be one of enum values ('success', 'error')")
+        return value
+
+    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) -> Optional[Self]:
+        """Create an instance of CreateCustomFileResponse 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of custom_file
+        if self.custom_file:
+            _dict['custom_file'] = self.custom_file.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateCustomFileResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj, context={"skip_enum_validation": True})
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "custom_file": CustomFile.from_dict(obj["custom_file"]) if obj.get("custom_file") is not None else None,
+            "errors": obj.get("errors")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_folder_data.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    DocSpring API
+
+    Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+    The version of the OpenAPI document: v1
+    Contact: support@docspring.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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateFolderData(BaseModel):
+    """
+    CreateFolderData
+    """ # noqa: E501
+    folder: Dict[str, Any]
+    __properties: ClassVar[List[str]] = ["folder"]
+
+    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) -> Optional[Self]:
+        """Create an instance of CreateFolderData 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateFolderData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj, context={"skip_enum_validation": True})
+
+        _obj = cls.model_validate({
+            "folder": obj.get("folder")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_html_template.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    DocSpring API
+
+    Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+    The version of the OpenAPI document: v1
+    Contact: support@docspring.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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateHtmlTemplate(BaseModel):
+    """
+    CreateHtmlTemplate
+    """ # noqa: E501
+    template: Dict[str, Any]
+    __properties: ClassVar[List[str]] = ["template"]
+
+    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) -> Optional[Self]:
+        """Create an instance of CreateHtmlTemplate 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateHtmlTemplate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj, context={"skip_enum_validation": True})
+
+        _obj = cls.model_validate({
+            "template": obj.get("template")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_pdf_submission_data.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    DocSpring API
+
+    Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+    The version of the OpenAPI document: v1
+    Contact: support@docspring.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from docspring.models.create_submission_data_request_data import CreateSubmissionDataRequestData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreatePdfSubmissionData(BaseModel):
+    """
+    CreatePdfSubmissionData
+    """ # noqa: E501
+    data: Dict[str, Any]
+    data_requests: Optional[List[CreateSubmissionDataRequestData]] = None
+    editable: Optional[StrictBool] = None
+    expires_in: Optional[StrictInt] = None
+    field_overrides: Optional[Dict[str, Any]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    password: Optional[StrictStr] = None
+    test: Optional[StrictBool] = None
+    version: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["data", "data_requests", "editable", "expires_in", "field_overrides", "metadata", "password", "test", "version"]
+
+    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) -> Optional[Self]:
+        """Create an instance of CreatePdfSubmissionData 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _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 data_requests (list)
+        _items = []
+        if self.data_requests:
+            for _item_data_requests in self.data_requests:
+                if _item_data_requests:
+                    _items.append(_item_data_requests.to_dict())
+            _dict['data_requests'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreatePdfSubmissionData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj, context={"skip_enum_validation": True})
+
+        _obj = cls.model_validate({
+            "data": obj.get("data"),
+            "data_requests": [CreateSubmissionDataRequestData.from_dict(_item) for _item in obj["data_requests"]] if obj.get("data_requests") is not None else None,
+            "editable": obj.get("editable"),
+            "expires_in": obj.get("expires_in"),
+            "field_overrides": obj.get("field_overrides"),
+            "metadata": obj.get("metadata"),
+            "password": obj.get("password"),
+            "test": obj.get("test"),
+            "version": obj.get("version")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_pdf_template.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    DocSpring API
+
+    Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+    The version of the OpenAPI document: v1
+    Contact: support@docspring.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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreatePdfTemplate(BaseModel):
+    """
+    CreatePdfTemplate
+    """ # noqa: E501
+    template: Dict[str, Any]
+    __properties: ClassVar[List[str]] = ["template"]
+
+    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) -> Optional[Self]:
+        """Create an instance of CreatePdfTemplate 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreatePdfTemplate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj, context={"skip_enum_validation": True})
+
+        _obj = cls.model_validate({
+            "template": obj.get("template")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_submission_data_request_data.py

@@ -0,0 +1,187 @@
+# coding: utf-8
+
+"""
+    DocSpring API
+
+    Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+    The version of the OpenAPI document: v1
+    Contact: support@docspring.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr, ValidationInfo, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSubmissionDataRequestData(BaseModel):
+    """
+    CreateSubmissionDataRequestData
+    """ # noqa: E501
+    auth_phone_number_hash: Optional[StrictStr] = None
+    auth_provider: Optional[StrictStr] = None
+    auth_second_factor_type: Optional[StrictStr] = None
+    auth_session_id_hash: Optional[StrictStr] = None
+    auth_session_started_at: Optional[StrictStr] = None
+    auth_type: Optional[StrictStr] = None
+    auth_user_id_hash: Optional[StrictStr] = None
+    auth_username_hash: Optional[StrictStr] = None
+    email: Optional[StrictStr] = None
+    fields: Optional[List[Optional[StrictStr]]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    name: Optional[StrictStr] = None
+    order: Optional[StrictInt] = None
+    skipped: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["auth_phone_number_hash", "auth_provider", "auth_second_factor_type", "auth_session_id_hash", "auth_session_started_at", "auth_type", "auth_user_id_hash", "auth_username_hash", "email", "fields", "metadata", "name", "order", "skipped"]
+
+    @field_validator('auth_second_factor_type')
+    def auth_second_factor_type_validate_enum(cls, value, info: ValidationInfo):
+        """Validates the enum"""
+        # from_dict accepts enum values this client doesn't know about yet
+        if info.context and info.context.get("skip_enum_validation"):
+            return value
+
+        if value is None:
+            return value
+
+        if value not in set(['none', 'phone_number', 'totp', 'mobile_push', 'security_key', 'fingerprint']):
+            raise ValueError("must be one of enum values ('none', 'phone_number', 'totp', 'mobile_push', 'security_key', 'fingerprint')")
+        return value
+
+    @field_validator('auth_type')
+    def auth_type_validate_enum(cls, value, info: ValidationInfo):
+        """Validates the enum"""
+        # from_dict accepts enum values this client doesn't know about yet
+        if info.context and info.context.get("skip_enum_validation"):
+            return value
+
+        if value is None:
+            return value
+
+        if value not in set(['none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml']):
+            raise ValueError("must be one of enum values ('none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml')")
+        return value
+
+    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) -> Optional[Self]:
+        """Create an instance of CreateSubmissionDataRequestData 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if auth_phone_number_hash (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_phone_number_hash is None and "auth_phone_number_hash" in self.model_fields_set:
+            _dict['auth_phone_number_hash'] = None
+
+        # set to None if auth_provider (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_provider is None and "auth_provider" in self.model_fields_set:
+            _dict['auth_provider'] = None
+
+        # set to None if auth_session_id_hash (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_session_id_hash is None and "auth_session_id_hash" in self.model_fields_set:
+            _dict['auth_session_id_hash'] = None
+
+        # set to None if auth_session_started_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_session_started_at is None and "auth_session_started_at" in self.model_fields_set:
+            _dict['auth_session_started_at'] = None
+
+        # set to None if auth_user_id_hash (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_user_id_hash is None and "auth_user_id_hash" in self.model_fields_set:
+            _dict['auth_user_id_hash'] = None
+
+        # set to None if auth_username_hash (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_username_hash is None and "auth_username_hash" in self.model_fields_set:
+            _dict['auth_username_hash'] = None
+
+        # set to None if email (nullable) is None
+        # and model_fields_set contains the field
+        if self.email is None and "email" in self.model_fields_set:
+            _dict['email'] = None
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if skipped (nullable) is None
+        # and model_fields_set contains the field
+        if self.skipped is None and "skipped" in self.model_fields_set:
+            _dict['skipped'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateSubmissionDataRequestData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj, context={"skip_enum_validation": True})
+
+        _obj = cls.model_validate({
+            "auth_phone_number_hash": obj.get("auth_phone_number_hash"),
+            "auth_provider": obj.get("auth_provider"),
+            "auth_second_factor_type": obj.get("auth_second_factor_type"),
+            "auth_session_id_hash": obj.get("auth_session_id_hash"),
+            "auth_session_started_at": obj.get("auth_session_started_at"),
+            "auth_type": obj.get("auth_type"),
+            "auth_user_id_hash": obj.get("auth_user_id_hash"),
+            "auth_username_hash": obj.get("auth_username_hash"),
+            "email": obj.get("email"),
+            "fields": obj.get("fields"),
+            "metadata": obj.get("metadata"),
+            "name": obj.get("name"),
+            "order": obj.get("order"),
+            "skipped": obj.get("skipped")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+