Maplink Package

Projeto para conectar com a maplink (SOAP)

pubspec.yaml

dependencies:
  maplink: <last version>

getAddressByZipcodeAndHouseNumber

final maplink = Maplink("your-token");
final response = await model.getAddressByZipcodeAndHouseNumber(
  "03118030", //cep
  "156", //numero da residência (opcional)
);

getAddressByStreetName

final maplink = Maplink("your-token");
final response = await model.getAddressByStreetName(
  state: "SP",
  city: "São Paulo",
  country: "BRA", //ISO 3166-1 alpha-3 country code (BRA)
  streetName: "Rua Guaimbé",
  houseNumber: "156", //numero da residência (opcional)
);

Erros Tratados

Todos os erros recebem por herança a estrutura da classe Failure, que tem 3 propriedades principais:

  • code: Código para identificar o erro;
  • message: Mensagem padrão do erro;
  • innerException: Exceção que causou o erro;

Esses são os erros tratados:

Validação de parâmetros

CódigoErroMensagemDescrição
null-token-failureNullTokenFailureÉ necessário preencher o token para continuar.Token nulo
empty-token-failureEmptyTokenFailureÉ necessário preencher o token para continuar.Token vazio
invalid-field-${fieldName}-failureInvalidFieldFailureÉ necessário preencher o campo $fieldName para continuar.Algum parâmetro informado está vazio ou nulo

<br/>

CódigoErroMensagemDescrição
empty-datasource-responseEmptyDatasourceResponseFailureEndereço não encontradoMaplink não encontrou nenhum endereço
null-datasource-responseNullDatasourceResponseFailurenullMaplink não retornou nada no body do response
maplink-error-messages-failureErrorsMaplinkFailureConcatenação de todas as mensagens retornadas nos erros, separados por \nErros tratados pela maplink. Tem uma lista de ErrorsMaplinkMessage, onde cada item tem as propriedades code e message

Libraries