@vouchfor/sdk 1.1.27 → 1.1.29

package/lib/services/baseService.js

@@ -27,6 +27,7 @@ class BaseService {
     this._integrationKey = config.integrationKey || '';
     this._baseUrl = `${config.baseUrl}${basePath}`;
     this._logger = logger;
+    this._utils = utils;
   }
 
   async _callApi({
@@ -48,7 +49,7 @@ class BaseService {
       apiHeaders['x-integration-key'] = integrationKey;
     }
 
-    return utils.request({
+    return this._utils.request({
       body,
       headers: apiHeaders,
       method,

package/lib/services/index.js

@@ -1,9 +1,14 @@
 module.exports = Object.freeze({
+  accounts: require('./rest/accountService'),
+  answers: require('./rest/answerService'),
+  assets: require('./rest/assetService'),
   applications: require('./rest/applicationService'),
   campaigns: require('./rest/campaignService'),
   entities: require('./rest/entityService'),
   integrations: require('./integration/integrationService'),
   vouches: require('./rest/vouchService'),
+  playlists: require('./rest/playlistService'),
+  compositions: require('./rest/compositionService'),
   files: require('./rest/fileService'),
   advocacy: require('./rest/advocacyService'),
   utilities: require('./rest/utilityService'),

package/lib/services/rest/accountService.js

@@ -0,0 +1,21 @@
+const BaseRestService = require('./base');
+
+class CompositionService extends BaseRestService {
+  constructor(client, config, logger) {
+    super(client, config, 'accounts', logger);
+  }
+
+  get(id, apiKey, opts = {}) {
+    return this._request({
+      apiKey,
+      path: `${id}`+ this._utils.queryString(opts)
+    });
+  }
+
+  list(apiKey) {
+    return this._request({ apiKey, path: '' });
+  }
+}
+
+module.exports = CompositionService;
+

package/lib/services/rest/advocacyService.js

@@ -7,7 +7,7 @@ class AdvocacyService extends BaseRestService {
     this.requests = new AdvocacyRequestService(client, config, logger);
   }
 
-  // advocacy has not methods yet
+  // advocacy has no methods yet
 }
 
 module.exports = AdvocacyService;

package/lib/services/rest/answerService.js

@@ -0,0 +1,16 @@
+const BaseRestService = require('./base');
+
+class AnswerService extends BaseRestService {
+  constructor(client, config, logger) {
+    super(client, config, 'answers', logger);
+  }
+
+  search(params, apiKey) {
+    return this._request({
+      apiKey,
+      path: '' + this._utils.queryString(params)
+    });
+  }
+}
+
+module.exports = AnswerService;

package/lib/services/rest/assetService.js

@@ -0,0 +1,16 @@
+const BaseRestService = require('./base');
+
+class AssetService extends BaseRestService {
+  constructor(client, config, logger) {
+    super(client, config, 'assets', logger);
+  }
+
+  search(params, apiKey) {
+    return this._request({
+      apiKey,
+      path: '' + this._utils.queryString(params)
+    });
+  }
+}
+
+module.exports = AssetService;

package/lib/services/rest/campaignService.js

@@ -5,32 +5,73 @@ class CampaignService extends BaseRestService {
     super(client, config, 'campaigns', logger);
   }
 
-  create(campaign, apiKey) {
+  create(payload, apiKey) {
     return this._request({
       apiKey,
-      body: campaign,
+      body: payload,
       path: '',
     });
   }
 
-  update(id, update, apiKey) {
+  update(id, payload, apiKey) {
     return this._request({
       apiKey,
-      body: update,
+      body: payload,
       path: `${id}`
     });
   }
 
-  get(id, apiKey) {
-    return this._request({ apiKey, path: `${id}` });
+  get(id, apiKey, opts = {}) {
+    return this._request({
+      apiKey,
+      path: `${id}`+ this._utils.queryString(opts)
+    });
+  }
+
+  delete(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/delete` });
   }
 
   list(apiKey) {
     return this._request({ apiKey, path: '' });
   }
 
-  vouches(id, apiKey) {
-    return this._request({ apiKey, path: `${id}/vouches` });
+  search(params = {}, apiKey) {
+    return this._request({
+      apiKey,
+      path: 'search' + this._utils.queryString(params)
+    });
+  }
+
+  counts(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/counts` });
+  }
+
+  status(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/status` });
+  }
+
+  publish(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/publish` });
+  }
+
+  pause(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/pause` });
+  }
+
+  vouches(id, apiKey, opts = {}) {
+    return this._request({
+      apiKey,
+      path: `${id}/vouches` + this._utils.queryString(opts)
+    });
+  }
+
+  convert(id, params, apiKey) {
+    return this._request({
+      apiKey,
+      body: params,
+      path: `${id}/vouch`
+    });
   }
 }
 

package/lib/services/rest/compositionService.js

@@ -0,0 +1,52 @@
+const BaseRestService = require('./base');
+
+class CompositionService extends BaseRestService {
+  constructor(client, config, logger) {
+    super(client, config, 'compositions', logger);
+  }
+
+  create(payload, apiKey) {
+    return this._request({
+      apiKey,
+      body: payload,
+      path: '',
+    });
+  }
+
+  update(id, payload, apiKey) {
+    return this._request({
+      apiKey,
+      body: payload,
+      path: `${id}`
+    });
+  }
+
+  get(id, apiKey, opts = {}) {
+    return this._request({
+      apiKey,
+      path: `${id}`+ this._utils.queryString(opts)
+    });
+  }
+
+  delete(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/delete` });
+  }
+
+  list(apiKey) {
+    return this._request({ apiKey, path: '' });
+  }
+
+  search(params = {}, apiKey) {
+    return this._request({
+      apiKey,
+      path: 'search' + this._utils.queryString(params)
+    });
+  }
+
+  counts(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/counts` });
+  }
+}
+
+module.exports = CompositionService;
+

package/lib/services/rest/entityService.js

@@ -40,6 +40,14 @@ class EntityService extends BaseRestService {
   users(id, apiKey) {
     return this._request({ apiKey, path: `${id}/users` });
   }
+
+  quotes(id, params, apiKey) {
+    return this._request({
+      apiKey,
+      body: params,
+      path: `${id}/quotes`
+    });
+  }
 }
 
 module.exports = EntityService;

package/lib/services/rest/fileService.js

@@ -13,12 +13,13 @@ class FileService extends BaseRestService {
     return this._request({ apiKey, path: `${id}` });
   }
 
-  upload(file, key, apiKey, { extract } = {}) {
+  upload(file, key, apiKey, { extract, extname } = {}) {
     const input = fs.createReadStream(file);
     const form = new FormData();
     form.append('title', key);
     form.append('file', input);
     form.append('extract', !!extract);
+    form.append('extname', !!extname);
     return this._request({
       apiKey,
       body: form,
@@ -54,12 +55,13 @@ class FileService extends BaseRestService {
   }
   ///////////////////////////////////////////*/
 
-  proxy(url, key, apiKey, { extract, headers } = {}) {
+  proxy(url, key, apiKey, { extract, extname, headers } = {}) {
     return this._request({
       apiKey,
       body: {
         url,
         extract,
+        extname,
         headers
       },
       path: key

package/lib/services/rest/playlistService.js

@@ -0,0 +1,51 @@
+const BaseRestService = require('./base');
+
+class PlaylistService extends BaseRestService {
+  constructor(client, config, logger) {
+    super(client, config, 'playlists', logger);
+  }
+
+  create(payload, apiKey) {
+    return this._request({
+      apiKey,
+      body: payload,
+      path: '',
+    });
+  }
+
+  update(id, payload, apiKey) {
+    return this._request({
+      apiKey,
+      body: payload,
+      path: `${id}`
+    });
+  }
+
+  get(id, apiKey, opts = {}) {
+    return this._request({
+      apiKey,
+      path: `${id}`+ this._utils.queryString(opts)
+    });
+  }
+
+  delete(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/delete` });
+  }
+
+  list(apiKey) {
+    return this._request({ apiKey, path: '' });
+  }
+
+  search(params = {}, apiKey) {
+    return this._request({
+      apiKey,
+      path: 'search' + this._utils.queryString(params)
+    });
+  }
+
+  counts(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/counts` });
+  }
+}
+
+module.exports = PlaylistService;

package/lib/services/rest/vouchService.js

@@ -5,27 +5,41 @@ class VouchService extends BaseRestService {
     super(client, config, 'vouches', logger);
   }
 
-  create(vouch, apiKey) {
+  create(payload, apiKey) {
     return this._request({
       apiKey,
-      body: vouch,
+      body: payload,
       path: '',
     });
   }
 
-  update(id, update, apiKey) {
+  update(id, payload, apiKey) {
     return this._request({
       apiKey,
-      body: update,
+      body: payload,
       path: `${id}`
     });
   }
 
-  get(id, apiKey, media = false) {
-    const query = media ? '?media=true' : ''
+  get(id, apiKey, opts = {}) {
     return this._request({
       apiKey,
-      path: `${id}`+ query
+      path: `${id}`+ this._utils.queryString(opts)
+    });
+  }
+
+  delete(id, apiKey) {
+    return this._request({ apiKey, path: `${id}/delete` });
+  }
+
+  list(apiKey) {
+    return this._request({ apiKey, path: '' });
+  }
+
+  search(params = {}, apiKey) {
+    return this._request({
+      apiKey,
+      path: 'search' + this._utils.queryString(params)
     });
   }
 
@@ -37,14 +51,10 @@ class VouchService extends BaseRestService {
     return this._request({ apiKey, path: `${id}/status` });
   }
 
-  list(apiKey) {
-    return this._request({ apiKey, path: '' });
-  }
-
-  upload(vouch, apiKey) {
+  upload(payload, apiKey) {
     return this._request({
       apiKey,
-      body: vouch,
+      body: payload,
       path: 'upload',
     });
   }
@@ -57,20 +67,20 @@ class VouchService extends BaseRestService {
     }
 
     return {
-      create: (clips, { id, ordinality }, apiKey) => {
+      create: (payload, { id, ordinality }, apiKey) => {
         const path = getPath(id, ordinality);
         return this._request({
           apiKey,
-          body: clips,
+          body: payload,
           path
         });
       },
 
-      delete: (clips, { id, ordinality }, apiKey) => {
+      delete: (payload, { id, ordinality }, apiKey) => {
         const path = getPath(id, ordinality);
         return this._request({
           apiKey,
-          body: clips,
+          body: payload,
           path: `${path}/delete`
         });
       },

package/lib/shared/utils.js

@@ -76,6 +76,12 @@ module.exports = {
     const isProd = env === 'prod';
     return isProd ? '' : `-${env}`;
   },
+  queryString(opts) {
+    const query = new URLSearchParams(
+      Object.entries(opts).filter(([,value]) => value)
+    ).toString();
+    return query ? `?${query}` : '';
+  },
   request({ body, headers, method, url, logger }) {
     const { protocol, hostname, port, pathname, search = '' } = new URL(url);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/sdk",
-  "version": "1.1.27",
+  "version": "1.1.29",
   "description": "Vouch API SDK",
   "main": "lib/index.js",
   "repository": {

package/test-accounts.js

@@ -0,0 +1,16 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+const id = 'WncEfS4KgY';
+
+(async () => {
+  const accounts = await vouchClient.accounts.list(apiKey).catch(() => undefined);
+  console.log(accounts);
+  const account = await vouchClient.accounts.get(id, apiKey).catch(() => undefined);
+  console.log(account);
+})();

package/test-answers.js

@@ -0,0 +1,17 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+
+(async () => {
+  const params = {
+    //query: 'clients',
+    limit: 5
+  };
+  const data = await vouchClient.answers.search(params, apiKey).catch(() => undefined);
+  console.log(data);
+})();

package/test-assets.js

@@ -0,0 +1,17 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+
+(async () => {
+  const params = {
+    //query: 'clients',
+    limit: 5
+  };
+  const data = await vouchClient.assets.search(params, apiKey).catch(() => undefined);
+  console.log(data);
+})();

package/test-campaigns.js

@@ -0,0 +1,20 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+console.log(vouchClient);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+
+(async () => {
+  const params = {
+    query: 'why',
+    limit: 2
+  };
+  const data = await vouchClient.campaigns.search(params, apiKey).catch(() => undefined);
+  console.log(data);
+})();
+

package/test-canva.js

@@ -0,0 +1,53 @@
+const axios = require('axios');
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+const VOUCH_APPLICATION_API_KEY = vouchClient.integrationKey;
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+
+const answerBaseUrl = vouchClient.vouches._baseUrl.replace('/vouches', '/answers');
+const listAnswersUrl = answerBaseUrl;
+const trackAnswerUrl = answerBaseUrl + '/track';
+
+const listAssetsUrl = vouchClient.vouches._baseUrl.replace('/vouches', '/assets');
+
+const listAnswers = (key, params) => {
+  return axios({
+    method: 'GET',
+    params,
+    url: listAnswersUrl,
+    headers: {
+      accept: 'application/json',
+      'content-type': 'application/json',
+      'x-integration-key': VOUCH_APPLICATION_API_KEY,
+      'x-api-key': key
+    }
+  });
+};
+
+const listAssets = (key, params) => {
+  return axios({
+    method: 'GET',
+    params,
+    url: listAssetsUrl,
+    headers: {
+      accept: 'application/json',
+      'content-type': 'application/json',
+      'x-integration-key': VOUCH_APPLICATION_API_KEY,
+      'x-api-key': key
+    }
+  });
+};
+
+(async () => {
+  const params = {
+    query: 'clients'
+  };
+  const data = await listAnswers(apiKey, params).catch(() => undefined);
+  console.log(data.data);
+})();

package/test-search.js

@@ -0,0 +1,18 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+
+(async () => {
+  const params = {
+    query: 'clients',
+    limit: 2
+  };
+  const data = await vouchClient.vouches.search(params, apiKey).catch(() => undefined);
+  console.log(data);
+})();
+

package/test-upload.js

@@ -0,0 +1,17 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+}, console);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+const url = 'https://examplefiles.org/files/video/mp4-example-video-download-640x480.mp4'
+const key1 = 'delete/file_example_MP4_480_1_5MG.mp4';
+const key2 = 'delete/file_example_MP4_480_1_EXT';
+
+(async () => {
+  const result = await vouchClient.files.proxy(url, key1, apiKey, { extract: true, extname: true }).catch(() => undefined);
+  console.log(result);
+})();
+