client-feedbacks-node v1.1.0

Feedbacks Microservice Client SDK for Node.js

This is a Node.js client SDK for service-feedbacks microservice. It provides an easy to use abstraction over communication protocols:

• HTTP client
• AWS Lambda client
• Direct client

Quick Links:

• Development Guide
• API Version 1

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "client-feedbacks-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

let sdk = new require('client-feedbacks-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
let config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
let client = sdk.FeedbacksHttpClientV1(config);

// Connect to the microservice
await client.open(null);

// Work with the microservice
...

Now the client is ready to perform operations

// Send feedback to support
let feedback = await client.sendFeedback(
    null,
    { 
        category: 'support',
        title: 'Please help',
        content: 'When I am trying to run application in Win 10 it crashes'
    },
    {
        id: '123',
        name: 'Test User',
        email: 'somebody@somewhere.com'
    }
);

// Reply feedback
feedback = await client.replyFeedback(
    null,
    feedback.id,
    'Please, be patient. We are working to fix that issue.',
    {
        id: '321',
        name: 'Support Team',
        email: 'support@somewhere.com'
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.