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

signwell_sdk/models/__init__.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+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
+
+# import models into model package
+from signwell_sdk.models.account_info_response import AccountInfoResponse
+from signwell_sdk.models.account_info_response_active_users_inner import AccountInfoResponseActiveUsersInner
+from signwell_sdk.models.account_info_response_preferences import AccountInfoResponsePreferences
+from signwell_sdk.models.additional_fields_inner_inner import AdditionalFieldsInnerInner
+from signwell_sdk.models.additional_fields_inner_inner_value import AdditionalFieldsInnerInnerValue
+from signwell_sdk.models.additional_files_inner import AdditionalFilesInner
+from signwell_sdk.models.api_application_response import ApiApplicationResponse
+from signwell_sdk.models.api_application_response_owner import ApiApplicationResponseOwner
+from signwell_sdk.models.api_application_response_preferences import ApiApplicationResponsePreferences
+from signwell_sdk.models.attachment_request_info import AttachmentRequestInfo
+from signwell_sdk.models.attachment_requests_inner import AttachmentRequestsInner
+from signwell_sdk.models.bulk_send_create_response import BulkSendCreateResponse
+from signwell_sdk.models.bulk_send_csv_request import BulkSendCsvRequest
+from signwell_sdk.models.bulk_send_csv_template_response import BulkSendCsvTemplateResponse
+from signwell_sdk.models.bulk_send_documents_response import BulkSendDocumentsResponse
+from signwell_sdk.models.bulk_send_list_item import BulkSendListItem
+from signwell_sdk.models.bulk_send_list_response import BulkSendListResponse
+from signwell_sdk.models.bulk_send_response import BulkSendResponse
+from signwell_sdk.models.bulk_send_response_templates_inner import BulkSendResponseTemplatesInner
+from signwell_sdk.models.bulk_send_validate_csv_response import BulkSendValidateCsvResponse
+from signwell_sdk.models.checkbox_group_info import CheckboxGroupInfo
+from signwell_sdk.models.checkbox_groups_inner import CheckboxGroupsInner
+from signwell_sdk.models.checkbox_validation import CheckboxValidation
+from signwell_sdk.models.completed_pdf_response import CompletedPdfResponse
+from signwell_sdk.models.completed_pdf_url_response import CompletedPdfUrlResponse
+from signwell_sdk.models.copied_contact_info import CopiedContactInfo
+from signwell_sdk.models.copied_contacts_inner import CopiedContactsInner
+from signwell_sdk.models.copied_placeholders_inner import CopiedPlaceholdersInner
+from signwell_sdk.models.create_bulk_send_request import CreateBulkSendRequest
+from signwell_sdk.models.create_webhook_request import CreateWebhookRequest
+from signwell_sdk.models.date_format import DateFormat
+from signwell_sdk.models.detailed_option import DetailedOption
+from signwell_sdk.models.document_from_template_request import DocumentFromTemplateRequest
+from signwell_sdk.models.document_from_template_response import DocumentFromTemplateResponse
+from signwell_sdk.models.document_from_template_response_fields_inner_inner import (
+    DocumentFromTemplateResponseFieldsInnerInner,
+)
+from signwell_sdk.models.document_from_template_response_fields_inner_inner_recipient import (
+    DocumentFromTemplateResponseFieldsInnerInnerRecipient,
+)
+from signwell_sdk.models.document_from_template_response_recipients_inner import (
+    DocumentFromTemplateResponseRecipientsInner,
+)
+from signwell_sdk.models.document_list_response import DocumentListResponse
+from signwell_sdk.models.document_request import DocumentRequest
+from signwell_sdk.models.document_response import DocumentResponse
+from signwell_sdk.models.document_response_attachment_requests_inner import DocumentResponseAttachmentRequestsInner
+from signwell_sdk.models.document_response_fields_inner_inner import DocumentResponseFieldsInnerInner
+from signwell_sdk.models.document_response_fields_inner_inner_options_inner import (
+    DocumentResponseFieldsInnerInnerOptionsInner,
+)
+from signwell_sdk.models.document_response_fields_inner_inner_recipient import DocumentResponseFieldsInnerInnerRecipient
+from signwell_sdk.models.document_response_fields_inner_inner_value import DocumentResponseFieldsInnerInnerValue
+from signwell_sdk.models.document_response_recipients_inner import DocumentResponseRecipientsInner
+from signwell_sdk.models.document_template_list_response import DocumentTemplateListResponse
+from signwell_sdk.models.document_template_request import DocumentTemplateRequest
+from signwell_sdk.models.document_template_response import DocumentTemplateResponse
+from signwell_sdk.models.document_template_response_copied_placeholders_inner import (
+    DocumentTemplateResponseCopiedPlaceholdersInner,
+)
+from signwell_sdk.models.document_template_response_placeholders_inner import DocumentTemplateResponsePlaceholdersInner
+from signwell_sdk.models.document_template_update_request import DocumentTemplateUpdateRequest
+from signwell_sdk.models.dropdown_option import DropdownOption
+from signwell_sdk.models.error_response import ErrorResponse
+from signwell_sdk.models.error_response_meta import ErrorResponseMeta
+from signwell_sdk.models.field_type import FieldType
+from signwell_sdk.models.fields_inner_inner import FieldsInnerInner
+from signwell_sdk.models.file_format import FileFormat
+from signwell_sdk.models.file_info import FileInfo
+from signwell_sdk.models.files_inner import FilesInner
+from signwell_sdk.models.label_info import LabelInfo
+from signwell_sdk.models.label_request import LabelRequest
+from signwell_sdk.models.label_response import LabelResponse
+from signwell_sdk.models.me_response import MeResponse
+from signwell_sdk.models.me_response_contact import MeResponseContact
+from signwell_sdk.models.me_response_user import MeResponseUser
+from signwell_sdk.models.me_response_user_preferences import MeResponseUserPreferences
+from signwell_sdk.models.nom151_certificate_response import Nom151CertificateResponse
+from signwell_sdk.models.nom151_certificate_response_nom151 import Nom151CertificateResponseNom151
+from signwell_sdk.models.nom151_url_response import Nom151UrlResponse
+from signwell_sdk.models.pagination_meta import PaginationMeta
+from signwell_sdk.models.placeholders_inner import PlaceholdersInner
+from signwell_sdk.models.rate_limit_error_response import RateLimitErrorResponse
+from signwell_sdk.models.recipients_inner import RecipientsInner
+from signwell_sdk.models.reminder_recipients_inner import ReminderRecipientsInner
+from signwell_sdk.models.send_reminder_request import SendReminderRequest
+from signwell_sdk.models.template_attachment_requests_inner import TemplateAttachmentRequestsInner
+from signwell_sdk.models.template_checkbox_groups_inner import TemplateCheckboxGroupsInner
+from signwell_sdk.models.template_field_values_inner import TemplateFieldValuesInner
+from signwell_sdk.models.template_field_values_inner_value import TemplateFieldValuesInnerValue
+from signwell_sdk.models.template_fields_inner_inner import TemplateFieldsInnerInner
+from signwell_sdk.models.template_recipients_inner import TemplateRecipientsInner
+from signwell_sdk.models.text_validation import TextValidation
+from signwell_sdk.models.update_document_and_send_request import UpdateDocumentAndSendRequest
+from signwell_sdk.models.update_recipients_map_inner import UpdateRecipientsMapInner
+from signwell_sdk.models.update_recipients_request import UpdateRecipientsRequest
+from signwell_sdk.models.validation_error_response import ValidationErrorResponse
+from signwell_sdk.models.webhook_response import WebhookResponse

signwell_sdk/models/account_info_response.py

@@ -0,0 +1,143 @@
+"""
+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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from signwell_sdk.models.account_info_response_active_users_inner import AccountInfoResponseActiveUsersInner
+from signwell_sdk.models.account_info_response_preferences import AccountInfoResponsePreferences
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class AccountInfoResponse(BaseModel):
+    """
+    Account or workspace information
+    """  # noqa: E501
+
+    id: StrictStr
+    name: StrictStr
+    plan_tier: StrictStr
+    active_templates: StrictInt | None = None
+    can_create_template: StrictBool | None = None
+    can_create_tracking_document: StrictBool | None = None
+    can_create_completion_document: StrictBool | None = None
+    active_users: List[AccountInfoResponseActiveUsersInner] | None = None
+    preferences: AccountInfoResponsePreferences | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "id",
+        "name",
+        "plan_tier",
+        "active_templates",
+        "can_create_template",
+        "can_create_tracking_document",
+        "can_create_completion_document",
+        "active_users",
+        "preferences",
+    ]
+
+    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 AccountInfoResponse 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 active_users (list)
+        _items_active_users: list[Any] = []
+        if self.active_users:
+            for _item_active_users in self.active_users:
+                if _item_active_users:
+                    _items_active_users.append(_item_active_users.to_dict())
+            _dict["active_users"] = _items_active_users
+        # override the default output from pydantic by calling `to_dict()` of preferences
+        if self.preferences:
+            _dict["preferences"] = self.preferences.to_dict()
+        # 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 AccountInfoResponse 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"),
+                "plan_tier": obj.get("plan_tier"),
+                "active_templates": obj.get("active_templates"),
+                "can_create_template": obj.get("can_create_template"),
+                "can_create_tracking_document": obj.get("can_create_tracking_document"),
+                "can_create_completion_document": obj.get("can_create_completion_document"),
+                "active_users": [AccountInfoResponseActiveUsersInner.from_dict(_item) for _item in obj["active_users"]]
+                if obj.get("active_users") is not None
+                else None,
+                "preferences": AccountInfoResponsePreferences.from_dict(obj["preferences"])
+                if obj.get("preferences") 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/account_info_response_active_users_inner.py

@@ -0,0 +1,107 @@
+"""
+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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class AccountInfoResponseActiveUsersInner(BaseModel):
+    """
+    AccountInfoResponseActiveUsersInner
+    """  # noqa: E501
+
+    id: StrictStr
+    name: StrictStr
+    email: StrictStr
+    has_google_registration: StrictBool | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "name", "email", "has_google_registration"]
+
+    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 AccountInfoResponseActiveUsersInner 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 AccountInfoResponseActiveUsersInner 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"),
+                "email": obj.get("email"),
+                "has_google_registration": obj.get("has_google_registration"),
+            }
+        )
+        # 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/account_info_response_preferences.py

@@ -0,0 +1,147 @@
+"""
+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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, Optional, Set
+from typing_extensions import Self
+
+
+class AccountInfoResponsePreferences(BaseModel):
+    """
+    AccountInfoResponsePreferences
+    """  # noqa: E501
+
+    date_format: StrictStr | None = None
+    days_until_links_expire: StrictInt | None = None
+    disable_apply_everywhere: StrictBool | None = None
+    disable_apply_everywhere_effective: StrictBool | None = None
+    disable_drawn_signatures: StrictBool | None = None
+    disable_typed_signatures: StrictBool | None = None
+    disable_uploaded_signatures: StrictBool | None = None
+    enable_redirect: StrictBool | None = None
+    hide_document_id_in_audit: StrictBool | None = None
+    mute_branding: StrictBool | None = None
+    redirect_url: StrictStr | None = None
+    separate_audit_pdf: StrictBool | None = None
+    separate_completed_file: StrictBool | None = None
+    enable_nom151_compliance: StrictBool | None = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "date_format",
+        "days_until_links_expire",
+        "disable_apply_everywhere",
+        "disable_apply_everywhere_effective",
+        "disable_drawn_signatures",
+        "disable_typed_signatures",
+        "disable_uploaded_signatures",
+        "enable_redirect",
+        "hide_document_id_in_audit",
+        "mute_branding",
+        "redirect_url",
+        "separate_audit_pdf",
+        "separate_completed_file",
+        "enable_nom151_compliance",
+    ]
+
+    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 AccountInfoResponsePreferences 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 redirect_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.redirect_url is None and "redirect_url" in self.model_fields_set:
+            _dict["redirect_url"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
+        """Create an instance of AccountInfoResponsePreferences from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "date_format": obj.get("date_format"),
+                "days_until_links_expire": obj.get("days_until_links_expire"),
+                "disable_apply_everywhere": obj.get("disable_apply_everywhere"),
+                "disable_apply_everywhere_effective": obj.get("disable_apply_everywhere_effective"),
+                "disable_drawn_signatures": obj.get("disable_drawn_signatures"),
+                "disable_typed_signatures": obj.get("disable_typed_signatures"),
+                "disable_uploaded_signatures": obj.get("disable_uploaded_signatures"),
+                "enable_redirect": obj.get("enable_redirect"),
+                "hide_document_id_in_audit": obj.get("hide_document_id_in_audit"),
+                "mute_branding": obj.get("mute_branding"),
+                "redirect_url": obj.get("redirect_url"),
+                "separate_audit_pdf": obj.get("separate_audit_pdf"),
+                "separate_completed_file": obj.get("separate_completed_file"),
+                "enable_nom151_compliance": obj.get("enable_nom151_compliance"),
+            }
+        )
+        # 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