gpdb-api-client - npm Package Compare versions

Comparing version 1.1.55 to 1.2.0

build/main/lib/client.d.ts

@@ -9,2 +9,3 @@ import IClient from '../types/client';
 import PermissionsRepository from './repositories/permissions';
+import PreferredRecordingsRepository from './repositories/preferred-recordings';
 import PronunciationsRepository from './repositories/pronunciations';
@@ -18,4 +19,5 @@ export default class Client implements IClient {
     readonly customAttributes: CustomAttributesRepository;
+    readonly preferredRecordings: PreferredRecordingsRepository;
     readonly application: Application;
     constructor(application: Application, configuration: IConfiguration);
 }

build/main/lib/client.js

@@ -12,2 +12,3 @@ "use strict";
 const permissions_1 = __importDefault(require("./repositories/permissions"));
+const preferred_recordings_1 = __importDefault(require("./repositories/preferred-recordings"));
 const pronunciations_1 = __importDefault(require("./repositories/pronunciations"));
@@ -18,11 +19,12 @@ class Client {
         this.application = application;
-        this.pronunciations = new pronunciations_1.default(apiHttpClient, application);
         this.analyticsEvents = new analytics_events_1.default(analyticsApiHttpClient);
         this.browserExtension = new browser_extension_1.default(analyticsApiHttpClient);
+        this.pronunciations = new pronunciations_1.default(apiHttpClient, application);
         this.permissions = new permissions_1.default(apiHttpClient, application);
         this.customAttributes = new custom_attributes_1.default(apiHttpClient, application);
         this.clientPreferences = new client_side_preferences_1.default(apiHttpClient, application);
+        this.preferredRecordings = new preferred_recordings_1.default(apiHttpClient, application);
     }
 }
 exports.default = Client;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9jbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFJQSxnRUFBdUM7QUFDdkMsdUZBQXdFO0FBQ3hFLHlGQUEwRTtBQUMxRSxxR0FBcUY7QUFDckYseUZBQTBFO0FBQzFFLDZFQUErRDtBQUMvRCxtRkFBcUU7QUFFckUsTUFBcUIsTUFBTTtJQVN6QixZQUFZLFdBQXdCLEVBQUUsYUFBNkI7UUFDakUsTUFBTSxzQkFBc0IsR0FBRyxJQUFJLHFCQUFVLENBQzNDLGFBQWEsQ0FBQyxlQUFlLEVBQzdCLGFBQWEsQ0FBQyxXQUFXLEVBQ3pCLGFBQWEsQ0FBQyxPQUFPLENBQ3RCLEVBQ0MsYUFBYSxHQUFHLElBQUkscUJBQVUsQ0FDOUIsYUFBYSxDQUFDLE1BQU0sRUFDcEIsYUFBYSxDQUFDLFdBQVcsRUFDekIsYUFBYSxDQUFDLE9BQU8sQ0FDdEIsQ0FBQztRQUVGLElBQUksQ0FBQyxXQUFXLEdBQUcsV0FBVyxDQUFDO1FBQy9CLElBQUksQ0FBQyxjQUFjLEdBQUcsSUFBSSx3QkFBd0IsQ0FDaEQsYUFBYSxFQUNiLFdBQVcsQ0FDWixDQUFDO1FBQ0YsSUFBSSxDQUFDLGVBQWUsR0FBRyxJQUFJLDBCQUF5QixDQUFDLHNCQUFzQixDQUFDLENBQUM7UUFDN0UsSUFBSSxDQUFDLGdCQUFnQixHQUFHLElBQUksMkJBQTBCLENBQUMsc0JBQXNCLENBQUMsQ0FBQztRQUMvRSxJQUFJLENBQUMsV0FBVyxHQUFHLElBQUkscUJBQXFCLENBQzFDLGFBQWEsRUFDYixXQUFXLENBQ1osQ0FBQTtRQUNELElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLDJCQUEwQixDQUNwRCxhQUFhLEVBQ2IsV0FBVyxDQUNaLENBQUE7UUFDRCxJQUFJLENBQUMsaUJBQWlCLEdBQUcsSUFBSSxpQ0FBK0IsQ0FDMUQsYUFBYSxFQUNiLFdBQVcsQ0FDWixDQUFBO0lBQ0gsQ0FBQztDQUNGO0FBekNELHlCQXlDQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9jbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFJQSxnRUFBdUM7QUFDdkMsdUZBQXdFO0FBQ3hFLHlGQUEwRTtBQUMxRSxxR0FBcUY7QUFDckYseUZBQTBFO0FBQzFFLDZFQUErRDtBQUMvRCwrRkFBZ0Y7QUFDaEYsbUZBQXFFO0FBRXJFLE1BQXFCLE1BQU07SUFVekIsWUFBWSxXQUF3QixFQUFFLGFBQTZCO1FBQ2pFLE1BQU0sc0JBQXNCLEdBQUcsSUFBSSxxQkFBVSxDQUMzQyxhQUFhLENBQUMsZUFBZSxFQUM3QixhQUFhLENBQUMsV0FBVyxFQUN6QixhQUFhLENBQUMsT0FBTyxDQUN0QixFQUNBLGFBQWEsR0FBRyxJQUFJLHFCQUFVLENBQzdCLGFBQWEsQ0FBQyxNQUFNLEVBQ3BCLGFBQWEsQ0FBQyxXQUFXLEVBQ3pCLGFBQWEsQ0FBQyxPQUFPLENBQ3RCLENBQUM7UUFFRixJQUFJLENBQUMsV0FBVyxHQUFHLFdBQVcsQ0FBQztRQUMvQixJQUFJLENBQUMsZUFBZSxHQUFHLElBQUksMEJBQXlCLENBQUMsc0JBQXNCLENBQUMsQ0FBQztRQUM3RSxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsSUFBSSwyQkFBMEIsQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO1FBRS9FLElBQUksQ0FBQyxjQUFjLEdBQUcsSUFBSSx3QkFBd0IsQ0FDaEQsYUFBYSxFQUNiLFdBQVcsQ0FDWixDQUFDO1FBQ0YsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLHFCQUFxQixDQUMxQyxhQUFhLEVBQ2IsV0FBVyxDQUNaLENBQUE7UUFDRCxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsSUFBSSwyQkFBMEIsQ0FDcEQsYUFBYSxFQUNiLFdBQVcsQ0FDWixDQUFBO1FBQ0QsSUFBSSxDQUFDLGlCQUFpQixHQUFHLElBQUksaUNBQStCLENBQzFELGFBQWEsRUFDYixXQUFXLENBQ1osQ0FBQTtRQUNELElBQUksQ0FBQyxtQkFBbUIsR0FBRyxJQUFJLDhCQUE2QixDQUMxRCxhQUFhLEVBQ2IsV0FBVyxDQUNaLENBQUE7SUFDSCxDQUFDO0NBQ0Y7QUEvQ0QseUJBK0NDIn0=

build/module/lib/client.d.ts

@@ -9,2 +9,3 @@ import IClient from '../types/client';
 import PermissionsRepository from './repositories/permissions';
+import PreferredRecordingsRepository from './repositories/preferred-recordings';
 import PronunciationsRepository from './repositories/pronunciations';
@@ -18,4 +19,5 @@ export default class Client implements IClient {
     readonly customAttributes: CustomAttributesRepository;
+    readonly preferredRecordings: PreferredRecordingsRepository;
     readonly application: Application;
     constructor(application: Application, configuration: IConfiguration);
 }

build/module/lib/client.js

@@ -7,2 +7,3 @@ import HttpClient from './http-client';
 import PermissionsRepository from './repositories/permissions';
+import PreferredRecordingsRepository from './repositories/preferred-recordings';
 import PronunciationsRepository from './repositories/pronunciations';
@@ -13,10 +14,11 @@ export default class Client {
         this.application = application;
-        this.pronunciations = new PronunciationsRepository(apiHttpClient, application);
         this.analyticsEvents = new AnalyticsEventsRepository(analyticsApiHttpClient);
         this.browserExtension = new BrowserExtensionRepository(analyticsApiHttpClient);
+        this.pronunciations = new PronunciationsRepository(apiHttpClient, application);
         this.permissions = new PermissionsRepository(apiHttpClient, application);
         this.customAttributes = new CustomAttributesRepository(apiHttpClient, application);
         this.clientPreferences = new ClientSidePreferencesRepository(apiHttpClient, application);
+        this.preferredRecordings = new PreferredRecordingsRepository(apiHttpClient, application);
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9jbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBSUEsT0FBTyxVQUFVLE1BQU0sZUFBZSxDQUFDO0FBQ3ZDLE9BQU8seUJBQXlCLE1BQU0saUNBQWlDLENBQUM7QUFDeEUsT0FBTywwQkFBMEIsTUFBTSxrQ0FBa0MsQ0FBQztBQUMxRSxPQUFPLCtCQUErQixNQUFNLHdDQUF3QyxDQUFDO0FBQ3JGLE9BQU8sMEJBQTBCLE1BQU0sa0NBQWtDLENBQUM7QUFDMUUsT0FBTyxxQkFBcUIsTUFBTSw0QkFBNEIsQ0FBQztBQUMvRCxPQUFPLHdCQUF3QixNQUFNLCtCQUErQixDQUFDO0FBRXJFLE1BQU0sQ0FBQyxPQUFPLE9BQU8sTUFBTTtJQVN6QixZQUFZLFdBQXdCLEVBQUUsYUFBNkI7UUFDakUsTUFBTSxzQkFBc0IsR0FBRyxJQUFJLFVBQVUsQ0FDM0MsYUFBYSxDQUFDLGVBQWUsRUFDN0IsYUFBYSxDQUFDLFdBQVcsRUFDekIsYUFBYSxDQUFDLE9BQU8sQ0FDdEIsRUFDQyxhQUFhLEdBQUcsSUFBSSxVQUFVLENBQzlCLGFBQWEsQ0FBQyxNQUFNLEVBQ3BCLGFBQWEsQ0FBQyxXQUFXLEVBQ3pCLGFBQWEsQ0FBQyxPQUFPLENBQ3RCLENBQUM7UUFFRixJQUFJLENBQUMsV0FBVyxHQUFHLFdBQVcsQ0FBQztRQUMvQixJQUFJLENBQUMsY0FBYyxHQUFHLElBQUksd0JBQXdCLENBQ2hELGFBQWEsRUFDYixXQUFXLENBQ1osQ0FBQztRQUNGLElBQUksQ0FBQyxlQUFlLEdBQUcsSUFBSSx5QkFBeUIsQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO1FBQzdFLElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLDBCQUEwQixDQUFDLHNCQUFzQixDQUFDLENBQUM7UUFDL0UsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLHFCQUFxQixDQUMxQyxhQUFhLEVBQ2IsV0FBVyxDQUNaLENBQUE7UUFDRCxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsSUFBSSwwQkFBMEIsQ0FDcEQsYUFBYSxFQUNiLFdBQVcsQ0FDWixDQUFBO1FBQ0QsSUFBSSxDQUFDLGlCQUFpQixHQUFHLElBQUksK0JBQStCLENBQzFELGFBQWEsRUFDYixXQUFXLENBQ1osQ0FBQTtJQUNILENBQUM7Q0FDRiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9jbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBSUEsT0FBTyxVQUFVLE1BQU0sZUFBZSxDQUFDO0FBQ3ZDLE9BQU8seUJBQXlCLE1BQU0saUNBQWlDLENBQUM7QUFDeEUsT0FBTywwQkFBMEIsTUFBTSxrQ0FBa0MsQ0FBQztBQUMxRSxPQUFPLCtCQUErQixNQUFNLHdDQUF3QyxDQUFDO0FBQ3JGLE9BQU8sMEJBQTBCLE1BQU0sa0NBQWtDLENBQUM7QUFDMUUsT0FBTyxxQkFBcUIsTUFBTSw0QkFBNEIsQ0FBQztBQUMvRCxPQUFPLDZCQUE2QixNQUFNLHFDQUFxQyxDQUFDO0FBQ2hGLE9BQU8sd0JBQXdCLE1BQU0sK0JBQStCLENBQUM7QUFFckUsTUFBTSxDQUFDLE9BQU8sT0FBTyxNQUFNO0lBVXpCLFlBQVksV0FBd0IsRUFBRSxhQUE2QjtRQUNqRSxNQUFNLHNCQUFzQixHQUFHLElBQUksVUFBVSxDQUMzQyxhQUFhLENBQUMsZUFBZSxFQUM3QixhQUFhLENBQUMsV0FBVyxFQUN6QixhQUFhLENBQUMsT0FBTyxDQUN0QixFQUNBLGFBQWEsR0FBRyxJQUFJLFVBQVUsQ0FDN0IsYUFBYSxDQUFDLE1BQU0sRUFDcEIsYUFBYSxDQUFDLFdBQVcsRUFDekIsYUFBYSxDQUFDLE9BQU8sQ0FDdEIsQ0FBQztRQUVGLElBQUksQ0FBQyxXQUFXLEdBQUcsV0FBVyxDQUFDO1FBQy9CLElBQUksQ0FBQyxlQUFlLEdBQUcsSUFBSSx5QkFBeUIsQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO1FBQzdFLElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLDBCQUEwQixDQUFDLHNCQUFzQixDQUFDLENBQUM7UUFFL0UsSUFBSSxDQUFDLGNBQWMsR0FBRyxJQUFJLHdCQUF3QixDQUNoRCxhQUFhLEVBQ2IsV0FBVyxDQUNaLENBQUM7UUFDRixJQUFJLENBQUMsV0FBVyxHQUFHLElBQUkscUJBQXFCLENBQzFDLGFBQWEsRUFDYixXQUFXLENBQ1osQ0FBQTtRQUNELElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLDBCQUEwQixDQUNwRCxhQUFhLEVBQ2IsV0FBVyxDQUNaLENBQUE7UUFDRCxJQUFJLENBQUMsaUJBQWlCLEdBQUcsSUFBSSwrQkFBK0IsQ0FDMUQsYUFBYSxFQUNiLFdBQVcsQ0FDWixDQUFBO1FBQ0QsSUFBSSxDQUFDLG1CQUFtQixHQUFHLElBQUksNkJBQTZCLENBQzFELGFBQWEsRUFDYixXQUFXLENBQ1osQ0FBQTtJQUNILENBQUM7Q0FDRiJ9

package.json

 {
   "name": "gpdb-api-client",
-  "version": "1.1.55",
+  "version": "1.2.0",
   "description": "Simple wrapper around NameCoach GPDB (General Pronunciation Database) API. It is useful to external developers who wish to add NameCoach services to an application.",
@@ -5,0 +5,0 @@ "main": "build/main/index.js",

README.md

@@ -241,2 +241,38 @@ # Gpdb Client
 ```
+
+### Preferred recordings
+
+#### Save
+
+Save preferred recordings with
+
+```javascript
+await.client.preferredRecordings.save({
+  firstNameRecordingId: "123456",
+  lastNameRecordingId: "789012",
+  userContext: { signature: '[e-mail]', signatureType: 'email' }
+})
+```
+
+#### Get
+
+Get saved preferred recordings with
+
+```javascript
+await.client.preferredRecordings.get({
+  userContext: { signature: '[e-mail]', signatureType: 'email' }
+})
+```
+
+#### Delete
+
+Delete saved preferred recordings with 
+
+```javascript
+await.client.preferredRecordings.get({
+  firstNameRecordingId: "123456",
+  lastNameRecordingId: "789012",
+  userContext: { signature: '[e-mail]', signatureType: 'email' }
+})
+```
 [Custom attributes documentation](https://namecoachgpdb.docs.apiary.io/#reference/custom-attributes)

No alert changes

Improved metrics

Total package byte prevSize

159812

increased by8.86%

Number of package files

140

increased by6.06%

Lines of code

2087

increased by8.87%

Number of lines in readme file

278

increased by14.88%

No dependency changes