add documentation

docs/README.md

@@ -4,44 +4,15 @@
 
 ## Modules
 
-- [`data_models`](./data_models.md#module-data_models)
-- [`environments`](./environments.md#module-environments)
-- [`nvm_backend`](./nvm_backend.md#module-nvm_backend)
-- [`payments`](./payments.md#module-payments)
-- [`utils`](./utils.md#module-utils)
+- No modules
 
 ## Classes
 
-- [`data_models.AgentExecutionStatus`](./data_models.md#class-agentexecutionstatus): An enumeration.
-- [`data_models.Artifact`](./data_models.md#class-artifact)
-- [`data_models.BalanceResultDto`](./data_models.md#class-balanceresultdto)
-- [`data_models.BurnResultDto`](./data_models.md#class-burnresultdto)
-- [`data_models.CreateAssetResultDto`](./data_models.md#class-createassetresultdto)
-- [`data_models.DownloadFileResultDto`](./data_models.md#class-downloadfileresultdto)
-- [`data_models.ExecutionInput`](./data_models.md#class-executioninput)
-- [`data_models.ExecutionOptions`](./data_models.md#class-executionoptions)
-- [`data_models.ExecutionOutput`](./data_models.md#class-executionoutput)
-- [`data_models.MintResultDto`](./data_models.md#class-mintresultdto)
-- [`data_models.OrderPlanResultDto`](./data_models.md#class-orderplanresultdto)
-- [`data_models.PlanType`](./data_models.md#class-plantype): An enumeration.
-- [`data_models.SearchSteps`](./data_models.md#class-searchsteps)
-- [`data_models.SearchTasks`](./data_models.md#class-searchtasks)
-- [`data_models.ServiceTokenResultDto`](./data_models.md#class-servicetokenresultdto)
-- [`data_models.Step`](./data_models.md#class-step)
-- [`data_models.Task`](./data_models.md#class-task)
-- [`data_models.TaskLog`](./data_models.md#class-tasklog)
-- [`environments.Environment`](./environments.md#class-environment): Enum class to define the different environments
-- [`nvm_backend.BackendApiOptions`](./nvm_backend.md#class-backendapioptions): Represents the backend API options.
-- [`nvm_backend.NVMBackendApi`](./nvm_backend.md#class-nvmbackendapi)
-- [`payments.Payments`](./payments.md#class-payments): A class representing a payment system.
+- No classes
 
 ## Functions
 
-- [`utils.generate_step_id`](./utils.md#function-generate_step_id): Generate a random ID.
-- [`utils.get_ai_hub_open_api_url`](./utils.md#function-get_ai_hub_open_api_url): Get the AI Hub Open API URL.
-- [`utils.get_query_protocol_endpoints`](./utils.md#function-get_query_protocol_endpoints): Get the query protocol endpoints.
-- [`utils.is_id_valid`](./utils.md#function-is_id_valid): Check if the ID is valid.
-- [`utils.snake_to_camel`](./utils.md#function-snake_to_camel): Convert snake_case to camelCase.
+- No functions
 
 
 ---

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "payments-py"
-version = "0.5.4"
+version = "0.5.5"
 description = ""
 authors = ["enrique <enrique@nevermined.io>"]
 readme = "README.md"

site/index.html

@@ -103,44 +103,15 @@
 <h1 id="api-overview">API Overview</h1>
 <h2 id="modules">Modules</h2>
 <ul>
-<li><a href="data_models/#module-data_models"><code>data_models</code></a></li>
-<li><a href="environments/#module-environments"><code>environments</code></a></li>
-<li><a href="nvm_backend/#module-nvm_backend"><code>nvm_backend</code></a></li>
-<li><a href="payments/#module-payments"><code>payments</code></a></li>
-<li><a href="utils/#module-utils"><code>utils</code></a></li>
+<li>No modules</li>
 </ul>
 <h2 id="classes">Classes</h2>
 <ul>
-<li><a href="data_models/#class-agentexecutionstatus"><code>data_models.AgentExecutionStatus</code></a>: An enumeration.</li>
-<li><a href="data_models/#class-artifact"><code>data_models.Artifact</code></a></li>
-<li><a href="data_models/#class-balanceresultdto"><code>data_models.BalanceResultDto</code></a></li>
-<li><a href="data_models/#class-burnresultdto"><code>data_models.BurnResultDto</code></a></li>
-<li><a href="data_models/#class-createassetresultdto"><code>data_models.CreateAssetResultDto</code></a></li>
-<li><a href="data_models/#class-downloadfileresultdto"><code>data_models.DownloadFileResultDto</code></a></li>
-<li><a href="data_models/#class-executioninput"><code>data_models.ExecutionInput</code></a></li>
-<li><a href="data_models/#class-executionoptions"><code>data_models.ExecutionOptions</code></a></li>
-<li><a href="data_models/#class-executionoutput"><code>data_models.ExecutionOutput</code></a></li>
-<li><a href="data_models/#class-mintresultdto"><code>data_models.MintResultDto</code></a></li>
-<li><a href="data_models/#class-orderplanresultdto"><code>data_models.OrderPlanResultDto</code></a></li>
-<li><a href="data_models/#class-plantype"><code>data_models.PlanType</code></a>: An enumeration.</li>
-<li><a href="data_models/#class-searchsteps"><code>data_models.SearchSteps</code></a></li>
-<li><a href="data_models/#class-searchtasks"><code>data_models.SearchTasks</code></a></li>
-<li><a href="data_models/#class-servicetokenresultdto"><code>data_models.ServiceTokenResultDto</code></a></li>
-<li><a href="data_models/#class-step"><code>data_models.Step</code></a></li>
-<li><a href="data_models/#class-task"><code>data_models.Task</code></a></li>
-<li><a href="data_models/#class-tasklog"><code>data_models.TaskLog</code></a></li>
-<li><a href="environments/#class-environment"><code>environments.Environment</code></a>: Enum class to define the different environments</li>
-<li><a href="nvm_backend/#class-backendapioptions"><code>nvm_backend.BackendApiOptions</code></a>: Represents the backend API options.</li>
-<li><a href="nvm_backend/#class-nvmbackendapi"><code>nvm_backend.NVMBackendApi</code></a></li>
-<li><a href="payments/#class-payments"><code>payments.Payments</code></a>: A class representing a payment system.</li>
+<li>No classes</li>
 </ul>
 <h2 id="functions">Functions</h2>
 <ul>
-<li><a href="utils/#function-generate_step_id"><code>utils.generate_step_id</code></a>: Generate a random ID.</li>
-<li><a href="utils/#function-get_ai_hub_open_api_url"><code>utils.get_ai_hub_open_api_url</code></a>: Get the AI Hub Open API URL.</li>
-<li><a href="utils/#function-get_query_protocol_endpoints"><code>utils.get_query_protocol_endpoints</code></a>: Get the query protocol endpoints.</li>
-<li><a href="utils/#function-is_id_valid"><code>utils.is_id_valid</code></a>: Check if the ID is valid.</li>
-<li><a href="utils/#function-snake_to_camel"><code>utils.snake_to_camel</code></a>: Convert snake_case to camelCase.</li>
+<li>No functions</li>
 </ul>
 <hr />
 <p><em>This file was automatically generated via <a href="https://github.com/ml-tooling/lazydocs">lazydocs</a>.</em></p>
@@ -192,5 +163,5 @@ <h2 id="functions">Functions</h2>
 
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2024-11-12 12:45:12.229148+00:00
+Build Date UTC : 2025-01-08 12:24:21.114166+00:00
 -->

site/sitemap.xml

@@ -2,30 +2,30 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://github.com/nevermined-io/payments-py/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
     <url>
          <loc>https://github.com/nevermined-io/payments-py/ai_query_api/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
     <url>
          <loc>https://github.com/nevermined-io/payments-py/data_models/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
     <url>
          <loc>https://github.com/nevermined-io/payments-py/environments/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
     <url>
          <loc>https://github.com/nevermined-io/payments-py/nvm_backend/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
     <url>
          <loc>https://github.com/nevermined-io/payments-py/payments/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
     <url>
          <loc>https://github.com/nevermined-io/payments-py/utils/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2025-01-08</lastmod>
     </url>
 </urlset>