docspring 3.1.0__py3-none-any.whl

docspring/models/create_submission_data_request_event_request.py

@@ -0,0 +1,134 @@
+# 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 CreateSubmissionDataRequestEventRequest(BaseModel):
+    """
+    CreateSubmissionDataRequestEventRequest
+    """ # noqa: E501
+    event_type: StrictStr
+    message_recipient: Optional[StrictStr] = None
+    message_type: Optional[StrictStr] = None
+    occurred_at: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["event_type", "message_recipient", "message_type", "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 CreateSubmissionDataRequestEventRequest 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 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 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 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 CreateSubmissionDataRequestEventRequest 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({
+            "event_type": obj.get("event_type"),
+            "message_recipient": obj.get("message_recipient"),
+            "message_type": obj.get("message_type"),
+            "occurred_at": obj.get("occurred_at")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_submission_data_request_event_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.submission_data_request_event import SubmissionDataRequestEvent
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSubmissionDataRequestEventResponse(BaseModel):
+    """
+    CreateSubmissionDataRequestEventResponse
+    """ # noqa: E501
+    status: StrictStr
+    event: SubmissionDataRequestEvent
+    errors: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["status", "event", "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 CreateSubmissionDataRequestEventResponse 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 event
+        if self.event:
+            _dict['event'] = self.event.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateSubmissionDataRequestEventResponse 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"),
+            "event": SubmissionDataRequestEvent.from_dict(obj["event"]) if obj.get("event") is not None else None,
+            "errors": obj.get("errors")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_submission_data_request_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.submission_data_request_show import SubmissionDataRequestShow
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSubmissionDataRequestResponse(BaseModel):
+    """
+    CreateSubmissionDataRequestResponse
+    """ # noqa: E501
+    status: StrictStr
+    data_request: SubmissionDataRequestShow
+    errors: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["status", "data_request", "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 CreateSubmissionDataRequestResponse 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 data_request
+        if self.data_request:
+            _dict['data_request'] = self.data_request.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateSubmissionDataRequestResponse 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"),
+            "data_request": SubmissionDataRequestShow.from_dict(obj["data_request"]) if obj.get("data_request") is not None else None,
+            "errors": obj.get("errors")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_submission_data_request_token_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.submission_data_request_token import SubmissionDataRequestToken
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSubmissionDataRequestTokenResponse(BaseModel):
+    """
+    CreateSubmissionDataRequestTokenResponse
+    """ # noqa: E501
+    status: StrictStr
+    token: SubmissionDataRequestToken
+    errors: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["status", "token", "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 CreateSubmissionDataRequestTokenResponse 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 token
+        if self.token:
+            _dict['token'] = self.token.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateSubmissionDataRequestTokenResponse 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"),
+            "token": SubmissionDataRequestToken.from_dict(obj["token"]) if obj.get("token") is not None else None,
+            "errors": obj.get("errors")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+

docspring/models/create_submission_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.submission_preview import SubmissionPreview
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSubmissionResponse(BaseModel):
+    """
+    CreateSubmissionResponse
+    """ # noqa: E501
+    status: StrictStr
+    submission: SubmissionPreview
+    errors: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["status", "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(['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 CreateSubmissionResponse 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 CreateSubmissionResponse 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"),
+            "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/create_webhook_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 CreateWebhookData(BaseModel):
+    """
+    CreateWebhookData
+    """ # noqa: E501
+    webhook: Dict[str, Any]
+    __properties: ClassVar[List[str]] = ["webhook"]
+
+    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 CreateWebhookData 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 CreateWebhookData 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({
+            "webhook": obj.get("webhook")
+        }, context={"skip_enum_validation": True})
+        return _obj
+
+