dpw-data-generator-sdk v1.0.57

DpwDataGenerator SDK

API SDK for DPW Date Generator according to Developer Portal: Self-Serve Support APIs

Installation

npm install dpw-data-generator-sdk

APIs

Create New SDK

import DpwDataGeneratorSDK from 'dpw-data-generator-sdk';
// or use: const DpwDataGeneratorSDK = require('dpw-data-generator-sdk').default;
export const CONFIG = {
    endpoint: 'http://intapi-dpwcixmn.lab.nordigy.ru:8082',
    clientID: 'dqlOs9GHQEyyb9zBKOreTw',
    clientKey: '4txL6wBfTDCDngrvJd4MUARi66jDYoTlSwLojPE_1UbQ',
    mysqlConfig: {
        host: 'xmn02-i01-msq01.lab.nordigy.ru',
        port: 3306,
        user: 'root',
        password: 'cFb7xnMz',
        database: 'dps_db_ci',
        connectTimeout: 60000
    },
    botConfig: {
        dpwUrl: 'https://developers-ci.lab.nordigy.ru',
        clientId: 'dqlOs9GHQEyyb9zBKOreTw',
        redirectUri: 'https://www.ringcentral.com/apps/api/login/login-call-back',
        initiatorId: 'botprovisioner'
    }
}

const dpwDataGeneratorSDK = new DpwDataGeneratorSDK(CONFIG);

Create Organization

const testOrganizationParameter = {
    rcAccountId: '400456607071',
    name: 'dpwDataGeneratorSDKTest_Organization',
    contactPhone: '18442064449',
    accessLevel: ACCESS_LEVEL.Basic
};
const response = await dpwDataGeneratorSDK.createOrganization(testOrganizationParameter);

Get Organization List

const searchParameter = {
            rcAccountId: '400456607071'
        }
const response = await dpwDataGeneratorSDK.getOrganizationList(searchParameter);

Get Organization Info

const response = await dpwDataGeneratorSDK.getOrganizationInfo(organizationId);

Update Organization

const updateOrganizationParameter = {
        id: applicationId,
        rcAccountId: '400456607071',
        name: 'dpwDataGeneratorSDKTest_Organization1',
        contactPhone: '18442064449',
        accessLevel: ACCESS_LEVEL.Basic
    };
const response = await dpwDataGeneratorSDK.updateOrganization(updateOrganizationParameter);

Delete Organization

const response = await dpwDataGeneratorSDK.deleteOrganization(organizationId);

Create Developer

const testDeveloperParameter = {
        rcExtensionId: '400495278071',
        email: 'mm1+1603937434266-5033302@dins.ru',
        organization: {
            id: 'ZPIJg_FSSZiTPi7P-3Q1Wg'
        },
};
const response = await dpwDataGeneratorSDK.createDeveloper(testDeveloperParameter);

Get Developer List

const searchParameter = {
            organizationId: 'ZPIJg_FSSZiTPi7P-3Q1Wg'
        }
const response = await dpwDataGeneratorSDK.getDeveloperList(searchParameter);

Get Developer Info

const response = await dpwDataGeneratorSDK.getDeveloperInfo(developerId);
);

Update Developer

const updateDeveloperParameter = {
        id: developerId,
        rcExtensionId: '400495278071',
        email: 'mm1+1603937434266-5033302@dins.ru',
        organization: {
            id: 'ZPIJg_FSSZiTPi7P-3Q1Wg'
        },
    };
const response = await dpwDataGeneratorSDK.updateDeveloper(updateDeveloperParameter);

Delete Developer

const response = await dpwDataGeneratorSDK.deleteDeveloper(developerId);

Create Application

const testApplicationParameter = {
        organization: {
            id: 'u2lko6QFQBeJwBVT-fsQ4A'
        },
        name: 'dpwDataGeneratorSDKTest',
        type: APP_TYPE.ServerWeb,
        description: 'Test',
        grantTypes: [APP_GRANTTYPE.AuthorizationCode],
        permissions: [APP_PERMISSIONS.ReadMessages],
        brands: ['1210'],
        scope: APP_SCOPE.Private,
        redirectUris: ['https://mycompany.testautomation.com/'],
        usagePlan: {
            id: APP_USAGEPLAN_ID.Beginner
        },
        displayName: null,
    };
const response = await dpwDataGeneratorSDK.createApplication(testApplicationParameter);

Get Application List

const searchParameter = {
            organizationId: 'u2lko6QFQBeJwBVT-fsQ4A'
        }
const response = await dpwDataGeneratorSDK.getApplicationList(searchParameter);

Get Application Information Endpoint

const searchParameter = {
            applicationId: applicationId
        }
const response = await dpwDataGeneratorSDK.getApplicationInfoEndpoint(searchParameter);

Get Application Info

const response = await dpwDataGeneratorSDK.getApplicationInfo(applicationId);

Update Application

const updateApplicationParameter = {
        id: applicationId,
        organization: {
            id: 'u2lko6QFQBeJwBVT-fsQ4A'
        },
        name: 'dpwDataGeneratorSDKTest',
        type: APP_TYPE.ServerWeb,
        description: 'Test',
        grantTypes: [APP_GRANTTYPE.AuthorizationCode],
        permissions: [APP_PERMISSIONS.ReadMessages],
        brands: ['1210'],
        scope: APP_SCOPE.Private,
        redirectUris: ['https://mycompany.testautomation.com/'],
        usagePlan: {
            id: APP_USAGEPLAN_ID.Beginner
        },
        displayName: null,
    };
const response = await dpwDataGeneratorSDK.updateApplication(updateApplicationParameter);

Delete Application

const response = await dpwDataGeneratorSDK.deleteApplication(applicationId);

Create App State

const testAppStateParameter = {
    application: {
        id: 'veHye8iNSd-RyF-H_pdedQ~2V9avmpwRwSpeCOY-dLM4g'
    },
    status: APP_STATE_STATUS.Reviewing,
};
const response = await dpwDataGeneratorSDK.createAppState(testAppStateParameter);

Get App State List

const searchParameter = {
    applicationId: 'veHye8iNSd-RyF-H_pdedQ~2V9avmpwRwSpeCOY-dLM4g'
}
const response = await dpwDataGeneratorSDK.getAppStateList(searchParameter);

Get App State Info

const response = await dpwDataGeneratorSDK.getAppStateInfo(appStateId);
);

Issue App Key

const testAppKeyParameter = {
        application: {
            id: 'veHye8iNSd-RyF-H_pdedQ~2V9avmpwRwSpeCOY-dLM4g'
        }
    };
const response = await dpwDataGeneratorSDK.issueAppKey(testAppKeyParameter)；

Get App Key List

const searchParameter = {
    applicationId: 'veHye8iNSd-RyF-H_pdedQ~2V9avmpwRwSpeCOY-dLM4g'
}
const response = await dpwDataGeneratorSDK.getAppKeyList(searchParameter);

Update App Key

const response = await dpwDataGeneratorSDK.updateAppKey(testAppKeyParameter);

Delete App Key

const response = await dpwDataGeneratorSDK.deleteAppKey(appkeyId);

Create Sandbox Account

const testSandboxAccountParameter = {
        organization: {
            id: 'ZPIJg_FSSZiTPi7P-3Q1Wg'
        },
        developer: {
            id: 'ZPIJg_FSSZiTPi7P-3Q1Wg~IiOgCKJ2TeGP37I4k2L12A'
        },
        rcAccountId: '400495278071',
        phoneNumber: '18883272918',

    };
const response = await dpwDataGeneratorSDK.createSandboxAccount(testSandboxAccountParameter);

Get Sandbox Account List

const searchParameter = {
            organizationId: 'ZPIJg_FSSZiTPi7P-3Q1Wg'
}
const response = await dpwDataGeneratorSDK.getSandboxAccountList(searchParameter);

Get Sandbox Account Info

const response = await dpwDataGeneratorSDK.getSandboxAccountInfo(sandboxAccountId);

Update Sandbox Account

const response = await dpwDataGeneratorSDK.updateSandboxAccount(testAppKeyParameter);

Delete Sandbox Account

const response = await dpwDataGeneratorSDK.deleteSandboxAccount(sandboxAccountId);

Create/Update Application Attribute

const attribute = await dpwDataGeneratorSDK.saveAppAttribute(attribute);

Get Application Attribute

const attribute = await dpwDataGeneratorSDK.getAppAttribute(attribute.application.id, attribute.id);

Delete Application Attribute

const attribute = await dpwDataGeneratorSDK.deleteAppAttribute(attribute.application.id, attribute.id);

Create App Profile

const response = await dpwDataGeneratorSDK.createAppProfile(testAppProfile);

Update App Profile

const response = await dpwDataGeneratorSDK.updateAppProfile(testAppProfile);

Delete App Profile

const response = await dpwDataGeneratorSDK.deleteAppProfile(appProfile.id);

Delete App Profile Lead Flag

const response = await dpwDataGeneratorSDK.deleteAppProfileLeadFlag(appProfile.id);

Get Authorization Code

const response = await dpwDataGeneratorSDK.getAuthorizationCode(accountId, extensionId);

Add Bot

const response = await dpwDataGeneratorSDK.addBot(clientId, authCode, botName);

Add Bot with Auth

const response = await dpwDataGeneratorSDK.addBotWithAuth(accountId, extensionId, clientId, botName);

Get Bot Status

const response = await dpwDataGeneratorSDK.getBotStatus(clientId, authCode);

Get Bot Status with Auth.

const response = await dpwDataGeneratorSDK.getBotStatusWithAuth(accountId, extensionId, clientId);

remove Bot.

const response = await dpwDataGeneratorSDK.removeBot(clientId, authCode);

remove Bot With Auth.

const response = await dpwDataGeneratorSDK.removeBotWithAuth(clientId, authCode);

create App Gallery Page.

const response = await dpwDataGeneratorSDK.createAppGalleryPage(appGalleryPageForm);

update App Gallery Page.

const response = await dpwDataGeneratorSDK.updateAppGalleryPage(appGalleryPageForm);

delete App Gallery Page.

const response = await dpwDataGeneratorSDK.deleteAppGalleryPage(appGalleryPageId);

delete App Gallery Page By Channel And BrandId.

const response = await dpwDataGeneratorSDK.deleteAppGalleryPageByChannelAndBrandId(channel, brandId);

create Gallery Page.

const response = await dpwDataGeneratorSDK.createGalleryPage(galleryPageForm);

update Gallery Page.

const response = await dpwDataGeneratorSDK.updateGalleryPage(galleryPageForm);

create Rise Partner Profile Simple.

const response = await dpwDataGeneratorSDK.createRisePartnerProfileSimple(testRisePartnerProfileSimple);

delete Rise Partner Profile Simple.

const response = await dpwDataGeneratorSDK.deleteRisePartnerProfileSimple(testRisePartnerProfileSimple.applicationId);

delete Gallery Page.

const response = await dpwDataGeneratorSDK.deleteGalleryPage(galleryPageId);

create Partner Badge.

const response = await dpwDataGeneratorSDK.createPartnerBadge(testPartnerBadge);

delete Partner Badge.

const response = await dpwDataGeneratorSDK.deletePartnerBadge(testPartnerBadge.organizationId);

create AppProfile Collection.

const response = await dpwDataGeneratorSDK.createAppProfileCollection(testAppProfileCollectionForm);

delete AppProfile Collection.

const response = await dpwDataGeneratorSDK.deleteAppProfileCollection(testAppProfileCollectionForm.collection.collectionId);

create Gallery Collection.

const response = await dpwDataGeneratorSDK.createGalleryCollection(testAppProfileCollectionForm);

delete Gallery Collection.

const response = await dpwDataGeneratorSDK.deleteGalleryCollection(testAppProfileCollectionForm.collection.collectionId);

create App Profile Rating.

const response = await dpwDataGeneratorSDK.createAppProfileRating(testAppProfileRating);

delete App Profile Rating.

const response = await dpwDataGeneratorSDK.deleteAppProfileRating(testAppProfileRating.applicationId);

create App Profile Review.

const response = await dpwDataGeneratorSDK.createAppProfileReview(testAppProfileReview);

delete App Profile Review.

const response = await dpwDataGeneratorSDK.deleteAppProfileReview(testAppProfileReview.id);

Get DPW account Info.

const response = await dpwDataGeneratorSDK.getDpwAccountInfo(accountId);

Get Gallery brand Info.

const response = await dpwDataGeneratorSDK.getGalleryBrandInfo(brandId);

Get Update Gallery brand.

const response = await dpwDataGeneratorSDK.updateGalleryBrand(galleryBrand);

Create App WebHook Info.

const response = await dpwDataGeneratorSDK.createAppWebHook(webHookInfo);

Delete App WebHook Info.

const response = await dpwDataGeneratorSDK.deleteAppWebHook(webHookInfo.applicationId);

Create Apps For Download.

const response = await dpwDataGeneratorSDK.createAppsForDownload(appsForDownnload);

Delete Apps For Download.

const response = await dpwDataGeneratorSDK.deleteAppsForDownload(appsForDownnload.applicationId);

Create App Parameter.

const response = await dpwDataGeneratorSDK.createAppParameter(appParameter);

Update App Parameter.

const response = await dpwDataGeneratorSDK.updateAppParameter(appParameter);

Delete App Parameter.

const response = await dpwDataGeneratorSDK.deleteAppParameter(appParameter.applicationId);

More Information

See Test Cases for DpwDataGenerator SDK to get more details.