blueink-client-python 1.2.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

blueink/bundle_helper.py

@@ -558,7 +558,7 @@ class BundleHelper:
             Bundle as dictionary
         """
         bundle = self._compile_bundle(**additional_data)
-        return bundle.dict(exclude_unset=True, exclude_none=True)
+        return bundle.model_dump(exclude_unset=True, exclude_none=True)
 
     def as_data_for_envelope_template(self, **additional_data):
         """Return data for creating a bundle from an envelope template.
@@ -588,8 +588,10 @@ class BundleHelper:
 
         packets = list(self._packets.values())
         result = {
-            "packets": [p.dict(exclude_unset=True, exclude_none=True) for p in packets],
-            "envelope_template": self._envelope_template.dict(
+            "packets": [
+                p.model_dump(exclude_unset=True, exclude_none=True) for p in packets
+            ],
+            "envelope_template": self._envelope_template.model_dump(
                 exclude_unset=True, exclude_none=True
             ),
         }
@@ -627,4 +629,4 @@ class BundleHelper:
             Bundle as json
         """
         bundle = self._compile_bundle(**additional_data)
-        return bundle.json(exclude_unset=True, exclude_none=True)
+        return bundle.model_dump_json(exclude_unset=True, exclude_none=True)

blueink/client.py

@@ -11,6 +11,7 @@ from blueink.subclients.envelope_template import EnvelopeTemplateSubClient
 from blueink.subclients.packet import PacketSubClient
 from blueink.subclients.person import PersonSubClient
 from blueink.subclients.template import TemplateSubClient
+from blueink.subclients.verify import VerifySubClient
 from blueink.subclients.webhook import WebhookSubClient
 
 
@@ -74,3 +75,4 @@ class Client:
             self._base_url, self._request_helper
         )
         self.webhooks = WebhookSubClient(self._base_url, self._request_helper)
+        self.verify = VerifySubClient(self._base_url, self._request_helper)

blueink/constants.py

@@ -94,6 +94,8 @@ EVENT_TYPE = Munch(
     EVENT_BUNDLE_DOCS_READY="bundle_docs_ready",
     EVENT_BUNDLE_ERROR="bundle_error",
     EVENT_BUNDLE_CANCELLED="bundle_cancelled",
+    EVENT_BUNDLE_SIGNER_REASSIGNED="bundle_signer_reassigned",
     EVENT_PACKET_VIEWED="packet_viewed",
     EVENT_PACKET_COMPLETE="packet_complete",
+    EVENT_PACKET_DECLINED="packet_declined",
 )

blueink/endpoints.py

@@ -12,6 +12,9 @@ class BUNDLES:
     CREATE_PREPARATION_SESSION = "/bundles/preparation_session/"
     LIST = "/bundles/"
     RETRIEVE = "/bundles/${bundle_id}/"
+    UPDATE = "/bundles/${bundle_id}/"
+    SEND = "/bundles/${bundle_id}/send/"
+    VALIDATE = "/bundles/${bundle_id}/validate/"
     CANCEL = "/bundles/${bundle_id}/cancel/"
     LIST_EVENTS = "/bundles/${bundle_id}/events/"
     LIST_FILES = "/bundles/${bundle_id}/files/"
@@ -45,6 +48,10 @@ class ENVELOPE_TEMPLATES:
     RETRIEVE = "/envelope-templates/${envelope_template_id}/"
 
 
+class VERIFY:
+    CREATE = "/verify/"
+
+
 class WEBHOOKS:
     CREATE = "/webhooks/"
     LIST = "/webhooks/"

blueink/model/bundles.py

@@ -1,8 +1,8 @@
 import random
 import string
-from typing import List, Optional
+from typing import List, Optional, Union
 
-from pydantic import BaseModel, EmailStr, validator
+from pydantic import BaseModel, ConfigDict, EmailStr, field_validator, model_validator
 
 from blueink.constants import DELIVER_VIA, FIELD_KIND
 
@@ -20,18 +20,17 @@ def generate_key(type, length=5):
 class AutoPlacement(BaseModel):
     """Model for auto-placement fields that automatically find and place fields on documents"""
 
-    kind: str = ...
-    search: str = ...
-    w: int = ...
-    h: int = ...
+    model_config = ConfigDict(extra="allow")
+
+    kind: str
+    search: str
+    w: int
+    h: int
     offset_x: Optional[int] = 0
     offset_y: Optional[int] = 0
-    editors: Optional[List[str]]
-    page: Optional[int]
-    v_attachment_types: Optional[List[str]]
-
-    class Config:
-        extra = "allow"
+    editors: Optional[List[str]] = None
+    page: Optional[int] = None
+    v_attachment_types: Optional[List[str]] = None
 
     @classmethod
     def create(
@@ -69,11 +68,13 @@ class AutoPlacement(BaseModel):
         )
         return obj
 
-    @validator("kind")
+    @field_validator("kind")
+    @classmethod
     def kind_is_allowed(cls, v):
-        assert (
-            v in FIELD_KIND.values()
-        ), f"AutoPlacement Kind '{v}' not allowed. Must be one of {FIELD_KIND.values()}"
+        if v not in FIELD_KIND.values():
+            raise ValueError(
+                f"AutoPlacement Kind '{v}' not allowed. Must be one of {FIELD_KIND.values()}"
+            )
         return v
 
     def add_editor(self, editor: str):
@@ -83,25 +84,24 @@ class AutoPlacement(BaseModel):
 
 
 class Field(BaseModel):
-    kind: str = ...
-    key: str = ...
-    x: int = ...
-    y: int = ...
-    w: int = ...
-    h: int = ...
-    label: Optional[str]
-    page: Optional[int]
-    v_pattern: Optional[int]
-    v_min: Optional[int]
-    v_max: Optional[int]
-    v_regex: Optional[str]
-    v_regex_msg: Optional[str]
-    editors: Optional[List[str]]
-    v_attachment_types: Optional[List[str]]
-    data_flow_tag: Optional[str]
-
-    class Config:
-        extra = "allow"
+    model_config = ConfigDict(extra="allow")
+
+    kind: str
+    key: str
+    x: int
+    y: int
+    w: int
+    h: int
+    label: Optional[str] = None
+    page: Optional[int] = None
+    v_pattern: Optional[int] = None
+    v_min: Optional[int] = None
+    v_max: Optional[int] = None
+    v_regex: Optional[str] = None
+    v_regex_msg: Optional[str] = None
+    editors: Optional[List[str]] = None
+    v_attachment_types: Optional[List[str]] = None
+    data_flow_tag: Optional[str] = None
 
     @classmethod
     def create(cls, x, y, w, h, page, kind, key=None, **kwargs):
@@ -110,11 +110,13 @@ class Field(BaseModel):
         obj = Field(key=key, x=x, y=y, w=w, h=h, page=page, kind=kind, **kwargs)
         return obj
 
-    @validator("kind")
+    @field_validator("kind")
+    @classmethod
     def kind_is_allowed(cls, v):
-        assert (
-            v in FIELD_KIND.values()
-        ), f"Field Kind '{v}' not allowed. Must be one of {FIELD_KIND.values()}"
+        if v not in FIELD_KIND.values():
+            raise ValueError(
+                f"Field Kind '{v}' not allowed. Must be one of {FIELD_KIND.values()}"
+            )
         return v
 
     def add_editor(self, editor: str):
@@ -124,26 +126,26 @@ class Field(BaseModel):
 
 
 class Packet(BaseModel):
-    key: str = ...
-    name: str = ...
-    email: Optional[EmailStr]
-    phone: Optional[str]
-    auth_sms: Optional[bool]
-    auth_selfie: Optional[bool]
-    auth_id: Optional[bool]
-    deliver_via: Optional[str]
-    person_id: Optional[str]
-    order: Optional[str]
-    requires_witness: Optional[bool]
-    witness_nominated_by: Optional[str]
-
-    class Config:
-        extra = "allow"
-
-    @validator("deliver_via")
+    model_config = ConfigDict(extra="allow")
+
+    key: str
+    name: str
+    email: Optional[EmailStr] = None
+    phone: Optional[str] = None
+    auth_sms: Optional[bool] = None
+    auth_selfie: Optional[bool] = None
+    auth_id: Optional[bool] = None
+    deliver_via: Optional[str] = None
+    person_id: Optional[str] = None
+    order: Optional[str] = None
+    requires_witness: Optional[bool] = None
+    witness_nominated_by: Optional[str] = None
+
+    @field_validator("deliver_via")
+    @classmethod
     def deliver_via_is_allowed(cls, v):
-        if v is not None:
-            assert v in DELIVER_VIA.values(), (
+        if v is not None and v not in DELIVER_VIA.values():
+            raise ValueError(
                 f"deliver_via '{v}' not allowed. Must be None"
                 f" or one of {DELIVER_VIA.values()}"
             )
@@ -158,11 +160,10 @@ class Packet(BaseModel):
 
 
 class TemplateRefAssignment(BaseModel):
-    role: str = ...
-    signer: str = ...
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    role: str
+    signer: str
 
     @classmethod
     def create(cls, role, signer, **kwargs):
@@ -171,11 +172,10 @@ class TemplateRefAssignment(BaseModel):
 
 
 class TemplateRefFieldValue(BaseModel):
-    key: str = ...
-    initial_value: str = ...
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    key: str
+    initial_value: str
 
     @classmethod
     def create(cls, key, initial_value, **kwargs):
@@ -186,11 +186,10 @@ class TemplateRefFieldValue(BaseModel):
 class EnvelopeTemplateFieldValue(BaseModel):
     """Model for field values in envelope templates"""
 
-    key: str = ...
-    initial_value: str = ...
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    key: str
+    initial_value: str
 
     @classmethod
     def create(cls, key, initial_value, **kwargs):
@@ -201,11 +200,10 @@ class EnvelopeTemplateFieldValue(BaseModel):
 class EnvelopeTemplate(BaseModel):
     """Model for envelope template reference"""
 
-    template_id: str = ...
-    field_values: Optional[List[EnvelopeTemplateFieldValue]]
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    template_id: str
+    field_values: Optional[List[EnvelopeTemplateFieldValue]] = None
 
     @classmethod
     def create(cls, template_id, field_values=None, **kwargs):
@@ -221,12 +219,11 @@ class EnvelopeTemplate(BaseModel):
 
 
 class TemplateRef(BaseModel):
-    template_id: Optional[str]
-    assignments: Optional[List[TemplateRefAssignment]]
-    field_values: Optional[List[TemplateRefFieldValue]]
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    template_id: Optional[str] = None
+    assignments: Optional[List[TemplateRefAssignment]] = None
+    field_values: Optional[List[TemplateRefFieldValue]] = None
 
     @classmethod
     def create(cls, key=None, **kwargs):
@@ -247,20 +244,19 @@ class TemplateRef(BaseModel):
 
 
 class Document(BaseModel):
-    key: str = ...
+    model_config = ConfigDict(extra="allow")
+
+    key: str
 
     # document related
-    file_url: Optional[str]
-    filename: Optional[str]
-    file_b64: Optional[str]
-    file_html: Optional[str]
-    file_index: Optional[int]
-    fields: Optional[List[Field]]
-    auto_placements: Optional[List[AutoPlacement]]
-    html_fields_mode: Optional[str]
-
-    class Config:
-        extra = "allow"
+    file_url: Optional[str] = None
+    filename: Optional[str] = None
+    file_b64: Optional[str] = None
+    file_html: Optional[str] = None
+    file_index: Optional[int] = None
+    fields: Optional[List[Field]] = None
+    auto_placements: Optional[List[AutoPlacement]] = None
+    html_fields_mode: Optional[str] = None
 
     @classmethod
     def create(cls, key=None, **kwargs):
@@ -297,22 +293,20 @@ class ImportedDocument(BaseModel):
     Providing both or neither will raise a ValidationError.
     """
 
-    key: Optional[str]
-    filename: Optional[str]
-    file_b64: Optional[str]
-    file_html: Optional[str]
-    file_url: Optional[str]
-    file_index: Optional[int]
-    fields: Optional[list]
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    key: Optional[str] = None
+    filename: Optional[str] = None
+    file_b64: Optional[str] = None
+    file_html: Optional[str] = None
+    file_url: Optional[str] = None
+    file_index: Optional[int] = None
+    fields: Optional[list] = None
 
-    @validator("file_html", always=True)
-    def validate_file_source(cls, file_html, values):
-        file_b64 = values.get("file_b64")
-        has_b64 = bool(file_b64)
-        has_html = bool(file_html)
+    @model_validator(mode="after")
+    def validate_file_source(self):
+        has_b64 = bool(self.file_b64)
+        has_html = bool(self.file_html)
 
         if has_b64 and has_html:
             raise ValueError("Provide only one of 'file_b64' or 'file_html', not both")
@@ -320,7 +314,7 @@ class ImportedDocument(BaseModel):
         if not has_b64 and not has_html:
             raise ValueError("Each document must have either 'file_b64' or 'file_html'")
 
-        return file_html
+        return self
 
     @classmethod
     def create(cls, key=None, **kwargs):
@@ -331,25 +325,29 @@ class ImportedDocument(BaseModel):
 
 
 class Bundle(BaseModel):
-    packets: List[Packet] = ...
-    documents: List[Document] = ...
-    label: Optional[str]
-    in_order: Optional[bool]
-    email_subject: Optional[str]
-    email_message: Optional[str]
-    cc_emails: Optional[List[EmailStr]]
-    is_test: Optional[bool]
-    custom_key: Optional[str]
-    team: Optional[str]
-    signing_brand: Optional[str]
-    expires: Optional[str]
-    tag_values: Optional[dict]
-
-    class Config:
-        extra = "allow"
+    model_config = ConfigDict(extra="allow")
+
+    packets: List[Packet]
+    documents: List[Union[Document, TemplateRef]]
+    label: Optional[str] = None
+    in_order: Optional[bool] = None
+    email_subject: Optional[str] = None
+    email_message: Optional[str] = None
+    cc_emails: Optional[List[EmailStr]] = None
+    is_test: Optional[bool] = None
+    custom_key: Optional[str] = None
+    team: Optional[str] = None
+    signing_brand: Optional[str] = None
+    expires: Optional[str] = None
+    tag_values: Optional[dict] = None
 
     @classmethod
-    def create(cls, packets: List[Packet], documents: List[Document], **kwargs):
+    def create(
+        cls,
+        packets: List[Packet],
+        documents: List[Union[Document, TemplateRef]],
+        **kwargs,
+    ):
         obj = Bundle(packets=packets, documents=documents, **kwargs)
         return obj
 

blueink/model/persons.py

@@ -1,20 +1,18 @@
-from pydantic import BaseModel, EmailStr
+from pydantic import BaseModel, ConfigDict, EmailStr
 from typing import Optional, List
 
 
 class ContactChannelSchema(BaseModel):
-    email: Optional[EmailStr]
-    phone: Optional[str]
-    kind: Optional[str]
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    email: Optional[EmailStr] = None
+    phone: Optional[str] = None
+    kind: Optional[str] = None
 
 
 class PersonSchema(BaseModel):
-    name: Optional[str]
-    metadata: Optional[dict]
-    channels: Optional[List[ContactChannelSchema]]
+    model_config = ConfigDict(extra="allow")
 
-    class Config:
-        extra = "allow"
+    name: Optional[str] = None
+    metadata: Optional[dict] = None
+    channels: Optional[List[ContactChannelSchema]] = None

blueink/model/webhook.py

@@ -1,12 +1,12 @@
 from typing import List, Optional
 
-from pydantic import BaseModel, Field, validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from blueink.constants import EVENT_TYPE
 
 
 class WebhookExtraHeaderSchema(BaseModel):
-    id: Optional[str]
+    id: Optional[str] = None
     webhook: str
     name: str
     value: str
@@ -14,17 +14,23 @@ class WebhookExtraHeaderSchema(BaseModel):
 
 
 class WebhookSchema(BaseModel):
-    id: Optional[str]
+    model_config = ConfigDict(populate_by_name=True)
+
+    id: Optional[str] = None
+    name: Optional[str] = None
     url: str
     enabled: bool = True
     json_: bool = Field(default=True, alias="json")
     event_types: List[str]
-    extra_headers: Optional[List[WebhookExtraHeaderSchema]]
+    extra_headers: Optional[List[WebhookExtraHeaderSchema]] = None
 
-    @validator("event_types")
+    @field_validator("event_types")
+    @classmethod
     def validate_event_types(cls, event_types):
         for event_type in event_types:
-            assert event_type in EVENT_TYPE.values(), (
-                f"subscription event_type '{event_type}' not allowed. Must be one of "
-                f"{EVENT_TYPE.values()}"
-            )
+            if event_type not in EVENT_TYPE.values():
+                raise ValueError(
+                    f"subscription event_type '{event_type}' not allowed. Must be one of "
+                    f"{EVENT_TYPE.values()}"
+                )
+        return event_types

blueink/person_helper.py

@@ -139,7 +139,7 @@ class PersonHelper:
             metadata=self._metadata,
             channels=channels,
         )
-        out_dict = person_out.dict(
+        out_dict = person_out.model_dump(
             exclude_unset=True,
         )
 

blueink/subclients/bundle.py

@@ -283,7 +283,50 @@ class BundleSubClient(SubClient):
 
         """
         url = self.build_url(endpoints.BUNDLES.CANCEL, bundle_id=bundle_id)
-        return self._request.put(url)
+        return self._requests.put(url)
+
+    def update(self, bundle_id: str, data: dict) -> NormalizedResponse:
+        """Partially update a Bundle (PATCH).
+
+        Typically used to update fields such as ``signing_brand``, ``team``,
+        ``expires``, ``cc_emails`` and reminder settings on an existing bundle.
+
+        Args:
+            bundle_id: bundle slug
+            data: dict of fields to update on the bundle
+
+        Returns:
+            NormalizedResponse object
+        """
+        if not data:
+            raise ValueError("data is required")
+
+        url = self.build_url(endpoints.BUNDLES.UPDATE, bundle_id=bundle_id)
+        return self._requests.patch(url, json=data)
+
+    def send(self, bundle_id: str) -> NormalizedResponse:
+        """Send a draft Bundle (POST).
+
+        Args:
+            bundle_id: bundle slug
+
+        Returns:
+            NormalizedResponse object
+        """
+        url = self.build_url(endpoints.BUNDLES.SEND, bundle_id=bundle_id)
+        return self._requests.post(url)
+
+    def validate(self, bundle_id: str) -> NormalizedResponse:
+        """Validate a draft Bundle (PUT).
+
+        Args:
+            bundle_id: bundle slug
+
+        Returns:
+            NormalizedResponse object, with keys ``can_send``, ``msg``, ``n_docs``
+        """
+        url = self.build_url(endpoints.BUNDLES.VALIDATE, bundle_id=bundle_id)
+        return self._requests.put(url)
 
     def list_events(self, bundle_id: str) -> NormalizedResponse:
         """Return a list of events for the supplied bundle corresponding to the id

blueink/subclients/packet.py

@@ -54,4 +54,4 @@ class PacketSubClient(SubClient):
             A NormalizedResponse
         """
         url = self.build_url(endpoints.PACKETS.REMIND, packet_id=packet_id)
-        self._requests.put(url)
+        return self._requests.put(url)

blueink/subclients/verify.py

@@ -0,0 +1,20 @@
+from blueink import endpoints
+from blueink.request_helper import NormalizedResponse
+from blueink.subclients.subclient import SubClient
+
+
+class VerifySubClient(SubClient):
+    def create(self, data: dict) -> NormalizedResponse:
+        """Verify a signed PDF against the Blueink application (POST /verify/).
+
+        Args:
+            data: dict containing the ``hash`` (sha256) of the document to verify
+
+        Returns:
+            NormalizedResponse object, with verification details as `data`
+        """
+        if not data:
+            raise ValueError("data is required")
+
+        url = self.build_url(endpoints.VERIFY.CREATE)
+        return self._requests.post(url, json=data)

blueink/subclients/webhook.py

@@ -15,9 +15,7 @@ class WebhookSubClient(SubClient):
     def list(self, **query_params) -> NormalizedResponse:
         url = self.build_url(endpoint=endpoints.WEBHOOKS.LIST)
 
-        return self._requests.get(
-            url, params=self.build_params(query_params=query_params)
-        )
+        return self._requests.get(url, params=self.build_params(**query_params))
 
     def retrieve(self, webhook_id: str) -> NormalizedResponse:
         url = self.build_url(
@@ -58,12 +56,12 @@ class WebhookSubClient(SubClient):
 
     def delete_header(self, header_id: str) -> NormalizedResponse:
         url = self.build_url(
-            endpoint=endpoints.WEBHOOKS.DELETE_HEADERE, webhook_header_id=header_id
+            endpoint=endpoints.WEBHOOKS.DELETE_HEADER, webhook_header_id=header_id
         )
 
         return self._requests.delete(url)
 
-    def update_header(self, header_id: str, **data) -> NormalizedResponse:
+    def update_header(self, header_id: str, data: dict) -> NormalizedResponse:
         url = self.build_url(
             endpoint=endpoints.WEBHOOKS.UPDATE_HEADER, webhook_header_id=header_id
         )
@@ -76,13 +74,11 @@ class WebhookSubClient(SubClient):
     def list_events(self, **query_params) -> NormalizedResponse:
         url = self.build_url(endpoint=endpoints.WEBHOOKS.LIST_EVENTS)
 
-        return self._requests.get(
-            url, params=self.build_params(query_params=query_params)
-        )
+        return self._requests.get(url, params=self.build_params(**query_params))
 
     def retrieve_event(self, event_id: str) -> NormalizedResponse:
         url = self.build_url(
-            endpoint=endpoints.WEBHOOKS.RETRIEVE_EVENT, wehook_event_id=event_id
+            endpoint=endpoints.WEBHOOKS.RETRIEVE_EVENT, webhook_event_id=event_id
         )
 
         return self._requests.get(url)
@@ -93,9 +89,7 @@ class WebhookSubClient(SubClient):
     def list_deliveries(self, **query_params) -> NormalizedResponse:
         url = self.build_url(endpoint=endpoints.WEBHOOKS.LIST_DELIVERIES)
 
-        return self._requests.get(
-            url, params=self.build_params(query_params=query_params)
-        )
+        return self._requests.get(url, params=self.build_params(**query_params))
 
     def retrieve_delivery(self, delivery_id: str) -> NormalizedResponse:
         url = self.build_url(

blueink/tests/test_client.py

@@ -543,16 +543,12 @@ class TestClientEndpoints(TestCase):
 
     def test_bundle_preparation_session_url(self):
         client = self._client()
-        url = client.bundles.build_url(
-            endpoints.BUNDLES.CREATE_PREPARATION_SESSION
-        )
+        url = client.bundles.build_url(endpoints.BUNDLES.CREATE_PREPARATION_SESSION)
         self.assert_equal(url, f"{self.BASE_URL}/bundles/preparation_session/")
 
     def test_template_preparation_session_url(self):
         client = self._client()
-        url = client.templates.build_url(
-            endpoints.TEMPLATES.CREATE_PREPARATION_SESSION
-        )
+        url = client.templates.build_url(endpoints.TEMPLATES.CREATE_PREPARATION_SESSION)
         self.assert_equal(url, f"{self.BASE_URL}/templates/preparation_session/")
 
     def test_template_update_url(self):
@@ -561,3 +557,27 @@ class TestClientEndpoints(TestCase):
             endpoints.TEMPLATES.UPDATE, template_id="T-abc123"
         )
         self.assert_equal(url, f"{self.BASE_URL}/templates/T-abc123/")
+
+    def test_bundle_update_url(self):
+        client = self._client()
+        url = client.bundles.build_url(endpoints.BUNDLES.UPDATE, bundle_id="B-abc123")
+        self.assert_equal(url, f"{self.BASE_URL}/bundles/B-abc123/")
+
+    def test_bundle_send_url(self):
+        client = self._client()
+        url = client.bundles.build_url(endpoints.BUNDLES.SEND, bundle_id="B-abc123")
+        self.assert_equal(url, f"{self.BASE_URL}/bundles/B-abc123/send/")
+
+    def test_bundle_validate_url(self):
+        client = self._client()
+        url = client.bundles.build_url(endpoints.BUNDLES.VALIDATE, bundle_id="B-abc123")
+        self.assert_equal(url, f"{self.BASE_URL}/bundles/B-abc123/validate/")
+
+    def test_verify_url(self):
+        client = self._client()
+        url = client.verify.build_url(endpoints.VERIFY.CREATE)
+        self.assert_equal(url, f"{self.BASE_URL}/verify/")
+
+    def test_verify_subclient_registered(self):
+        client = self._client()
+        self.assert_not_none(client.verify)

{blueink_client_python-1.2.0.dist-info → blueink_client_python-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blueink-client-python
-Version: 1.2.0
+Version: 1.3.0
 Summary: Python Client for Blueink eSignature API
 Home-page: https://github.com/blueinkhq/blueink-client-python
 Author: Blueink
@@ -14,16 +14,16 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: munch
 Requires-Dist: requests
-Requires-Dist: pydantic
-Requires-Dist: email-validator
+Requires-Dist: pydantic<3.0,>=2.0
+Requires-Dist: email-validator<3.0,>=2.0
 Provides-Extra: munch
 Requires-Dist: munch>=2.5; extra == "munch"
 Provides-Extra: requests
 Requires-Dist: requests>=2.31; extra == "requests"
 Provides-Extra: pydantic
-Requires-Dist: pydantic>=1.9; extra == "pydantic"
+Requires-Dist: pydantic<3.0,>=2.0; extra == "pydantic"
 Provides-Extra: email-validator
-Requires-Dist: 1.2; extra == "email-validator"
+Requires-Dist: email-validator<3.0,>=2.0; extra == "email-validator"
 Dynamic: license-file
 
 # blueink-client-python
@@ -124,6 +124,7 @@ The supported "resources" are:
  * `persons`
  * `packets`
  * `templates`
+ * `envelope_templates`
  * `webhooks`
 
  The methods correspond to common REST operations:
@@ -266,6 +267,8 @@ as kwargs.
 
 ### Bundle Related
 * Create via ```client.bundles.create(...)``` or ```client.bundles.create_from_bundle_helper(...)```
+* Create from Envelope Template via ```client.bundles.create_from_envelope_template_helper(...)``` or ```client.bundles.create_from_envelope_template(...)```
+* Create Preparation Session via ```client.bundles.create_preparation_session(...)```
 * List via ```client.bundles.list(...)``` or ```client.bundles.paged_list(...)```
 * Retrieve via ```client.bundles.retrieve(...)```
 * Cancel via ```client.bundles.cancel(...)```
@@ -289,6 +292,12 @@ as kwargs.
 ### Template Related
 * List via ```client.templates.list(...)``` or ```client.templates.paged_list(...)```
 * Retrieve via ```client.templates.retrieve(...)```
+* Update via ```client.templates.update(...)```
+* Create Preparation Session via ```client.templates.create_preparation_session(...)```
+
+### Envelope Template Related
+* List via ```client.envelope_templates.list(...)``` or ```client.envelope_templates.paged_list(...)```
+* Retrieve via ```client.envelope_templates.retrieve(...)```
 
 ### Webhook Related
 
@@ -452,6 +461,19 @@ response = client.bundles.create_from_bundle_helper(bh)
 - Automatically adjusts to text position in the document
 - Can be combined with regular manually-positioned fields
 
+#### Bundle Tag Values
+
+Bundle-level `tag_values` can be set on the `BundleHelper` constructor to attach
+arbitrary key/value metadata to a Bundle at creation time:
+
+```python
+bh = BundleHelper(
+    label="Tagged Agreement",
+    is_test=True,
+    tag_values={"contract_type": "nda"},
+)
+```
+
 #### Retrieval
 
 Getting a single bundle is fairly easy. They can be accessed with a single call. To get
@@ -688,9 +710,64 @@ for page in client.templates.paged_list():
     page.data  # templates in page
 # single
 template_response = client.templates.retrieve(template_id)
+```
+
+Templates can also be partially updated (for example, to write template metadata):
+
+```python
+client.templates.update(template_id, {"metadata": {"key": "value"}})
+```
+
+#### Template Preparation Sessions
+
+A preparation session creates a secure, time-limited URL that can be embedded in an
+iframe to let an end user prepare a template through your application:
+
+```python
+response = client.templates.create_preparation_session({
+    "template_id": template_id,        # optional: slug of an existing template to edit
+    "redirect_url": "https://your-app.example.com/done",  # optional
+})
+prep_url = response.data.url           # URL to embed in an iframe
+expires = response.data.expires        # ISO 8601 timestamp when the URL expires
+```
+
+A similar session can be created for bundle/document preparation via
+`client.bundles.create_preparation_session(...)`.
+
+### Envelope Templates
+
+Envelope Templates are reusable document workflows that contain predefined documents,
+field layouts, signer roles, and configuration settings. They can be listed (non-paged),
+listed (paged) or retrieved singly:
+
+```python
+# non paged
+envelope_templates_response = client.envelope_templates.list()
+# paged
+for page in client.envelope_templates.paged_list():
+    page.data  # envelope templates in page
+# single
+envelope_template_response = client.envelope_templates.retrieve(envelope_template_id)
+```
 
+To create a Bundle from an envelope template, configure a `BundleHelper` with the
+template and its signers, then create the Bundle:
 
+```python
+from blueink import BundleHelper, Client
+
+bh = BundleHelper(label="Contract", is_test=True)
+bh.add_signer(name="John Doe", email="john@example.com", key="signer-1")
+bh.set_envelope_template(
+    template_id="T-abc123",
+    field_values={"company_name": "ACME Corp"},
+)
+
+client = Client()
+response = client.bundles.create_from_envelope_template_helper(bh)
 ```
+
 ### Webhooks
 
 Webhooks can be interacted with via several methods. Webhooks also have related objects, such as
@@ -701,8 +778,8 @@ methods to interact with.
 from copy import deepcopy
 
 from requests import HTTPError
-from src.blueink import Client
-from src.blueink.constants import EVENT_TYPE
+from blueink import Client
+from blueink.constants import EVENT_TYPE
 
 WEBHOOK_01 = {
     "url": "https://www.example.com/01/",

blueink_client_python-1.3.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+blueink/__init__.py,sha256=2UQx6cM2oh8-osuqB9N8zmfTWlkJ0mTn-6i3F5S44mI,267
+blueink/bundle_helper.py,sha256=Z9eKd4lVJL50JDe8JLWiaXfsE54eVv6D7BPZgdTzlkg,20385
+blueink/client.py,sha256=vRsDjZhtxEljqNAt7j-9072j9do8j4YGa_nzpMx3f6Q,3077
+blueink/constants.py,sha256=RQIXXqs2KHXmrUUY_9kq9bT9RT_J0eziW4AGNgB9lMU,1946
+blueink/endpoints.py,sha256=Yr5U_LeH-lbwINtZk7oFYM9ylHpgx3EvhXOB2k1V9BY,2611
+blueink/paginator.py,sha256=WIdYFdAsdXVYVBmQwmyXkChAHkM5Kr2jGDBEIVaihfY,1754
+blueink/person_helper.py,sha256=iZKzh_zl9G80PKo-YERKyKjnYY7WmPDVvHz351k-VJk,3897
+blueink/request_helper.py,sha256=704lm-ZIqW3eebg-dl5sYubeXaEt_F3LZyVwuAY4dr8,3893
+blueink/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blueink/model/bundles.py,sha256=KB-i7goTrOobsgV5U1S2rwqlJGnD4_fKXVeCpzKE17E,10290
+blueink/model/persons.py,sha256=SnCbCGo97bkk-sR0il70-O2ssq5UgY_w1YX9ko3_6mc,478
+blueink/model/webhook.py,sha256=G8VmmR5fwXmLDFVm-xxwk1wAbTOlO5iGHHtpDJoRRHw,1021
+blueink/subclients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blueink/subclients/bundle.py,sha256=tSBfyDScSuhQHAJ-Nnu9Nw-bEUKoI274UcxZT0ycxKg,13612
+blueink/subclients/envelope_template.py,sha256=dLXSOyXSoSjAEaJRvYs1Yf_iujgjFV-jNFZ8TTO239Y,2205
+blueink/subclients/packet.py,sha256=NTxikTbaDf1okdLWR0c9Vcr3UJGkJzn5lu_0loGHmvk,1995
+blueink/subclients/person.py,sha256=MzJt4fInfkxwdM5fnb_T0xAuqweiU8k83unsrAfS8Pw,3822
+blueink/subclients/subclient.py,sha256=yk5Zk3H-CiVgJkDeTMqjp65Z4jz6Jppti9rALo7ttxg,1692
+blueink/subclients/template.py,sha256=UpQXwlLzLOH-emT-bXsxeYDD02x4OK7WBbs-xTJZn8w,3375
+blueink/subclients/verify.py,sha256=bmi-y7G9fP2fEp_uR4OTa2APrnHzLuK6qhGSLY3uO78,685
+blueink/subclients/webhook.py,sha256=lvF0rrczPHTuLIapxq2a1kCzXwtP7IcoYrskdHBou9M,3804
+blueink/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blueink/tests/test_bundle_helper.py,sha256=S69bMI9RYr1ubeP4GP9pJ9gic7CWocpfrnl2I_aeqZM,23016
+blueink/tests/test_client.py,sha256=7dgeI1Vun9G0xu3Kno4gnHnd14Hsh--hZksj9GbyLSE,20427
+blueink/tests/test_person_helper.py,sha256=ie4UmIiEt3hT6oRp91FN1Uj6P6D7_U3M1zPxBr5NPU4,1900
+blueink/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blueink/utils/testcase.py,sha256=K_4ff5U0oh8mkOqvdXY0NWEaaJ5qnzJnxIN6vmISie4,1027
+blueink_client_python-1.3.0.dist-info/licenses/LICENSE,sha256=2O7Tj4oNAFf3vQhgcbYenxAcanqcAjOmA9kHp1Y_zDc,1094
+blueink_client_python-1.3.0.dist-info/METADATA,sha256=0cNS3Md8Ii7MDiTnXRkNulB4g_EcOt4RIp90I2ZBggw,26966
+blueink_client_python-1.3.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+blueink_client_python-1.3.0.dist-info/top_level.txt,sha256=9hbus8lB_HAEBjA8Vz2_ZKcm8mdU9Bo6V8raVwZPfFs,8
+blueink_client_python-1.3.0.dist-info/RECORD,,

{blueink_client_python-1.2.0.dist-info → blueink_client_python-1.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (83.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

blueink_client_python-1.2.0.dist-info/RECORD

@@ -1,31 +0,0 @@
-blueink/__init__.py,sha256=2UQx6cM2oh8-osuqB9N8zmfTWlkJ0mTn-6i3F5S44mI,267
-blueink/bundle_helper.py,sha256=kMnJ6xHA3kPTnAdpx-ZlmxATwRsOnE7AG9u3f2nT5iM,20326
-blueink/client.py,sha256=Vmb3RL3A9QwNcMYaQGWkC7k91q18vACWY-rJHPeA4Pk,2947
-blueink/constants.py,sha256=NhlzcWvx4vlg4p163yF6aOab4Ev_HvADlBWCbLQzxKQ,1838
-blueink/endpoints.py,sha256=PxnOB7lpQy9WWR3fgwkA0hbhM-2F0t14vXJyJX6W6uY,2443
-blueink/paginator.py,sha256=WIdYFdAsdXVYVBmQwmyXkChAHkM5Kr2jGDBEIVaihfY,1754
-blueink/person_helper.py,sha256=FJtzv4d0RJLtsI8kOXIQJlX6SyKmjpPxmvcuCRAcsXI,3891
-blueink/request_helper.py,sha256=704lm-ZIqW3eebg-dl5sYubeXaEt_F3LZyVwuAY4dr8,3893
-blueink/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-blueink/model/bundles.py,sha256=kptX6_AnmBvXRQOepaplkutrszC_wR_fF-jUCiRM1Ec,9801
-blueink/model/persons.py,sha256=Lg84UK8hjokcLcmr0JA7c1LNGHxGSDGZ_xwpN45HUMI,418
-blueink/model/webhook.py,sha256=lzNjwdpvzY5My87HLuNvvZ_lVgnoA5RG3fWSK-jlT5M,803
-blueink/subclients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-blueink/subclients/bundle.py,sha256=UNcLD4f7rQryz_nZujBFI-s7uInWRO0wJlxTjJpRbuw,12245
-blueink/subclients/envelope_template.py,sha256=dLXSOyXSoSjAEaJRvYs1Yf_iujgjFV-jNFZ8TTO239Y,2205
-blueink/subclients/packet.py,sha256=S1y1ab4tg5a9I-PKlp5qhuxbGWPUtl33RyZ2iLPazI0,1988
-blueink/subclients/person.py,sha256=MzJt4fInfkxwdM5fnb_T0xAuqweiU8k83unsrAfS8Pw,3822
-blueink/subclients/subclient.py,sha256=yk5Zk3H-CiVgJkDeTMqjp65Z4jz6Jppti9rALo7ttxg,1692
-blueink/subclients/template.py,sha256=UpQXwlLzLOH-emT-bXsxeYDD02x4OK7WBbs-xTJZn8w,3375
-blueink/subclients/webhook.py,sha256=igcreILfcxyLCyAN7zJaTbqeMHFY9FPaq1WLp4kWbT0,3899
-blueink/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-blueink/tests/test_bundle_helper.py,sha256=S69bMI9RYr1ubeP4GP9pJ9gic7CWocpfrnl2I_aeqZM,23016
-blueink/tests/test_client.py,sha256=xHMgmYxPs6JxlUgI73UmY93FmTpYbCT2Bx67uZvHyJQ,19465
-blueink/tests/test_person_helper.py,sha256=ie4UmIiEt3hT6oRp91FN1Uj6P6D7_U3M1zPxBr5NPU4,1900
-blueink/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-blueink/utils/testcase.py,sha256=K_4ff5U0oh8mkOqvdXY0NWEaaJ5qnzJnxIN6vmISie4,1027
-blueink_client_python-1.2.0.dist-info/licenses/LICENSE,sha256=2O7Tj4oNAFf3vQhgcbYenxAcanqcAjOmA9kHp1Y_zDc,1094
-blueink_client_python-1.2.0.dist-info/METADATA,sha256=mDE3nheOoIsgdCHHE_RumwsY5k4xQGYHn9TiuUUFXe0,24150
-blueink_client_python-1.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-blueink_client_python-1.2.0.dist-info/top_level.txt,sha256=9hbus8lB_HAEBjA8Vz2_ZKcm8mdU9Bo6V8raVwZPfFs,8
-blueink_client_python-1.2.0.dist-info/RECORD,,