pip_clients_accounts

Description:

pip clients accounts

User Accounts Microservice Client SDK for Dart #
This is a Dart client SDK for pip-services-accounts microservice.
Download #
Right now the only way to get the microservice is to check it out directly from github repository
git clone [email protected]:pip-services-users/pip-clients-accounts-dart.git
copied to clipboard
Pip.Service team is working to implement packaging and make stable releases available for your
as zip downloadable archieves.
Contract #
Logical contract of the microservice is presented below. For physical implementation (HTTP/REST),
please, refer to documentation of the specific protocol.
class AccountV1 implements IStringIdentifiable {
/* Identification */
String id;
String login;
String name;

/* Activity tracking */
DateTime create_time;
bool deleted;
bool active;

/* User preferences */
String about;
String time_zone;
String language;
String theme;

/* Custom fields */
var custom_hdr;
var custom_dat;
}

abstract class IAccountsV1 {
Future<DataPage<AccountV1>> getAccounts(
String correlationId, FilterParams filter, PagingParams paging);

Future<AccountV1> getAccountById(String correlationId, String id);

Future<AccountV1> getAccountByLogin(String correlationId, String login);

Future<AccountV1> getAccountByIdOrLogin(String correlationId, String idOrLogin);

Future<AccountV1> createAccount(String correlationId, AccountV1 account);

Future<AccountV1> updateAccount(String correlationId, AccountV1 account);

Future<AccountV1> deleteAccountById(String correlationId, String accountId);
}
copied to clipboard
Use #
The easiest way to work with the microservice is to use client SDK.
Define client configuration parameters that match the configuration of the microservice's external API
// Client configuration
var httpConfig = ConfigParams.fromTuples(
"connection.protocol", "http",
"connection.host", "localhost",
"connection.port", 8080
);
copied to clipboard
Instantiate the client and open connection to the microservice
// Create the client instance
var client = AccountsHttpClientV1(config);

// Configure the client
client.configure(httpConfig);

// Connect to the microservice
try{
await client.open(null)
}catch() {
// Error handling...
}
// Work with the microservice
// ...
copied to clipboard
Now the client is ready to perform operations
// Create a new account
final ACCOUNT = AccountV1(
id: '1',
login: '[email protected]',
name: 'Test User 1',
deleted: false
);

// Create the account
try {
var account = await client.createAccount('123', ACCOUNT);
// Do something with the returned account...
} catch(err) {
// Error handling...
}
copied to clipboard
// Get the account
try {
var account = await client.getAccountByLogin(
null,
'[email protected]');
// Do something with account...

} catch(err) { // Error handling}
copied to clipboard
Acknowledgements #
This microservice was created and currently maintained by

Sergey Seroukhov.
Nuzhnykh Egor