restpki-ng-python-client 0.9.0__py3-none-any.whl

restpki_ng_python_client/models/pdf_container_definition.py

@@ -0,0 +1,208 @@
+from .pades_visual_rectangle_model import PadesVisualRectangleModel
+
+
+class PdfContainerDefinition:
+
+    class VarWidthAndHeight:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def margins(self,
+                    top_margin,
+                    right_margin=None,
+                    bottom_margin=None,
+                    left_margin=None):
+            self.__container.top = top_margin
+            self.__container.right = right_margin \
+                if right_margin is not None else top_margin
+            self.__container.bottom = bottom_margin \
+                if bottom_margin is not None else top_margin
+            self.__container.left = left_margin \
+                if left_margin is not None else self.__container.right
+            return self.__container
+
+    class HeightDefinedVarWidth:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def margins(self, left_margin, right_margin=None):
+            self.__container.left = left_margin
+            self.__container.right = right_margin \
+                if right_margin is not None else left_margin
+            return self.__container
+
+    class HeightDefinedFixedWidth:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def anchor_left(self, margin=0.0):
+            self.__container.left = margin
+            return self.__container
+
+        def anchor_right(self, margin=0.0):
+            self.__container.right = margin
+            return self.__container
+
+        def center(self):
+            return self.__container
+
+    class WidthDefinedVarHeight:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def margins(self, top_margin, bottom_margin=None):
+            self.__container.top = top_margin
+            self.__container.bottom = bottom_margin \
+                if bottom_margin is not None else top_margin
+            return self.__container
+
+    class WidthDefinedFixedHeight:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def anchor_top(self, margin=0.0):
+            self.__container.top = margin
+            return self.__container
+
+        def anchor_bottom(self, margin=0.0):
+            self.__container.bottom = margin
+            return self.__container
+
+        def center(self):
+            return self.__container
+
+    class HeightDefined:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def width(self, value):
+            self.__container.width = value
+            return PdfContainerDefinition.\
+                HeightDefinedFixedWidth(self.__container)
+
+        def var_width(self):
+            return PdfContainerDefinition.\
+                HeightDefinedVarWidth(self.__container)
+
+        def full_width(self):
+            self.__container.left = 0.0
+            self.__container.right = 0.0
+            return self.__container
+
+    class WidthDefined:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def height(self, value):
+            self.__container.height = value
+            return PdfContainerDefinition.\
+                WidthDefinedFixedHeight(self.__container)
+
+        def var_height(self):
+            return PdfContainerDefinition.\
+                WidthDefinedVarHeight(self.__container)
+
+        def full_height(self):
+            self.__container.top = 0.0
+            self.__container.bottom = 0.0
+            return self.__container
+
+    class VarHeight:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def margins(self, top_margin, bottom_margin=None):
+            self.__container.top = top_margin
+            self.__container.bottom = bottom_margin \
+                if bottom_margin is not None else top_margin
+            return PdfContainerDefinition.HeightDefined(self.__container)
+
+    class FixedHeight:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def anchor_top(self, margin=0.0):
+            self.__container.top = margin
+            return PdfContainerDefinition.HeightDefined(self.__container)
+
+        def anchor_bottom(self, margin=0.0):
+            self.__container.bottom = margin
+            return PdfContainerDefinition.HeightDefined(self.__container)
+
+        def center(self):
+            return PdfContainerDefinition.HeightDefined(self.__container)
+
+    class VarWidth:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def margins(self, left_margin, right_margin=None):
+            self.__container.left = left_margin
+            self.__container.right = right_margin \
+                if right_margin is not None else left_margin
+            return PdfContainerDefinition.WidthDefined(self.__container)
+
+    class FixedWidth:
+
+        def __init__(self, container: PadesVisualRectangleModel):
+            self.__container = container
+
+        def anchor_left(self, margin=0.0):
+            self.__container.left = margin
+            return PdfContainerDefinition.WidthDefined(self.__container)
+
+        def anchor_right(self, margin=0.0):
+            self.__container.right = margin
+            return PdfContainerDefinition.WidthDefined(self.__container)
+
+        def center(self):
+            return PdfContainerDefinition.WidthDefined(self.__container)
+
+    class Initial:
+
+        def __init__(self):
+            self.__container = PadesVisualRectangleModel()
+
+        def width(self, value):
+            self.__container.width = value
+            return PdfContainerDefinition.FixedWidth(self.__container)
+
+        def var_width(self):
+            return PdfContainerDefinition.VarWidth(self.__container)
+
+        def full_width(self):
+            self.__container.left = 0.0
+            self.__container.right = 0.0
+            return PdfContainerDefinition.WidthDefined(self.__container)
+
+        def height(self, value):
+            self.__container.height = value
+            return PdfContainerDefinition.FixedHeight(self.__container)
+
+        def var_height(self):
+            return PdfContainerDefinition.VarHeight(self.__container)
+
+        def full_height(self):
+            self.__container.top = 0.0
+            self.__container.bottom = 0.0
+            return PdfContainerDefinition.HeightDefined(self.__container)
+
+        def var_width_and_height(self):
+            return PdfContainerDefinition.VarWidthAndHeight(self.__container)
+
+        def full(self):
+            self.__container.top = 0.0
+            self.__container.right = 0.0
+            self.__container.bottom = 0.0
+            self.__container.left = 0.0
+            return self.__container

restpki_ng_python_client/models/pdf_helper.py

@@ -0,0 +1,43 @@
+from .pdf_mark_image_model import PdfMarkImageModel
+from .pades_visual_rectangle_model import PadesVisualRectangleModel
+from .pdf_mark_element_type import PdfMarkElementType
+from .pdf_mark_element_model import PdfMarkElementModel
+from .pdf_text_style import PdfTextStyle
+from .pdf_container_definition import PdfContainerDefinition
+from .pdf_text_section_model import PdfTextSectionModel
+from .pdf_mark_model import PdfMarkModel
+
+class PdfHelper(object):
+
+    @staticmethod
+    def mark():
+        return PdfMarkModel(
+            container=PadesVisualRectangleModel(), 
+            elements=list()
+        )
+
+    @staticmethod
+    def container():
+        return PdfContainerDefinition.Initial()
+
+    @staticmethod
+    def text_element():
+        return PdfMarkElementModel(
+            elementType=PdfMarkElementType.TEXT,
+            textSections=list()
+        )
+
+    @staticmethod
+    def image_element():
+        return PdfMarkElementModel(
+            elementType=PdfMarkElementType.IMAGE,
+            image=PdfMarkImageModel()
+            )
+
+    @staticmethod
+    def qr_code_element():
+        return PdfMarkElementModel(elementType=PdfMarkElementType.QRCODE)
+
+    @staticmethod
+    def text_section():
+        return PdfTextSectionModel(text="TEXT SECTION")

restpki_ng_python_client/models/pdf_mark_element_model.py

@@ -0,0 +1,230 @@
+# coding: utf-8
+
+"""
+    Rest PKI Core API
+
+    <b><i>Para Português, <a href=\"https://docs.lacunasoftware.com/pt-br/articles/rest-pki/core/integration/get-started\">clique aqui</a></i></b>  <p>   <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/\">Rest PKI Core</a> is an upcoming version of   <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/\">Rest PKI</a> that will have extended compatibility with environments and databases.  </p>  <p>   In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on <b>Linux</b> (Debian- and RedHat-based distributions)   and on <b>Docker</b>. As for database servers, in addition to SQL Server, <b>PostgreSQL</b> will also be supported.  </p>  <p>   <b>Before getting started, see the integration overview on the <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/\">Integration Guide</a></b>  </p>  <p>   For questions regarding the usage of this API, please reach us at <a href=\"https://lacuna.help/\">lacuna.help</a>  </p>    <h2>Parameters</h2>  <p>   You will need the following parameters:  </p>  <ul>   <li><b>Endpoint</b>: address of the Rest PKI Core instance that will be used</li>   <li><b>API Key</b>: authorization key for using the API</li>  </ul>  <p>   The <span class=\"model\">endpoint</span> must be prefixed to all relative URLs mentioned here. As for the <span class=\"model\">API Key</span>, see how to use it below.  </p>    <h2>Authentication</h2>  <p>   The API key must be sent on the <span class=\"model\">X-Api-Key</span> header on each request:  </p>    <!-- unfortunately, class \"example microlight\" doesn't seem to work here -->  <pre style=\"font-size: 12px; padding: 10px; border-radius: 4px; background: #41444e; font-weight: 600; color: #fff;\">  X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  </pre>    <h2>HTTP Codes</h2>    <p>   The APIs will return the following HTTP codes:  </p>    <table>   <thead>    <tr>     <th>Code</th>     <th>Description</th>    </tr>   </thead>   <tbody>    <tr>     <td><strong class=\"model-title\">200 (OK)</strong></td>     <td>Request processed successfully. The response is different for each API, please refer to the operation's documentation</td>    </tr>    <tr>     <td><strong class=\"model-title\">400 (Bad Request)</strong></td>     <td>Syntax error. For instance, when a required field was not provided</td>    </tr>    <tr>     <td><strong class=\"model-title\">401 (Unauthorized)</strong></td>     <td>API key not provided or invalid</td>    </tr>    <tr>     <td><strong class=\"model-title\">403 (Forbidden)</strong></td>     <td>API key is valid, but the application has insufficient permissions to complete the requested operation</td>    </tr>    <tr>     <td><strong class=\"model-title\">422 (Unprocessable Entity)</strong></td>     <td>API error. The response body is an <a href=\"#model-ErrorModelV2\" class=\"model\">ErrorModelV2</a>    </tr>    <tr>     <td><strong class=\"model-title\">500 (Internal Server Error)</strong></td>     <td>An unexpected error occurred. The <span class=\"model\">exceptionCode</span> contained on the response body may be of help for our support team during diagnostic.</td>    </tr>   </tbody>  </table>    <h3>Error Codes</h3>    <p>   Some of the error codes returned in the <span class=\"model\">code</span> field of an <a href=\"#model-ErrorModelV2\" class=\"model\">ErrorModelV2</a>   (body of responses with HTTP status code 422) are provided below*:  </p>    <table>   <thead>    <tr>     <th>Code</th>     <th>Description</th>    </tr>   </thead>   <tbody>    <tr>     <td class=\"model\">DocumentNotFound</td>     <td>A referenced document was not found (check the document ID)</td>    </tr>    <tr>     <td class=\"model\">SecurityContextNotFound</td>     <td>A referenced security context was not found (check the security context ID)</td>    </tr>    <tr>     <td class=\"model\">SignatureSessionNotFound</td>     <td>A referenced signature session was not found (check the signature session ID)</td>    </tr>    <tr>     <td class=\"model\">BadSignatureSessionOperation</td>     <td>The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still <span class=\"model\">Pending</span> results in this error</td>    </tr>    <tr>     <td class=\"model\">BackgroundProcessing</td>     <td>The operation cannot be completed at this time because the resource is being processed in background</td>    </tr>    <tr>     <td class=\"model\">SignatureSessionTokenRequired</td>     <td>The signature session token was not passed on the <span class=\"model\">X-Signature-Session-Token</span> request header</td>    </tr>    <tr>     <td class=\"model\">BadSignatureSessionToken</td>     <td>An invalid signature session token was passed on the <span class=\"model\">X-Signature-Session-Token</span> request header. Check your application for possible corruption of the session token, which may contain characters <span class=\"code\">-</span> (hyphen) and <span class=\"code\">_</span> (underscore)</td>    </tr>    <tr>     <td class=\"model\">ExpiredSignatureSessionToken</td>     <td>An expired signature session token was passed on the <span class=\"model\">X-Signature-Session-Token</span> request header. Signature session tokens are normally valid for 4 hours.</td>    </tr>   </tbody>  </table>    <p style=\"font-size: 0.9em\">   *The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.  </p>    <h2>Culture / Internationalization (i18n)</h2>  <p>The <span class=\"model\">Accept-Language</span> request header is observed by this API. The following cultures are supported:</p>  <ul>   <li><span class=\"code\">en-US</span> (or simply <span class=\"code\">en</span>)</li>   <li><span class=\"code\">pt-BR</span> (or simply <span class=\"code\">pt</span>)</li>  </ul>  <p><i>Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.</i></p>  
+
+    The version of the OpenAPI document: 2.1.2
+    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 typing import Any, ClassVar, Dict, List, Optional, Union
+from pydantic import BaseModel, StrictBool, StrictFloat, StrictInt, StrictStr
+from pydantic import Field
+from restpki_ng_python_client.models.resource_content_or_reference import ResourceContentOrReference
+from restpki_ng_python_client.models.pdf_text_style import PdfTextStyle
+from restpki_ng_python_client.models.pades_horizontal_align import PadesHorizontalAlign
+from restpki_ng_python_client.models.pades_vertical_align import PadesVerticalAlign
+from restpki_ng_python_client.models.pades_visual_rectangle_model import PadesVisualRectangleModel
+from restpki_ng_python_client.models.pdf_mark_element_type import PdfMarkElementType
+from restpki_ng_python_client.models.pdf_mark_image_model import PdfMarkImageModel
+from restpki_ng_python_client.models.pdf_text_section_model import PdfTextSectionModel
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class PdfMarkElementModel(BaseModel):
+    """
+    PdfMarkElementModel
+    """ # noqa: E501
+    element_type: Optional[PdfMarkElementType] = Field(default=None, alias="elementType")
+    relative_container: Optional[PadesVisualRectangleModel] = Field(default=None, alias="relativeContainer")
+    rotation: Optional[StrictInt] = None
+    text_sections: Optional[List[PdfTextSectionModel]] = Field(default=None, alias="textSections")
+    image: Optional[PdfMarkImageModel] = None
+    qr_code_data: Optional[StrictStr] = Field(default=None, alias="qrCodeData")
+    qr_code_draw_quiet_zones: Optional[StrictBool] = Field(default=None, alias="qrCodeDrawQuietZones")
+    align: Optional[PadesHorizontalAlign] = None
+    vertical_align: Optional[PadesVerticalAlign] = Field(default=None, alias="verticalAlign")
+    opacity: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["elementType", "relativeContainer", "rotation", "textSections", "image", "qrCodeData", "qrCodeDrawQuietZones", "align", "verticalAlign", "opacity"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    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) -> Self:
+        """Create an instance of PdfMarkElementModel 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.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of relative_container
+        if self.relative_container:
+            _dict['relativeContainer'] = self.relative_container.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in text_sections (list)
+        _items = []
+        if self.text_sections:
+            for _item in self.text_sections:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['textSections'] = _items
+        # override the default output from pydantic by calling `to_dict()` of image
+        if self.image:
+            _dict['image'] = self.image.to_dict()
+        # set to None if text_sections (nullable) is None
+        # and model_fields_set contains the field
+        if self.text_sections is None and "text_sections" in self.model_fields_set:
+            _dict['textSections'] = None
+
+        # set to None if qr_code_data (nullable) is None
+        # and model_fields_set contains the field
+        if self.qr_code_data is None and "qr_code_data" in self.model_fields_set:
+            _dict['qrCodeData'] = None
+
+        # set to None if qr_code_draw_quiet_zones (nullable) is None
+        # and model_fields_set contains the field
+        if self.qr_code_draw_quiet_zones is None and "qr_code_draw_quiet_zones" in self.model_fields_set:
+            _dict['qrCodeDrawQuietZones'] = None
+
+        # set to None if opacity (nullable) is None
+        # and model_fields_set contains the field
+        if self.opacity is None and "opacity" in self.model_fields_set:
+            _dict['opacity'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of PdfMarkElementModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "elementType": obj.get("elementType"),
+            "relativeContainer": PadesVisualRectangleModel.from_dict(obj.get("relativeContainer")) if obj.get("relativeContainer") is not None else None,
+            "rotation": obj.get("rotation"),
+            "textSections": [PdfTextSectionModel.from_dict(_item) for _item in obj.get("textSections")] if obj.get("textSections") is not None else None,
+            "image": PdfMarkImageModel.from_dict(obj.get("image")) if obj.get("image") is not None else None,
+            "qrCodeData": obj.get("qrCodeData"),
+            "qrCodeDrawQuietZones": obj.get("qrCodeDrawQuietZones"),
+            "align": obj.get("align"),
+            "verticalAlign": obj.get("verticalAlign"),
+            "opacity": obj.get("opacity")
+        })
+        return _obj
+
+    # region FluentAPI Text
+
+    def align_text_left(self):
+        self.align = PadesHorizontalAlign.LEFT
+        return self
+
+    def align_text_right(self):
+        self.align = PadesHorizontalAlign.RIGHT
+        return self
+
+    def align_text_center(self):
+        self.align = PadesHorizontalAlign.CENTER
+        return self
+
+    def add_section_from_text(self, text: str):
+        self.text_sections.append(PdfTextSectionModel(text=text))
+        return self
+
+    def add_section(self, section: PdfTextSectionModel):
+        self.text_sections.append(section)
+        return self
+
+    # endregion
+
+    # region FluentAPI Image
+
+    def with_image(self, image: PdfMarkImageModel):
+        self.image = image
+        return self
+
+    def with_image_content(self, image_content, mime_type):
+        self.image = PdfMarkImageModel(resource=
+            ResourceContentOrReference(content=image_content, mimeType=mime_type)
+        )
+        return self
+    
+    def with_opacity(self, opacity):
+        self.opacity = opacity
+        return self
+    
+    # endregion
+
+    # region FluentAPI QRCode
+
+    def with_qr_code_data(self, qr_code_data):
+        self.qr_code_data = qr_code_data
+        return self
+
+    def draw_quiet_zones(self):
+        self.qr_code_draw_quiet_zones = True
+        return self
+
+    # endregion
+
+    # region FluentAPI
+
+    def on_container(self, relative_container):
+        self.relative_container = relative_container
+        return self
+
+    def with_rotation(self, rotation):
+        self.rotation = rotation
+        return self
+
+    def rotate_90_clockwise(self):
+        self.rotation = 270
+        return self
+
+    def rotate_90_counter_clockwise(self):
+        self.rotation = 90
+        return self
+
+    def rotate_180(self):
+        self.rotation = 180
+        return self
+
+    def with_opacity(self, opacity):
+        self.opacity = opacity
+        return self
+
+    # endregion
+
+
+

restpki_ng_python_client/models/pdf_mark_element_type.py

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+"""
+    Rest PKI Core API
+
+    <b><i>Para Português, <a href=\"https://docs.lacunasoftware.com/pt-br/articles/rest-pki/core/integration/get-started\">clique aqui</a></i></b>  <p>   <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/\">Rest PKI Core</a> is an upcoming version of   <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/\">Rest PKI</a> that will have extended compatibility with environments and databases.  </p>  <p>   In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on <b>Linux</b> (Debian- and RedHat-based distributions)   and on <b>Docker</b>. As for database servers, in addition to SQL Server, <b>PostgreSQL</b> will also be supported.  </p>  <p>   <b>Before getting started, see the integration overview on the <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/\">Integration Guide</a></b>  </p>  <p>   For questions regarding the usage of this API, please reach us at <a href=\"https://lacuna.help/\">lacuna.help</a>  </p>    <h2>Parameters</h2>  <p>   You will need the following parameters:  </p>  <ul>   <li><b>Endpoint</b>: address of the Rest PKI Core instance that will be used</li>   <li><b>API Key</b>: authorization key for using the API</li>  </ul>  <p>   The <span class=\"model\">endpoint</span> must be prefixed to all relative URLs mentioned here. As for the <span class=\"model\">API Key</span>, see how to use it below.  </p>    <h2>Authentication</h2>  <p>   The API key must be sent on the <span class=\"model\">X-Api-Key</span> header on each request:  </p>    <!-- unfortunately, class \"example microlight\" doesn't seem to work here -->  <pre style=\"font-size: 12px; padding: 10px; border-radius: 4px; background: #41444e; font-weight: 600; color: #fff;\">  X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  </pre>    <h2>HTTP Codes</h2>    <p>   The APIs will return the following HTTP codes:  </p>    <table>   <thead>    <tr>     <th>Code</th>     <th>Description</th>    </tr>   </thead>   <tbody>    <tr>     <td><strong class=\"model-title\">200 (OK)</strong></td>     <td>Request processed successfully. The response is different for each API, please refer to the operation's documentation</td>    </tr>    <tr>     <td><strong class=\"model-title\">400 (Bad Request)</strong></td>     <td>Syntax error. For instance, when a required field was not provided</td>    </tr>    <tr>     <td><strong class=\"model-title\">401 (Unauthorized)</strong></td>     <td>API key not provided or invalid</td>    </tr>    <tr>     <td><strong class=\"model-title\">403 (Forbidden)</strong></td>     <td>API key is valid, but the application has insufficient permissions to complete the requested operation</td>    </tr>    <tr>     <td><strong class=\"model-title\">422 (Unprocessable Entity)</strong></td>     <td>API error. The response body is an <a href=\"#model-ErrorModelV2\" class=\"model\">ErrorModelV2</a>    </tr>    <tr>     <td><strong class=\"model-title\">500 (Internal Server Error)</strong></td>     <td>An unexpected error occurred. The <span class=\"model\">exceptionCode</span> contained on the response body may be of help for our support team during diagnostic.</td>    </tr>   </tbody>  </table>    <h3>Error Codes</h3>    <p>   Some of the error codes returned in the <span class=\"model\">code</span> field of an <a href=\"#model-ErrorModelV2\" class=\"model\">ErrorModelV2</a>   (body of responses with HTTP status code 422) are provided below*:  </p>    <table>   <thead>    <tr>     <th>Code</th>     <th>Description</th>    </tr>   </thead>   <tbody>    <tr>     <td class=\"model\">DocumentNotFound</td>     <td>A referenced document was not found (check the document ID)</td>    </tr>    <tr>     <td class=\"model\">SecurityContextNotFound</td>     <td>A referenced security context was not found (check the security context ID)</td>    </tr>    <tr>     <td class=\"model\">SignatureSessionNotFound</td>     <td>A referenced signature session was not found (check the signature session ID)</td>    </tr>    <tr>     <td class=\"model\">BadSignatureSessionOperation</td>     <td>The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still <span class=\"model\">Pending</span> results in this error</td>    </tr>    <tr>     <td class=\"model\">BackgroundProcessing</td>     <td>The operation cannot be completed at this time because the resource is being processed in background</td>    </tr>    <tr>     <td class=\"model\">SignatureSessionTokenRequired</td>     <td>The signature session token was not passed on the <span class=\"model\">X-Signature-Session-Token</span> request header</td>    </tr>    <tr>     <td class=\"model\">BadSignatureSessionToken</td>     <td>An invalid signature session token was passed on the <span class=\"model\">X-Signature-Session-Token</span> request header. Check your application for possible corruption of the session token, which may contain characters <span class=\"code\">-</span> (hyphen) and <span class=\"code\">_</span> (underscore)</td>    </tr>    <tr>     <td class=\"model\">ExpiredSignatureSessionToken</td>     <td>An expired signature session token was passed on the <span class=\"model\">X-Signature-Session-Token</span> request header. Signature session tokens are normally valid for 4 hours.</td>    </tr>   </tbody>  </table>    <p style=\"font-size: 0.9em\">   *The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.  </p>    <h2>Culture / Internationalization (i18n)</h2>  <p>The <span class=\"model\">Accept-Language</span> request header is observed by this API. The following cultures are supported:</p>  <ul>   <li><span class=\"code\">en-US</span> (or simply <span class=\"code\">en</span>)</li>   <li><span class=\"code\">pt-BR</span> (or simply <span class=\"code\">pt</span>)</li>  </ul>  <p><i>Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.</i></p>  
+
+    The version of the OpenAPI document: 2.1.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+import re  # noqa: F401
+from enum import Enum
+
+
+
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+
+class PdfMarkElementType(str, Enum):
+    """
+    PdfMarkElementType
+    """
+
+    """
+    allowed enum values
+    """
+    TEXT = 'Text'
+    IMAGE = 'Image'
+    QRCODE = 'QRCode'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PdfMarkElementType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

restpki_ng_python_client/models/pdf_mark_image_model.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Rest PKI Core API
+
+    <b><i>Para Português, <a href=\"https://docs.lacunasoftware.com/pt-br/articles/rest-pki/core/integration/get-started\">clique aqui</a></i></b>  <p>   <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/\">Rest PKI Core</a> is an upcoming version of   <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/\">Rest PKI</a> that will have extended compatibility with environments and databases.  </p>  <p>   In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on <b>Linux</b> (Debian- and RedHat-based distributions)   and on <b>Docker</b>. As for database servers, in addition to SQL Server, <b>PostgreSQL</b> will also be supported.  </p>  <p>   <b>Before getting started, see the integration overview on the <a href=\"https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/\">Integration Guide</a></b>  </p>  <p>   For questions regarding the usage of this API, please reach us at <a href=\"https://lacuna.help/\">lacuna.help</a>  </p>    <h2>Parameters</h2>  <p>   You will need the following parameters:  </p>  <ul>   <li><b>Endpoint</b>: address of the Rest PKI Core instance that will be used</li>   <li><b>API Key</b>: authorization key for using the API</li>  </ul>  <p>   The <span class=\"model\">endpoint</span> must be prefixed to all relative URLs mentioned here. As for the <span class=\"model\">API Key</span>, see how to use it below.  </p>    <h2>Authentication</h2>  <p>   The API key must be sent on the <span class=\"model\">X-Api-Key</span> header on each request:  </p>    <!-- unfortunately, class \"example microlight\" doesn't seem to work here -->  <pre style=\"font-size: 12px; padding: 10px; border-radius: 4px; background: #41444e; font-weight: 600; color: #fff;\">  X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  </pre>    <h2>HTTP Codes</h2>    <p>   The APIs will return the following HTTP codes:  </p>    <table>   <thead>    <tr>     <th>Code</th>     <th>Description</th>    </tr>   </thead>   <tbody>    <tr>     <td><strong class=\"model-title\">200 (OK)</strong></td>     <td>Request processed successfully. The response is different for each API, please refer to the operation's documentation</td>    </tr>    <tr>     <td><strong class=\"model-title\">400 (Bad Request)</strong></td>     <td>Syntax error. For instance, when a required field was not provided</td>    </tr>    <tr>     <td><strong class=\"model-title\">401 (Unauthorized)</strong></td>     <td>API key not provided or invalid</td>    </tr>    <tr>     <td><strong class=\"model-title\">403 (Forbidden)</strong></td>     <td>API key is valid, but the application has insufficient permissions to complete the requested operation</td>    </tr>    <tr>     <td><strong class=\"model-title\">422 (Unprocessable Entity)</strong></td>     <td>API error. The response body is an <a href=\"#model-ErrorModelV2\" class=\"model\">ErrorModelV2</a>    </tr>    <tr>     <td><strong class=\"model-title\">500 (Internal Server Error)</strong></td>     <td>An unexpected error occurred. The <span class=\"model\">exceptionCode</span> contained on the response body may be of help for our support team during diagnostic.</td>    </tr>   </tbody>  </table>    <h3>Error Codes</h3>    <p>   Some of the error codes returned in the <span class=\"model\">code</span> field of an <a href=\"#model-ErrorModelV2\" class=\"model\">ErrorModelV2</a>   (body of responses with HTTP status code 422) are provided below*:  </p>    <table>   <thead>    <tr>     <th>Code</th>     <th>Description</th>    </tr>   </thead>   <tbody>    <tr>     <td class=\"model\">DocumentNotFound</td>     <td>A referenced document was not found (check the document ID)</td>    </tr>    <tr>     <td class=\"model\">SecurityContextNotFound</td>     <td>A referenced security context was not found (check the security context ID)</td>    </tr>    <tr>     <td class=\"model\">SignatureSessionNotFound</td>     <td>A referenced signature session was not found (check the signature session ID)</td>    </tr>    <tr>     <td class=\"model\">BadSignatureSessionOperation</td>     <td>The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still <span class=\"model\">Pending</span> results in this error</td>    </tr>    <tr>     <td class=\"model\">BackgroundProcessing</td>     <td>The operation cannot be completed at this time because the resource is being processed in background</td>    </tr>    <tr>     <td class=\"model\">SignatureSessionTokenRequired</td>     <td>The signature session token was not passed on the <span class=\"model\">X-Signature-Session-Token</span> request header</td>    </tr>    <tr>     <td class=\"model\">BadSignatureSessionToken</td>     <td>An invalid signature session token was passed on the <span class=\"model\">X-Signature-Session-Token</span> request header. Check your application for possible corruption of the session token, which may contain characters <span class=\"code\">-</span> (hyphen) and <span class=\"code\">_</span> (underscore)</td>    </tr>    <tr>     <td class=\"model\">ExpiredSignatureSessionToken</td>     <td>An expired signature session token was passed on the <span class=\"model\">X-Signature-Session-Token</span> request header. Signature session tokens are normally valid for 4 hours.</td>    </tr>   </tbody>  </table>    <p style=\"font-size: 0.9em\">   *The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.  </p>    <h2>Culture / Internationalization (i18n)</h2>  <p>The <span class=\"model\">Accept-Language</span> request header is observed by this API. The following cultures are supported:</p>  <ul>   <li><span class=\"code\">en-US</span> (or simply <span class=\"code\">en</span>)</li>   <li><span class=\"code\">pt-BR</span> (or simply <span class=\"code\">pt</span>)</li>  </ul>  <p><i>Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.</i></p>  
+
+    The version of the OpenAPI document: 2.1.2
+    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 typing import Any, ClassVar, Dict, List, Optional, Union
+from pydantic import BaseModel, StrictFloat, StrictInt
+from restpki_ng_python_client.models.resource_content_or_reference import ResourceContentOrReference
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class PdfMarkImageModel(BaseModel):
+    """
+    PdfMarkImageModel
+    """ # noqa: E501
+    opacity: Optional[Union[StrictFloat, StrictInt]] = None
+    resource: Optional[ResourceContentOrReference] = None
+    __properties: ClassVar[List[str]] = ["opacity", "resource"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    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) -> Self:
+        """Create an instance of PdfMarkImageModel 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.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of resource
+        if self.resource:
+            _dict['resource'] = self.resource.to_dict()
+        # set to None if opacity (nullable) is None
+        # and model_fields_set contains the field
+        if self.opacity is None and "opacity" in self.model_fields_set:
+            _dict['opacity'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of PdfMarkImageModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "opacity": obj.get("opacity"),
+            "resource": ResourceContentOrReference.from_dict(obj.get("resource")) if obj.get("resource") is not None else None
+        })
+        return _obj
+
+