blueink-client-python 1.0.1__tar.gz → 1.3.0__tar.gz

{blueink_client_python-1.0.1 → blueink_client_python-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: blueink-client-python
-Version: 1.0.1
+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,17 @@ 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: email-validator>=1.2; extra == "email-validator"
+Requires-Dist: email-validator<3.0,>=2.0; extra == "email-validator"
+Dynamic: license-file
 
 # blueink-client-python
 ![Tests](https://github.com/blueinkhq/blueink-client-python/actions/workflows/helper-tests.yml/badge.svg)
@@ -123,6 +124,7 @@ The supported "resources" are:
  * `persons`
  * `packets`
  * `templates`
+ * `envelope_templates`
  * `webhooks`
 
  The methods correspond to common REST operations:
@@ -265,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(...)```
@@ -288,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
 
@@ -451,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
@@ -687,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
@@ -700,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.0.1/src/blueink_client_python.egg-info/PKG-INFO → blueink_client_python-1.3.0/README.md

@@ -1,30 +1,3 @@
-Metadata-Version: 2.1
-Name: blueink-client-python
-Version: 1.0.1
-Summary: Python Client for Blueink eSignature API
-Home-page: https://github.com/blueinkhq/blueink-client-python
-Author: Blueink
-Author-email: pypi@blueink.com
-Project-URL: Bug Tracker, https://github.com/blueinkhq/blueink-client-python/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: munch
-Requires-Dist: requests
-Requires-Dist: pydantic
-Requires-Dist: email-validator
-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"
-Provides-Extra: email-validator
-Requires-Dist: email-validator>=1.2; extra == "email-validator"
-
 # blueink-client-python
 ![Tests](https://github.com/blueinkhq/blueink-client-python/actions/workflows/helper-tests.yml/badge.svg)
 ![Style Checks](https://github.com/blueinkhq/blueink-client-python/actions/workflows/style-checks.yml/badge.svg)
@@ -123,6 +96,7 @@ The supported "resources" are:
  * `persons`
  * `packets`
  * `templates`
+ * `envelope_templates`
  * `webhooks`
 
  The methods correspond to common REST operations:
@@ -265,6 +239,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(...)```
@@ -288,6 +264,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
 
@@ -451,6 +433,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
@@ -687,9 +682,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
@@ -700,8 +750,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.0.1 → blueink_client_python-1.3.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = blueink-client-python
-version = 1.0.1
+version = 1.3.0
 author = Blueink
 author_email = pypi@blueink.com
 description = Python Client for Blueink eSignature API
@@ -22,18 +22,14 @@ python_requires = >=3.8
 install_requires = 
 	munch
 	requests
-	pydantic
-	email-validator
+	pydantic>=2.0,<3.0
+	email-validator>=2.0,<3.0
 
 [options.extras_require]
-munch = 
-	munch>=2.5
-requests = 
-	requests>=2.31
-pydantic = 
-	pydantic>=1.9
-email-validator = 
-	email-validator>=1.2
+munch = munch>=2.5;
+requests = requests>=2.31;
+pydantic = pydantic>=2.0,<3.0
+email-validator = email-validator>=2.0,<3.0
 
 [options.packages.find]
 where = src

{blueink_client_python-1.0.1 → blueink_client_python-1.3.0}/src/blueink/bundle_helper.py

@@ -10,6 +10,7 @@ from blueink.model.bundles import (
     EnvelopeTemplate,
     EnvelopeTemplateFieldValue,
     Field,
+    ImportedDocument,
     Packet,
     TemplateRef,
     TemplateRefAssignment,
@@ -28,6 +29,9 @@ class BundleHelper:
         is_test: bool = False,
         custom_key: str = None,
         team: str = None,
+        signing_brand: str = None,
+        expires: str = None,
+        tag_values: dict = None,
     ):
         """Helper class to aid building a Bundle.
 
@@ -41,6 +45,9 @@ class BundleHelper:
             is_test:
             custom_key:
             team:
+            signing_brand:
+            expires:
+            tag_values: Optional dict mapping data flow tags to pre-filled values
         """
         self._label = label
         self._in_order = in_order
@@ -52,6 +59,9 @@ class BundleHelper:
         self._packets = {}
         self._custom_key = custom_key
         self._team = team
+        self._signing_brand = signing_brand
+        self._expires = expires
+        self._tag_values = tag_values
         self._envelope_template = None
 
         # for file uploads, index should match those in the document "file_index" field
@@ -111,6 +121,20 @@ class BundleHelper:
 
         return self.add_document_by_b64(filename, b64str, **additional_data)
 
+    def add_document_by_html(self, html_content: str, **additional_data) -> str:
+        """Add a document using an HTML string for HTML-to-PDF conversion.
+
+        Args:
+            html_content: HTML content string
+            additional_data: Optional additional kwargs (e.g., filename, html_fields_mode)
+
+        Returns:
+            Document Key
+        """
+        document = Document.create(file_html=html_content, **additional_data)
+        self._documents[document.key] = document
+        return document.key
+
     def add_document_by_b64(self, filename: str, b64str: str, **additional_data):
         """Add a file using a b64 string; utf-8 encoded
 
@@ -209,6 +233,10 @@ class BundleHelper:
         v_pattern: str = None,
         v_min: int = None,
         v_max: int = None,
+        v_regex: str = None,
+        v_regex_msg: str = None,
+        v_attachment_types: List[str] = None,
+        data_flow_tag: str = None,
         key=None,
         **additional_data,
     ):
@@ -226,6 +254,10 @@ class BundleHelper:
             v_pattern: Optional
             v_min: Optional
             v_max: Optional
+            v_regex: Optional regular expression for field validation
+            v_regex_msg: Optional error message shown when v_regex validation fails
+            v_attachment_types: Optional list of allowed attachment file extensions (only for kind='att')
+            data_flow_tag: Optional data flow tag to associate with the field
             editors: Optional
             key: Optional
             additional_data: Optional and will append any additional kwargs to the json of the field
@@ -247,6 +279,10 @@ class BundleHelper:
             v_pattern=v_pattern,
             v_min=v_min,
             v_max=v_max,
+            v_regex=v_regex,
+            v_regex_msg=v_regex_msg,
+            v_attachment_types=v_attachment_types,
+            data_flow_tag=data_flow_tag,
             key=key,
             **additional_data,
         )
@@ -267,6 +303,7 @@ class BundleHelper:
         offset_y: int = 0,
         editors: List[str] = None,
         page: int = None,
+        v_attachment_types: List[str] = None,
         **additional_data,
     ):
         """Add an auto-placement field to a document.
@@ -284,6 +321,7 @@ class BundleHelper:
             offset_y: Vertical offset from the search text (default: 0)
             editors: List of signer keys who can edit this field
             page: Optional page number to limit search to
+            v_attachment_types: Optional list of allowed attachment file extensions (only for kind='att')
             additional_data: Optional additional kwargs to append to the auto-placement
 
         Returns:
@@ -313,6 +351,7 @@ class BundleHelper:
             offset_x=offset_x,
             offset_y=offset_y,
             page=page,
+            v_attachment_types=v_attachment_types,
             **additional_data,
         )
 
@@ -334,6 +373,8 @@ class BundleHelper:
         auth_id: bool = False,
         order: int = None,
         key=None,
+        requires_witness: bool = None,
+        witness_nominated_by: str = None,
         **additional_data,
     ):
         """Create and add a signer. With at least an email xor phone number.
@@ -349,6 +390,8 @@ class BundleHelper:
             auth_id: Optional
             deliver_via: Optional
             order: Optional
+            requires_witness: Optional
+            witness_nominated_by: Optional
             additional_data: Optional and will append any additional kwargs to the json of the signer
 
         Returns:
@@ -368,6 +411,8 @@ class BundleHelper:
             deliver_via=deliver_via,
             order=order,
             key=key,
+            requires_witness=requires_witness,
+            witness_nominated_by=witness_nominated_by,
             **additional_data,
         )
         self._packets[packet.key] = packet
@@ -496,6 +541,9 @@ class BundleHelper:
             cc_emails=self._cc_emails,
             custom_key=self._custom_key,
             team=self._team,
+            signing_brand=self._signing_brand,
+            expires=self._expires,
+            tag_values=self._tag_values,
             **additional_data,
         )
         return bundle_out
@@ -510,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.
@@ -540,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
             ),
         }
@@ -561,6 +611,8 @@ class BundleHelper:
             result["custom_key"] = self._custom_key
         if self._team:
             result["team"] = self._team
+        if self._signing_brand:
+            result["signing_brand"] = self._signing_brand
 
         # Add any additional data
         result.update(additional_data)
@@ -577,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_python-1.0.1 → blueink_client_python-1.3.0}/src/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_client_python-1.0.1 → blueink_client_python-1.3.0}/src/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_client_python-1.0.1 → blueink_client_python-1.3.0}/src/blueink/endpoints.py

@@ -9,8 +9,12 @@ from string import Template
 class BUNDLES:
     CREATE = "/bundles/"
     CREATE_FROM_ENVELOPE_TEMPLATE = "/bundles/create_from_envelope_template/"
+    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/"
@@ -35,6 +39,8 @@ class PACKETS:
 class TEMPLATES:
     LIST = "/templates/"
     RETRIEVE = "/templates/${template_id}/"
+    UPDATE = "/templates/${template_id}/"
+    CREATE_PREPARATION_SESSION = "/templates/preparation_session/"
 
 
 class ENVELOPE_TEMPLATES:
@@ -42,6 +48,10 @@ class ENVELOPE_TEMPLATES:
     RETRIEVE = "/envelope-templates/${envelope_template_id}/"
 
 
+class VERIFY:
+    CREATE = "/verify/"
+
+
 class WEBHOOKS:
     CREATE = "/webhooks/"
     LIST = "/webhooks/"