Metadata-Version: 2.4
Name: mozarbot
Version: 0.1.1
Summary: SDK para automações do Mozarbot
Author-email: Marcel Zanluca <marcel.zanluca@gmail.com>
License-Expression: MIT
Requires-Python: >=3.10
Requires-Dist: requests
Description-Content-Type: text/markdown

# RPA Client

## Instalação

```bash
pip install mozarbot
```

## Como usar?

```python
from mozarbot.sdk import rpa

rpa.alert(task_id, title, message, type)
```

## Documentação

### Para gerar alertas

```python
rpa.alert(task_id, title, message, type)
```

### Para retornar informações da execução atual

```python
rpa.get_execution_data()
```
O retorno é um JSON com as informações da execução atual, com os seguintes campos:

```json
{
  task: {
    id: string # ID da execução
    robotId: string # ID do robô
    runnerId: string # ID do runner
    automationId: string # ID da automação
  } | null
}
```

### Para retornar informações dos parametros da execução atual

```python
rpa.get_params(automation_id)
```
O retorno é um JSON com os parametros da execução atual, com os seguintes campos:

```json
{
  parameters: [
    {
      id: string # ID do parametro
      type: string # Tipo do parametro
      label: string # Label do parametro
      required: boolean # Se o parametro é obrigatório
      defaultValue: string # Valor default do parametro
    }
  ]
}
```

### Para retornar os secrets do automação

```python
# label é opcional
rpa.get_secrets(label)
```
O retorno é um JSON com os secrets da automação, com os seguintes campos:

```json
{
  secrets: [
    {
      id: string
      label: string
      value: string
    }
  ]
}
```

### Para reportar o tempo de execução da task

```python
rpa.report_saving(task_id, automation_id, time_spent)
```