swiftyper-node 1.0.9 → 1.0.11

package/lib/makeRequest.js

@@ -1,103 +1,105 @@
-'use strict';
-
-const utils = require('./utils');
-
-function getRequestOpts(self, requestArgs, spec, overrideData) {
-  const commandPath = utils.makeURLInterpolator(spec.path || '');
-  const requestMethod = (spec.method || 'POST').toUpperCase();
-  const urlParams = spec.urlParams || [];
-  const encode = spec.encode || ((data) => data);
-  const host = spec.host;
-  const path = self.createResourcePathWithSymbols(spec.path);
-
-  const args = [].slice.call(requestArgs);
-
-  const urlData = urlParams.reduce((urlData, param) => {
-    const arg = args.shift();
-    if (typeof arg !== 'string') {
-      throw new Error(
-        `Swiftyper: Argument "${param}" must be a string, but got: ${arg} (on API request to \`${requestMethod} ${path}\`)`
-      );
-    }
-
-    urlData[param] = arg;
-    return urlData;
-  }, {});
-
-  const dataFromArgs = utils.getDataFromArgs(args);
-  const data = encode(Object.assign({}, dataFromArgs, overrideData));
-  const options = utils.getOptionsFromArgs(args);
-
-  if (args.filter((x) => x != null).length) {
-    throw new Error(
-      `Swiftyper: Unknown arguments (${args}). Did you mean to pass an options object? See https://github.com/swiftyper-sk/swiftyper-node/wiki/Passing-Options. (on API request to ${requestMethod} \`${path}\`)`
-    );
-  }
-
-  const requestPath = self.createFullPath(commandPath, urlData);
-  const headers = Object.assign(options.headers, spec.headers);
-
-  if (spec.validator) {
-    spec.validator(data, {headers});
-  }
-
-  const dataInQuery = spec.method === 'GET';
-  const bodyData = dataInQuery ? {} : data;
-  const queryData = dataInQuery ? data : {};
-
-  return {
-    requestMethod,
-    requestPath,
-    bodyData,
-    queryData,
-    auth: options.auth,
-    headers,
-    host,
-    settings: options.settings,
-  };
-}
-
-function makeRequest(self, requestArgs, spec, overrideData) {
-  return new Promise((resolve, reject) => {
-    let opts;
-    try {
-      opts = getRequestOpts(self, requestArgs, spec, overrideData);
-    } catch (err) {
-      reject(err);
-      return;
-    }
-
-    function requestCallback(err, response) {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(
-          spec.transformResponseData
-            ? spec.transformResponseData(response)
-            : response
-        );
-      }
-    }
-
-    const emptyQuery = Object.keys(opts.queryData).length === 0;
-    const path = [
-      opts.requestPath,
-      emptyQuery ? '' : '?',
-      utils.stringifyRequestData(opts.queryData),
-    ].join('');
-
-    const {headers, settings} = opts;
-
-    self._request(
-      opts.requestMethod,
-      opts.host,
-      path,
-      opts.bodyData,
-      opts.auth,
-      {headers, settings},
-      requestCallback
-    );
-  });
-}
-
-module.exports = makeRequest;
+'use strict';
+
+const utils = require('./utils');
+
+function getRequestOpts(self, requestArgs, spec, overrideData) {
+  const commandPath = utils.makeURLInterpolator(spec.path || '');
+  const requestMethod = (spec.method || 'POST').toUpperCase();
+  const urlParams = spec.urlParams || [];
+  const encode = spec.encode || ((data) => data);
+  const host = spec.host;
+  const path = self.createResourcePathWithSymbols(spec.path);
+
+  const args = [].slice.call(requestArgs);
+
+  const urlData = urlParams.reduce((urlData, param) => {
+    const arg = args.shift();
+    if (typeof arg !== 'string') {
+      throw new Error(
+        `Swiftyper: Argument "${param}" must be a string, but got: ${arg} (on API request to \`${requestMethod} ${path}\`)`
+      );
+    }
+
+    urlData[param] = arg;
+    return urlData;
+  }, {});
+
+  const dataFromArgs = utils.getDataFromArgs(args);
+  const data = encode(Object.assign({}, dataFromArgs, overrideData));
+  const options = utils.getOptionsFromArgs(args);
+
+  if (args.filter((x) => x != null).length) {
+    throw new Error(
+      `Swiftyper: Unknown arguments (${args}). Did you mean to pass an options object? See https://github.com/swiftyper-sk/swiftyper-node/wiki/Passing-Options. (on API request to ${requestMethod} \`${path}\`)`
+    );
+  }
+
+  const requestPath = self.createFullPath(commandPath, urlData);
+  const headers = Object.assign(options.headers, spec.headers);
+
+  if (spec.validator) {
+    spec.validator(data, {headers});
+  }
+
+  const dataInQuery = spec.method === 'GET';
+  const bodyData = dataInQuery ? {} : data;
+  const queryData = dataInQuery ? data : {};
+
+  return {
+    requestMethod,
+    requestPath,
+    bodyData,
+    queryData,
+    auth: options.auth,
+    headers,
+    host,
+    settings: options.settings,
+  };
+}
+
+function makeRequest(self, requestArgs, spec, overrideData) {
+  return new Promise((resolve, reject) => {
+    let opts;
+    try {
+      opts = getRequestOpts(self, requestArgs, spec, overrideData);
+    } catch (err) {
+      reject(err);
+      return;
+    }
+
+    function requestCallback(err, response) {
+      if (err) {
+        reject(err);
+      } else if (spec.streaming) {
+        resolve(utils.parseSSEStream(response));
+      } else {
+        resolve(
+          spec.transformResponseData
+            ? spec.transformResponseData(response)
+            : response
+        );
+      }
+    }
+
+    const emptyQuery = Object.keys(opts.queryData).length === 0;
+    const path = [
+      opts.requestPath,
+      emptyQuery ? '' : '?',
+      utils.stringifyRequestData(opts.queryData),
+    ].join('');
+
+    const {headers, settings} = opts;
+
+    self._request(
+      opts.requestMethod,
+      opts.host,
+      path,
+      opts.bodyData,
+      opts.auth,
+      {headers, settings, rawStream: !!spec.streaming},
+      requestCallback
+    );
+  });
+}
+
+module.exports = makeRequest;

package/lib/resources/Business.js

@@ -1,23 +1,23 @@
-'use strict';
-
-const SwiftyperResource = require('../SwiftyperResource');
-const swiftyperMethod = SwiftyperResource.method;
-
-module.exports = SwiftyperResource.extend({
-  path: 'business',
-
-  query: swiftyperMethod({
-    method: 'POST',
-    path: '/query',
-  }),
-
-  identifier: swiftyperMethod({
-    method: 'POST',
-    path: '/identifier',
-  }),
-
-  detail: swiftyperMethod({
-    method: 'POST',
-    path: '/{business_id}',
-  }),
-});
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'business',
+
+  query: swiftyperMethod({
+    method: 'POST',
+    path: '/query',
+  }),
+
+  identifier: swiftyperMethod({
+    method: 'POST',
+    path: '/identifier',
+  }),
+
+  detail: swiftyperMethod({
+    method: 'POST',
+    path: '/{business_id}',
+  }),
+});

package/lib/resources/EmailUtil.js

@@ -1,13 +1,13 @@
-'use strict';
-
-const SwiftyperResource = require('../SwiftyperResource');
-const swiftyperMethod = SwiftyperResource.method;
-
-module.exports = SwiftyperResource.extend({
-  path: 'utils/email',
-
-  validate: swiftyperMethod({
-    method: 'POST',
-    path: '/validate',
-  }),
-});
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'utils/email',
+
+  validate: swiftyperMethod({
+    method: 'POST',
+    path: '/validate',
+  }),
+});

package/lib/resources/Fbt.js

@@ -1,13 +1,13 @@
-'use strict';
-
-const SwiftyperResource = require('../SwiftyperResource');
-const swiftyperMethod = SwiftyperResource.method;
-
-module.exports = SwiftyperResource.extend({
-  path: 'intl/fbt',
-
-  init: swiftyperMethod({
-    method: 'POST',
-    path: '/initialize',
-  }),
-});
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'intl/fbt',
+
+  init: swiftyperMethod({
+    method: 'POST',
+    path: '/initialize',
+  }),
+});

package/lib/resources/HelpCenter.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'help-center',
+
+  configuration: swiftyperMethod({
+    method: 'POST',
+    path: '/configuration',
+  }),
+
+  contact: swiftyperMethod({
+    method: 'POST',
+    path: '/contact',
+  }),
+});

package/lib/resources/HelpCenterArticle.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'help-center/articles',
+
+  query: swiftyperMethod({
+    method: 'POST',
+    path: '/query',
+  }),
+
+  popular: swiftyperMethod({
+    method: 'POST',
+    path: '/popular',
+  }),
+
+  detail: swiftyperMethod({
+    method: 'POST',
+    path: '/{article_id}',
+  }),
+});

package/lib/resources/HelpCenterCategory.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'help-center/categories',
+
+  query: swiftyperMethod({
+    method: 'POST',
+    path: '/query',
+  }),
+
+  detail: swiftyperMethod({
+    method: 'POST',
+    path: '/{category_id}',
+  }),
+});

package/lib/resources/HelpCenterChat.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'help-center/chat',
+
+  stream: swiftyperMethod({
+    method: 'POST',
+    headers: {Accept: 'text/event-stream'},
+    path: '/stream',
+    streaming: true,
+  }),
+
+  handoff: swiftyperMethod({
+    method: 'POST',
+    path: '/handoff',
+  }),
+
+  contact: swiftyperMethod({
+    method: 'POST',
+    path: '/handoffs/{request_id}/contact',
+  }),
+
+  skip: swiftyperMethod({
+    method: 'POST',
+    path: '/handoffs/{request_id}/skip',
+  }),
+
+  feedback: swiftyperMethod({
+    method: 'POST',
+    path: '/{session_id}/feedback',
+  }),
+
+  end: swiftyperMethod({
+    method: 'POST',
+    path: '/{session_id}/end',
+  }),
+});

package/lib/resources/IpUtil.js

@@ -1,13 +1,13 @@
-'use strict';
-
-const SwiftyperResource = require('../SwiftyperResource');
-const swiftyperMethod = SwiftyperResource.method;
-
-module.exports = SwiftyperResource.extend({
-  path: 'utils/ip',
-
-  info: swiftyperMethod({
-    method: 'GET',
-    path: '/{ip_address}',
-  }),
-});
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'utils/ip',
+
+  info: swiftyperMethod({
+    method: 'GET',
+    path: '/{ip_address}',
+  }),
+});

package/lib/resources/Phrase.js

@@ -1,23 +1,23 @@
-'use strict';
-
-const SwiftyperResource = require('../SwiftyperResource');
-const swiftyperMethod = SwiftyperResource.method;
-
-module.exports = SwiftyperResource.extend({
-  path: 'intl/phrases',
-
-  query: swiftyperMethod({
-    method: 'POST',
-    path: '/query',
-  }),
-
-  upload: swiftyperMethod({
-    method: 'POST',
-    path: '/upload',
-  }),
-
-  raw: swiftyperMethod({
-    method: 'GET',
-    path: '/raw',
-  }),
-});
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'intl/phrases',
+
+  query: swiftyperMethod({
+    method: 'POST',
+    path: '/query',
+  }),
+
+  upload: swiftyperMethod({
+    method: 'POST',
+    path: '/upload',
+  }),
+
+  raw: swiftyperMethod({
+    method: 'GET',
+    path: '/raw',
+  }),
+});

package/lib/resources/Places.js

@@ -1,58 +1,58 @@
-'use strict';
-
-const SwiftyperResource = require('../SwiftyperResource');
-const swiftyperMethod = SwiftyperResource.method;
-
-module.exports = SwiftyperResource.extend({
-  path: 'places',
-
-  query: swiftyperMethod({
-    method: 'POST',
-    path: '/query',
-  }),
-
-  validate: swiftyperMethod({
-    method: 'POST',
-    path: '/validate',
-  }),
-
-  street: swiftyperMethod({
-    method: 'POST',
-    path: '/street',
-  }),
-
-  municipality: swiftyperMethod({
-    method: 'POST',
-    path: '/municipality',
-  }),
-
-  postal: swiftyperMethod({
-    method: 'POST',
-    path: '/postal',
-  }),
-
-  reverse: swiftyperMethod({
-    method: 'POST',
-    path: '/reverse',
-  }),
-
-  regions: swiftyperMethod({
-    method: 'POST',
-    path: '/regions',
-  }),
-
-  counties: swiftyperMethod({
-    method: 'POST',
-    path: '/counties',
-  }),
-
-  municipalities: swiftyperMethod({
-    method: 'POST',
-    path: '/municipalities',
-  }),
-
-  detail: swiftyperMethod({
-    method: 'POST',
-    path: '/{place_id}',
-  }),
-});
+'use strict';
+
+const SwiftyperResource = require('../SwiftyperResource');
+const swiftyperMethod = SwiftyperResource.method;
+
+module.exports = SwiftyperResource.extend({
+  path: 'places',
+
+  query: swiftyperMethod({
+    method: 'POST',
+    path: '/query',
+  }),
+
+  validate: swiftyperMethod({
+    method: 'POST',
+    path: '/validate',
+  }),
+
+  street: swiftyperMethod({
+    method: 'POST',
+    path: '/street',
+  }),
+
+  municipality: swiftyperMethod({
+    method: 'POST',
+    path: '/municipality',
+  }),
+
+  postal: swiftyperMethod({
+    method: 'POST',
+    path: '/postal',
+  }),
+
+  reverse: swiftyperMethod({
+    method: 'POST',
+    path: '/reverse',
+  }),
+
+  regions: swiftyperMethod({
+    method: 'POST',
+    path: '/regions',
+  }),
+
+  counties: swiftyperMethod({
+    method: 'POST',
+    path: '/counties',
+  }),
+
+  municipalities: swiftyperMethod({
+    method: 'POST',
+    path: '/municipalities',
+  }),
+
+  detail: swiftyperMethod({
+    method: 'POST',
+    path: '/{place_id}',
+  }),
+});