signedly 0.1.0__py3-none-any.whl

signedly/rest.py

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+"""
+    Signedly API
+
+     The Signedly REST API lets your system upload documents, add signatories and fields, send them for signing and download the signed result. Every path starts with `/ap1/`, and every request and response body is JSON unless an endpoint says otherwise (the uploads are `multipart/form-data`).  ## Authentication  1. In the Signedly web app, open **Account & Settings → API** and generate a    **client ID** and **client secret** for your organisation. 2. `POST /ap1/token/` with them. You get an `access_token` (valid **2 hours**) and    a `refresh_token` (valid **7 days**). While both are still valid, calling    `/ap1/token/` again returns the same pair. 3. Send the access token on every other call:    `Authorization: Bearer <access_token>`. 4. When the access token expires, `POST /ap1/refreshtoken/` with the refresh token    for a new access token. When the refresh token has expired too, call    `/ap1/token/` again.  `/ap1/token/` and `/ap1/refreshtoken/` allow 60 calls a minute per IP address; more answer 429. A missing, unknown or expired access token answers 403 (`\"Client not found\"` or `\"Access token expired\"`).  The API acts for your **organisation's admin account**: documents you upload belong to it and appear in its Signedly web app, and you can reach only that account's documents, templates, signatories and fields. Another organisation's IDs answer 404, as if they didn't exist.  ## Plans  What the API allows depends on the Signedly plan of your **organisation's admin account** (Account & Settings → Account & Plan). The same rules apply to live and test keys.  | What | Free | Personal Pro | Business Pro | Teams | |---|---|---|---|---| | Generate live and test keys (Account & Settings → API) | – | ✓ | ✓ | ✓ | | Every endpoint, `/ap1/token/` and `/ap1/refreshtoken/` included | – | ✓ | ✓ | ✓ | | `require_email_otp` on `POST /ap1/signatories/` and `POST /ap1/signatories/bulk/` | – | ✓ | ✓ | ✓ | | Bulk send: `GET /ap1/bulk-sends/columns/` and `POST /ap1/bulk-sends/` | – | – | – | ✓ |  The API is part of the paid plans. On Free (or with no plan) every call answers 403 `\"... Your plan doesn't include API access.\"`, with live or test keys, also with a token or keys made earlier; they work again once the plan is paid. On a paid plan, a feature it doesn't include answers 400 with `\"Your plan doesn't include ...\"` and changes nothing, and `GET /ap1/bulk-sends/{id}/` still reports bulk sends already made.  Live documents also need an API contract with Signedly. Without one, or with an unpaid API invoice, `POST /ap1/upload/` (except templates), `/ap1/upload_app/`, `/ap1/documents/fromtemplate/` and `/ap1/bulk-sends/` answer 402 with live keys. Test keys work without a contract (see Sandbox).  ## Sending a document for signing  1. `POST /ap1/upload/` a PDF or DOCX (`type` 2). The document is prepared in the    background: find it in `GET /ap1/documents/?name=<name>` (its `upload.id` is    the upload's `id`), and wait until `GET /ap1/documents/{id}/pages/` lists its    pages. 2. `POST /ap1/signatories/` (one) or `POST /ap1/signatories/bulk/` (several) to    add the people who sign. 3. `POST /ap1/documents/fields/` to place the fields each signatory fills in. 4. Send it:    - `POST /ap1/document/send/` emails every signatory a signing link (with      ordered signing, only the first; each next one is emailed in      turn), or    - `POST /ap1/document/send_url/` sends no email and returns the first      signatory's signing link, for you to show or send yourself. 5. Poll `GET /ap1/documents-status-list/` (or `GET /ap1/documents/`) until the    status is 6 (Completed), then `GET /ap1/document/download-link/` for the    signed PDF and `GET /ap1/document/download-audit-link/` for its audit trail.  **From a template:** upload with `type` 4 and a `template_name` (or make the template in the web app), place its fields with `POST /ap1/templates/fields/`, then for each signing make a document with `POST /ap1/documents/fromtemplate/`, add its signatory, and send it.  **One signer, one call:** `POST /ap1/upload_app/` uploads a PDF or DOCX for one signer and returns their signing link in `redirect_url`; the signer places their own signature. After signing they go to the `redirect_url` you sent, and the signed PDF and its audit trail are emailed to `final_email` (otherwise to your organisation's admin).  ## Quick start with curl  Each step uses an ID from the step before. `$API` is this server, e.g. `https://l0ads.signedly.com`.  ```bash # 1. Token curl -X POST $API/ap1/token/ -H 'Content-Type: application/json' \\   -d '{\"client_id\": \"<client id>\", \"client_secret\": \"<client secret>\"}' TOKEN=<access_token from the answer>  # 2. Upload a PDF (answers with the upload's id) curl -X POST $API/ap1/upload/ -H \"Authorization: Bearer $TOKEN\" \\   -F file=@nda.pdf -F name=nda-ann-lee -F type=2  # 3. Find the document, then wait until it has pages curl \"$API/ap1/documents/?name=nda-ann-lee\" -H \"Authorization: Bearer $TOKEN\" DOC=<results[0].id> curl $API/ap1/documents/$DOC/pages/ -H \"Authorization: Bearer $TOKEN\" PAGE=<[0].id>  # 4. Add the signatory curl -X POST $API/ap1/signatories/ -H \"Authorization: Bearer $TOKEN\" \\   -H 'Content-Type: application/json' \\   -d '{\"document_id\": \"'$DOC'\", \"name\": \"Ann Lee\", \"email\": \"ann@example.com\"}' SIGNER=<id from the answer>  # 5. Place her signature: 150 × 40 points, 72 points from the left, 640 from the top curl -X POST $API/ap1/documents/fields/ -H \"Authorization: Bearer $TOKEN\" \\   -H 'Content-Type: application/json' \\   -d '[{\"document_id\": \"'$DOC'\", \"signatory_id\": \"'$SIGNER'\", \"kind\": 2,         \"label\": \"Signature\", \"placeholder\": \"Sign here\", \"page\": \"'$PAGE'\",         \"page_number\": 0, \"x\": 72, \"y\": 640, \"width\": 150, \"height\": 40}]'  # 6. Send it (Ann gets the signing email) curl -X POST $API/ap1/document/send/ -H \"Authorization: Bearer $TOKEN\" \\   -H 'Content-Type: application/json' \\   -d '{\"document_id\": \"'$DOC'\", \"subject\": \"Please sign the NDA\",        \"message\": \"Hi Ann, please sign by Friday.\", \"expiry_date\": \"2026-12-31\"}'  # 7. Poll until status is 6 (Completed), then get the signed PDF curl \"$API/ap1/documents-status-list/?document_ids=$DOC\" -H \"Authorization: Bearer $TOKEN\" curl \"$API/ap1/document/download-link/?id=$DOC\" -H \"Authorization: Bearer $TOKEN\" ```  ## Postman  Import the whole API into Postman with **Import → Link** and `<this server>/swaggerap1/postman.json`. Set `client_id` and `client_secret` in the collection's **Variables**, run **Get an access token** (it saves the token for every other request), and set `document_id` when a request needs one.  ## Webhooks  Instead of polling, add an endpoint with `POST /ap1/webhooks/` (or in **Account & Settings → API**) and Signedly posts your organisation's document events to it: `document.sent`, `document.viewed`, `document.signed`, `document.approved`, `document.completed`, `document.rejected` and `document.expired` (all of them, or the `events` you choose). Each is a JSON `POST`:  ```json {\"id\": \"5b7f…\", \"type\": \"document.signed\", \"created_at\": \"2026-10-27T09:12:00+00:00\",  \"test\": false,  \"data\": {\"document\": {\"id\": \"6f0c…\", \"name\": \"nda.pdf\", \"status\": 5},           \"recipient\": {\"id\": \"0b6e…\", \"email\": \"ann@example.com\", \"name\": \"Ann Lee\",                         \"role\": \"signer\"}}} ```  `recipient` is null for events no recipient caused (sent, completed, expired); `test` is true for documents made with your test keys. Fetch anything else, such as download links, with your access token: events never carry links.  **Check every event is from Signedly.** The `Signedly-Signature` header is `t=<unix seconds>,v1=<signature>`, where the signature is the hex HMAC-SHA256 of `<t>.<raw body>` with the endpoint's secret. Refuse an event whose signature doesn't match or whose `t` is more than 5 minutes off:  ```python import hashlib, hmac, time  def is_from_signedly(secret, header, raw_body):     parts = dict(item.split(\"=\", 1) for item in header.split(\",\"))     signed = f\"{parts['t']}.{raw_body.decode()}\".encode()     expected = hmac.new(secret.encode(), signed, hashlib.sha256).hexdigest()     fresh = abs(time.time() - int(parts[\"t\"])) <= 300     return fresh and hmac.compare_digest(parts[\"v1\"], expected) ```  **Answer 2xx within 10 seconds**, then do the work. Anything else is retried after 1 and 5 minutes, then 30 minutes and 2, 5 and 10 hours (7 tries in about 18 hours). `Signedly-Event-Id` is the same on every try of an event: use it to ignore repeats. After 20 events in a row fail for good, Signedly switches the endpoint off and emails your organisation's admin; switch it on again with `PUT /ap1/webhooks/{id}/` and `\"is_active\": true`. Each endpoint's deliveries and their last answers are at `GET /ap1/webhooks/{id}/deliveries/`, and any can be sent again.  ## Sandbox  Build and test against the API without paying for documents: in **Account & Settings → API**, generate your **test keys**, and get a token with them at `/ap1/token/` as usual. Everything works the same, except that what you upload or make from a template with a test token is a **test document** (`is_test` on its upload):  - every page of its PDF and of its audit trail says **TEST – NOT LEGALLY BINDING**; - its emails are real, with `[TEST]` at the start of the subject; - it isn't billed or counted toward your plan; - your organisation can make 50 a calendar month (templates don't count); the next   upload answers 429.  ## Fields  Positions and sizes are in **PDF points** (1/72 inch), measured from the **top-left corner** of the page as it is displayed (rotation applied). `page_number` counts pages from 0. A field must sit wholly on its page (1 point of tolerance); otherwise it is refused with 400. A field's page and signatory can't be changed later: delete the field and add it again.  ## Status values  **Document `status`:** 1 Draft · 2 Signees Added · 3 Prepared · 4 Sent · 5 In Progress · 6 Completed · 7 Rejected · 8 Archived · 9 Expired. Signatories, fields and sends are only accepted while a document is 1–3 (not yet sent).  **Signatory `status`:** 1 Waiting · 2 Invited · 3 Signed · 4 Viewed · 5 Rejected.  ## Lists  `GET /ap1/documents/`, `/ap1/documents-status-list/`, `/ap1/templates/`, `/ap1/logs/` and `/ap1/logs/hits/` are paged: pass `limit` (default 10) and `offset`, and read `count`, `next`, `previous` and `results` from the response.  ## Errors  | Status | Meaning | |---|---| | 400 | The request was refused, also when your plan doesn't include it (see Plans); the body says why (`{\"error\": \"...\"}`, or the name of each bad field with its messages). Nothing was changed. | | 403 | The access token is missing, unknown or expired; the client ID and secret or the refresh token were refused; the organisation's plan has no API access (Free, see Plans); or an `expiry_date` isn't in the future (`\"Invalid Date Entered\"`). | | 402 | No API contract, or an unpaid API invoice: live documents are refused (test keys keep working). | | 404 | The document, template, signatory or field doesn't exist or isn't yours. | | 429 | Too many token requests (wait a minute), or this month's 50 test documents are used. | | 5xx | Our side failed; retry later. |  A send that times out may still have worked: check the document's status before sending again (a second send of a sent document answers 400).  Download, view and audit links are valid for about 7 days; ask for a new one whenever you need it. 
+
+    The version of the OpenAPI document: v1
+    Contact: info@signedly.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from signedly.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

signedly-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Signedly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

signedly-0.1.0.dist-info/METADATA

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: signedly
+Version: 0.1.0
+Summary: Signedly API
+Home-page: https://github.com/signedly/signedly-sdks
+Author: Signedly
+Author-email: info@signedly.com
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,Signedly API
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3 <3.0.0,>=1.25.3
+Requires-Dist: python-dateutil >=2.8.2
+Requires-Dist: pydantic >=2
+Requires-Dist: typing-extensions >=4.7.1
+
+     The Signedly REST API lets your system upload documents, add signatories and fields, send them for signing and download the signed result. Every path starts with &#x60;/ap1/&#x60;, and every request and response body is JSON unless an endpoint says otherwise (the uploads are &#x60;multipart/form-data&#x60;).  ## Authentication  1. In the Signedly web app, open **Account &amp; Settings → API** and generate a    **client ID** and **client secret** for your organisation. 2. &#x60;POST /ap1/token/&#x60; with them. You get an &#x60;access_token&#x60; (valid **2 hours**) and    a &#x60;refresh_token&#x60; (valid **7 days**). While both are still valid, calling    &#x60;/ap1/token/&#x60; again returns the same pair. 3. Send the access token on every other call:    &#x60;Authorization: Bearer &lt;access_token&gt;&#x60;. 4. When the access token expires, &#x60;POST /ap1/refreshtoken/&#x60; with the refresh token    for a new access token. When the refresh token has expired too, call    &#x60;/ap1/token/&#x60; again.  &#x60;/ap1/token/&#x60; and &#x60;/ap1/refreshtoken/&#x60; allow 60 calls a minute per IP address; more answer 429. A missing, unknown or expired access token answers 403 (&#x60;\&quot;Client not found\&quot;&#x60; or &#x60;\&quot;Access token expired\&quot;&#x60;).  The API acts for your **organisation&#39;s admin account**: documents you upload belong to it and appear in its Signedly web app, and you can reach only that account&#39;s documents, templates, signatories and fields. Another organisation&#39;s IDs answer 404, as if they didn&#39;t exist.  ## Plans  What the API allows depends on the Signedly plan of your **organisation&#39;s admin account** (Account &amp; Settings → Account &amp; Plan). The same rules apply to live and test keys.  | What | Free | Personal Pro | Business Pro | Teams | |---|---|---|---|---| | Generate live and test keys (Account &amp; Settings → API) | – | ✓ | ✓ | ✓ | | Every endpoint, &#x60;/ap1/token/&#x60; and &#x60;/ap1/refreshtoken/&#x60; included | – | ✓ | ✓ | ✓ | | &#x60;require_email_otp&#x60; on &#x60;POST /ap1/signatories/&#x60; and &#x60;POST /ap1/signatories/bulk/&#x60; | – | ✓ | ✓ | ✓ | | Bulk send: &#x60;GET /ap1/bulk-sends/columns/&#x60; and &#x60;POST /ap1/bulk-sends/&#x60; | – | – | – | ✓ |  The API is part of the paid plans. On Free (or with no plan) every call answers 403 &#x60;\&quot;... Your plan doesn&#39;t include API access.\&quot;&#x60;, with live or test keys, also with a token or keys made earlier; they work again once the plan is paid. On a paid plan, a feature it doesn&#39;t include answers 400 with &#x60;\&quot;Your plan doesn&#39;t include ...\&quot;&#x60; and changes nothing, and &#x60;GET /ap1/bulk-sends/{id}/&#x60; still reports bulk sends already made.  Live documents also need an API contract with Signedly. Without one, or with an unpaid API invoice, &#x60;POST /ap1/upload/&#x60; (except templates), &#x60;/ap1/upload_app/&#x60;, &#x60;/ap1/documents/fromtemplate/&#x60; and &#x60;/ap1/bulk-sends/&#x60; answer 402 with live keys. Test keys work without a contract (see Sandbox).  ## Sending a document for signing  1. &#x60;POST /ap1/upload/&#x60; a PDF or DOCX (&#x60;type&#x60; 2). The document is prepared in the    background: find it in &#x60;GET /ap1/documents/?name&#x3D;&lt;name&gt;&#x60; (its &#x60;upload.id&#x60; is    the upload&#39;s &#x60;id&#x60;), and wait until &#x60;GET /ap1/documents/{id}/pages/&#x60; lists its    pages. 2. &#x60;POST /ap1/signatories/&#x60; (one) or &#x60;POST /ap1/signatories/bulk/&#x60; (several) to    add the people who sign. 3. &#x60;POST /ap1/documents/fields/&#x60; to place the fields each signatory fills in. 4. Send it:    - &#x60;POST /ap1/document/send/&#x60; emails every signatory a signing link (with      ordered signing, only the first; each next one is emailed in      turn), or    - &#x60;POST /ap1/document/send_url/&#x60; sends no email and returns the first      signatory&#39;s signing link, for you to show or send yourself. 5. Poll &#x60;GET /ap1/documents-status-list/&#x60; (or &#x60;GET /ap1/documents/&#x60;) until the    status is 6 (Completed), then &#x60;GET /ap1/document/download-link/&#x60; for the    signed PDF and &#x60;GET /ap1/document/download-audit-link/&#x60; for its audit trail.  **From a template:** upload with &#x60;type&#x60; 4 and a &#x60;template_name&#x60; (or make the template in the web app), place its fields with &#x60;POST /ap1/templates/fields/&#x60;, then for each signing make a document with &#x60;POST /ap1/documents/fromtemplate/&#x60;, add its signatory, and send it.  **One signer, one call:** &#x60;POST /ap1/upload_app/&#x60; uploads a PDF or DOCX for one signer and returns their signing link in &#x60;redirect_url&#x60;; the signer places their own signature. After signing they go to the &#x60;redirect_url&#x60; you sent, and the signed PDF and its audit trail are emailed to &#x60;final_email&#x60; (otherwise to your organisation&#39;s admin).  ## Quick start with curl  Each step uses an ID from the step before. &#x60;$API&#x60; is this server, e.g. &#x60;https://l0ads.signedly.com&#x60;.  &#x60;&#x60;&#x60;bash # 1. Token curl -X POST $API/ap1/token/ -H &#39;Content-Type: application/json&#39; \   -d &#39;{\&quot;client_id\&quot;: \&quot;&lt;client id&gt;\&quot;, \&quot;client_secret\&quot;: \&quot;&lt;client secret&gt;\&quot;}&#39; TOKEN&#x3D;&lt;access_token from the answer&gt;  # 2. Upload a PDF (answers with the upload&#39;s id) curl -X POST $API/ap1/upload/ -H \&quot;Authorization: Bearer $TOKEN\&quot; \   -F file&#x3D;@nda.pdf -F name&#x3D;nda-ann-lee -F type&#x3D;2  # 3. Find the document, then wait until it has pages curl \&quot;$API/ap1/documents/?name&#x3D;nda-ann-lee\&quot; -H \&quot;Authorization: Bearer $TOKEN\&quot; DOC&#x3D;&lt;results[0].id&gt; curl $API/ap1/documents/$DOC/pages/ -H \&quot;Authorization: Bearer $TOKEN\&quot; PAGE&#x3D;&lt;[0].id&gt;  # 4. Add the signatory curl -X POST $API/ap1/signatories/ -H \&quot;Authorization: Bearer $TOKEN\&quot; \   -H &#39;Content-Type: application/json&#39; \   -d &#39;{\&quot;document_id\&quot;: \&quot;&#39;$DOC&#39;\&quot;, \&quot;name\&quot;: \&quot;Ann Lee\&quot;, \&quot;email\&quot;: \&quot;ann@example.com\&quot;}&#39; SIGNER&#x3D;&lt;id from the answer&gt;  # 5. Place her signature: 150 × 40 points, 72 points from the left, 640 from the top curl -X POST $API/ap1/documents/fields/ -H \&quot;Authorization: Bearer $TOKEN\&quot; \   -H &#39;Content-Type: application/json&#39; \   -d &#39;[{\&quot;document_id\&quot;: \&quot;&#39;$DOC&#39;\&quot;, \&quot;signatory_id\&quot;: \&quot;&#39;$SIGNER&#39;\&quot;, \&quot;kind\&quot;: 2,         \&quot;label\&quot;: \&quot;Signature\&quot;, \&quot;placeholder\&quot;: \&quot;Sign here\&quot;, \&quot;page\&quot;: \&quot;&#39;$PAGE&#39;\&quot;,         \&quot;page_number\&quot;: 0, \&quot;x\&quot;: 72, \&quot;y\&quot;: 640, \&quot;width\&quot;: 150, \&quot;height\&quot;: 40}]&#39;  # 6. Send it (Ann gets the signing email) curl -X POST $API/ap1/document/send/ -H \&quot;Authorization: Bearer $TOKEN\&quot; \   -H &#39;Content-Type: application/json&#39; \   -d &#39;{\&quot;document_id\&quot;: \&quot;&#39;$DOC&#39;\&quot;, \&quot;subject\&quot;: \&quot;Please sign the NDA\&quot;,        \&quot;message\&quot;: \&quot;Hi Ann, please sign by Friday.\&quot;, \&quot;expiry_date\&quot;: \&quot;2026-12-31\&quot;}&#39;  # 7. Poll until status is 6 (Completed), then get the signed PDF curl \&quot;$API/ap1/documents-status-list/?document_ids&#x3D;$DOC\&quot; -H \&quot;Authorization: Bearer $TOKEN\&quot; curl \&quot;$API/ap1/document/download-link/?id&#x3D;$DOC\&quot; -H \&quot;Authorization: Bearer $TOKEN\&quot; &#x60;&#x60;&#x60;  ## Postman  Import the whole API into Postman with **Import → Link** and &#x60;&lt;this server&gt;/swaggerap1/postman.json&#x60;. Set &#x60;client_id&#x60; and &#x60;client_secret&#x60; in the collection&#39;s **Variables**, run **Get an access token** (it saves the token for every other request), and set &#x60;document_id&#x60; when a request needs one.  ## Webhooks  Instead of polling, add an endpoint with &#x60;POST /ap1/webhooks/&#x60; (or in **Account &amp; Settings → API**) and Signedly posts your organisation&#39;s document events to it: &#x60;document.sent&#x60;, &#x60;document.viewed&#x60;, &#x60;document.signed&#x60;, &#x60;document.approved&#x60;, &#x60;document.completed&#x60;, &#x60;document.rejected&#x60; and &#x60;document.expired&#x60; (all of them, or the &#x60;events&#x60; you choose). Each is a JSON &#x60;POST&#x60;:  &#x60;&#x60;&#x60;json {\&quot;id\&quot;: \&quot;5b7f…\&quot;, \&quot;type\&quot;: \&quot;document.signed\&quot;, \&quot;created_at\&quot;: \&quot;2026-10-27T09:12:00+00:00\&quot;,  \&quot;test\&quot;: false,  \&quot;data\&quot;: {\&quot;document\&quot;: {\&quot;id\&quot;: \&quot;6f0c…\&quot;, \&quot;name\&quot;: \&quot;nda.pdf\&quot;, \&quot;status\&quot;: 5},           \&quot;recipient\&quot;: {\&quot;id\&quot;: \&quot;0b6e…\&quot;, \&quot;email\&quot;: \&quot;ann@example.com\&quot;, \&quot;name\&quot;: \&quot;Ann Lee\&quot;,                         \&quot;role\&quot;: \&quot;signer\&quot;}}} &#x60;&#x60;&#x60;  &#x60;recipient&#x60; is null for events no recipient caused (sent, completed, expired); &#x60;test&#x60; is true for documents made with your test keys. Fetch anything else, such as download links, with your access token: events never carry links.  **Check every event is from Signedly.** The &#x60;Signedly-Signature&#x60; header is &#x60;t&#x3D;&lt;unix seconds&gt;,v1&#x3D;&lt;signature&gt;&#x60;, where the signature is the hex HMAC-SHA256 of &#x60;&lt;t&gt;.&lt;raw body&gt;&#x60; with the endpoint&#39;s secret. Refuse an event whose signature doesn&#39;t match or whose &#x60;t&#x60; is more than 5 minutes off:  &#x60;&#x60;&#x60;python import hashlib, hmac, time  def is_from_signedly(secret, header, raw_body):     parts &#x3D; dict(item.split(\&quot;&#x3D;\&quot;, 1) for item in header.split(\&quot;,\&quot;))     signed &#x3D; f\&quot;{parts[&#39;t&#39;]}.{raw_body.decode()}\&quot;.encode()     expected &#x3D; hmac.new(secret.encode(), signed, hashlib.sha256).hexdigest()     fresh &#x3D; abs(time.time() - int(parts[\&quot;t\&quot;])) &lt;&#x3D; 300     return fresh and hmac.compare_digest(parts[\&quot;v1\&quot;], expected) &#x60;&#x60;&#x60;  **Answer 2xx within 10 seconds**, then do the work. Anything else is retried after 1 and 5 minutes, then 30 minutes and 2, 5 and 10 hours (7 tries in about 18 hours). &#x60;Signedly-Event-Id&#x60; is the same on every try of an event: use it to ignore repeats. After 20 events in a row fail for good, Signedly switches the endpoint off and emails your organisation&#39;s admin; switch it on again with &#x60;PUT /ap1/webhooks/{id}/&#x60; and &#x60;\&quot;is_active\&quot;: true&#x60;. Each endpoint&#39;s deliveries and their last answers are at &#x60;GET /ap1/webhooks/{id}/deliveries/&#x60;, and any can be sent again.  ## Sandbox  Build and test against the API without paying for documents: in **Account &amp; Settings → API**, generate your **test keys**, and get a token with them at &#x60;/ap1/token/&#x60; as usual. Everything works the same, except that what you upload or make from a template with a test token is a **test document** (&#x60;is_test&#x60; on its upload):  - every page of its PDF and of its audit trail says **TEST – NOT LEGALLY BINDING**; - its emails are real, with &#x60;[TEST]&#x60; at the start of the subject; - it isn&#39;t billed or counted toward your plan; - your organisation can make 50 a calendar month (templates don&#39;t count); the next   upload answers 429.  ## Fields  Positions and sizes are in **PDF points** (1/72 inch), measured from the **top-left corner** of the page as it is displayed (rotation applied). &#x60;page_number&#x60; counts pages from 0. A field must sit wholly on its page (1 point of tolerance); otherwise it is refused with 400. A field&#39;s page and signatory can&#39;t be changed later: delete the field and add it again.  ## Status values  **Document &#x60;status&#x60;:** 1 Draft · 2 Signees Added · 3 Prepared · 4 Sent · 5 In Progress · 6 Completed · 7 Rejected · 8 Archived · 9 Expired. Signatories, fields and sends are only accepted while a document is 1–3 (not yet sent).  **Signatory &#x60;status&#x60;:** 1 Waiting · 2 Invited · 3 Signed · 4 Viewed · 5 Rejected.  ## Lists  &#x60;GET /ap1/documents/&#x60;, &#x60;/ap1/documents-status-list/&#x60;, &#x60;/ap1/templates/&#x60;, &#x60;/ap1/logs/&#x60; and &#x60;/ap1/logs/hits/&#x60; are paged: pass &#x60;limit&#x60; (default 10) and &#x60;offset&#x60;, and read &#x60;count&#x60;, &#x60;next&#x60;, &#x60;previous&#x60; and &#x60;results&#x60; from the response.  ## Errors  | Status | Meaning | |---|---| | 400 | The request was refused, also when your plan doesn&#39;t include it (see Plans); the body says why (&#x60;{\&quot;error\&quot;: \&quot;...\&quot;}&#x60;, or the name of each bad field with its messages). Nothing was changed. | | 403 | The access token is missing, unknown or expired; the client ID and secret or the refresh token were refused; the organisation&#39;s plan has no API access (Free, see Plans); or an &#x60;expiry_date&#x60; isn&#39;t in the future (&#x60;\&quot;Invalid Date Entered\&quot;&#x60;). | | 402 | No API contract, or an unpaid API invoice: live documents are refused (test keys keep working). | | 404 | The document, template, signatory or field doesn&#39;t exist or isn&#39;t yours. | | 429 | Too many token requests (wait a minute), or this month&#39;s 50 test documents are used. | | 5xx | Our side failed; retry later. |  A send that times out may still have worked: check the document&#39;s status before sending again (a second send of a sent document answers 400).  Download, view and audit links are valid for about 7 days; ask for a new one whenever you need it. 
+    

signedly-0.1.0.dist-info/RECORD

@@ -0,0 +1,74 @@
+signedly/__init__.py,sha256=Id3S0yqn_Z-DTbbLiRLObFhNFPJnWZQXD2JmmspazPU,16838
+signedly/api_client.py,sha256=g0ONad-QOPIn9rw8FX9DE3mLaN8MhLihGRjHzwqU1RE,39028
+signedly/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+signedly/configuration.py,sha256=4nS1tvPWro6na6VIJAks243cjXgc1IDjL1I1nXgKfRo,30110
+signedly/exceptions.py,sha256=374s6EA38Q0jJvNy9Wit7xdcnDf0FghKilyBi1C38SY,17569
+signedly/helpers.py,sha256=LN6TEaTr5X3-Ohzrxhz9StWALPPgs1r2DsSRjNMEBZ4,3728
+signedly/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+signedly/rest.py,sha256=OI5OVdQllceadj3Yld3jpgneJuPK6dY1ELz0qumfRpU,21003
+signedly/api/__init__.py,sha256=lbCXEUldDoa2kxyBdv29aLA8DC2dl4WUUxyiF54VAPc,587
+signedly/api/api_request_logs_api.py,sha256=5he1Lw7Ae8EOYUHGcM0cPxbkZlJMZrqjBfidyX0Ko-0,39227
+signedly/api/authentication_api.py,sha256=PI73ei-OtWyddOI9ANkM3MmpX5aQMq_xAVLla0Xbjio,35527
+signedly/api/bulk_sending_api.py,sha256=1ZzQ1XUIPWnvCcXU6QGRjZtTS5qMEHHFeeOQsE7lyys,46957
+signedly/api/documents_api.py,sha256=861RYI3mNfJ1iwJotxhmXh2ZMArcMRM5EU5p3xMOfpo,121095
+signedly/api/downloads_api.py,sha256=1efhudtI8-guLPnFavsJhc-fwvqWxj80iYBEAnd3NQI,44426
+signedly/api/fields_api.py,sha256=GH8DRMjcFs3O0d1s95_1_gv1h6bHm_TSgtYZEFdBe_A,102764
+signedly/api/sending_api.py,sha256=ROzSPKYaJEBKKTCnzVDRl7pvhvJJAjRPGS-GlfGWObI,48582
+signedly/api/signatories_api.py,sha256=f1b9EabdGVIfL_k3N6cfqTt3MFmjBrrfEbjmP_FCbhQ,57757
+signedly/api/templates_api.py,sha256=eQlkSoAOu0EDy73R2XZ_tzomRGmWuuMZratOKIp_uE0,68791
+signedly/api/webhooks_api.py,sha256=6UaNhChTjqHiW7KULWjFCXVODQO_yL-U1MBZiGfbNdk,112438
+signedly/models/__init__.py,sha256=jiVhQoudjeGzOLrg4CFNarLaJpnDk4HBDyB7zYIA5tg,15809
+signedly/models/create_bulk_send202_response.py,sha256=2l5BKU1W133aoEy3qGlwsk6M2jzgQoftdhXBU7Tss3A,15655
+signedly/models/create_bulk_send_request.py,sha256=L_oNWDLWAbQxbw0N6mJS5Ym3oXtbaVxcK-7zB5m9T7o,15310
+signedly/models/create_document_fields_request_inner.py,sha256=Bbja97ywfbET91Qr61wF9YFOX2ntaD1UuqT-rU4U_Gk,20550
+signedly/models/create_document_from_template200_response.py,sha256=x8X3mGvuV9png8eV1KXGl-Z8Fc2aLvuTF8WacEoq_Bw,15270
+signedly/models/create_document_from_template_request.py,sha256=4kUzsWgurOLBlpyR1CCVUbeN-ba0arapwL04FVZ6wHU,16182
+signedly/models/create_document_from_template_request_recipients_inner.py,sha256=hcbgzq6wABgdd4qcPNA_qkmsTzs_fAtwtovSjDrRFtc,14481
+signedly/models/create_signatories_request.py,sha256=dakUJSiRM51X_QMUREpUvAWTyJzACN6CLzD5XSRGbb0,15338
+signedly/models/create_signatories_request_signatories_inner.py,sha256=TIIM11t4I29ysS6V9WOkXS4FnBQRm7Ki-LcGZpqXThA,14734
+signedly/models/create_signatory_request.py,sha256=r2jWhOD9evpz8QP03e9fhJYCQ3lnaXZpMc3FRuN54IU,14826
+signedly/models/create_template_fields_request_inner.py,sha256=cuewNi-oL3zco21frvQoITxDUCQXI8-zC7ccJVUi_Ko,20587
+signedly/models/create_webhook_endpoint_request.py,sha256=OayzfWyX4b2pwiTktd_1Z8EOyecpWkYcoGlKotN9ec0,15339
+signedly/models/delete_field_request.py,sha256=xFd-SLNOcH5Vn3_Xp1bg4c6Ke-NP1vTC-yDjukKHRFg,14196
+signedly/models/document.py,sha256=O4FIJEa7sBTz3vpK3K6-ZaE3FLAYJ_c7H4zcLFgwmos,18518
+signedly/models/document_page.py,sha256=kDiVuC3PxOw49GIDDRrSYdGIkQWPISCt1Bo9KbyZH1g,15464
+signedly/models/document_status_page.py,sha256=2y7vb_74A3lW-a8_ApvGYUvmQntSAAJKyehvDjOkiYQ,15526
+signedly/models/document_status_row.py,sha256=jSb_n4Wyd1A35prIZuwplNp7Vx371E5hBofU0pTRZo0,14353
+signedly/models/fill_and_send_document_request.py,sha256=Urqq5mUmKUQ11S-T3__hlCcgRxf6oNKqdpXDQOLcOZs,16835
+signedly/models/fill_and_send_document_request_elements_inner.py,sha256=YZHTz4ao62WeOxNctUFN9N5zPRUcbKrVMKcfFiGqxGw,14857
+signedly/models/get_access_token_request.py,sha256=2L9slkYpGjUIx1ybedwSJ9JvYI2c-GWlHWZw4Yt8UO8,14307
+signedly/models/get_audit_trail_link200_response.py,sha256=0x2puupJzPZ2FN_690cIjZZBIP8GiOv32Oil56iHZqM,14228
+signedly/models/get_download_status200_response.py,sha256=QarIE6OHppF7Qxhl1ocuh1s2_oVTO3GICCQZ9K2Pv-k,14434
+signedly/models/list_bulk_send_columns200_response_inner.py,sha256=FEMPLxXCMjNNBRQpySkwFlNjsg-m-mZId7fFhzWrPUI,14517
+signedly/models/model_field.py,sha256=eBrcl0C2Gkb8SfzCJS9WAs801JFcWINxJ07PFe83Arw,21871
+signedly/models/page.py,sha256=IRemy8UwY6wHfd0BgtrAhDYf7Vpdxri401dHbLvn02g,14989
+signedly/models/refresh_access_token200_response.py,sha256=hXUU1pecdaghM5KkuNq7xo45cTlRBZoHZuhl3l4oMSg,15302
+signedly/models/refresh_access_token_request.py,sha256=y63ZGh_VecWmeoGLJxvl24qdMU6ekmeRozpM0HwanIk,14215
+signedly/models/request_count_page.py,sha256=M3_N4mdQG6EZwPqwed9pyZmPaxlMmKxIIynA1_kvEZs,15489
+signedly/models/request_hit.py,sha256=VlW-HsAHz6tVaGDKpKr9o1m4bcIRL5qzI0GaVvxb63Y,14568
+signedly/models/request_log.py,sha256=m3j1Q2D1WxXovlFpayrRnVSD2wm2epP86HAiU6Px_80,15634
+signedly/models/request_log_page.py,sha256=tfsJVqQYdi4zk6QJ60hdY9RxRk8uGZ9NadoRix2fQdk,15481
+signedly/models/send_document200_response.py,sha256=z0IUrf_Jhhol6ICxb4I6kwroVYNjxorPMonxUBgwOzc,14192
+signedly/models/send_document_by_link200_response.py,sha256=OzczUPW4a0Atnb6uKmKJj-HM0GgV3rjVkdaY2dWTYfE,14378
+signedly/models/send_document_by_link_request.py,sha256=XxflTj3CkerOezyFK0vBk7Q10oLTGAdiBblzBOH6OvI,14406
+signedly/models/send_document_request.py,sha256=mD1FbG-CPd-jsyRt4cYG2QDiuAxic1kujGPzPOTLeSw,15795
+signedly/models/signatory.py,sha256=KvvOZcCP8AOgCdgjXmZNMEnq0UPEvFm8zA4GB3qsL4k,16200
+signedly/models/template.py,sha256=FUrgXbeDw3YbI8-n4cFNKz8x4TWtM3Hbavs8FbFPjno,16201
+signedly/models/template_field.py,sha256=AkurATDmQtnz7dlDzgP2OgtWe_nzWZVxmnHobSZHvaA,21868
+signedly/models/template_page.py,sha256=sTLvFdWtwrUJxEuK_zWa91Efgg4S_NgD_MnyCR2okYw,15464
+signedly/models/update_document_field_by_body_request.py,sha256=0Qs8OUzEpjeSh0L8dXlDiQULIvm1hLlzfSpw3YAw38Q,20693
+signedly/models/update_document_field_by_body_request_items_inner.py,sha256=L7ZqXp29B89QZzZOniWTYPZ08dn1ciiIiwmezvDxKy8,14563
+signedly/models/update_webhook_endpoint_request.py,sha256=zMqnTF5PVZqfN9yy72RRNFgYMMILXeAe681mO5PfaAU,15556
+signedly/models/upload.py,sha256=K1tQCgg6ZFkzWzAbvaa9VaKUKYaICRFvdwlvjl5mIa4,15704
+signedly/models/upload_document_for_one_signer200_response.py,sha256=iNpy2CraURGMvOY0Wo9xsnZ3BwD8CpeiYnnKA1w6HSQ,14441
+signedly/models/upload_document_for_one_signer_request.py,sha256=TU05ZHZtsYwJai9wu9j6DqOGrZj_Rn-HkGS3Akyq4XQ,15100
+signedly/models/upload_document_request.py,sha256=Z1osnHO1prjxP8R6NIQIvxEYNV2ZIg9dLMKLtjsb47U,15174
+signedly/models/webhook_delivery.py,sha256=U8EIGe_vPRd-eUe_aH9p81WufWfUGx5JZBss7rsaeGY,17415
+signedly/models/webhook_delivery_page.py,sha256=boOU9AiduFpKeTdkQzO5FV1f9Xs3vAtELIO3fEQJPBM,15521
+signedly/models/webhook_endpoint.py,sha256=6w4g_tYiKIVc-oSqeU9me8XV0DnpI7GC3cy5gVReRvQ,16053
+signedly/models/webhook_endpoint_with_secret.py,sha256=1hON9mLJrcecwBuBtszXnosiXQGptCm78gDgkOh9c6M,16406
+signedly-0.1.0.dist-info/LICENSE,sha256=cXExLuzHbgljqP0yeAjfIF7KpeDziJUNWiFxEEbD5SE,1065
+signedly-0.1.0.dist-info/METADATA,sha256=1-aSqbeHIC6DVV0EJar1qycsJhAwI5HzLr33U_TJ6lg,14408
+signedly-0.1.0.dist-info/WHEEL,sha256=BNRMDyzLkkcmlv0J8ppDQkk2VED33SesJDynr9ED1gc,91
+signedly-0.1.0.dist-info/top_level.txt,sha256=wQ613pmn-xJx-_m4ZGEHZnse0YWGJ7cfkfLANT8tuik,9
+signedly-0.1.0.dist-info/RECORD,,

signedly-0.1.0.dist-info/WHEEL

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

signedly-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+signedly