templatefox 1.0.0__py3-none-any.whl

templatefox/exceptions.py

@@ -0,0 +1,220 @@
+# 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
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

templatefox/models/__init__.py

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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 models into model package
+from templatefox.models.account_info_response import AccountInfoResponse
+from templatefox.models.create_pdf_request import CreatePdfRequest
+from templatefox.models.create_pdf_response import CreatePdfResponse
+from templatefox.models.export_type import ExportType
+from templatefox.models.http_validation_error import HTTPValidationError
+from templatefox.models.location_inner import LocationInner
+from templatefox.models.s3_config_request import S3ConfigRequest
+from templatefox.models.s3_config_response import S3ConfigResponse
+from templatefox.models.s3_success_response import S3SuccessResponse
+from templatefox.models.s3_test_response import S3TestResponse
+from templatefox.models.template_field import TemplateField
+from templatefox.models.template_list_item import TemplateListItem
+from templatefox.models.templates_list_response import TemplatesListResponse
+from templatefox.models.transaction import Transaction
+from templatefox.models.transactions_response import TransactionsResponse
+from templatefox.models.validation_error import ValidationError
+

templatefox/models/account_info_response.py

@@ -0,0 +1,95 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AccountInfoResponse(BaseModel):
+    """
+    Response for account info endpoint
+    """ # noqa: E501
+    credits: StrictInt = Field(description="Remaining credits")
+    email: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["credits", "email"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AccountInfoResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if email (nullable) is None
+        # and model_fields_set contains the field
+        if self.email is None and "email" in self.model_fields_set:
+            _dict['email'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AccountInfoResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "credits": obj.get("credits"),
+            "email": obj.get("email")
+        })
+        return _obj
+
+

templatefox/models/create_pdf_request.py

@@ -0,0 +1,149 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from templatefox.models.export_type import ExportType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreatePdfRequest(BaseModel):
+    """
+    Request model for PDF generation
+    """ # noqa: E501
+    template_id: Annotated[str, Field(min_length=12, strict=True, max_length=12)] = Field(description="**Required.** Template short ID (12 characters)")
+    data: Dict[str, Any] = Field(description="**Required.** Key-value data to render in the template. Keys must match template variables.")
+    export_type: Optional[ExportType] = Field(default=None, description="Export format: `url` uploads to CDN and returns URL, `binary` returns raw PDF bytes")
+    expiration: Optional[Annotated[int, Field(le=604800, strict=True, ge=60)]] = Field(default=86400, description="URL expiration in seconds. Min: 60 (1 min), Max: 604800 (7 days). Only applies to `url` export type.")
+    filename: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    store_s3: Optional[StrictBool] = Field(default=False, description="Upload to your configured S3 bucket instead of CDN")
+    s3_filepath: Optional[Annotated[str, Field(strict=True, max_length=500)]] = None
+    s3_bucket: Optional[Annotated[str, Field(min_length=3, strict=True, max_length=63)]] = None
+    __properties: ClassVar[List[str]] = ["template_id", "data", "export_type", "expiration", "filename", "store_s3", "s3_filepath", "s3_bucket"]
+
+    @field_validator('filename')
+    def filename_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z0-9_\-\.]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_\-\.]+$/")
+        return value
+
+    @field_validator('s3_filepath')
+    def s3_filepath_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z0-9_\-\.\/]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_\-\.\/]+$/")
+        return value
+
+    @field_validator('s3_bucket')
+    def s3_bucket_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-z0-9][a-z0-9.\-]*[a-z0-9]$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9][a-z0-9.\-]*[a-z0-9]$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreatePdfRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if filename (nullable) is None
+        # and model_fields_set contains the field
+        if self.filename is None and "filename" in self.model_fields_set:
+            _dict['filename'] = None
+
+        # set to None if s3_filepath (nullable) is None
+        # and model_fields_set contains the field
+        if self.s3_filepath is None and "s3_filepath" in self.model_fields_set:
+            _dict['s3_filepath'] = None
+
+        # set to None if s3_bucket (nullable) is None
+        # and model_fields_set contains the field
+        if self.s3_bucket is None and "s3_bucket" in self.model_fields_set:
+            _dict['s3_bucket'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreatePdfRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "template_id": obj.get("template_id"),
+            "data": obj.get("data"),
+            "export_type": obj.get("export_type"),
+            "expiration": obj.get("expiration") if obj.get("expiration") is not None else 86400,
+            "filename": obj.get("filename"),
+            "store_s3": obj.get("store_s3") if obj.get("store_s3") is not None else False,
+            "s3_filepath": obj.get("s3_filepath"),
+            "s3_bucket": obj.get("s3_bucket")
+        })
+        return _obj
+
+

templatefox/models/create_pdf_response.py

@@ -0,0 +1,94 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreatePdfResponse(BaseModel):
+    """
+    Response for URL export type
+    """ # noqa: E501
+    url: StrictStr = Field(description="Signed URL to download the PDF (expires after specified time)")
+    filename: StrictStr = Field(description="Filename of the generated PDF")
+    credits_remaining: StrictInt = Field(description="Remaining credits after this request")
+    expires_in: StrictInt = Field(description="Seconds until URL expires")
+    __properties: ClassVar[List[str]] = ["url", "filename", "credits_remaining", "expires_in"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreatePdfResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreatePdfResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "filename": obj.get("filename"),
+            "credits_remaining": obj.get("credits_remaining"),
+            "expires_in": obj.get("expires_in")
+        })
+        return _obj
+
+

templatefox/models/export_type.py

@@ -0,0 +1,38 @@
+# 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
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ExportType(str, Enum):
+    """
+    PDF export type options
+    """
+
+    """
+    allowed enum values
+    """
+    URL = 'url'
+    BINARY = 'binary'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ExportType from a JSON string"""
+        return cls(json.loads(json_str))
+
+