restpki-ng-python-client 0.9.0.1__tar.gz → 0.9.2rc1__tar.gz

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/PKG-INFO

@@ -1,16 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: restpki_ng_python_client
-Version: 0.9.0.1
+Version: 0.9.2rc1
 Summary: Rest PKI Core API
 Home-page: 
 Author: OpenAPI Generator community
 Author-email: team@openapitools.org
 Keywords: OpenAPI,OpenAPI-Generator,Rest PKI Core API
 Description-Content-Type: text/markdown
-Requires-Dist: urllib3<2.1.0,>=1.25.11
+Requires-Dist: urllib3<2.1.0,>=1.24.3
 Requires-Dist: python-dateutil
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
 
     &lt;b&gt;&lt;i&gt;Para Português, &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/pt-br/articles/rest-pki/core/integration/get-started\&quot;&gt;clique aqui&lt;/a&gt;&lt;/i&gt;&lt;/b&gt;  &lt;p&gt;   &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/\&quot;&gt;Rest PKI Core&lt;/a&gt; is an upcoming version of   &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/en-us/articles/rest-pki/\&quot;&gt;Rest PKI&lt;/a&gt; that will have extended compatibility with environments and databases.  &lt;/p&gt;  &lt;p&gt;   In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on &lt;b&gt;Linux&lt;/b&gt; (Debian- and RedHat-based distributions)   and on &lt;b&gt;Docker&lt;/b&gt;. As for database servers, in addition to SQL Server, &lt;b&gt;PostgreSQL&lt;/b&gt; will also be supported.  &lt;/p&gt;  &lt;p&gt;   &lt;b&gt;Before getting started, see the integration overview on the &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/\&quot;&gt;Integration Guide&lt;/a&gt;&lt;/b&gt;  &lt;/p&gt;  &lt;p&gt;   For questions regarding the usage of this API, please reach us at &lt;a href&#x3D;\&quot;https://lacuna.help/\&quot;&gt;lacuna.help&lt;/a&gt;  &lt;/p&gt;    &lt;h2&gt;Parameters&lt;/h2&gt;  &lt;p&gt;   You will need the following parameters:  &lt;/p&gt;  &lt;ul&gt;   &lt;li&gt;&lt;b&gt;Endpoint&lt;/b&gt;: address of the Rest PKI Core instance that will be used&lt;/li&gt;   &lt;li&gt;&lt;b&gt;API Key&lt;/b&gt;: authorization key for using the API&lt;/li&gt;  &lt;/ul&gt;  &lt;p&gt;   The &lt;span class&#x3D;\&quot;model\&quot;&gt;endpoint&lt;/span&gt; must be prefixed to all relative URLs mentioned here. As for the &lt;span class&#x3D;\&quot;model\&quot;&gt;API Key&lt;/span&gt;, see how to use it below.  &lt;/p&gt;    &lt;h2&gt;Authentication&lt;/h2&gt;  &lt;p&gt;   The API key must be sent on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Api-Key&lt;/span&gt; header on each request:  &lt;/p&gt;    &lt;!-- unfortunately, class \&quot;example microlight\&quot; doesn&#39;t seem to work here --&gt;  &lt;pre style&#x3D;\&quot;font-size: 12px; padding: 10px; border-radius: 4px; background: #41444e; font-weight: 600; color: #fff;\&quot;&gt;  X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  &lt;/pre&gt;    &lt;h2&gt;HTTP Codes&lt;/h2&gt;    &lt;p&gt;   The APIs will return the following HTTP codes:  &lt;/p&gt;    &lt;table&gt;   &lt;thead&gt;    &lt;tr&gt;     &lt;th&gt;Code&lt;/th&gt;     &lt;th&gt;Description&lt;/th&gt;    &lt;/tr&gt;   &lt;/thead&gt;   &lt;tbody&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;200 (OK)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;Request processed successfully. The response is different for each API, please refer to the operation&#39;s documentation&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;400 (Bad Request)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;Syntax error. For instance, when a required field was not provided&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;401 (Unauthorized)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;API key not provided or invalid&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;403 (Forbidden)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;API key is valid, but the application has insufficient permissions to complete the requested operation&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;422 (Unprocessable Entity)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;API error. The response body is an &lt;a href&#x3D;\&quot;#model-ErrorModelV2\&quot; class&#x3D;\&quot;model\&quot;&gt;ErrorModelV2&lt;/a&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;500 (Internal Server Error)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;An unexpected error occurred. The &lt;span class&#x3D;\&quot;model\&quot;&gt;exceptionCode&lt;/span&gt; contained on the response body may be of help for our support team during diagnostic.&lt;/td&gt;    &lt;/tr&gt;   &lt;/tbody&gt;  &lt;/table&gt;    &lt;h3&gt;Error Codes&lt;/h3&gt;    &lt;p&gt;   Some of the error codes returned in the &lt;span class&#x3D;\&quot;model\&quot;&gt;code&lt;/span&gt; field of an &lt;a href&#x3D;\&quot;#model-ErrorModelV2\&quot; class&#x3D;\&quot;model\&quot;&gt;ErrorModelV2&lt;/a&gt;   (body of responses with HTTP status code 422) are provided below*:  &lt;/p&gt;    &lt;table&gt;   &lt;thead&gt;    &lt;tr&gt;     &lt;th&gt;Code&lt;/th&gt;     &lt;th&gt;Description&lt;/th&gt;    &lt;/tr&gt;   &lt;/thead&gt;   &lt;tbody&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;DocumentNotFound&lt;/td&gt;     &lt;td&gt;A referenced document was not found (check the document ID)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;SecurityContextNotFound&lt;/td&gt;     &lt;td&gt;A referenced security context was not found (check the security context ID)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;SignatureSessionNotFound&lt;/td&gt;     &lt;td&gt;A referenced signature session was not found (check the signature session ID)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;BadSignatureSessionOperation&lt;/td&gt;     &lt;td&gt;The operation is invalid for the current signature session or document status. For instance, trying to await the session&#39;s completion if it is still &lt;span class&#x3D;\&quot;model\&quot;&gt;Pending&lt;/span&gt; results in this error&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;BackgroundProcessing&lt;/td&gt;     &lt;td&gt;The operation cannot be completed at this time because the resource is being processed in background&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;SignatureSessionTokenRequired&lt;/td&gt;     &lt;td&gt;The signature session token was not passed on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Signature-Session-Token&lt;/span&gt; request header&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;BadSignatureSessionToken&lt;/td&gt;     &lt;td&gt;An invalid signature session token was passed on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Signature-Session-Token&lt;/span&gt; request header. Check your application for possible corruption of the session token, which may contain characters &lt;span class&#x3D;\&quot;code\&quot;&gt;-&lt;/span&gt; (hyphen) and &lt;span class&#x3D;\&quot;code\&quot;&gt;_&lt;/span&gt; (underscore)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;ExpiredSignatureSessionToken&lt;/td&gt;     &lt;td&gt;An expired signature session token was passed on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Signature-Session-Token&lt;/span&gt; request header. Signature session tokens are normally valid for 4 hours.&lt;/td&gt;    &lt;/tr&gt;   &lt;/tbody&gt;  &lt;/table&gt;    &lt;p style&#x3D;\&quot;font-size: 0.9em\&quot;&gt;   *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.  &lt;/p&gt;    &lt;h2&gt;Culture / Internationalization (i18n)&lt;/h2&gt;  &lt;p&gt;The &lt;span class&#x3D;\&quot;model\&quot;&gt;Accept-Language&lt;/span&gt; request header is observed by this API. The following cultures are supported:&lt;/p&gt;  &lt;ul&gt;   &lt;li&gt;&lt;span class&#x3D;\&quot;code\&quot;&gt;en-US&lt;/span&gt; (or simply &lt;span class&#x3D;\&quot;code\&quot;&gt;en&lt;/span&gt;)&lt;/li&gt;   &lt;li&gt;&lt;span class&#x3D;\&quot;code\&quot;&gt;pt-BR&lt;/span&gt; (or simply &lt;span class&#x3D;\&quot;code\&quot;&gt;pt&lt;/span&gt;)&lt;/li&gt;  &lt;/ul&gt;  &lt;p&gt;&lt;i&gt;Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.&lt;/i&gt;&lt;/p&gt;  
     

restpki_ng_python_client-0.9.2rc1/README.md

@@ -0,0 +1,93 @@
+# Python RestPkiCore Lib Auto Generation
+This is a comprehensive tutorial to assist new developers when generating the lib again. This lib is generated with the help of [OpenAPI's Python Generator](https://openapi-generator.tech/docs/generators/python).
+
+## Project Structure
+As seen in the first command line in `cmd.ps1`, the output folder for all generated files is the `dist` folder. Therefore, all files in this folder will be automatically overwritten during generation. So it is important to have **static proprietary modules**. Static proprietary modules are modules which are not in the library generation but are necessary for it to work completely, such as the `RestPkiClient` class inside `restpki_ng_client.py`.
+
+After generation, the project structure is as follows:
+```
+└── 📁restpkicore-python
+    └── 00.pdf
+    └── cmd.ps1
+    └── openapitools.json
+    └── python-openapi-config.json
+    └── README.md
+    └── restpki_ng_client.py
+    └── 📁test
+        └── ...
+        └── __init__.py
+    └── 📁dist
+        └── 📁.github
+            └── 📁workflows
+                └── python.yml
+        └── 📁.openapi-generator
+            └── FILES
+            └── VERSION
+        └── 📁docs
+            └── ...*.md
+        └── 📁restpki_ng_python_client
+            └── 📁api
+                └── ...*.py
+                └── __init__.py
+            └── 📁models
+                └── ...*.py
+                └── __init__.py
+            └── api_client.py
+            └── api_response.py
+            └── configuration.py
+            └── exceptions.py
+            └── py.typed
+            └── rest.py
+            └── restpki_ng_client.py
+            └── __init__.py
+        └── 📁test
+            └── ...*.py
+            └── __init__.py
+        └── setup.cfg
+        └── setup.py
+        └── test-requirements.txt
+        └── tox.ini
+        └── git_push.sh
+        └── pyproject.toml
+        └── README.md
+        └── requirements.txt
+        └── .openapi-generator-ignore
+        └── .travis.yml    
+        └── .gitignore
+        └── .gitlab-ci.yml
+```
+
+### Local files
+Local files are outside the dist folder, some of them are:
+* `00.pdf`: Sample PDF to perform _ad-hoc_ signatures
+* `cmd.ps1`: PowerShell script to run the `cmd.ps1`, which is the file which contains automated steps such as:
+1. Generating the lib using OpenAPI CLI with the configurations defined `python-openapi-config.json` (you may define new configurations as you need them, **but be aware of the new effects it may cause in this generation**)
+2. Copying static proprietary modules. You are also free to add new files and copy them into the restpki_ng_python_client new steps to the `cmd.ps1` script whenever necessary. Just remember to document all new files and define their use in the project.
+* `restpki_ng_client.py`: This is an example of static proprietary module file. This class contains a facade class which directly calls the APIs in the `dist/api` folder and gives them a more user-friendly name.
+
+### Generated folder (`dist`)
+The `dist` folder contains the generated files and the static proprietary modules from `cmd.ps1`. It is recommended to only add necessary files for the library and its functions. The `dist` folder contains
+* An API folder, which is comprised of all endpoints as individual modules.
+* Models folder, which contains all models generated from the specification.
+* `gitlab-ci.yml`: Gitlab's CI file to test in different versions of Python.
+
+
+## Steps 
+### Generating and testing the library
+1. Run `cmd.ps1`
+2. Test your application, for that we have a copy of the `test` folder outside of the `dist` folder which must overwrite the `dist/test` folder with populated tests. The tests are also kept outside the dist folder so they are not overwritten during the generation process. 
+* Copy and overwrite the `test` folder into `dist/test`.
+* Test all modules using `pytest`, you also may test one at a time by running `pytest [filename.py]`
+3. Run `python setup.py install` in the `dist` folder. This will generate a local library in your python modules as if it is already installed on your machine. However, you still need to publish it 
+
+### Publishing
+
+TODO
+
+### Adding new files to the project
+Adding new files is not a complex task, but it requires attention from the devs as not to break previous functionalities, so **it is vital to test them before publishing**. For this project, only integration tests were made available with only a test case for each endpoint. The tests do not cover
+* Unit tests;
+* Value range;
+* Required values (those are inferred from the Swagger specification);
+
+ In case you need to test a new functionality, add a new test case in the class and run it again. In case of a breaking change (i.e. a change which needs to be applied to previous test cases for them to work again), you might want to refactor previous tests and others affected from this change. Once you get them all working again, release a new version  

{restpki_ng_python_client-0.9.0.1/restpki_ng_python_client → restpki_ng_python_client-0.9.2rc1/manually_generated_files}/restpki_ng_client.py

@@ -10,7 +10,7 @@ from io import BufferedReader, BytesIO
 import io
 import os
 import ssl
-from typing import Dict, List
+from typing import Dict, List, Union
 from restpki_ng_python_client.rest import RESTResponse
 from restpki_ng_python_client.configuration import Configuration
 from restpki_ng_python_client.api_client import ApiClient
@@ -284,11 +284,17 @@ class RestPkiClient:
     # Upload
 
     # public methods
-    def upload_file_multipart(self, file_desc: BufferedReader | BytesIO | str):
+    def upload_file_multipart(self, file_desc: Union[BufferedReader,BytesIO,str]):
+        if not isinstance(file_desc, BufferedReader) or not isinstance(file_desc, BytesIO) or not isinstance(file_desc, str):
+            raise TypeError("File is not a valid type, it must be a instance of BufferedReader, BytesIO or string")
+
         blob_token = self._upload_multipart(file_desc)
         return blob_token
     
-    def upload_file_plain(self, file_path: str, file_desc: BufferedReader | BytesIO | str):
+    def upload_file_plain(self, file_path: str, file_desc: Union[BufferedReader,BytesIO,str]):
+        if not isinstance(file_desc, BufferedReader) or not isinstance(file_desc, BytesIO) or not isinstance(file_desc, str):
+            raise TypeError("File is not a valid type, it must be a instance of BufferedReader, BytesIO or string")
+
         blob_token = self._perform_plain_uploads(file_path, file_desc)
         return blob_token
 

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/restpki_ng_python_client.egg-info/PKG-INFO

@@ -1,16 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: restpki_ng_python_client
-Version: 0.9.0.1
+Version: 0.9.2rc1
 Summary: Rest PKI Core API
 Home-page: 
 Author: OpenAPI Generator community
 Author-email: team@openapitools.org
 Keywords: OpenAPI,OpenAPI-Generator,Rest PKI Core API
 Description-Content-Type: text/markdown
-Requires-Dist: urllib3<2.1.0,>=1.25.11
+Requires-Dist: urllib3<2.1.0,>=1.24.3
 Requires-Dist: python-dateutil
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
 
     &lt;b&gt;&lt;i&gt;Para Português, &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/pt-br/articles/rest-pki/core/integration/get-started\&quot;&gt;clique aqui&lt;/a&gt;&lt;/i&gt;&lt;/b&gt;  &lt;p&gt;   &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/\&quot;&gt;Rest PKI Core&lt;/a&gt; is an upcoming version of   &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/en-us/articles/rest-pki/\&quot;&gt;Rest PKI&lt;/a&gt; that will have extended compatibility with environments and databases.  &lt;/p&gt;  &lt;p&gt;   In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on &lt;b&gt;Linux&lt;/b&gt; (Debian- and RedHat-based distributions)   and on &lt;b&gt;Docker&lt;/b&gt;. As for database servers, in addition to SQL Server, &lt;b&gt;PostgreSQL&lt;/b&gt; will also be supported.  &lt;/p&gt;  &lt;p&gt;   &lt;b&gt;Before getting started, see the integration overview on the &lt;a href&#x3D;\&quot;https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/\&quot;&gt;Integration Guide&lt;/a&gt;&lt;/b&gt;  &lt;/p&gt;  &lt;p&gt;   For questions regarding the usage of this API, please reach us at &lt;a href&#x3D;\&quot;https://lacuna.help/\&quot;&gt;lacuna.help&lt;/a&gt;  &lt;/p&gt;    &lt;h2&gt;Parameters&lt;/h2&gt;  &lt;p&gt;   You will need the following parameters:  &lt;/p&gt;  &lt;ul&gt;   &lt;li&gt;&lt;b&gt;Endpoint&lt;/b&gt;: address of the Rest PKI Core instance that will be used&lt;/li&gt;   &lt;li&gt;&lt;b&gt;API Key&lt;/b&gt;: authorization key for using the API&lt;/li&gt;  &lt;/ul&gt;  &lt;p&gt;   The &lt;span class&#x3D;\&quot;model\&quot;&gt;endpoint&lt;/span&gt; must be prefixed to all relative URLs mentioned here. As for the &lt;span class&#x3D;\&quot;model\&quot;&gt;API Key&lt;/span&gt;, see how to use it below.  &lt;/p&gt;    &lt;h2&gt;Authentication&lt;/h2&gt;  &lt;p&gt;   The API key must be sent on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Api-Key&lt;/span&gt; header on each request:  &lt;/p&gt;    &lt;!-- unfortunately, class \&quot;example microlight\&quot; doesn&#39;t seem to work here --&gt;  &lt;pre style&#x3D;\&quot;font-size: 12px; padding: 10px; border-radius: 4px; background: #41444e; font-weight: 600; color: #fff;\&quot;&gt;  X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  &lt;/pre&gt;    &lt;h2&gt;HTTP Codes&lt;/h2&gt;    &lt;p&gt;   The APIs will return the following HTTP codes:  &lt;/p&gt;    &lt;table&gt;   &lt;thead&gt;    &lt;tr&gt;     &lt;th&gt;Code&lt;/th&gt;     &lt;th&gt;Description&lt;/th&gt;    &lt;/tr&gt;   &lt;/thead&gt;   &lt;tbody&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;200 (OK)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;Request processed successfully. The response is different for each API, please refer to the operation&#39;s documentation&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;400 (Bad Request)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;Syntax error. For instance, when a required field was not provided&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;401 (Unauthorized)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;API key not provided or invalid&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;403 (Forbidden)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;API key is valid, but the application has insufficient permissions to complete the requested operation&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;422 (Unprocessable Entity)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;API error. The response body is an &lt;a href&#x3D;\&quot;#model-ErrorModelV2\&quot; class&#x3D;\&quot;model\&quot;&gt;ErrorModelV2&lt;/a&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td&gt;&lt;strong class&#x3D;\&quot;model-title\&quot;&gt;500 (Internal Server Error)&lt;/strong&gt;&lt;/td&gt;     &lt;td&gt;An unexpected error occurred. The &lt;span class&#x3D;\&quot;model\&quot;&gt;exceptionCode&lt;/span&gt; contained on the response body may be of help for our support team during diagnostic.&lt;/td&gt;    &lt;/tr&gt;   &lt;/tbody&gt;  &lt;/table&gt;    &lt;h3&gt;Error Codes&lt;/h3&gt;    &lt;p&gt;   Some of the error codes returned in the &lt;span class&#x3D;\&quot;model\&quot;&gt;code&lt;/span&gt; field of an &lt;a href&#x3D;\&quot;#model-ErrorModelV2\&quot; class&#x3D;\&quot;model\&quot;&gt;ErrorModelV2&lt;/a&gt;   (body of responses with HTTP status code 422) are provided below*:  &lt;/p&gt;    &lt;table&gt;   &lt;thead&gt;    &lt;tr&gt;     &lt;th&gt;Code&lt;/th&gt;     &lt;th&gt;Description&lt;/th&gt;    &lt;/tr&gt;   &lt;/thead&gt;   &lt;tbody&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;DocumentNotFound&lt;/td&gt;     &lt;td&gt;A referenced document was not found (check the document ID)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;SecurityContextNotFound&lt;/td&gt;     &lt;td&gt;A referenced security context was not found (check the security context ID)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;SignatureSessionNotFound&lt;/td&gt;     &lt;td&gt;A referenced signature session was not found (check the signature session ID)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;BadSignatureSessionOperation&lt;/td&gt;     &lt;td&gt;The operation is invalid for the current signature session or document status. For instance, trying to await the session&#39;s completion if it is still &lt;span class&#x3D;\&quot;model\&quot;&gt;Pending&lt;/span&gt; results in this error&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;BackgroundProcessing&lt;/td&gt;     &lt;td&gt;The operation cannot be completed at this time because the resource is being processed in background&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;SignatureSessionTokenRequired&lt;/td&gt;     &lt;td&gt;The signature session token was not passed on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Signature-Session-Token&lt;/span&gt; request header&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;BadSignatureSessionToken&lt;/td&gt;     &lt;td&gt;An invalid signature session token was passed on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Signature-Session-Token&lt;/span&gt; request header. Check your application for possible corruption of the session token, which may contain characters &lt;span class&#x3D;\&quot;code\&quot;&gt;-&lt;/span&gt; (hyphen) and &lt;span class&#x3D;\&quot;code\&quot;&gt;_&lt;/span&gt; (underscore)&lt;/td&gt;    &lt;/tr&gt;    &lt;tr&gt;     &lt;td class&#x3D;\&quot;model\&quot;&gt;ExpiredSignatureSessionToken&lt;/td&gt;     &lt;td&gt;An expired signature session token was passed on the &lt;span class&#x3D;\&quot;model\&quot;&gt;X-Signature-Session-Token&lt;/span&gt; request header. Signature session tokens are normally valid for 4 hours.&lt;/td&gt;    &lt;/tr&gt;   &lt;/tbody&gt;  &lt;/table&gt;    &lt;p style&#x3D;\&quot;font-size: 0.9em\&quot;&gt;   *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.  &lt;/p&gt;    &lt;h2&gt;Culture / Internationalization (i18n)&lt;/h2&gt;  &lt;p&gt;The &lt;span class&#x3D;\&quot;model\&quot;&gt;Accept-Language&lt;/span&gt; request header is observed by this API. The following cultures are supported:&lt;/p&gt;  &lt;ul&gt;   &lt;li&gt;&lt;span class&#x3D;\&quot;code\&quot;&gt;en-US&lt;/span&gt; (or simply &lt;span class&#x3D;\&quot;code\&quot;&gt;en&lt;/span&gt;)&lt;/li&gt;   &lt;li&gt;&lt;span class&#x3D;\&quot;code\&quot;&gt;pt-BR&lt;/span&gt; (or simply &lt;span class&#x3D;\&quot;code\&quot;&gt;pt&lt;/span&gt;)&lt;/li&gt;  &lt;/ul&gt;  &lt;p&gt;&lt;i&gt;Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.&lt;/i&gt;&lt;/p&gt;  
     

restpki_ng_python_client-0.9.2rc1/restpki_ng_python_client.egg-info/SOURCES.txt

@@ -0,0 +1,179 @@
+README.md
+setup.py
+manually_generated_files/file_utils.py
+manually_generated_files/restpki_ng_client.py
+manually_generated_files/standard_signature_policies.py
+manually_generated_files/utils.py
+manually_generated_files/api/upload_api.py
+manually_generated_files/models/pdf_container_definition.py
+manually_generated_files/models/pdf_helper.py
+manually_generated_files/models/pdf_mark_element_model.py
+manually_generated_files/models/pdf_mark_model.py
+manually_generated_files/models/pdf_text_section_model.py
+restpki_ng_python_client.egg-info/PKG-INFO
+restpki_ng_python_client.egg-info/SOURCES.txt
+restpki_ng_python_client.egg-info/dependency_links.txt
+restpki_ng_python_client.egg-info/requires.txt
+restpki_ng_python_client.egg-info/top_level.txt
+test/test_allocate_document_key_batch_request.py
+test/test_allocate_document_key_request.py
+test/test_attribute_certificate_model.py
+test/test_audit_package_options.py
+test/test_authentication_api.py
+test/test_authentication_failures.py
+test/test_authentication_get_response.py
+test/test_authentication_post_request.py
+test/test_authentication_post_response.py
+test/test_authentications_post_request.py
+test/test_authentications_post_response.py
+test/test_authentications_post_signed_bytes_request.py
+test/test_authentications_post_signed_bytes_response.py
+test/test_auto_positioning_horizontal_directions.py
+test/test_auto_positioning_vertical_directions.py
+test/test_blockchains.py
+test/test_cades_signature_api.py
+test/test_cades_signature_model.py
+test/test_cades_signature_post_request_v1.py
+test/test_cades_signature_post_request_v2.py
+test/test_cades_signature_post_request_v3.py
+test/test_cades_signature_post_response.py
+test/test_cades_signature_post_signed_bytes_request.py
+test/test_cades_signature_post_signed_bytes_response.py
+test/test_cades_signer_model.py
+test/test_cades_timestamp_model.py
+test/test_certificate_model.py
+test/test_certificate_reference_model.py
+test/test_certificate_requirement.py
+test/test_certificate_requirement_types.py
+test/test_certificate_summary.py
+test/test_certified_attribute_model.py
+test/test_certified_attribute_types.py
+test/test_cms_content_types.py
+test/test_cms_signature_options.py
+test/test_color_model.py
+test/test_commitment_type_model.py
+test/test_complete_authentication_request.py
+test/test_complete_authentication_response.py
+test/test_complete_signature_request.py
+test/test_complete_signature_request_v2.py
+test/test_create_signature_session_request.py
+test/test_create_signature_session_response.py
+test/test_digest_algorithm_and_value_model.py
+test/test_digest_algorithms.py
+test/test_document_file_model.py
+test/test_document_key_model.py
+test/test_document_key_query_response.py
+test/test_document_key_summary.py
+test/test_document_keys_api.py
+test/test_document_model.py
+test/test_document_query_response.py
+test/test_document_status.py
+test/test_document_summary.py
+test/test_documents_api.py
+test/test_error_model_v2.py
+test/test_file_model.py
+test/test_file_reference_model.py
+test/test_full_xml_signature_post_request.py
+test/test_general_name_choices.py
+test/test_general_name_model.py
+test/test_holder_types.py
+test/test_inspect_signature_failures.py
+test/test_inspect_signature_request.py
+test/test_inspect_signature_response.py
+test/test_multipart_upload_begin_response.py
+test/test_multipart_upload_end_request.py
+test/test_name_model.py
+test/test_namespace_model.py
+test/test_open_cades_signature_request_model.py
+test/test_open_signature_request_model.py
+test/test_open_xml_signature_request_model.py
+test/test_other_name_model.py
+test/test_pades_certification_level.py
+test/test_pades_horizontal_align.py
+test/test_pades_measurement_units.py
+test/test_pades_page_optimization_model.py
+test/test_pades_signature_api.py
+test/test_pades_signature_model.py
+test/test_pades_signature_post_request_v1.py
+test/test_pades_signature_post_request_v2.py
+test/test_pades_signature_post_response.py
+test/test_pades_signature_post_signed_bytes_request.py
+test/test_pades_signature_post_signed_bytes_response.py
+test/test_pades_signer_model.py
+test/test_pades_size_model.py
+test/test_pades_text_horizontal_align.py
+test/test_pades_vertical_align.py
+test/test_pades_visual_auto_positioning_model.py
+test/test_pades_visual_image_model.py
+test/test_pades_visual_positioning_model.py
+test/test_pades_visual_positioning_presets_api.py
+test/test_pades_visual_rectangle_model.py
+test/test_pades_visual_representation_model.py
+test/test_pades_visual_text_model.py
+test/test_page_orientations.py
+test/test_paper_sizes.py
+test/test_pdf_add_marks_request.py
+test/test_pdf_add_marks_response.py
+test/test_pdf_api.py
+test/test_pdf_mark_element_model.py
+test/test_pdf_mark_element_type.py
+test/test_pdf_mark_image_model.py
+test/test_pdf_mark_model.py
+test/test_pdf_mark_page_options.py
+test/test_pdf_signature_options.py
+test/test_pdf_text_section_model.py
+test/test_pdf_text_style.py
+test/test_pki_brazil_certificate_model.py
+test/test_pki_brazil_certificate_types.py
+test/test_pki_italy_certificate_model.py
+test/test_pki_italy_certificate_types.py
+test/test_prepare_authentication_request.py
+test/test_prepare_authentication_response.py
+test/test_prepare_signature_failures.py
+test/test_prepare_signature_request.py
+test/test_prepare_signature_response.py
+test/test_resource_content_or_reference.py
+test/test_role_attribute_model.py
+test/test_session_completion_status.py
+test/test_signature_algorithm_and_value_model.py
+test/test_signature_algorithm_identifier.py
+test/test_signature_algorithms.py
+test/test_signature_api.py
+test/test_signature_b_stamp_model.py
+test/test_signature_inspection_api.py
+test/test_signature_policy_identifier_model.py
+test/test_signature_result_model.py
+test/test_signature_session_document_data.py
+test/test_signature_session_document_summary.py
+test/test_signature_session_model.py
+test/test_signature_session_status.py
+test/test_signature_sessions_api.py
+test/test_signature_types.py
+test/test_signer_b_stamp_model.py
+test/test_signer_model.py
+test/test_signer_summary.py
+test/test_timestamp_api.py
+test/test_timestamp_issue_response.py
+test/test_upload_api.py
+test/test_validation_item_model.py
+test/test_validation_item_types.py
+test/test_validation_results_model.py
+test/test_webhook_event_model.py
+test/test_webhook_event_types.py
+test/test_xml_attribute_model.py
+test/test_xml_element_location_model.py
+test/test_xml_element_model.py
+test/test_xml_element_signature_post_request.py
+test/test_xml_id_attribute_model.py
+test/test_xml_id_resolution_table_model.py
+test/test_xml_insertion_options.py
+test/test_xml_node_name_model.py
+test/test_xml_signature_api.py
+test/test_xml_signature_model.py
+test/test_xml_signature_options.py
+test/test_xml_signature_post_response.py
+test/test_xml_signature_post_signed_bytes_request.py
+test/test_xml_signature_post_signed_bytes_response.py
+test/test_xml_signature_response_model.py
+test/test_xml_signature_types.py
+test/test_xml_signed_entity_types.py

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/restpki_ng_python_client.egg-info/requires.txt

@@ -1,4 +1,4 @@
-urllib3<2.1.0,>=1.25.11
+urllib3<2.1.0,>=1.24.3
 python-dateutil
 pydantic>=2
 typing-extensions>=4.7.1

restpki_ng_python_client-0.9.2rc1/restpki_ng_python_client.egg-info/top_level.txt

@@ -0,0 +1 @@
+manually_generated_files

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/setup.cfg

@@ -1,6 +1,3 @@
-[flake8]
-max-line-length = 99
-
 [egg_info]
 tag_build = 
 tag_date = 0

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/setup.py

@@ -21,10 +21,10 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "restpki_ng_python_client"
-VERSION = "0.9.0.1"
+VERSION = "0.9.2-rc1"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
-    "urllib3 >= 1.25.11, < 2.1.0",
+    "urllib3<2.1.0,>=1.24.3",
     "python-dateutil",
     "pydantic >= 2",
     "typing-extensions >= 4.7.1",
@@ -39,7 +39,7 @@ setup(
     url="",
     keywords=["OpenAPI", "OpenAPI-Generator", "Rest PKI Core API"],
     install_requires=REQUIRES,
-    packages=find_packages(exclude=["test", "tests"]),
+    # packages=find_packages(exclude=["test", "tests"]),
     include_package_data=True,
     long_description_content_type='text/markdown',
     long_description="""\

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/test/test_authentication_api.py

@@ -15,6 +15,7 @@
 import unittest
 
 from restpki_ng_python_client.api.authentication_api import AuthenticationApi
+from restpki_ng_python_client.api import *
 
 
 class TestAuthenticationApi(unittest.TestCase):

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/test/test_pades_signature_api.py

@@ -14,7 +14,6 @@
 
 import base64
 import unittest
-from restpki_ng_python_client.exceptions import ApiException
 
 from restpki_ng_python_client.models.pades_signature_post_response import PadesSignaturePostResponse
 
@@ -58,13 +57,9 @@ class TestPadesSignatureApi(unittest.TestCase):
             visual_representation=None
                 )
             res = self.api.start_pades_signature_v2(pades_sig_v2)
-            assert isinstance(res, PadesSignaturePostResponse)
-            assert res.certificate.thumbprint == certThumb
-            
+            return res
         except ApiException as e:
             print(e)
-        # check if response is an instance of PadesSignaturePostResponse
-            
         
 
     def test_api_pades_signatures_post(self) -> None:

{restpki_ng_python_client-0.9.0.1 → restpki_ng_python_client-0.9.2rc1}/test/test_signature_sessions_api.py

@@ -13,15 +13,75 @@
 
 
 import unittest
+import datetime
+import base64
+import threading
+import http.server
+import socketserver
+import urllib.parse
+import time
+import os
 
 from restpki_ng_python_client.api.signature_sessions_api import SignatureSessionsApi
-
+from restpki_ng_python_client.models.create_signature_session_request import CreateSignatureSessionRequest
+from restpki_ng_python_client.models.signature_session_document_data import SignatureSessionDocumentData
+from restpki_ng_python_client.models.file_reference_model import FileReferenceModel
+from restpki_ng_python_client.models.pdf_signature_options import PdfSignatureOptions
+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.pades_visual_rectangle_model import PadesVisualRectangleModel
+from restpki_ng_python_client.models.pades_visual_positioning_model import PadesVisualPositioningModel
+from restpki_ng_python_client.models.pades_visual_auto_positioning_model import PadesVisualAutoPositioningModel
+from restpki_ng_python_client.models.pades_size_model import PadesSizeModel
+from restpki_ng_python_client.models.pades_page_optimization_model import PadesPageOptimizationModel
+from restpki_ng_python_client.models.pades_measurement_units import PadesMeasurementUnits
+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.auto_positioning_horizontal_directions import AutoPositioningHorizontalDirections
+from restpki_ng_python_client.models.auto_positioning_vertical_directions import AutoPositioningVerticalDirections
+from restpki_ng_python_client.models.signature_types import SignatureTypes
+from test import rest_pki_client
+
+class CallbackHandler(http.server.SimpleHTTPRequestHandler):
+    """Handler for the callback URL"""
+    callback_received = False
+    callback_data = None
+
+    def do_GET(self):
+        """Handle GET request to the callback URL"""
+        # Parse the query parameters
+        query_components = urllib.parse.parse_qs(urllib.parse.urlparse(self.path).query)
+        
+        # Store the callback data
+        CallbackHandler.callback_received = True
+        CallbackHandler.callback_data = query_components
+        
+        # Send response
+        self.send_response(200)
+        self.send_header('Content-type', 'text/html')
+        self.end_headers()
+        self.wfile.write(b"Callback received successfully!")
+
+def start_callback_server(port=8000):
+    """Start a local HTTP server to handle the callback"""
+    handler = CallbackHandler
+    with socketserver.TCPServer(("", port), handler) as httpd:
+        print(f"Serving at port {port}")
+        httpd.serve_forever()
 
 class TestSignatureSessionsApi(unittest.TestCase):
     """SignatureSessionsApi unit test stubs"""
 
+    @classmethod
+    def setUpClass(cls):
+        # Start the callback server in a separate thread
+        cls.server_thread = threading.Thread(target=start_callback_server, daemon=True)
+        cls.server_thread.start()
+        # Give the server a moment to start
+        time.sleep(1)
+
     def setUp(self) -> None:
-        self.api = SignatureSessionsApi()
+        pass
 
     def tearDown(self) -> None:
         pass
@@ -45,7 +105,40 @@ class TestSignatureSessionsApi(unittest.TestCase):
 
         Creates a signature session
         """
-        pass
+        # Create a sample PDF file content (minimal valid PDF)
+        pdf_content = base64.b64encode(b'%PDF-1.4\n1 0 obj\n<<>>\nendobj\ntrailer\n<<>>\n%%EOF').decode('utf-8')
+
+        # Create the request
+        request = CreateSignatureSessionRequest(
+            return_url='http://localhost:8000/callback'
+        )
+
+        # Call the API
+        response = rest_pki_client.create_signature_session(create_signature_session_request=request)
+
+        # Assert the response
+        self.assertIsNotNone(response)
+        self.assertIsNotNone(response.session_id)
+        self.assertIsNotNone(response.redirect_url)
+        self.assertTrue(response.redirect_url.startswith('http'))
+
+        # Print the redirect URL for manual testing
+        print(f"\nPlease visit this URL to complete the signature: {response.redirect_url}")
+        print("The callback server is running at http://localhost:8000/callback")
+        print("Press Ctrl+C to stop the test when done\n")
+
+        # Wait for callback (with timeout)
+        timeout = 300  # 5 minutes timeout
+        start_time = time.time()
+        while not CallbackHandler.callback_received:
+            if time.time() - start_time > timeout:
+                self.fail("Timeout waiting for callback")
+            time.sleep(1)
+
+        # Verify callback data
+        self.assertTrue(CallbackHandler.callback_received)
+        self.assertIsNotNone(CallbackHandler.callback_data)
+        print(f"Callback received with data: {CallbackHandler.callback_data}")
 
 
 if __name__ == '__main__':