intelliprove-sdk v0.6.0

Support

• NodeJS (CommonJS)

Tested and verified

• NodeJS 16.x
• NodeJS 18.x
• NodeJS 19.x

Support is guaranteed for the NodeJS versions mentioned above. Other versions are most likely supported but not tested.

Installation

npm add intelliprove-sdk

Updating

npm update intelliprove-sdk

Documentation

You can find our SDK documentation here.

Release Notes

• 0.6

0.6

New features​

Updates

• Refactor of QualityResponse class:

  The following properties for the QualityResponse model have been renamed:

  • message => prompt
  • error_type => error_code With the property error_type now being re-used as string value to provide feedback in a more human readable way.

Deprecated features

How to Upgrade

1. Ensure you are using the new property names QualityResponse model correctly

Example usage

const IntelliProveSDK = require('intelliprove-sdk').default;

const APIKEY = '';

const IMAGE_PATH = '/path/to/image.jpg';
const VIDEO_PATH = '/path/to/video.mp4';

const intelliprove = new IntelliProveSDK(APIKEY);

(async () => {
    try {
        // Do a quality check on an image saved to disk
        const quality_response = await intelliprove.check(IMAGE_PATH);
        // Upload a video for processing
        const uuid = await intelliprove.upload(VIDEO_PATH, quality_response);

        // Get the results of the uploaded video for the first time
        const results = await intelliprove.results(uuid);
        console.log(results);

        // Get the current user/customer by authentication credentials
        const user = await intelliprove.userInfo();
        console.log(user);
    } catch (error) {
        console.error(error);
    }
})();