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

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

@@ -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.2.0/src/blueink_client_python.egg-info/PKG-INFO → blueink_client_python-1.3.0/README.md

@@ -1,31 +1,3 @@
-Metadata-Version: 2.4
-Name: blueink-client-python
-Version: 1.2.0
-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: 1.2; extra == "email-validator"
-Dynamic: license-file
-
 # 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)
@@ -124,6 +96,7 @@ The supported "resources" are:
  * `persons`
  * `packets`
  * `templates`
+ * `envelope_templates`
  * `webhooks`
 
  The methods correspond to common REST operations:
@@ -266,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(...)```
@@ -289,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
 
@@ -452,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
@@ -688,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
@@ -701,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.2.0 → blueink_client_python-1.3.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = blueink-client-python
-version = 1.2.0
+version = 1.3.0
 author = Blueink
 author_email = pypi@blueink.com
 description = Python Client for Blueink eSignature API
@@ -22,14 +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> = 1.2
+pydantic = pydantic>=2.0,<3.0
+email-validator = email-validator>=2.0,<3.0
 
 [options.packages.find]
 where = src

{blueink_client_python-1.2.0 → blueink_client_python-1.3.0}/src/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_python-1.2.0 → 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.2.0 → 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.2.0 → blueink_client_python-1.3.0}/src/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/"