gpdb-client v1.0.0

Gpdb Client

The package is a simple wrapper around NameCoach GPDB (General Pronunciation Database) API. It is useful to external developers who wish to add NameCoach services to an application.

For more information on NameCoach GPDB APi, you can visit documentation page.

• Installation
• Configuration
• Usage
• API
  • Pronunciations
    • Simple search
    • Complex search
  • Analytics Events
    • Create

Installation

Using npm:

npm i --save gpdb-client

Configuration:

Specify all needed values through environment variables:

GPDB_API_URL - api url (e.x. https://gpdb.name-coach.com/api/public/v1)
GPDB_ANALYTICS_API_URL - analytics api url (e.x. https://analytics-api-staging.name-coach.com/api/v1)
GPDB_ACCESS_KEY_ID - access key id for your app
GPDB_SECRET_ACCESS_KEY - secret access key for your app

Or pass it manually:

import { Configuration } from "gpdb-client";

const config = new Configuration({
  accessKeyId: 'access key',
  secretAccessKey: 'secret access key',
  apiUrl: 'https://gpdb.name-coach.com/api/public/v1',
  analyticsApiUrl: 'https://analytics-api-staging.name-coach.com/api/v1'
});

Usage

You need to create a client instance to perform requests. Basic example:

import { Client, Configuration } from "gpdb-client";
// ... configuration

const client = new Client({ instanceSig: 'example.com', typeSig: 'dns' }, config);
const result = await client.pronunciations.simpleSearch({ target: "Sergey", targetTypeSig: "fristName", targetOwnerSig: "sergey" })

You can find detailed information about all possible parameters and the response format on the documentation page. Links to the specific methods are placed at the end of each paragraph.

All parameters should be in camelCase

API

Pronunciations

Simple search

Quick simple request to get pronunciation for a single target.

  const result = await client.pronunciations.simpleSearch({ 
    target: "Sergey", 
    targetTypeSig: "fristName", 
    targetOwnerSig: "sergey" 
  });

  result
  // { target_result: { ... }, meta: { ... } }

Simple search documentation

Complex search

Perform a search in GPDB given between 1 and 10 search targets.

  const result =  await client.pronunciations.complexSearch({
    targets: [
      { target: "jack", targetTypeSig: 'test', targetOwnerContext: { signature: 'uuid' } },
      { target: "pavel", targetTypeSig: 'test', targetOwnerContext: { signature: 'uuid' } } 
      ],
    userContext: { signature: "uuid" }
  });

  result
  // { target_result: { ... }, meta: { ... } }

Complex search documentation

Analytics Events

Create analytics events

Create analytics event:

  await client.analyticsEvents.create({
    customerId: "uuid",
    entityId: "uuid",
    entityType: "playback",
    userId: "uuid"
  });

Create analytics events documentation