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

signwell_sdk/models/bulk_send_list_response.py

@@ -0,0 +1,138 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from signwell_sdk.models.bulk_send_list_item import BulkSendListItem
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class BulkSendListResponse(BaseModel):
+    """
+    List of bulk sends with pagination
+    """  # noqa: E501
+
+    bulk_sends: List[BulkSendListItem]
+    current_page: StrictInt
+    next_page: StrictInt | None = None
+    previous_page: StrictInt | None = None
+    total_count: StrictInt
+    total_pages: StrictInt
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "bulk_sends",
+        "current_page",
+        "next_page",
+        "previous_page",
+        "total_count",
+        "total_pages",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of BulkSendListResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in bulk_sends (list)
+        _items_bulk_sends: list[Any] = []
+        if self.bulk_sends:
+            for _item_bulk_sends in self.bulk_sends:
+                if _item_bulk_sends:
+                    _items_bulk_sends.append(_item_bulk_sends.to_dict())
+            _dict["bulk_sends"] = _items_bulk_sends
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if next_page (nullable) is None
+        # and model_fields_set contains the field
+        if self.next_page is None and "next_page" in self.model_fields_set:
+            _dict["next_page"] = None
+
+        # set to None if previous_page (nullable) is None
+        # and model_fields_set contains the field
+        if self.previous_page is None and "previous_page" in self.model_fields_set:
+            _dict["previous_page"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of BulkSendListResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "bulk_sends": [BulkSendListItem.from_dict(_item) for _item in obj["bulk_sends"]]
+                if obj.get("bulk_sends") is not None
+                else None,
+                "current_page": obj.get("current_page"),
+                "next_page": obj.get("next_page"),
+                "previous_page": obj.get("previous_page"),
+                "total_count": obj.get("total_count"),
+                "total_pages": obj.get("total_pages"),
+            }
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/bulk_send_response.py

@@ -0,0 +1,151 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from signwell_sdk.models.bulk_send_response_templates_inner import BulkSendResponseTemplatesInner
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class BulkSendResponse(BaseModel):
+    """
+    Bulk send details
+    """  # noqa: E501
+
+    id: StrictStr
+    name: StrictStr | None = None
+    api_application_id: StrictStr | None = None
+    documents_count: StrictInt
+    documents_completed: StrictInt | None = None
+    documents_not_completed: StrictInt | None = None
+    created_at: datetime
+    user_id: StrictStr | None = None
+    status: StrictStr
+    templates: List[BulkSendResponseTemplatesInner] | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "id",
+        "name",
+        "api_application_id",
+        "documents_count",
+        "documents_completed",
+        "documents_not_completed",
+        "created_at",
+        "user_id",
+        "status",
+        "templates",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of BulkSendResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in templates (list)
+        _items_templates: list[Any] = []
+        if self.templates:
+            for _item_templates in self.templates:
+                if _item_templates:
+                    _items_templates.append(_item_templates.to_dict())
+            _dict["templates"] = _items_templates
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if api_application_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.api_application_id is None and "api_application_id" in self.model_fields_set:
+            _dict["api_application_id"] = None
+
+        # set to None if user_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_id is None and "user_id" in self.model_fields_set:
+            _dict["user_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of BulkSendResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "name": obj.get("name"),
+                "api_application_id": obj.get("api_application_id"),
+                "documents_count": obj.get("documents_count"),
+                "documents_completed": obj.get("documents_completed"),
+                "documents_not_completed": obj.get("documents_not_completed"),
+                "created_at": obj.get("created_at"),
+                "user_id": obj.get("user_id"),
+                "status": obj.get("status"),
+                "templates": [BulkSendResponseTemplatesInner.from_dict(_item) for _item in obj["templates"]]
+                if obj.get("templates") is not None
+                else None,
+            }
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/bulk_send_response_templates_inner.py

@@ -0,0 +1,98 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class BulkSendResponseTemplatesInner(BaseModel):
+    """
+    BulkSendResponseTemplatesInner
+    """  # noqa: E501
+
+    id: StrictStr
+    name: StrictStr
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "name"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of BulkSendResponseTemplatesInner from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of BulkSendResponseTemplatesInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"id": obj.get("id"), "name": obj.get("name")})
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/bulk_send_validate_csv_response.py

@@ -0,0 +1,129 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class BulkSendValidateCsvResponse(BaseModel):
+    """
+    Validated bulk send CSV response with defaults applied
+    """  # noqa: E501
+
+    bulk_send_csv: StrictStr = Field(description="Base64-encoded CSV content")
+    template_ids: List[StrictStr]
+    skip_row_errors: StrictBool | None = None
+    api_application_id: StrictStr | None = None
+    name: StrictStr | None = None
+    subject: StrictStr | None = None
+    message: StrictStr | None = None
+    apply_signing_order: StrictBool | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "bulk_send_csv",
+        "template_ids",
+        "skip_row_errors",
+        "api_application_id",
+        "name",
+        "subject",
+        "message",
+        "apply_signing_order",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of BulkSendValidateCsvResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if api_application_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.api_application_id is None and "api_application_id" in self.model_fields_set:
+            _dict["api_application_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of BulkSendValidateCsvResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "bulk_send_csv": obj.get("bulk_send_csv"),
+                "template_ids": obj.get("template_ids"),
+                "skip_row_errors": obj.get("skip_row_errors"),
+                "api_application_id": obj.get("api_application_id"),
+                "name": obj.get("name"),
+                "subject": obj.get("subject"),
+                "message": obj.get("message"),
+                "apply_signing_order": obj.get("apply_signing_order"),
+            }
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

signwell_sdk/models/checkbox_group_info.py

@@ -0,0 +1,138 @@
+"""
+SignWell Developer API
+
+API for creating, managing, and tracking electronic signature workflows.
+
+The version of the OpenAPI document: v1
+Contact: support@signwell.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from signwell_sdk.models.checkbox_validation import CheckboxValidation
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class CheckboxGroupInfo(BaseModel):
+    """
+    Checkbox group configuration
+    """  # noqa: E501
+
+    id: StrictStr = Field(description="Checkbox group ID")
+    group_name: StrictStr | None = Field(default=None, description="Name of the checkbox group")
+    recipient_id: StrictStr | None = Field(default=None, description="Recipient ID associated with the group")
+    checkbox_ids: List[StrictStr] = Field(description="IDs of checkboxes in this group")
+    validation: CheckboxValidation | None = None
+    required: StrictBool = Field(description="Whether at least one checkbox must be checked")
+    min_value: StrictInt | None = Field(default=None, description="Minimum number of checkboxes to check")
+    max_value: StrictInt | None = Field(default=None, description="Maximum number of checkboxes to check")
+    exact_value: StrictInt | None = Field(default=None, description="Exact number of checkboxes that must be checked")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "id",
+        "group_name",
+        "recipient_id",
+        "checkbox_ids",
+        "validation",
+        "required",
+        "min_value",
+        "max_value",
+        "exact_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) -> Self | None:
+        """Create an instance of CheckboxGroupInfo from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if group_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.group_name is None and "group_name" in self.model_fields_set:
+            _dict["group_name"] = None
+
+        # set to None if recipient_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.recipient_id is None and "recipient_id" in self.model_fields_set:
+            _dict["recipient_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of CheckboxGroupInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "group_name": obj.get("group_name"),
+                "recipient_id": obj.get("recipient_id"),
+                "checkbox_ids": obj.get("checkbox_ids"),
+                "validation": obj.get("validation"),
+                "required": obj.get("required"),
+                "min_value": obj.get("min_value"),
+                "max_value": obj.get("max_value"),
+                "exact_value": obj.get("exact_value"),
+            }
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj