pip_clients_emailsettings 1.0.2
pip_clients_emailsettings: ^1.0.2

Dart native

Clients for Email Settings microservice for Pip.Services in Dart. This microservice keeps settings of email recipients.

Pip.Services Logo
Email Settings Microservice Client SDK for Dart #

This is a Dart client SDK for pip-services-emailsettings microservice.

Download #

Right now the only way to get the microservice is to check it out directly from github repository

git clone git@github.com:pip-services-users/pip-clients-emailsettings-dart.git

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 EmailSettingsV1 implements IStringIdentifiable {
  /* Recipient information */
  String id;
  String name;
  String email;
  String language;

  /* EmailSettings management */
  dynamic subscriptions;
  bool verified;
  String ver_code;
  DateTime ver_expire_time;

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

abstract class IEmailSettingsV1 {
  Future<List<EmailSettingsV1>> getSettingsByIds(
      String correlationId, List<String> recipientIds);

  Future<EmailSettingsV1> getSettingsById(String correlationId, String recipientId);

  Future<EmailSettingsV1> getSettingsByEmail(String correlationId, String email);

  Future<EmailSettingsV1> setSettings(String correlationId, EmailSettingsV1 settings);

  Future<EmailSettingsV1> setVerifiedSettings(String correlationId, EmailSettingsV1 settings);  

  Future<EmailSettingsV1> setRecipient(String correlationId, String recipientId, String name, String email, String language);

  Future<EmailSettingsV1> setSubscriptions(String correlationId, String recipientId, dynamic subscriptions);

  Future<EmailSettingsV1> deleteSettingsById(String correlationId, String recipientId);

  Future resendVerification(String correlationId, String recipientId);

  Future verifyEmail(String correlationId, String recipientId, String code);
}

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
);

Instantiate the client and open connection to the microservice

// Create the client instance
var client = EmailSettingsHttpClientV1(config);

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

// Connect to the microservice
try{
  await client.open(null)
}catch() {
  // Error handling...
}       
// Work with the microservice
// ...

Now the client is ready to perform operations

// Create a new settings
final SETTINGS = EmailSettingsV1(
    id: '1',
    name: 'User 1',
    email: 'somebody@somewhere.com',
    language: 'en',
    verified: false);

    // Create the settings
    try {
      var settings = await client.setSettings('123', SETTINGS);
      // Do something with the returned settings...
    } catch(err) {
      // Error handling...     
    }
// Get the settings
try {
var settings = await client.getSettingsByEmail(
    null,
    'somebody@somewhere.com');
    // Do something with settings...

    } catch(err) { // Error handling}
// Verify an email
try {
    settings1 = SETTINGS;
    settings1.ver_code = '123';  
    await controller.verifyEmail(null, '1', '123');

    var settings = await client.getSettingsById(
    null,
    '1');
    // Do something with settings...

    } catch(err) { // Error handling}

Acknowledgements #

This microservice was created and currently maintained by

  • Sergey Seroukhov
  • Nuzhnykh Egor.
0
likes
90
pub points
0%
popularity

Publisher

entinco.com

Clients for Email Settings microservice for Pip.Services in Dart. This microservice keeps settings of email recipients.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

angel_framework, http, pip_clients_email, pip_services3_commons, pip_services3_components, pip_services3_data, pip_services3_rpc, pip_services_emailsettings

More

Packages that depend on pip_clients_emailsettings