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

{blueink_client_python-1.0.1/src/blueink_client_python.egg-info → blueink_client_python-1.2.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.2.0
 Summary: Python Client for Blueink eSignature API
 Home-page: https://github.com/blueinkhq/blueink-client-python
 Author: Blueink
@@ -23,7 +23,8 @@ 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"
+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)

{blueink_client_python-1.0.1 → blueink_client_python-1.2.0}/setup.cfg

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

{blueink_client_python-1.0.1 → blueink_client_python-1.2.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
@@ -561,6 +609,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)

{blueink_client_python-1.0.1 → blueink_client_python-1.2.0}/src/blueink/endpoints.py

@@ -9,6 +9,7 @@ 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}/"
     CANCEL = "/bundles/${bundle_id}/cancel/"
@@ -35,6 +36,8 @@ class PACKETS:
 class TEMPLATES:
     LIST = "/templates/"
     RETRIEVE = "/templates/${template_id}/"
+    UPDATE = "/templates/${template_id}/"
+    CREATE_PREPARATION_SESSION = "/templates/preparation_session/"
 
 
 class ENVELOPE_TEMPLATES:

{blueink_client_python-1.0.1 → blueink_client_python-1.2.0}/src/blueink/model/bundles.py

@@ -28,6 +28,7 @@ class AutoPlacement(BaseModel):
     offset_y: Optional[int] = 0
     editors: Optional[List[str]]
     page: Optional[int]
+    v_attachment_types: Optional[List[str]]
 
     class Config:
         extra = "allow"
@@ -93,7 +94,11 @@ class Field(BaseModel):
     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"
@@ -129,6 +134,8 @@ class Packet(BaseModel):
     deliver_via: Optional[str]
     person_id: Optional[str]
     order: Optional[str]
+    requires_witness: Optional[bool]
+    witness_nominated_by: Optional[str]
 
     class Config:
         extra = "allow"
@@ -246,9 +253,11 @@ class Document(BaseModel):
     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"
@@ -281,6 +290,46 @@ class Document(BaseModel):
         self.assignments.append(assignment)
 
 
+class ImportedDocument(BaseModel):
+    """Model for documents in an imported bundle.
+
+    Each imported document must have exactly one of file_b64 or file_html.
+    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]
+
+    class Config:
+        extra = "allow"
+
+    @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)
+
+        if has_b64 and has_html:
+            raise ValueError("Provide only one of 'file_b64' or 'file_html', not both")
+
+        if not has_b64 and not has_html:
+            raise ValueError("Each document must have either 'file_b64' or 'file_html'")
+
+        return file_html
+
+    @classmethod
+    def create(cls, key=None, **kwargs):
+        if not key:
+            key = generate_key("doc", 5)
+        obj = ImportedDocument(key=key, **kwargs)
+        return obj
+
+
 class Bundle(BaseModel):
     packets: List[Packet] = ...
     documents: List[Document] = ...
@@ -292,6 +341,9 @@ class Bundle(BaseModel):
     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"

{blueink_client_python-1.0.1 → blueink_client_python-1.2.0}/src/blueink/subclients/bundle.py

@@ -320,3 +320,32 @@ class BundleSubClient(SubClient):
         """
         url = self.build_url(endpoints.BUNDLES.LIST_DATA, bundle_id=bundle_id)
         return self._requests.get(url)
+
+    def create_preparation_session(self, data: dict) -> NormalizedResponse:
+        """Create an embedded document preparation session.
+
+        Creates a secure, time-limited URL that can be embedded in an iframe to allow
+        end users to prepare documents for signing through your application.
+
+        At least one document source must be enabled: either upload_pdf=True or
+        template_ids/folder_ids must be provided.
+
+        Args:
+            data: configuration for the preparation session. Supported keys:
+                - upload_pdf (bool): whether to allow PDF uploads (default True)
+                - draft_bundle (str, optional): slug of an existing draft bundle
+                - template_ids (list, optional): list of template UUIDs to restrict to
+                - folder_ids (list, optional): list of folder BUIDs to restrict to
+                - redirect_url (str, optional): URL to redirect to after preparation
+                - allow_search_signers (bool, optional): whether to allow signer search
+
+        Returns:
+            NormalizedResponse object with keys:
+                - url: the preparation session URL to embed in an iframe
+                - expires: ISO 8601 timestamp when the session URL expires
+        """
+        if not data:
+            raise ValueError("data is required")
+
+        url = self.build_url(endpoints.BUNDLES.CREATE_PREPARATION_SESSION)
+        return self._requests.post(url, json=data)

{blueink_client_python-1.0.1 → blueink_client_python-1.2.0}/src/blueink/subclients/template.py

@@ -56,3 +56,44 @@ class TemplateSubClient(SubClient):
         """
         url = self.build_url(endpoints.TEMPLATES.RETRIEVE, template_id=template_id)
         return self._requests.get(url)
+
+    def update(self, template_id: str, data: dict) -> NormalizedResponse:
+        """Partially update a Template.
+
+        Typically used to write template metadata, e.g.
+        ``{"metadata": {"key": "value"}}``.
+
+        Args:
+            template_id:
+            data: dict of fields to update on the template
+
+        Returns:
+            NormalizedResponse object
+        """
+        if not data:
+            raise ValueError("data is required")
+
+        url = self.build_url(endpoints.TEMPLATES.UPDATE, template_id=template_id)
+        return self._requests.patch(url, json=data)
+
+    def create_preparation_session(self, data: dict) -> NormalizedResponse:
+        """Create an embedded template preparation session.
+
+        Creates a secure, time-limited URL that can be embedded in an iframe to allow
+        end users to prepare a template through your application.
+
+        Args:
+            data: configuration for the preparation session. Supported keys:
+                - template_id (str, optional): slug of an existing template to edit
+                - redirect_url (str, optional): URL to redirect to after preparation
+
+        Returns:
+            NormalizedResponse object with keys:
+                - url: the preparation session URL to embed in an iframe
+                - expires: ISO 8601 timestamp when the session URL expires
+        """
+        if not data:
+            raise ValueError("data is required")
+
+        url = self.build_url(endpoints.TEMPLATES.CREATE_PREPARATION_SESSION)
+        return self._requests.post(url, json=data)