Jestor SDK para .NET (Beta)

Documentação do SDK do .NET.

Configurações Padrão

Para usar o Jestor SDK, você precisa passar sua organização (nome da conta) e o token da API.

No construtor você deve passar a classe da tabela com a qual deseja trabalhar. É possível usar dynamic ou object, mas você pode considerar a criação de tipos de classe com base em cada tabela com a qual trabalhará.

Criar Registro

Para criar um registro use o método tables usando o nome da tabela como parâmetro, depois o método insert usando um objeto como parâmetro. Exemplo:

var jestor = new Jestor<MyTable>(org, token);
var record = new MyTable{
  field1 ="value1",
  field2 = 1,
  field3 = "value3"
};
var result = jestor.Tables("table_name").Insert(record);

Console.WriteLine(result.id_table_name); //result will be an object in your table

Editar Registro

Para editar um registro use o método tables usando o nome da tabela como parâmetro, depois o método update usando o id do registro que será alterado e um Dicionário como parâmetro. Exemplo:

var jestor = new Jestor<MyTable>(org, token);
int recordId = 1;
var dictionary = new Dictionary<string, dynamic>();
dictionary.Add("field1", "value 123");
dictionary.Add("field_date", new DateTime(2022,12,25));
var result = jestor.Tables('table_name').Update(recordId, dictionary);
Console.WriteLine(result.field1); //result will be an object in your table

Deletar Registro

Para excluir um registro, use o método tables usando o nome da tabela como parâmetro, depois o método delete usando o id do registro como parâmetro. Exemplo:

var jestor = new Jestor<MyTable>(org, token);
int recordId = 1;
bool isOK = jestor.Tables('table_name').Delete(recordId);
Console.WriteLine(isOK == true? "Successfully deleted.": "Error when deleting.");

Listar Registro

Para listar os registros, use o método tables usando o nome da tabela como parâmetro e, em seguida, o método get.

  • filtros: Lista de filtros = null,
  • limite: int = 100,
  • página: int = 1,
  • ordenação: string = null

Exemplo:

var jestor = new Jestor<MyTable>(org, token);
var list = jestor.Tables('table_name').Get();

Console.WriteLine(list.Count); //list will be a list of objects

// To apply filters use the Filter object:

var filters = new List<Filter>();
filters.Add(new	Filter("field_name", "field_value", "string", Operators.like));

var list = jestor.Tables('table_name').Get(filters)
Console.WriteLine(list.Count); //list will be list of objects filtered by filters

O objeto Filter recebe os seguintes parâmetros:

  • field_name: string (nome do campo).
  • valor: string (valor do campo).
  • tipo: string (tipo de campo).
  • operador: Enumerável.

Criar Usuário

Para criar um usuário utilize o método user(), depois o método createUser() passando uma lista como parâmetro. Esta lista deve conter os seguintes campos em ordem: [email, password, profile_id, name]. Exemplo:

var jestor = new Jestor<MyTable>(org, token);
var newUser = jestor.User().CreateUser("email", "password", 999, "name", true, Seats.member);

Console.WriteLine(newUser.name); //newUser will be list a User object

Lista de campos:

  • email: string (e-mail do usuário).
  • password: string (senha do usuário, caso não queira definir uma senha padrão é só passar uma string vazia).
  • profileId: int (funções dos usuários).
  • nome: string (primeiro nome do usuário).
  • sendEmailToValidation: bool (Por padrão é definido como falso, se você deseja que o usuário confirme se o e-mail é real, defina como verdadeiro. Se definir como verdadeiro, não precisa passar senha).
  • Assentos: Enumeráveis (Por padrão, novos usuários serão criados como membros, mas você pode definir outros tipos).

Listar Usuários

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

  • filtros: Lista de filtros = null,
  • limite: int = 100,
  • página: int = 1,
  • ordenação: string = null

Exemplo:

var jestor = new Jestor<MyTable>(org, token);
var list = jestor.User().Get();

Console.WriteLine(list.Count); //list will be a  list of users 
// To apply filters use the Filter object:

var filters = new List<Filter>();
filters.Add(new	Filter("email", "email", "string", Operators.like));

var list = jestor.User().Get(filters);

Console.WriteLine(list.Count);