templatefox 1.0.0__py3-none-any.whl

templatefox/rest.py

@@ -0,0 +1,264 @@
+# coding: utf-8
+
+"""
+    TemplateFox API
+
+    Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@pdftemplateapi.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 templatefox.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
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        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,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        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)

templatefox-1.0.0.dist-info/METADATA

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: templatefox
+Version: 1.0.0
+Summary: Official TemplateFox Python SDK - Generate PDFs from HTML templates
+Home-page: https://github.com/TemplateFoxPDF/pythonsdk
+Author: TemplateFox
+Author-email: TemplateFox <support@pdftemplateapi.com>
+License: MIT
+Project-URL: Repository, https://github.com/TemplateFoxPDF/pythonsdk
+Keywords: OpenAPI,OpenAPI-Generator,TemplateFox API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# TemplateFox Python SDK
+
+Official Python SDK for [TemplateFox](https://pdftemplateapi.com) - Generate PDFs from HTML templates via API.
+
+[![PyPI version](https://badge.fury.io/py/templatefox.svg)](https://pypi.org/project/templatefox/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+```bash
+pip install templatefox
+```
+
+Or with poetry:
+
+```bash
+poetry add templatefox
+```
+
+## Quick Start
+
+```python
+from templatefox import ApiClient, Configuration
+from templatefox.api import PDFApi
+from templatefox.models import CreatePdfRequest
+
+# Initialize the client
+config = Configuration()
+config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+with ApiClient(config) as client:
+    api = PDFApi(client)
+
+    # Generate a PDF
+    response = api.create_pdf(
+        CreatePdfRequest(
+            template_id='YOUR_TEMPLATE_ID',
+            data={
+                'name': 'John Doe',
+                'invoice_number': 'INV-001',
+                'total_amount': 150.00,
+            }
+        )
+    )
+
+    print(f'PDF URL: {response.url}')
+    print(f'Credits remaining: {response.credits_remaining}')
+```
+
+## Features
+
+- **Template-based PDF generation** - Create templates with dynamic variables, generate PDFs with your data
+- **Multiple export options** - Get a signed URL (default) or raw binary PDF
+- **S3 integration** - Upload generated PDFs directly to your own S3-compatible storage
+- **Type hints** - Full type annotations for IDE support
+
+## API Methods
+
+### PDF Generation
+
+```python
+from templatefox.models import CreatePdfRequest
+
+# Generate PDF and get URL
+response = api.create_pdf(
+    CreatePdfRequest(
+        template_id='TEMPLATE_ID',
+        data={'name': 'John Doe'},
+        export_type='url',       # 'url' or 'binary'
+        expiration=86400,        # URL expiration in seconds (default: 24h)
+        filename='invoice-001'   # Custom filename
+    )
+)
+```
+
+### Templates
+
+```python
+from templatefox.api import TemplatesApi
+
+templates_api = TemplatesApi(client)
+
+# List all templates
+templates = templates_api.list_templates()
+for template in templates.templates:
+    print(f'{template.id}: {template.name}')
+
+# Get template fields
+fields = templates_api.get_template_fields(template_id='TEMPLATE_ID')
+for field in fields:
+    print(f'{field.key}: {field.type} (required: {field.required})')
+```
+
+### Account
+
+```python
+from templatefox.api import AccountApi
+
+account_api = AccountApi(client)
+
+# Get account info
+account = account_api.get_account()
+print(f'Credits: {account.credits}')
+print(f'Email: {account.email}')
+
+# List transactions
+transactions = account_api.list_transactions(limit=100, offset=0)
+for tx in transactions.transactions:
+    print(f'{tx.transaction_type}: {tx.credits} credits')
+```
+
+### S3 Integration
+
+```python
+from templatefox.api import IntegrationsApi
+from templatefox.models import S3ConfigRequest
+
+integrations_api = IntegrationsApi(client)
+
+# Save S3 configuration
+integrations_api.save_s3_config(
+    S3ConfigRequest(
+        endpoint_url='https://s3.amazonaws.com',
+        access_key_id='AKIAIOSFODNN7EXAMPLE',
+        secret_access_key='your-secret-key',
+        bucket_name='my-pdf-bucket',
+        default_prefix='generated/pdfs/'
+    )
+)
+
+# Test connection
+test = integrations_api.test_s3_connection()
+print(f'Connection: {"OK" if test.success else "Failed"}')
+```
+
+## Configuration
+
+```python
+from templatefox import Configuration
+
+config = Configuration(
+    host='https://api.pdftemplateapi.com',  # Default API URL
+)
+config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+# Or use environment variable
+import os
+config.api_key['ApiKeyAuth'] = os.environ.get('TEMPLATEFOX_API_KEY')
+```
+
+## Error Handling
+
+```python
+from templatefox.exceptions import ApiException
+
+try:
+    response = api.create_pdf(CreatePdfRequest(...))
+except ApiException as e:
+    if e.status == 402:
+        print('Insufficient credits')
+    elif e.status == 403:
+        print('Access denied - check your API key')
+    elif e.status == 404:
+        print('Template not found')
+    else:
+        print(f'Error: {e.reason}')
+```
+
+## Async Support
+
+```python
+import asyncio
+from templatefox import ApiClient, Configuration
+from templatefox.api import PDFApi
+from templatefox.models import CreatePdfRequest
+
+async def generate_pdfs():
+    config = Configuration()
+    config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+    async with ApiClient(config) as client:
+        api = PDFApi(client)
+        # Use async methods
+        response = await api.create_pdf(
+            CreatePdfRequest(template_id='...', data={...})
+        )
+
+asyncio.run(generate_pdfs())
+```
+
+## Documentation
+
+- [API Documentation](https://pdftemplateapi.com/docs)
+- [Swagger UI](https://api.pdftemplateapi.com/docs)
+- [Dashboard](https://pdftemplateapi.com/dashboard)
+
+## Support
+
+- Email: support@pdftemplateapi.com
+- Issues: [GitHub Issues](https://github.com/TemplateFoxPDF/pythonsdk/issues)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

templatefox-1.0.0.dist-info/RECORD

@@ -0,0 +1,34 @@
+templatefox/__init__.py,sha256=alii2T_BztynbASoOvBYcbmls0HeLLbjAOkn_7C7Znw,3376
+templatefox/api_client.py,sha256=E3YL1cXqnY6w4tMrEHL43S7PCgsAOOnv0QxVZykTVSg,27788
+templatefox/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+templatefox/configuration.py,sha256=6_l72ngubZLdqtFMr3R6NaxWGRRgp4E64flfeaOKdXE,19154
+templatefox/exceptions.py,sha256=Hcel4vbmPgpu1E7Vs_6D2xzxRiwdORmo_HoqxZqp90w,6555
+templatefox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+templatefox/rest.py,sha256=zUfLbqW561bWt6hqUuwHu_Z-YA8EdgXa5HfiwIMJndM,9669
+templatefox/api/__init__.py,sha256=eILPdjf1khXsyw8cwgadHha_yb7xiCHhNK9uAprHSew,258
+templatefox/api/account_api.py,sha256=GfW1ZqHC2aWcfBHgOYAkPG3DJCVRiMcf1Huv0CjvRhA,23993
+templatefox/api/integrations_api.py,sha256=MOC1tzaFCeYvrJPjcVwYkAgrWwwW1cvrQRrOE5ldAzg,45423
+templatefox/api/pdf_api.py,sha256=Y7ohwlVdugtbLBitrDqVEtLbrAeGTJrj-wJBhAFO1d8,13988
+templatefox/api/templates_api.py,sha256=_YMf5Ns2S6q_VqKELBwvuUeQV3IqaVOT8uKhRn6_nNc,23896
+templatefox/models/__init__.py,sha256=hbjF-9Z6RPnpdBQ4eQ3-wIp42VSc_JmXsMCgtXAbC-0,1442
+templatefox/models/account_info_response.py,sha256=j_zwxnZG-AtIvwK9Y9A4Jc331EwaRuIZsFp0f66hV-I,2894
+templatefox/models/create_pdf_request.py,sha256=uyEsUxV5wS08nCoB_vVkPi-QfPTVk_U6VfpMSEE6dfQ,5983
+templatefox/models/create_pdf_response.py,sha256=pfvMW5eW2NNW79WodF5E9-NNcsXNyKZVkwDh90nohs8,3060
+templatefox/models/export_type.py,sha256=3rjFl_GfMUMBolmfrOKLVuu8nLnIpD5O0a02B0kTIic,767
+templatefox/models/http_validation_error.py,sha256=I6M4ECtyrv0zcyeJki6M1-_Z6_b4At6gDlwdGk6XtAk,3018
+templatefox/models/location_inner.py,sha256=6munPndEDR98pv6Sm4IXxTELCuwORWuAI8vIKCcmcLY,4842
+templatefox/models/s3_config_request.py,sha256=hKTN559fEyG_khQHFnxs1hR6LiRmve0i7FfzTP7QRrY,4977
+templatefox/models/s3_config_response.py,sha256=5KWsv61rdt2MTTV8jtrMOXYaKFTgv6WKgKKMGZZN3Oc,3430
+templatefox/models/s3_success_response.py,sha256=I03llZ1DQC6rdeuOXI8rV3BrdP56kjlyEX_tnpnvkNQ,2602
+templatefox/models/s3_test_response.py,sha256=-CDj2ZO7z0a-M30O5WN1ihgGcO1wH3bAAMVK4kmGmzA,2719
+templatefox/models/template_field.py,sha256=7A0ylB5cjhDjDnXD-XN4Jz_JPMzSM80Pbfa2rWyzp-U,3457
+templatefox/models/template_list_item.py,sha256=G9WlwQxbznHFthYtG3TD39MmBlERulCCk6zfkvn-Wa0,2931
+templatefox/models/templates_list_response.py,sha256=Jo-kLKNVB-mZF9vf-hlbDtR-hwYCrLzXyVbTz5ANrdQ,3054
+templatefox/models/transaction.py,sha256=4sQMQnA-e_mmz_OQ2HnZ8i35zUW7YMyjlL8lw3rnsdQ,3722
+templatefox/models/transactions_response.py,sha256=-LXBiOdJGFOt9UkQnc3sRF5PxbFZZWDQMADFrEYtkJs,3449
+templatefox/models/validation_error.py,sha256=vHM5POO0Ze9BJalMAvnCrATmn511kkh92wDXrDzenJQ,3068
+templatefox-1.0.0.dist-info/licenses/LICENSE,sha256=LS5mJ2kGW6681vGD3LITctiVok0PUc9xZ1ZDpzHAHSQ,1068
+templatefox-1.0.0.dist-info/METADATA,sha256=brnZbvSk_aNiE-1wcKywRjKhdZWIwczbQSBHPxOsndM,5699
+templatefox-1.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+templatefox-1.0.0.dist-info/top_level.txt,sha256=90Av3vksTOHrRrfMRCjRbNJ5fn2uZIRg3Jasi-oiteQ,12
+templatefox-1.0.0.dist-info/RECORD,,

templatefox-1.0.0.dist-info/WHEEL

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

templatefox-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TemplateFox
+
+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.

templatefox-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+templatefox