@suprsend/node-sdk 1.11.1 → 1.13.0

package/dist/objects_api.js

@@ -0,0 +1,527 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _utils = require("./utils");
+var _signature = _interopRequireDefault(require("./signature"));
+var _axios = _interopRequireDefault(require("axios"));
+var _object_edit = _interopRequireDefault(require("./object_edit"));
+var ObjectsApi = /*#__PURE__*/function () {
+  function ObjectsApi(config) {
+    (0, _classCallCheck2["default"])(this, ObjectsApi);
+    this.config = config;
+    this.list_url = "".concat(this.config.base_url, "v1/object/");
+    this.bulk_url = "".concat(this.config.base_url, "v1/bulk/object/");
+  }
+  (0, _createClass2["default"])(ObjectsApi, [{
+    key: "__get_headers",
+    value: function __get_headers() {
+      return {
+        "Content-Type": "application/json; charset=utf-8",
+        "User-Agent": this.config.user_agent,
+        Date: new Date().toISOString()
+      };
+    }
+  }, {
+    key: "_validate_object_type",
+    value: function _validate_object_type(object_type) {
+      if (!object_type || !(0, _utils.is_string)(object_type) || !object_type.trim()) {
+        throw new _utils.InputValueError("missing object_type");
+      }
+      return object_type.trim();
+    }
+  }, {
+    key: "_validate_object_id",
+    value: function _validate_object_id(object_id) {
+      if (!object_id || !(0, _utils.is_string)(object_id) || !object_id.trim()) {
+        throw new _utils.InputValueError("missing object_id");
+      }
+      return object_id.trim();
+    }
+  }, {
+    key: "list",
+    value: function () {
+      var _list = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(object_type, options) {
+        var object_type_encoded, encoded_options, url, headers, sig, response;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                object_type = this._validate_object_type(object_type);
+                object_type_encoded = encodeURIComponent(object_type);
+                encoded_options = options ? new URLSearchParams(options).toString() : "";
+                url = "".concat(this.list_url).concat(object_type_encoded, "/").concat(encoded_options ? "?".concat(encoded_options) : "");
+                headers = this.__get_headers();
+                sig = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(sig);
+                _context.prev = 7;
+                _context.next = 10;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+              case 10:
+                response = _context.sent;
+                return _context.abrupt("return", response.data);
+              case 14:
+                _context.prev = 14;
+                _context.t0 = _context["catch"](7);
+                throw new _utils.SuprsendApiError(_context.t0);
+              case 17:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this, [[7, 14]]);
+      }));
+      function list(_x, _x2) {
+        return _list.apply(this, arguments);
+      }
+      return list;
+    }()
+  }, {
+    key: "detail_url",
+    value: function detail_url(object_type, object_id) {
+      object_type = this._validate_object_type(object_type);
+      var object_type_encoded = encodeURIComponent(object_type);
+      object_id = this._validate_object_id(object_id);
+      var object_id_encoded = encodeURIComponent(object_id);
+      return "".concat(this.list_url).concat(object_type_encoded, "/").concat(object_id_encoded, "/");
+    }
+  }, {
+    key: "get",
+    value: function () {
+      var _get = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(object_type, object_id) {
+        var url, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                url = this.detail_url(object_type, object_id);
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context2.prev = 4;
+                _context2.next = 7;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+              case 7:
+                response = _context2.sent;
+                return _context2.abrupt("return", response.data);
+              case 11:
+                _context2.prev = 11;
+                _context2.t0 = _context2["catch"](4);
+                throw new _utils.SuprsendApiError(_context2.t0);
+              case 14:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2, this, [[4, 11]]);
+      }));
+      function get(_x3, _x4) {
+        return _get.apply(this, arguments);
+      }
+      return get;
+    }()
+  }, {
+    key: "upsert",
+    value: function () {
+      var _upsert = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(object_type, object_id) {
+        var payload,
+          url,
+          headers,
+          content_text,
+          signature,
+          response,
+          _args3 = arguments;
+        return _regenerator["default"].wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                payload = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : {};
+                url = this.detail_url(object_type, object_id);
+                payload = payload || {};
+                headers = this.__get_headers();
+                content_text = JSON.stringify(payload || {});
+                signature = (0, _signature["default"])(url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context3.prev = 7;
+                _context3.next = 10;
+                return _axios["default"].post(url, content_text, {
+                  headers: headers
+                });
+              case 10:
+                response = _context3.sent;
+                return _context3.abrupt("return", response.data);
+              case 14:
+                _context3.prev = 14;
+                _context3.t0 = _context3["catch"](7);
+                throw new _utils.SuprsendApiError(_context3.t0);
+              case 17:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3, this, [[7, 14]]);
+      }));
+      function upsert(_x5, _x6) {
+        return _upsert.apply(this, arguments);
+      }
+      return upsert;
+    }()
+  }, {
+    key: "edit",
+    value: function () {
+      var _edit = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(edit_ins_or_object_type, object_id, edit_payload) {
+        var payload, url, edit_ins, object_type, content_text, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee4$(_context4) {
+          while (1) {
+            switch (_context4.prev = _context4.next) {
+              case 0:
+                if (edit_ins_or_object_type instanceof _object_edit["default"]) {
+                  edit_ins = edit_ins_or_object_type;
+                  edit_ins.validate_body();
+                  payload = edit_ins.get_payload();
+                  url = this.detail_url(edit_ins.object_type, edit_ins.object_id);
+                } else {
+                  object_type = edit_ins_or_object_type;
+                  payload = edit_payload || {};
+                  url = this.detail_url(object_type, object_id);
+                }
+                content_text = JSON.stringify(payload || {});
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "PATCH", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context4.prev = 5;
+                _context4.next = 8;
+                return _axios["default"].patch(url, content_text, {
+                  headers: headers
+                });
+              case 8:
+                response = _context4.sent;
+                return _context4.abrupt("return", response.data);
+              case 12:
+                _context4.prev = 12;
+                _context4.t0 = _context4["catch"](5);
+                throw new _utils.SuprsendApiError(_context4.t0);
+              case 15:
+              case "end":
+                return _context4.stop();
+            }
+          }
+        }, _callee4, this, [[5, 12]]);
+      }));
+      function edit(_x7, _x8, _x9) {
+        return _edit.apply(this, arguments);
+      }
+      return edit;
+    }()
+  }, {
+    key: "delete",
+    value: function () {
+      var _delete2 = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5(object_type, object_id) {
+        var url, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee5$(_context5) {
+          while (1) {
+            switch (_context5.prev = _context5.next) {
+              case 0:
+                url = this.detail_url(object_type, object_id);
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "DELETE", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context5.prev = 4;
+                _context5.next = 7;
+                return _axios["default"]["delete"](url, {
+                  headers: headers
+                });
+              case 7:
+                response = _context5.sent;
+                if (!(response.status >= 200 && response.status < 300)) {
+                  _context5.next = 12;
+                  break;
+                }
+                return _context5.abrupt("return", {
+                  success: true,
+                  status_code: response.status
+                });
+              case 12:
+                throw new _utils.SuprsendApiError(response.statusText);
+              case 13:
+                _context5.next = 18;
+                break;
+              case 15:
+                _context5.prev = 15;
+                _context5.t0 = _context5["catch"](4);
+                throw new _utils.SuprsendApiError(_context5.t0);
+              case 18:
+              case "end":
+                return _context5.stop();
+            }
+          }
+        }, _callee5, this, [[4, 15]]);
+      }));
+      function _delete(_x10, _x11) {
+        return _delete2.apply(this, arguments);
+      }
+      return _delete;
+    }()
+  }, {
+    key: "bulk_delete",
+    value: function () {
+      var _bulk_delete = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee6(object_type, payload) {
+        var object_type_encoded, url, headers, content_text, signature, response;
+        return _regenerator["default"].wrap(function _callee6$(_context6) {
+          while (1) {
+            switch (_context6.prev = _context6.next) {
+              case 0:
+                object_type = this._validate_object_type(object_type);
+                object_type_encoded = encodeURIComponent(object_type);
+                url = "".concat(this.bulk_url).concat(object_type_encoded, "/");
+                payload = payload || {};
+                headers = this.__get_headers();
+                content_text = JSON.stringify(payload);
+                signature = (0, _signature["default"])(url, "DELETE", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context6.prev = 8;
+                _context6.next = 11;
+                return _axios["default"]["delete"](url, {
+                  headers: headers,
+                  data: content_text
+                });
+              case 11:
+                response = _context6.sent;
+                if (!(response.status >= 200 && response.status < 300)) {
+                  _context6.next = 16;
+                  break;
+                }
+                return _context6.abrupt("return", {
+                  success: true,
+                  status_code: response.status
+                });
+              case 16:
+                throw new _utils.SuprsendApiError(response.statusText);
+              case 17:
+                _context6.next = 22;
+                break;
+              case 19:
+                _context6.prev = 19;
+                _context6.t0 = _context6["catch"](8);
+                throw new _utils.SuprsendApiError(_context6.t0);
+              case 22:
+              case "end":
+                return _context6.stop();
+            }
+          }
+        }, _callee6, this, [[8, 19]]);
+      }));
+      function bulk_delete(_x12, _x13) {
+        return _bulk_delete.apply(this, arguments);
+      }
+      return bulk_delete;
+    }()
+  }, {
+    key: "get_subscriptions",
+    value: function () {
+      var _get_subscriptions = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee7(object_type, object_id, options) {
+        var encoded_options, _detail_url, url, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee7$(_context7) {
+          while (1) {
+            switch (_context7.prev = _context7.next) {
+              case 0:
+                encoded_options = options ? new URLSearchParams(options).toString() : "";
+                _detail_url = this.detail_url(object_type, object_id);
+                url = "".concat(_detail_url, "subscription/").concat(encoded_options ? "?".concat(encoded_options) : "");
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context7.prev = 6;
+                _context7.next = 9;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+              case 9:
+                response = _context7.sent;
+                return _context7.abrupt("return", response.data);
+              case 13:
+                _context7.prev = 13;
+                _context7.t0 = _context7["catch"](6);
+                throw new _utils.SuprsendApiError(_context7.t0);
+              case 16:
+              case "end":
+                return _context7.stop();
+            }
+          }
+        }, _callee7, this, [[6, 13]]);
+      }));
+      function get_subscriptions(_x14, _x15, _x16) {
+        return _get_subscriptions.apply(this, arguments);
+      }
+      return get_subscriptions;
+    }()
+  }, {
+    key: "create_subscriptions",
+    value: function () {
+      var _create_subscriptions = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee8(object_type, object_id, payload) {
+        var _detail_url, url, content_text, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee8$(_context8) {
+          while (1) {
+            switch (_context8.prev = _context8.next) {
+              case 0:
+                _detail_url = this.detail_url(object_type, object_id);
+                url = "".concat(_detail_url, "subscription/");
+                payload = payload || {};
+                content_text = JSON.stringify(payload);
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context8.prev = 7;
+                _context8.next = 10;
+                return _axios["default"].post(url, content_text, {
+                  headers: headers
+                });
+              case 10:
+                response = _context8.sent;
+                return _context8.abrupt("return", response.data);
+              case 14:
+                _context8.prev = 14;
+                _context8.t0 = _context8["catch"](7);
+                throw new _utils.SuprsendApiError(_context8.t0);
+              case 17:
+              case "end":
+                return _context8.stop();
+            }
+          }
+        }, _callee8, this, [[7, 14]]);
+      }));
+      function create_subscriptions(_x17, _x18, _x19) {
+        return _create_subscriptions.apply(this, arguments);
+      }
+      return create_subscriptions;
+    }()
+  }, {
+    key: "delete_subscriptions",
+    value: function () {
+      var _delete_subscriptions = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee9(object_type, object_id, payload) {
+        var _detail_url, url, content_text, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee9$(_context9) {
+          while (1) {
+            switch (_context9.prev = _context9.next) {
+              case 0:
+                _detail_url = this.detail_url(object_type, object_id);
+                url = "".concat(_detail_url, "subscription/");
+                payload = payload || {};
+                content_text = JSON.stringify(payload);
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "DELETE", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context9.prev = 7;
+                _context9.next = 10;
+                return _axios["default"]["delete"](url, {
+                  headers: headers,
+                  data: content_text
+                });
+              case 10:
+                response = _context9.sent;
+                if (!(response.status >= 200 && response.status < 300)) {
+                  _context9.next = 15;
+                  break;
+                }
+                return _context9.abrupt("return", {
+                  success: true,
+                  status_code: response.status
+                });
+              case 15:
+                throw new _utils.SuprsendApiError(response.statusText);
+              case 16:
+                _context9.next = 21;
+                break;
+              case 18:
+                _context9.prev = 18;
+                _context9.t0 = _context9["catch"](7);
+                throw new _utils.SuprsendApiError(_context9.t0);
+              case 21:
+              case "end":
+                return _context9.stop();
+            }
+          }
+        }, _callee9, this, [[7, 18]]);
+      }));
+      function delete_subscriptions(_x20, _x21, _x22) {
+        return _delete_subscriptions.apply(this, arguments);
+      }
+      return delete_subscriptions;
+    }()
+  }, {
+    key: "get_objects_subscribed_to",
+    value: function () {
+      var _get_objects_subscribed_to = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee10(object_type, object_id) {
+        var options,
+          encoded_options,
+          _detail_url,
+          url,
+          headers,
+          signature,
+          response,
+          _args10 = arguments;
+        return _regenerator["default"].wrap(function _callee10$(_context10) {
+          while (1) {
+            switch (_context10.prev = _context10.next) {
+              case 0:
+                options = _args10.length > 2 && _args10[2] !== undefined ? _args10[2] : null;
+                encoded_options = options ? new URLSearchParams(options).toString() : "";
+                _detail_url = this.detail_url(object_type, object_id);
+                url = "".concat(_detail_url, "subscribed_to/object/").concat(encoded_options ? "?".concat(encoded_options) : "");
+                headers = this.__get_headers();
+                signature = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context10.prev = 7;
+                _context10.next = 10;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+              case 10:
+                response = _context10.sent;
+                return _context10.abrupt("return", response.data);
+              case 14:
+                _context10.prev = 14;
+                _context10.t0 = _context10["catch"](7);
+                throw new _utils.SuprsendApiError(_context10.t0);
+              case 17:
+              case "end":
+                return _context10.stop();
+            }
+          }
+        }, _callee10, this, [[7, 14]]);
+      }));
+      function get_objects_subscribed_to(_x23, _x24) {
+        return _get_objects_subscribed_to.apply(this, arguments);
+      }
+      return get_objects_subscribed_to;
+    }()
+  }, {
+    key: "get_instance",
+    value: function get_instance(object_type, object_id) {
+      object_type = this._validate_object_type(object_type);
+      object_id = this._validate_object_id(object_id);
+      return new _object_edit["default"](this.config, object_type, object_id);
+    }
+  }, {
+    key: "get_edit_instance",
+    value: function get_edit_instance(object_type, object_id) {
+      object_type = this._validate_object_type(object_type);
+      object_id = this._validate_object_id(object_id);
+      return new _object_edit["default"](this.config, object_type, object_id);
+    }
+  }]);
+  return ObjectsApi;
+}();
+exports["default"] = ObjectsApi;
+module.exports = exports.default;

package/dist/request_json/workflow.json

@@ -51,7 +51,6 @@
       "type": "array",
       "items": { "$ref": "#/definitions/user_setting" },
       "minItems": 1,
-      "maxItems": 100,
       "description": "user object to run workflow for. At least 1 user is required"
     },
     "data": {
@@ -65,27 +64,6 @@
       "type": "string",
       "minLength": 2
     },
-    "mobile_number_pattern": {
-      "type": "string",
-      "minLength": 8,
-      "pattern": "^\\+[0-9\\s]+",
-      "message": {
-        "required": "Either a mobile-number or an array of mobile-numbers. e.g [\"+41446681800\"]",
-        "pattern": "number must start with + and must contain country code. e.g. +41446681800"
-      }
-    },
-    "email_pattern": {
-      "type": "string",
-      "format": "email",
-      "pattern": "^\\S+@\\S+\\.\\S+$",
-      "description": "email of an user",
-      "minLength": 6,
-      "maxLength": 127,
-      "message": {
-        "required": "",
-        "pattern": "value in email format required. e.g. user@example.com"
-      }
-    },
     "slack_setting": {
       "type": "object",
       "properties": {
@@ -113,7 +91,7 @@
           }
         },
         "email": {
-          "$ref": "#/definitions/email_pattern"
+          "$ref": "#/definitions/non_empty_string"
         },
         "incoming_webhook": {
           "type": "object",
@@ -240,25 +218,25 @@
         },
         "$email": {
           "oneOf": [
-            { "$ref": "#/definitions/email_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/email_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$sms": {
           "oneOf": [
-            { "$ref": "#/definitions/mobile_number_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
@@ -304,13 +282,13 @@
         },
         "$whatsapp": {
           "oneOf": [
-            { "$ref": "#/definitions/mobile_number_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },