biatoolkit 1.2.1__tar.gz → 1.2.2__tar.gz

{biatoolkit-1.2.1 → biatoolkit-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: biatoolkit
-Version: 1.2.1
+Version: 1.2.2
 Summary: Biblioteca para desenvolvedores que utilizam o BiaAgentBuilder
 Author: Bia Platform Team
 Author-email: data.platform@sankhya.com.br
@@ -462,9 +462,58 @@ O Bia Toolkit oferece integração pronta para consumo de serviços HTTP da plat
 
 - **SankhyaSettings**: Dataclass de configuração de timeouts/retries/SSL. Use `SankhyaSettings.from_env()` para obter as configurações do ambiente.
 - **Sankhya**: Classe principal de integração. Permite instanciar com contexto MCP (`FastMCP`) ou usar métodos estáticos.
-    - `call_json(...)`: Realiza chamada HTTP autenticada, retorna JSON.
-    - `load_view(...)`: Helper para consultas a views Sankhya (`CRUDServiceProvider.loadView`).
-    - `Call(...)`: Método estático compatível com scaffolds legados.
+    - `call_json(...)`: Realiza chamada HTTP autenticada, retorna JSON. Veja detalhes dos parâmetros abaixo.
+    - `load_view(...)`: Helper para consultas a views Sankhya (`CRUDServiceProvider.loadView`). Veja detalhes dos parâmetros abaixo.
+    - `Call(...)`: Método estático compatível com scaffolds legados. Veja detalhes dos parâmetros abaixo.
+### Parâmetros dos métodos principais
+
+#### `call_json`
+
+| Parâmetro         | Obrigatório | Descrição |
+|-------------------|-------------|-----------|
+| payload           | Não         | Dicionário enviado como corpo da requisição (POST). Pode ser None. |
+| jsessionid        | Não         | Token de sessão JSESSIONID. Se não informado, tenta extrair do header do runtime (via MCP/BiaUtil). |
+| url               | Não         | URL completa para chamada. Se informado, ignora base_url. |
+| base_url          | Sim*        | Base URL do serviço Sankhya (ex: https://meu.sankhya.com.br). Obrigatório se não estiver em contexto MCP (header). |
+| query             | Não         | Querystring adicional (ex: serviceName=...&outputType=json). |
+| method            | Não         | "POST" (default) ou "GET". |
+| extra_headers     | Não         | Dicionário de headers adicionais. |
+| timeout           | Não         | Tupla (connect, read) para sobrescrever timeout padrão. |
+| raise_for_http_error | Não      | Se True (default), lança SankhyaHTTPError em erro HTTP. |
+
+*Se não passar base_url, o método tentará extrair automaticamente do header do runtime (MCP) se disponível. Caso contrário, será obrigatório.
+
+#### `load_view`
+
+| Parâmetro         | Obrigatório | Descrição |
+|-------------------|-------------|-----------|
+| view_name         | Sim         | Nome da view no Sankhya. |
+| where_sql         | Sim         | Cláusula WHERE (string). |
+| fields            | Não         | Campos a retornar (string). Default: "*". |
+| jsessionid        | Não         | Token de sessão JSESSIONID. Se não informado, tenta extrair do header do runtime (via MCP/BiaUtil). |
+| url               | Não         | URL completa opcional (override). |
+| base_url          | Não*        | Base URL do serviço Sankhya. Se não informado, tenta extrair do header do runtime (current_host). |
+| output_type       | Não         | "json" (default). |
+| extra_headers     | Não         | Dicionário de headers adicionais. |
+
+*Se não passar base_url, o método tentará extrair automaticamente do header do runtime (MCP) via BiaUtil. Caso não consiga, lança erro.
+
+#### `Call`
+
+| Parâmetro         | Obrigatório | Descrição |
+|-------------------|-------------|-----------|
+| jsessionID        | Não         | Token de sessão JSESSIONID. Se não informado, tenta extrair do header do runtime (via MCP/BiaUtil). |
+| payload           | Não         | Dicionário enviado como corpo da requisição. |
+| mcp               | Não         | Instância opcional do FastMCP para contexto do runtime. |
+| url               | Não         | URL completa (opcional). |
+| base_url          | Sim*        | Base URL do serviço Sankhya. Obrigatório se não estiver em contexto MCP (header). |
+| query             | Não         | Querystring adicional (opcional). |
+| method            | Não         | "POST" (default) ou "GET". |
+| extra_headers     | Não         | Dicionário de headers adicionais. |
+
+*Se não passar base_url, o método tentará extrair automaticamente do header do runtime (MCP) se disponível. Caso contrário, será obrigatório.
+
+**Resumo:** Sempre que possível, o toolkit resolve automaticamente base_url e jsessionid do contexto MCP (headers). Se não estiver rodando em MCP, passe base_url explicitamente.
 - **SankhyaHTTPError**: Exceção lançada em caso de erro HTTP (status != 200), contendo status_code e response_text.
 
 ### Exemplo de uso (instanciado)

{biatoolkit-1.2.1 → biatoolkit-1.2.2}/biatoolkit/sankhya_call.py

@@ -364,13 +364,15 @@ class Sankhya:
             },
         }
         
-
-        util = BiaUtil(self.mcp)
         # Se base_url não foi fornecido, tenta obter do util.get_header().current_host
         if not base_url:
-            base_url = util.get_header().current_host
-            if not base_url:
-                raise ValueError("base_url não definida e não foi possível obter current_host do header.")
+            util = BiaUtil(self.mcp)
+            header = util.get_header()
+            base_url = getattr(header, "current_host", None)
+
+        if not base_url:
+            raise ValueError("base_url não definida e não foi possível obter current_host do header.")
+
 
         return self.call_json(
             payload=body,

{biatoolkit-1.2.1 → biatoolkit-1.2.2}/biatoolkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: biatoolkit
-Version: 1.2.1
+Version: 1.2.2
 Summary: Biblioteca para desenvolvedores que utilizam o BiaAgentBuilder
 Author: Bia Platform Team
 Author-email: data.platform@sankhya.com.br
@@ -462,9 +462,58 @@ O Bia Toolkit oferece integração pronta para consumo de serviços HTTP da plat
 
 - **SankhyaSettings**: Dataclass de configuração de timeouts/retries/SSL. Use `SankhyaSettings.from_env()` para obter as configurações do ambiente.
 - **Sankhya**: Classe principal de integração. Permite instanciar com contexto MCP (`FastMCP`) ou usar métodos estáticos.
-    - `call_json(...)`: Realiza chamada HTTP autenticada, retorna JSON.
-    - `load_view(...)`: Helper para consultas a views Sankhya (`CRUDServiceProvider.loadView`).
-    - `Call(...)`: Método estático compatível com scaffolds legados.
+    - `call_json(...)`: Realiza chamada HTTP autenticada, retorna JSON. Veja detalhes dos parâmetros abaixo.
+    - `load_view(...)`: Helper para consultas a views Sankhya (`CRUDServiceProvider.loadView`). Veja detalhes dos parâmetros abaixo.
+    - `Call(...)`: Método estático compatível com scaffolds legados. Veja detalhes dos parâmetros abaixo.
+### Parâmetros dos métodos principais
+
+#### `call_json`
+
+| Parâmetro         | Obrigatório | Descrição |
+|-------------------|-------------|-----------|
+| payload           | Não         | Dicionário enviado como corpo da requisição (POST). Pode ser None. |
+| jsessionid        | Não         | Token de sessão JSESSIONID. Se não informado, tenta extrair do header do runtime (via MCP/BiaUtil). |
+| url               | Não         | URL completa para chamada. Se informado, ignora base_url. |
+| base_url          | Sim*        | Base URL do serviço Sankhya (ex: https://meu.sankhya.com.br). Obrigatório se não estiver em contexto MCP (header). |
+| query             | Não         | Querystring adicional (ex: serviceName=...&outputType=json). |
+| method            | Não         | "POST" (default) ou "GET". |
+| extra_headers     | Não         | Dicionário de headers adicionais. |
+| timeout           | Não         | Tupla (connect, read) para sobrescrever timeout padrão. |
+| raise_for_http_error | Não      | Se True (default), lança SankhyaHTTPError em erro HTTP. |
+
+*Se não passar base_url, o método tentará extrair automaticamente do header do runtime (MCP) se disponível. Caso contrário, será obrigatório.
+
+#### `load_view`
+
+| Parâmetro         | Obrigatório | Descrição |
+|-------------------|-------------|-----------|
+| view_name         | Sim         | Nome da view no Sankhya. |
+| where_sql         | Sim         | Cláusula WHERE (string). |
+| fields            | Não         | Campos a retornar (string). Default: "*". |
+| jsessionid        | Não         | Token de sessão JSESSIONID. Se não informado, tenta extrair do header do runtime (via MCP/BiaUtil). |
+| url               | Não         | URL completa opcional (override). |
+| base_url          | Não*        | Base URL do serviço Sankhya. Se não informado, tenta extrair do header do runtime (current_host). |
+| output_type       | Não         | "json" (default). |
+| extra_headers     | Não         | Dicionário de headers adicionais. |
+
+*Se não passar base_url, o método tentará extrair automaticamente do header do runtime (MCP) via BiaUtil. Caso não consiga, lança erro.
+
+#### `Call`
+
+| Parâmetro         | Obrigatório | Descrição |
+|-------------------|-------------|-----------|
+| jsessionID        | Não         | Token de sessão JSESSIONID. Se não informado, tenta extrair do header do runtime (via MCP/BiaUtil). |
+| payload           | Não         | Dicionário enviado como corpo da requisição. |
+| mcp               | Não         | Instância opcional do FastMCP para contexto do runtime. |
+| url               | Não         | URL completa (opcional). |
+| base_url          | Sim*        | Base URL do serviço Sankhya. Obrigatório se não estiver em contexto MCP (header). |
+| query             | Não         | Querystring adicional (opcional). |
+| method            | Não         | "POST" (default) ou "GET". |
+| extra_headers     | Não         | Dicionário de headers adicionais. |
+
+*Se não passar base_url, o método tentará extrair automaticamente do header do runtime (MCP) se disponível. Caso contrário, será obrigatório.
+
+**Resumo:** Sempre que possível, o toolkit resolve automaticamente base_url e jsessionid do contexto MCP (headers). Se não estiver rodando em MCP, passe base_url explicitamente.
 - **SankhyaHTTPError**: Exceção lançada em caso de erro HTTP (status != 200), contendo status_code e response_text.
 
 ### Exemplo de uso (instanciado)

{biatoolkit-1.2.1 → biatoolkit-1.2.2}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='biatoolkit',
-    version='1.2.1',
+    version='1.2.2',
     packages=find_packages(),
     install_requires=[],
     author='Bia Platform Team',