Jestor SDK para Python (Beta)

Documentação do SDK Python.

Criar Registro

Para criar um registro use o método table passando o nome da tabela como parâmetro, em seguida, o método insert passando um Dictionary como parâmetro. Exemplo:

jestor = Jestor(token, org)
result = jestor.table('table_name').insert({'name': 'test'})
print(result) #result será um array python com os valores

Editar Registro

Para editar um registro use o método table passando o nome da tabela como parâmetro, em seguida, o método update passando o id do registro que será alterado e um Dictionary como parâmetro. Exemplo:

jestor = Jestor(token, org)
recordId = 1
result = jestor.table('table_name').update(recordId, {'name': 'test'})
print(result) #result será um array python com os valores

Deletar Registro

Para deletar um registro use o método table passando o nome da tabela como parâmetro, em seguida, o método delete passando o id do registro como parâmetro. Exemplo:

jestor = Jestor(token, org)
result = jestor.table('table_name').delete(1)
print(result)

Listar Registros

Para listar registros use o método table passando o nome da tabela como parâmetro, em seguida, o método get. Exemplo:

jestor = Jestor(token, org)
result = jestor.table('table_name').get()
print(result) #resultado será um array python com os valores

## Para aplicar filtros utilize o objeto Filter:

filters = [
	Filter('name', 'test', Operators.CONTAINS, 'string'),
]

result = jestor.table('table_name').get(filters)
print(result) #resultado será um array python com os valores

O objeto Filter recebe os seguintes parâmetros:

  • field: str (nome do campo).
  • value: str (valor do campo).
  • operator: str (os operadores podem ser encontrados na classe Operators).
  • type: str (tipo do campo).

Criar Usuário

Para criar um usuário use o método user(), em seguida, o método createUser() passando uma lista como parâmetro. Essa lista deve conter os campos em ordem [email, senha, id_do_perfil, nome]. Exemplo:

jestor = Jestor(token, org)
result = jestor.user().createUser(['[email protected]', 'senha@123', '1','Test']);
print(result) #result será um array python com os valores

Listar Usuários

Para listar usuários utilize o método user(), em seguida, o método get. O método get aceita os seguintes parâmetros:

  • filters: List[Filter] = None,
  • limit: int = 100,
  • page: int = 1,
  • sort: str = None

Exemplo:

jestor = Jestor(token, org)
result = jestor.user().get();
print(result) #result will be a python array with the values

## Para aplicar filtros utilize o objeto Filter:

filters = [
	Filter('name', 'test', Operators.CONTAINS, 'string'),
]

result = jestor.user().get(filters=filters,sort='name asc')
print(result) #result will be a python array with the values

Listar Tarefas

Para listar as tarefas utilize o método fetchTasks. O método fetchTasks aceita um parâmetro do tipo lista, podendo conter os campos em ordem [[Filter], limit, page]. Exemplo:

jestor = Jestor(token, org)
result = jestor.fetchTasks();
print(result) #result será um array python com os valores

## Para aplicar filtros utilize o objeto Filter:

filters = [
	Filter('description', 'test', Operators.CONTAINS, 'string'),
]
limit = 10
page = 1
result = jestor.fetchTasks([filters, limit, page])
print(result) #result será um array python com os valores

Arquivos

Para manipular arquivos utilize o objeto File. Ele recebe os seguintes parâmetros:

  • table: str
  • recordId: int = None
  • field: str = None
tableName = 'table_name'
recordId = 1
field = 'teste'
files = jestor.file(tableName, recordId, field)

Adicionando, removendo e editando arquivos em um registro existente:

tableName = 'table_name'
recordId = 1
field = 'teste'
files = jestor.file(tableName, recordId, field)

files.add({'name': 'file_test', 'content': '<content string>', 'contentType': 'pdf'})

idFile = 'A1CVwLAxzjjYprO5Bjdfi-5'
files.remove(idFile)

idFile = 'E0DOdSKgvkkMncI8Fnhst-2'
files.update(idFile, {'name': 'file_update_name'})


result = jestor.table('table_teste').update(recordId, {field: files.toJson()})

print(result) #result será um array python com os valores

Adicionando arquivos em um registro novo:

tableName = 'table_name'
files = jestor.file(tableName)

files.add({'name': 'file_test', 'content': '<content string>', 'contentType': 'pdf'})

result = jestor.table(tableName).insert({'name': 'create new record', 'files': files.toJson()})

print(result) #result será um array python com os valores