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

restpki_ng_python_client/file_utils.py

@@ -0,0 +1,122 @@
+import base64
+from six import BytesIO
+from .utils import Utils
+
+from restpki_ng_python_client.models.file_model import FileModel
+from restpki_ng_python_client.restpki_ng_client import RestPkiClient
+
+class FileUtils():
+    def __init__(self, client: RestPkiClient, file_model: FileModel):
+        self.__client = client
+        self.__file = file_model
+
+    @property
+    def client(self):
+        return self.__client
+
+    @client.setter
+    def client(self, value):
+        self.__client = value
+
+    def open(self, buff_size=4096):
+        content_base64 = self.__file.content
+        content_raw = Utils._base64_decode(content_base64)\
+            if content_base64 is not None else None
+        if content_raw is not None:
+            stream = Utils._get_raw_stream(content_raw)
+        else:
+            stream = BytesIO()
+            with self.__client.get_file_from_url(self.__file.url) as response:
+                for chunk in response.stream(buff_size):
+                    stream.write(chunk)
+                stream.seek(0, 0)
+        return stream
+
+    def write_to(self, f_out, offset=0, from_where=0, buff_size=4096):
+        content_base64 = self.__file.content
+        content_raw = Utils._base64_decode(content_base64)\
+            if content_base64 is not None else None
+        if content_raw is not None:
+            f_in = self.open()
+            Utils._copy_stream(f_in, f_out, offset, from_where, buff_size)
+            f_in.close()
+        else:
+            f_out.seek(offset, from_where)
+            with self.__client.get_file_from_url(self.__file.url) as response:
+                for chunk in response.stream(buff_size):
+                    f_out.write(chunk)
+                
+
+    def write_to_file(self, path, offset=0, from_where=0, buff_size=4096):
+        content_base64 = self.__file.content
+        content_raw = Utils._base64_decode(content_base64)\
+            if content_base64 is not None else None
+        with open(path, 'wb') as f_out:
+            if content_raw is not None:
+                f_in = self.open()
+                Utils._copy_stream(f_in, f_out, offset, from_where, buff_size)
+                f_in.close()
+            else:
+                with self.__client.get_file_from_url(self.__file.url) as response:
+                    for chunk in response.stream(buff_size):
+                        f_out.write(chunk)
+
+    # region "content" accessors
+
+    @property
+    def content(self):
+        return self.__get_content()
+
+    def __get_content(self):
+        buffer = BytesIO()
+        self.write_to(buffer)
+        buffer.seek(0, 0)
+        return buffer.read()
+
+    @content.setter
+    def content(self, value):
+        self.__set_content(value)
+
+    def __set_content(self, value):
+        if value is None:
+            raise Exception('The provided "content" is not valid')
+        if self.__file is None:
+            self.__file = {
+                'content': None,
+                'mimeType': None,
+                'blobToken': None,
+                'url': None
+            }
+        self.__file['content'] = base64.b64encode(value)
+
+    # endregion
+
+    # region "content_base64" accessors
+
+    @property
+    def content_base64(self):
+        return self.__get_content_base64()
+
+    def __get_content_base64(self):
+        buffer = BytesIO()
+        self.write_to(buffer)
+        buffer.seek(0, 0)
+        return Utils._base64_encode_string(buffer.read())
+
+    @content_base64.setter
+    def content_base64(self, value):
+        self.__set_content_base64(value)
+
+    def __set_content_base64(self, value):
+        if value is None:
+            raise Exception('The provided "content_base64" is not valid')
+        if self.__file is None:
+            self.__file = {
+                'content': None,
+                'mimeType': None,
+                'blobToken': None,
+                'url': None
+            }
+        self.__file['content'] = value
+
+    # endregion

restpki_ng_python_client/models/__init__.py

@@ -0,0 +1,165 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+
+# import models into model package
+from restpki_ng_python_client.models.allocate_document_key_batch_request import AllocateDocumentKeyBatchRequest
+from restpki_ng_python_client.models.allocate_document_key_request import AllocateDocumentKeyRequest
+from restpki_ng_python_client.models.attribute_certificate_model import AttributeCertificateModel
+from restpki_ng_python_client.models.audit_package_options import AuditPackageOptions
+from restpki_ng_python_client.models.authentication_failures import AuthenticationFailures
+from restpki_ng_python_client.models.authentication_get_response import AuthenticationGetResponse
+from restpki_ng_python_client.models.authentication_post_request import AuthenticationPostRequest
+from restpki_ng_python_client.models.authentication_post_response import AuthenticationPostResponse
+from restpki_ng_python_client.models.authentications_post_request import AuthenticationsPostRequest
+from restpki_ng_python_client.models.authentications_post_response import AuthenticationsPostResponse
+from restpki_ng_python_client.models.authentications_post_signed_bytes_request import AuthenticationsPostSignedBytesRequest
+from restpki_ng_python_client.models.authentications_post_signed_bytes_response import AuthenticationsPostSignedBytesResponse
+from restpki_ng_python_client.models.auto_positioning_horizontal_directions import AutoPositioningHorizontalDirections
+from restpki_ng_python_client.models.auto_positioning_vertical_directions import AutoPositioningVerticalDirections
+from restpki_ng_python_client.models.blockchains import Blockchains
+from restpki_ng_python_client.models.cades_signature_model import CadesSignatureModel
+from restpki_ng_python_client.models.cades_signature_post_request_v1 import CadesSignaturePostRequestV1
+from restpki_ng_python_client.models.cades_signature_post_request_v2 import CadesSignaturePostRequestV2
+from restpki_ng_python_client.models.cades_signature_post_request_v3 import CadesSignaturePostRequestV3
+from restpki_ng_python_client.models.cades_signature_post_response import CadesSignaturePostResponse
+from restpki_ng_python_client.models.cades_signature_post_signed_bytes_request import CadesSignaturePostSignedBytesRequest
+from restpki_ng_python_client.models.cades_signature_post_signed_bytes_response import CadesSignaturePostSignedBytesResponse
+from restpki_ng_python_client.models.cades_signer_model import CadesSignerModel
+from restpki_ng_python_client.models.cades_timestamp_model import CadesTimestampModel
+from restpki_ng_python_client.models.certificate_model import CertificateModel
+from restpki_ng_python_client.models.certificate_reference_model import CertificateReferenceModel
+from restpki_ng_python_client.models.certificate_requirement import CertificateRequirement
+from restpki_ng_python_client.models.certificate_requirement_types import CertificateRequirementTypes
+from restpki_ng_python_client.models.certificate_summary import CertificateSummary
+from restpki_ng_python_client.models.certified_attribute_model import CertifiedAttributeModel
+from restpki_ng_python_client.models.certified_attribute_types import CertifiedAttributeTypes
+from restpki_ng_python_client.models.cms_content_types import CmsContentTypes
+from restpki_ng_python_client.models.cms_signature_options import CmsSignatureOptions
+from restpki_ng_python_client.models.color_model import ColorModel
+from restpki_ng_python_client.models.commitment_type_model import CommitmentTypeModel
+from restpki_ng_python_client.models.complete_authentication_request import CompleteAuthenticationRequest
+from restpki_ng_python_client.models.complete_authentication_response import CompleteAuthenticationResponse
+from restpki_ng_python_client.models.complete_signature_request import CompleteSignatureRequest
+from restpki_ng_python_client.models.complete_signature_request_v2 import CompleteSignatureRequestV2
+from restpki_ng_python_client.models.create_signature_session_request import CreateSignatureSessionRequest
+from restpki_ng_python_client.models.create_signature_session_response import CreateSignatureSessionResponse
+from restpki_ng_python_client.models.digest_algorithm_and_value_model import DigestAlgorithmAndValueModel
+from restpki_ng_python_client.models.digest_algorithms import DigestAlgorithms
+from restpki_ng_python_client.models.document_file_model import DocumentFileModel
+from restpki_ng_python_client.models.document_key_model import DocumentKeyModel
+from restpki_ng_python_client.models.document_key_query_response import DocumentKeyQueryResponse
+from restpki_ng_python_client.models.document_key_summary import DocumentKeySummary
+from restpki_ng_python_client.models.document_model import DocumentModel
+from restpki_ng_python_client.models.document_query_response import DocumentQueryResponse
+from restpki_ng_python_client.models.document_status import DocumentStatus
+from restpki_ng_python_client.models.document_summary import DocumentSummary
+from restpki_ng_python_client.models.error_model_v2 import ErrorModelV2
+from restpki_ng_python_client.models.file_model import FileModel
+from restpki_ng_python_client.models.file_reference_model import FileReferenceModel
+from restpki_ng_python_client.models.full_xml_signature_post_request import FullXmlSignaturePostRequest
+from restpki_ng_python_client.models.general_name_choices import GeneralNameChoices
+from restpki_ng_python_client.models.general_name_model import GeneralNameModel
+from restpki_ng_python_client.models.holder_types import HolderTypes
+from restpki_ng_python_client.models.inspect_signature_failures import InspectSignatureFailures
+from restpki_ng_python_client.models.inspect_signature_request import InspectSignatureRequest
+from restpki_ng_python_client.models.inspect_signature_response import InspectSignatureResponse
+from restpki_ng_python_client.models.multipart_upload_begin_response import MultipartUploadBeginResponse
+from restpki_ng_python_client.models.multipart_upload_end_request import MultipartUploadEndRequest
+from restpki_ng_python_client.models.name_model import NameModel
+from restpki_ng_python_client.models.namespace_model import NamespaceModel
+from restpki_ng_python_client.models.open_cades_signature_request_model import OpenCadesSignatureRequestModel
+from restpki_ng_python_client.models.open_signature_request_model import OpenSignatureRequestModel
+from restpki_ng_python_client.models.open_xml_signature_request_model import OpenXmlSignatureRequestModel
+from restpki_ng_python_client.models.other_name_model import OtherNameModel
+from restpki_ng_python_client.models.pades_certification_level import PadesCertificationLevel
+from restpki_ng_python_client.models.pades_horizontal_align import PadesHorizontalAlign
+from restpki_ng_python_client.models.pades_measurement_units import PadesMeasurementUnits
+from restpki_ng_python_client.models.pades_page_optimization_model import PadesPageOptimizationModel
+from restpki_ng_python_client.models.pades_signature_model import PadesSignatureModel
+from restpki_ng_python_client.models.pades_signature_post_request_v1 import PadesSignaturePostRequestV1
+from restpki_ng_python_client.models.pades_signature_post_request_v2 import PadesSignaturePostRequestV2
+from restpki_ng_python_client.models.pades_signature_post_response import PadesSignaturePostResponse
+from restpki_ng_python_client.models.pades_signature_post_signed_bytes_request import PadesSignaturePostSignedBytesRequest
+from restpki_ng_python_client.models.pades_signature_post_signed_bytes_response import PadesSignaturePostSignedBytesResponse
+from restpki_ng_python_client.models.pades_signer_model import PadesSignerModel
+from restpki_ng_python_client.models.pades_size_model import PadesSizeModel
+from restpki_ng_python_client.models.pades_text_horizontal_align import PadesTextHorizontalAlign
+from restpki_ng_python_client.models.pades_vertical_align import PadesVerticalAlign
+from restpki_ng_python_client.models.pades_visual_auto_positioning_model import PadesVisualAutoPositioningModel
+from restpki_ng_python_client.models.pades_visual_image_model import PadesVisualImageModel
+from restpki_ng_python_client.models.pades_visual_positioning_model import PadesVisualPositioningModel
+from restpki_ng_python_client.models.pades_visual_rectangle_model import PadesVisualRectangleModel
+from restpki_ng_python_client.models.pades_visual_representation_model import PadesVisualRepresentationModel
+from restpki_ng_python_client.models.pades_visual_text_model import PadesVisualTextModel
+from restpki_ng_python_client.models.page_orientations import PageOrientations
+from restpki_ng_python_client.models.paper_sizes import PaperSizes
+from restpki_ng_python_client.models.pdf_add_marks_request import PdfAddMarksRequest
+from restpki_ng_python_client.models.pdf_add_marks_response import PdfAddMarksResponse
+from restpki_ng_python_client.models.pdf_mark_element_model import PdfMarkElementModel
+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_mark_model import PdfMarkModel
+from restpki_ng_python_client.models.pdf_mark_page_options import PdfMarkPageOptions
+from restpki_ng_python_client.models.pdf_signature_options import PdfSignatureOptions
+from restpki_ng_python_client.models.pdf_text_section_model import PdfTextSectionModel
+from restpki_ng_python_client.models.pdf_text_style import PdfTextStyle
+from restpki_ng_python_client.models.pki_brazil_certificate_model import PkiBrazilCertificateModel
+from restpki_ng_python_client.models.pki_brazil_certificate_types import PkiBrazilCertificateTypes
+from restpki_ng_python_client.models.pki_italy_certificate_model import PkiItalyCertificateModel
+from restpki_ng_python_client.models.pki_italy_certificate_types import PkiItalyCertificateTypes
+from restpki_ng_python_client.models.prepare_authentication_request import PrepareAuthenticationRequest
+from restpki_ng_python_client.models.prepare_authentication_response import PrepareAuthenticationResponse
+from restpki_ng_python_client.models.prepare_signature_failures import PrepareSignatureFailures
+from restpki_ng_python_client.models.prepare_signature_request import PrepareSignatureRequest
+from restpki_ng_python_client.models.prepare_signature_response import PrepareSignatureResponse
+from restpki_ng_python_client.models.resource_content_or_reference import ResourceContentOrReference
+from restpki_ng_python_client.models.role_attribute_model import RoleAttributeModel
+from restpki_ng_python_client.models.session_completion_status import SessionCompletionStatus
+from restpki_ng_python_client.models.signature_algorithm_and_value_model import SignatureAlgorithmAndValueModel
+from restpki_ng_python_client.models.signature_algorithm_identifier import SignatureAlgorithmIdentifier
+from restpki_ng_python_client.models.signature_algorithms import SignatureAlgorithms
+from restpki_ng_python_client.models.signature_b_stamp_model import SignatureBStampModel
+from restpki_ng_python_client.models.signature_policy_identifier_model import SignaturePolicyIdentifierModel
+from restpki_ng_python_client.models.signature_result_model import SignatureResultModel
+from restpki_ng_python_client.models.signature_session_document_data import SignatureSessionDocumentData
+from restpki_ng_python_client.models.signature_session_document_summary import SignatureSessionDocumentSummary
+from restpki_ng_python_client.models.signature_session_model import SignatureSessionModel
+from restpki_ng_python_client.models.signature_session_status import SignatureSessionStatus
+from restpki_ng_python_client.models.signature_types import SignatureTypes
+from restpki_ng_python_client.models.signer_b_stamp_model import SignerBStampModel
+from restpki_ng_python_client.models.signer_model import SignerModel
+from restpki_ng_python_client.models.signer_summary import SignerSummary
+from restpki_ng_python_client.models.timestamp_issue_response import TimestampIssueResponse
+from restpki_ng_python_client.models.validation_item_model import ValidationItemModel
+from restpki_ng_python_client.models.validation_item_types import ValidationItemTypes
+from restpki_ng_python_client.models.validation_results_model import ValidationResultsModel
+from restpki_ng_python_client.models.webhook_event_model import WebhookEventModel
+from restpki_ng_python_client.models.webhook_event_types import WebhookEventTypes
+from restpki_ng_python_client.models.xml_attribute_model import XmlAttributeModel
+from restpki_ng_python_client.models.xml_element_location_model import XmlElementLocationModel
+from restpki_ng_python_client.models.xml_element_model import XmlElementModel
+from restpki_ng_python_client.models.xml_element_signature_post_request import XmlElementSignaturePostRequest
+from restpki_ng_python_client.models.xml_id_attribute_model import XmlIdAttributeModel
+from restpki_ng_python_client.models.xml_id_resolution_table_model import XmlIdResolutionTableModel
+from restpki_ng_python_client.models.xml_insertion_options import XmlInsertionOptions
+from restpki_ng_python_client.models.xml_node_name_model import XmlNodeNameModel
+from restpki_ng_python_client.models.xml_signature_model import XmlSignatureModel
+from restpki_ng_python_client.models.xml_signature_options import XmlSignatureOptions
+from restpki_ng_python_client.models.xml_signature_post_response import XmlSignaturePostResponse
+from restpki_ng_python_client.models.xml_signature_post_signed_bytes_request import XmlSignaturePostSignedBytesRequest
+from restpki_ng_python_client.models.xml_signature_post_signed_bytes_response import XmlSignaturePostSignedBytesResponse
+from restpki_ng_python_client.models.xml_signature_response_model import XmlSignatureResponseModel
+from restpki_ng_python_client.models.xml_signature_types import XmlSignatureTypes
+from restpki_ng_python_client.models.xml_signed_entity_types import XmlSignedEntityTypes

restpki_ng_python_client/models/allocate_document_key_batch_request.py

@@ -0,0 +1,96 @@
+# 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
+from pydantic import BaseModel, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class AllocateDocumentKeyBatchRequest(BaseModel):
+    """
+    AllocateDocumentKeyBatchRequest
+    """ # noqa: E501
+    count: Optional[Annotated[int, Field(le=100, strict=True, ge=1)]] = None
+    provisional_metadata: Optional[Dict[str, List[StrictStr]]] = Field(default=None, alias="provisionalMetadata")
+    __properties: ClassVar[List[str]] = ["count", "provisionalMetadata"]
+
+    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 AllocateDocumentKeyBatchRequest 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,
+        )
+        # set to None if provisional_metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.provisional_metadata is None and "provisional_metadata" in self.model_fields_set:
+            _dict['provisionalMetadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of AllocateDocumentKeyBatchRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "count": obj.get("count"),
+            "provisionalMetadata": obj.get("provisionalMetadata")
+        })
+        return _obj
+
+

restpki_ng_python_client/models/allocate_document_key_request.py

@@ -0,0 +1,93 @@
+# 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
+from pydantic import BaseModel, StrictStr
+from pydantic import Field
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class AllocateDocumentKeyRequest(BaseModel):
+    """
+    AllocateDocumentKeyRequest
+    """ # noqa: E501
+    provisional_metadata: Optional[Dict[str, List[StrictStr]]] = Field(default=None, alias="provisionalMetadata")
+    __properties: ClassVar[List[str]] = ["provisionalMetadata"]
+
+    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 AllocateDocumentKeyRequest 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,
+        )
+        # set to None if provisional_metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.provisional_metadata is None and "provisional_metadata" in self.model_fields_set:
+            _dict['provisionalMetadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of AllocateDocumentKeyRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "provisionalMetadata": obj.get("provisionalMetadata")
+        })
+        return _obj
+
+