docspring 3.1.0__py3-none-any.whl

docspring/models/submission_batch_data.py

@@ -0,0 +1,106 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubmissionBatchData(BaseModel):
+    """
+    SubmissionBatchData
+    """ # noqa: E501
+    metadata: Optional[Dict[str, Any]] = None
+    submissions: List[Dict[str, Any]]
+    template_id: Optional[StrictStr] = None
+    template_version: Optional[StrictStr] = None
+    test: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["metadata", "submissions", "template_id", "template_version", "test"]
+
+    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 SubmissionBatchData 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 template_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.template_id is None and "template_id" in self.model_fields_set:
+            _dict['template_id'] = None
+
+        # set to None if template_version (nullable) is None
+        # and model_fields_set contains the field
+        if self.template_version is None and "template_version" in self.model_fields_set:
+            _dict['template_version'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubmissionBatchData 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({
+            "metadata": obj.get("metadata"),
+            "submissions": obj.get("submissions"),
+            "template_id": obj.get("template_id"),
+            "template_version": obj.get("template_version"),
+            "test": obj.get("test")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/submission_batch_with_submissions.py

@@ -0,0 +1,133 @@
+# 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, StrictFloat, StrictInt, StrictStr, ValidationInfo, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from docspring.models.submission_preview import SubmissionPreview
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubmissionBatchWithSubmissions(BaseModel):
+    """
+    SubmissionBatchWithSubmissions
+    """ # noqa: E501
+    id: Optional[StrictStr]
+    state: StrictStr
+    metadata: Dict[str, Any]
+    processed_at: Optional[StrictStr]
+    total_count: StrictInt
+    pending_count: StrictInt
+    error_count: StrictInt
+    completion_percentage: Union[StrictFloat, StrictInt]
+    submissions: Optional[List[SubmissionPreview]] = None
+    __properties: ClassVar[List[str]] = ["id", "state", "metadata", "processed_at", "total_count", "pending_count", "error_count", "completion_percentage", "submissions"]
+
+    @field_validator('state')
+    def state_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(['pending', 'processed', 'error']):
+            raise ValueError("must be one of enum values ('pending', 'processed', '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 SubmissionBatchWithSubmissions 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 submissions (list)
+        _items = []
+        if self.submissions:
+            for _item_submissions in self.submissions:
+                if _item_submissions:
+                    _items.append(_item_submissions.to_dict())
+            _dict['submissions'] = _items
+        # set to None if id (nullable) is None
+        # and model_fields_set contains the field
+        if self.id is None and "id" in self.model_fields_set:
+            _dict['id'] = None
+
+        # set to None if processed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.processed_at is None and "processed_at" in self.model_fields_set:
+            _dict['processed_at'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubmissionBatchWithSubmissions 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({
+            "id": obj.get("id"),
+            "state": obj.get("state"),
+            "metadata": obj.get("metadata"),
+            "processed_at": obj.get("processed_at"),
+            "total_count": obj.get("total_count"),
+            "pending_count": obj.get("pending_count"),
+            "error_count": obj.get("error_count"),
+            "completion_percentage": obj.get("completion_percentage"),
+            "submissions": [SubmissionPreview.from_dict(_item) for _item in obj["submissions"]] if obj.get("submissions") is not None else None
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/submission_data_request.py

@@ -0,0 +1,253 @@
+# 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, StrictInt, StrictStr, ValidationInfo, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubmissionDataRequest(BaseModel):
+    """
+    SubmissionDataRequest
+    """ # noqa: E501
+    id: Optional[StrictStr]
+    email: Optional[StrictStr]
+    name: Optional[StrictStr]
+    order: Optional[StrictInt]
+    sort_order: StrictInt
+    fields: Optional[List[StrictStr]]
+    metadata: Optional[Dict[str, Any]]
+    state: StrictStr
+    viewed_at: Optional[StrictStr]
+    completed_at: Optional[StrictStr]
+    declined_at: Optional[StrictStr]
+    data: Optional[Dict[str, Any]]
+    auth_type: StrictStr
+    auth_second_factor_type: StrictStr
+    auth_provider: Optional[StrictStr]
+    auth_session_started_at: Optional[StrictStr]
+    auth_session_id_hash: Optional[StrictStr]
+    auth_user_id_hash: Optional[StrictStr]
+    auth_username_hash: Optional[StrictStr]
+    auth_phone_number_hash: Optional[StrictStr]
+    ip_address: Optional[StrictStr]
+    user_agent: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["id", "email", "name", "order", "sort_order", "fields", "metadata", "state", "viewed_at", "completed_at", "declined_at", "data", "auth_type", "auth_second_factor_type", "auth_provider", "auth_session_started_at", "auth_session_id_hash", "auth_user_id_hash", "auth_username_hash", "auth_phone_number_hash", "ip_address", "user_agent"]
+
+    @field_validator('state')
+    def state_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(['pending', 'completed', 'declined']):
+            raise ValueError("must be one of enum values ('pending', 'completed', 'declined')")
+        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 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
+
+    @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 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
+
+    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 SubmissionDataRequest 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 id (nullable) is None
+        # and model_fields_set contains the field
+        if self.id is None and "id" in self.model_fields_set:
+            _dict['id'] = 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 order (nullable) is None
+        # and model_fields_set contains the field
+        if self.order is None and "order" in self.model_fields_set:
+            _dict['order'] = None
+
+        # set to None if fields (nullable) is None
+        # and model_fields_set contains the field
+        if self.fields is None and "fields" in self.model_fields_set:
+            _dict['fields'] = None
+
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        # set to None if viewed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.viewed_at is None and "viewed_at" in self.model_fields_set:
+            _dict['viewed_at'] = None
+
+        # set to None if completed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_at is None and "completed_at" in self.model_fields_set:
+            _dict['completed_at'] = None
+
+        # set to None if declined_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.declined_at is None and "declined_at" in self.model_fields_set:
+            _dict['declined_at'] = None
+
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = 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_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_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_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 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 ip_address (nullable) is None
+        # and model_fields_set contains the field
+        if self.ip_address is None and "ip_address" in self.model_fields_set:
+            _dict['ip_address'] = None
+
+        # set to None if user_agent (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_agent is None and "user_agent" in self.model_fields_set:
+            _dict['user_agent'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubmissionDataRequest 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({
+            "id": obj.get("id"),
+            "email": obj.get("email"),
+            "name": obj.get("name"),
+            "order": obj.get("order"),
+            "sort_order": obj.get("sort_order"),
+            "fields": obj.get("fields"),
+            "metadata": obj.get("metadata"),
+            "state": obj.get("state"),
+            "viewed_at": obj.get("viewed_at"),
+            "completed_at": obj.get("completed_at"),
+            "declined_at": obj.get("declined_at"),
+            "data": obj.get("data"),
+            "auth_type": obj.get("auth_type"),
+            "auth_second_factor_type": obj.get("auth_second_factor_type"),
+            "auth_provider": obj.get("auth_provider"),
+            "auth_session_started_at": obj.get("auth_session_started_at"),
+            "auth_session_id_hash": obj.get("auth_session_id_hash"),
+            "auth_user_id_hash": obj.get("auth_user_id_hash"),
+            "auth_username_hash": obj.get("auth_username_hash"),
+            "auth_phone_number_hash": obj.get("auth_phone_number_hash"),
+            "ip_address": obj.get("ip_address"),
+            "user_agent": obj.get("user_agent")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/submission_data_request_event.py

@@ -0,0 +1,155 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class SubmissionDataRequestEvent(BaseModel):
+    """
+    SubmissionDataRequestEvent
+    """ # noqa: E501
+    id: Optional[StrictStr]
+    submission_id: Optional[StrictStr]
+    submission_data_request_id: Optional[StrictStr]
+    event_type: StrictStr
+    message_type: Optional[StrictStr]
+    message_recipient: Optional[StrictStr]
+    occurred_at: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["id", "submission_id", "submission_data_request_id", "event_type", "message_type", "message_recipient", "occurred_at"]
+
+    @field_validator('event_type')
+    def event_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 not in set(['send_request', 'view_request', 'accepted_terms', 'decline_request', 'sign_request', 'all_completed']):
+            raise ValueError("must be one of enum values ('send_request', 'view_request', 'accepted_terms', 'decline_request', 'sign_request', 'all_completed')")
+        return value
+
+    @field_validator('message_type')
+    def message_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(['email', 'sms', 'fax', 'mail', 'slack', 'msteams', 'discord', 'telegram', 'whatsapp']):
+            raise ValueError("must be one of enum values ('email', 'sms', 'fax', 'mail', 'slack', 'msteams', 'discord', 'telegram', 'whatsapp')")
+        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 SubmissionDataRequestEvent 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 id (nullable) is None
+        # and model_fields_set contains the field
+        if self.id is None and "id" in self.model_fields_set:
+            _dict['id'] = None
+
+        # set to None if submission_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.submission_id is None and "submission_id" in self.model_fields_set:
+            _dict['submission_id'] = None
+
+        # set to None if submission_data_request_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.submission_data_request_id is None and "submission_data_request_id" in self.model_fields_set:
+            _dict['submission_data_request_id'] = None
+
+        # set to None if message_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.message_type is None and "message_type" in self.model_fields_set:
+            _dict['message_type'] = None
+
+        # set to None if message_recipient (nullable) is None
+        # and model_fields_set contains the field
+        if self.message_recipient is None and "message_recipient" in self.model_fields_set:
+            _dict['message_recipient'] = None
+
+        # set to None if occurred_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.occurred_at is None and "occurred_at" in self.model_fields_set:
+            _dict['occurred_at'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubmissionDataRequestEvent 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({
+            "id": obj.get("id"),
+            "submission_id": obj.get("submission_id"),
+            "submission_data_request_id": obj.get("submission_data_request_id"),
+            "event_type": obj.get("event_type"),
+            "message_type": obj.get("message_type"),
+            "message_recipient": obj.get("message_recipient"),
+            "occurred_at": obj.get("occurred_at")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+