docspring 3.1.0__py3-none-any.whl

docspring/models/submission.py

@@ -0,0 +1,287 @@
+# 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, ValidationInfo, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from docspring.models.submission_action import SubmissionAction
+from docspring.models.submission_data_request import SubmissionDataRequest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Submission(BaseModel):
+    """
+    Submission
+    """ # noqa: E501
+    batch_id: Optional[StrictStr]
+    data_requests: List[SubmissionDataRequest]
+    editable: Optional[StrictBool]
+    error_message: Optional[StrictStr]
+    expired: StrictBool
+    expires_at: Optional[StrictStr]
+    id: Optional[StrictStr]
+    json_schema_errors: Optional[List[StrictStr]]
+    metadata: Dict[str, Any]
+    password: Optional[StrictStr]
+    processed_at: Optional[StrictStr]
+    state: StrictStr
+    template_id: Optional[StrictStr]
+    template_type: StrictStr
+    template_version: Optional[StrictStr]
+    test: StrictBool
+    truncated_text: Optional[Dict[str, Any]]
+    pdf_hash: Optional[StrictStr]
+    download_url: Optional[StrictStr]
+    permanent_download_url: Optional[StrictStr]
+    preview_download_url: Optional[StrictStr]
+    preview_generated_at: Optional[StrictStr]
+    audit_trail_download_url: Optional[StrictStr]
+    actions: List[SubmissionAction]
+    source: Optional[StrictStr] = None
+    referrer: Optional[StrictStr] = None
+    data: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[List[str]] = ["batch_id", "data_requests", "editable", "error_message", "expired", "expires_at", "id", "json_schema_errors", "metadata", "password", "processed_at", "state", "template_id", "template_type", "template_version", "test", "truncated_text", "pdf_hash", "download_url", "permanent_download_url", "preview_download_url", "preview_generated_at", "audit_trail_download_url", "actions", "source", "referrer", "data"]
+
+    @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', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked', 'accidental', 'declined']):
+            raise ValueError("must be one of enum values ('pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked', 'accidental', 'declined')")
+        return value
+
+    @field_validator('template_type')
+    def template_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(['pdf', 'html']):
+            raise ValueError("must be one of enum values ('pdf', 'html')")
+        return value
+
+    @field_validator('source')
+    def source_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(['api', 'web', 'reprocess', 'webhook']):
+            raise ValueError("must be one of enum values ('api', 'web', 'reprocess', 'webhook')")
+        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 Submission 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
+        # override the default output from pydantic by calling `to_dict()` of each item in actions (list)
+        _items = []
+        if self.actions:
+            for _item_actions in self.actions:
+                if _item_actions:
+                    _items.append(_item_actions.to_dict())
+            _dict['actions'] = _items
+        # set to None if batch_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.batch_id is None and "batch_id" in self.model_fields_set:
+            _dict['batch_id'] = None
+
+        # set to None if editable (nullable) is None
+        # and model_fields_set contains the field
+        if self.editable is None and "editable" in self.model_fields_set:
+            _dict['editable'] = None
+
+        # set to None if error_message (nullable) is None
+        # and model_fields_set contains the field
+        if self.error_message is None and "error_message" in self.model_fields_set:
+            _dict['error_message'] = None
+
+        # set to None if expires_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_at is None and "expires_at" in self.model_fields_set:
+            _dict['expires_at'] = None
+
+        # 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 json_schema_errors (nullable) is None
+        # and model_fields_set contains the field
+        if self.json_schema_errors is None and "json_schema_errors" in self.model_fields_set:
+            _dict['json_schema_errors'] = None
+
+        # set to None if password (nullable) is None
+        # and model_fields_set contains the field
+        if self.password is None and "password" in self.model_fields_set:
+            _dict['password'] = 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
+
+        # 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
+
+        # set to None if truncated_text (nullable) is None
+        # and model_fields_set contains the field
+        if self.truncated_text is None and "truncated_text" in self.model_fields_set:
+            _dict['truncated_text'] = None
+
+        # set to None if pdf_hash (nullable) is None
+        # and model_fields_set contains the field
+        if self.pdf_hash is None and "pdf_hash" in self.model_fields_set:
+            _dict['pdf_hash'] = None
+
+        # set to None if download_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.download_url is None and "download_url" in self.model_fields_set:
+            _dict['download_url'] = None
+
+        # set to None if permanent_download_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.permanent_download_url is None and "permanent_download_url" in self.model_fields_set:
+            _dict['permanent_download_url'] = None
+
+        # set to None if preview_download_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.preview_download_url is None and "preview_download_url" in self.model_fields_set:
+            _dict['preview_download_url'] = None
+
+        # set to None if preview_generated_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.preview_generated_at is None and "preview_generated_at" in self.model_fields_set:
+            _dict['preview_generated_at'] = None
+
+        # set to None if audit_trail_download_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.audit_trail_download_url is None and "audit_trail_download_url" in self.model_fields_set:
+            _dict['audit_trail_download_url'] = None
+
+        # set to None if referrer (nullable) is None
+        # and model_fields_set contains the field
+        if self.referrer is None and "referrer" in self.model_fields_set:
+            _dict['referrer'] = 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Submission 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({
+            "batch_id": obj.get("batch_id"),
+            "data_requests": [SubmissionDataRequest.from_dict(_item) for _item in obj["data_requests"]] if obj.get("data_requests") is not None else None,
+            "editable": obj.get("editable"),
+            "error_message": obj.get("error_message"),
+            "expired": obj.get("expired"),
+            "expires_at": obj.get("expires_at"),
+            "id": obj.get("id"),
+            "json_schema_errors": obj.get("json_schema_errors"),
+            "metadata": obj.get("metadata"),
+            "password": obj.get("password"),
+            "processed_at": obj.get("processed_at"),
+            "state": obj.get("state"),
+            "template_id": obj.get("template_id"),
+            "template_type": obj.get("template_type"),
+            "template_version": obj.get("template_version"),
+            "test": obj.get("test"),
+            "truncated_text": obj.get("truncated_text"),
+            "pdf_hash": obj.get("pdf_hash"),
+            "download_url": obj.get("download_url"),
+            "permanent_download_url": obj.get("permanent_download_url"),
+            "preview_download_url": obj.get("preview_download_url"),
+            "preview_generated_at": obj.get("preview_generated_at"),
+            "audit_trail_download_url": obj.get("audit_trail_download_url"),
+            "actions": [SubmissionAction.from_dict(_item) for _item in obj["actions"]] if obj.get("actions") is not None else None,
+            "source": obj.get("source"),
+            "referrer": obj.get("referrer"),
+            "data": obj.get("data")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/submission422_response.py

@@ -0,0 +1,109 @@
+# 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, Field, StrictStr, ValidationInfo, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from docspring.models.submission_preview import SubmissionPreview
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Submission422Response(BaseModel):
+    """
+    Submission422Response
+    """ # noqa: E501
+    status: StrictStr
+    error: Optional[StrictStr] = Field(default=None, description="Single error message (for non-validation errors)")
+    submission: Optional[SubmissionPreview] = None
+    errors: Optional[List[StrictStr]] = Field(default=None, description="Array of validation error messages (when submission data is invalid)")
+    __properties: ClassVar[List[str]] = ["status", "error", "submission", "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(['error']):
+            raise ValueError("must be one of enum values ('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 Submission422Response 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 submission
+        if self.submission:
+            _dict['submission'] = self.submission.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Submission422Response 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"),
+            "error": obj.get("error"),
+            "submission": SubmissionPreview.from_dict(obj["submission"]) if obj.get("submission") is not None else None,
+            "errors": obj.get("errors")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/submission_action.py

@@ -0,0 +1,148 @@
+# 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 SubmissionAction(BaseModel):
+    """
+    SubmissionAction
+    """ # noqa: E501
+    id: Optional[StrictStr]
+    integration_id: Optional[StrictStr]
+    state: StrictStr
+    action_type: StrictStr
+    action_category: StrictStr
+    result_data: Dict[str, Any]
+    error_message: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["id", "integration_id", "state", "action_type", "action_category", "result_data", "error_message"]
+
+    @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', 'failed', 'error']):
+            raise ValueError("must be one of enum values ('pending', 'processed', 'failed', 'error')")
+        return value
+
+    @field_validator('action_type')
+    def action_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(['webhook', 'slack_webhook', 'email', 'aws_s3_upload']):
+            raise ValueError("must be one of enum values ('webhook', 'slack_webhook', 'email', 'aws_s3_upload')")
+        return value
+
+    @field_validator('action_category')
+    def action_category_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(['notification', 'file_upload']):
+            raise ValueError("must be one of enum values ('notification', 'file_upload')")
+        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 SubmissionAction 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 integration_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.integration_id is None and "integration_id" in self.model_fields_set:
+            _dict['integration_id'] = None
+
+        # set to None if error_message (nullable) is None
+        # and model_fields_set contains the field
+        if self.error_message is None and "error_message" in self.model_fields_set:
+            _dict['error_message'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubmissionAction 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"),
+            "integration_id": obj.get("integration_id"),
+            "state": obj.get("state"),
+            "action_type": obj.get("action_type"),
+            "action_category": obj.get("action_category"),
+            "result_data": obj.get("result_data"),
+            "error_message": obj.get("error_message")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/submission_batch.py

@@ -0,0 +1,123 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class SubmissionBatch(BaseModel):
+    """
+    SubmissionBatch
+    """ # 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]
+    __properties: ClassVar[List[str]] = ["id", "state", "metadata", "processed_at", "total_count", "pending_count", "error_count", "completion_percentage"]
+
+    @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 SubmissionBatch 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 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 SubmissionBatch 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")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+