@selfcommunity/api-services 0.1.6-alpha.0 → 0.1.6-alpha.3

package/lib/cjs/constants/Endpoints.js

@@ -14,6 +14,14 @@ const Endpoints = {
     method: 'POST'
   },
 
+  /**
+   * Dynamic Preference Endpoints
+   */
+  Preferences: {
+    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/'),
+    method: 'GET'
+  },
+
   /**
    * SSO Endpoints
    */
@@ -26,22 +34,6 @@ const Endpoints = {
     method: 'POST'
   },
 
-  /**
-   * Dynamic Preference Endpoints
-   */
-  Preferences: {
-    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/'),
-    method: 'GET'
-  },
-  PreferencesSearch: {
-    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/search/'),
-    method: 'GET'
-  },
-  SpecificPreference: {
-    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/$(id)/'),
-    method: 'GET'
-  },
-
   /**
    * Features Endpoints
    * */

package/lib/cjs/index.js

@@ -22,6 +22,10 @@ var _token = require("./utils/token");
 exports.generateJWTToken = _token.generateJWTToken;
 exports.parseJwt = _token.parseJwt;
 
+var _apiRequest = require("./utils/apiRequest");
+
+exports.apiRequest = _apiRequest.apiRequest;
+
 var _category = _interopRequireWildcard(require("./services/category"));
 
 exports.CategoryService = _category.default;
@@ -52,12 +56,6 @@ exports.DataPortabilityService = _data_portability.default;
 exports.DataPortabilityApiClient = _data_portability.DataPortabilityApiClient;
 exports.DataPortabilityApiClientInterface = _data_portability.DataPortabilityApiClientInterface;
 
-var _dynamic_preference = _interopRequireWildcard(require("./services/dynamic_preference"));
-
-exports.DynamicPreferenceService = _dynamic_preference.default;
-exports.DynamicPreferenceApiClient = _dynamic_preference.DynamicPreferenceApiClient;
-exports.DynamicPreferenceApiClientInterface = _dynamic_preference.DynamicPreferenceApiClientInterface;
-
 var _embed = _interopRequireWildcard(require("./services/embed"));
 
 exports.EmbedService = _embed.default;
@@ -178,6 +176,12 @@ exports.WebhookService = _webhook.default;
 exports.WebhookApiClient = _webhook.WebhookApiClient;
 exports.WebhookApiClientInterface = _webhook.WebhookApiClientInterface;
 
+var _types = require("./types");
+
+exports.SCPaginatedResponse = _types.SCPaginatedResponse;
+exports.WebhookParamType = _types.WebhookParamType;
+exports.WebhookEventsType = _types.WebhookEventsType;
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/lib/cjs/services/webhook/index.js

@@ -3,232 +3,147 @@
 exports.__esModule = true;
 exports.default = exports.WebhookApiClient = void 0;
 
-var _client = _interopRequireDefault(require("../../client"));
-
 var _Endpoints = _interopRequireDefault(require("../../constants/Endpoints"));
 
+var _apiRequest = require("../../utils/apiRequest");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/**
+ * Contains all the endpoints needed to manage webhooks.
+ */
 class WebhookApiClient {
+  /**
+   * This endpoint retrieves all webhook endpoints
+   */
   static getAllWebhookEndpoints() {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookEndpointsList.url({}),
-      method: _Endpoints.default.WebhookEndpointsList.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve webhook endpoints (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve endpoints.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookEndpointsList.url({}), _Endpoints.default.WebhookEndpointsList.method);
   }
+  /**
+   * This endpoint retrieves webhook events that can be enabled in the endpoint.
+   */
+
 
   static getAllWebhookEvents() {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookEventsList.url({}),
-      method: _Endpoints.default.WebhookEventsList.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve webhook endpoints events (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve endpoints events.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookEventsList.url({}), _Endpoints.default.WebhookEventsList.method);
   }
+  /**
+   * This endpoint creates a webhook endpoint and connects it to the given webhook events.
+   * @param data
+   */
 
-  static createWebhookEndpoint() {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookCreate.url({}),
-      method: _Endpoints.default.WebhookCreate.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
+
+  static createWebhookEndpoint(data) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookCreate.url({}), _Endpoints.default.WebhookCreate.method, data);
   }
+  /**
+   * This endpoint retrieves a specific webhook endpoint using ID.
+   * @param id
+   */
+
 
   static getASpecificWebhookEndpoint(id) {
-    return _client.default.request({
-      url: _Endpoints.default.GetSpecificWebhook.url({
-        id
-      }),
-      method: _Endpoints.default.GetSpecificWebhook.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve webhook (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to retrieve webhook.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.GetSpecificWebhook.url({
+      id
+    }), _Endpoints.default.GetSpecificWebhook.method);
   }
+  /**
+   * This endpoint updates a specific webhook endpoint.
+   * @param id
+   * @param params
+   */
 
-  static updateASpecificWebhookEndpoint(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookUpdate.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookUpdate.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
+
+  static updateASpecificWebhookEndpoint(id, params) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookUpdate.url({
+      id
+    }), _Endpoints.default.WebhookUpdate.method, params);
   }
+  /**
+   * This endpoint updates a specific field for a specific webhook endpoint.
+   * @param id
+   * @param params
+   */
 
-  static updateASingleWebhookEndpointField(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookPatch.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookPatch.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
+
+  static updateASingleWebhookEndpointField(id, params) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookPatch.url({
+      id
+    }), _Endpoints.default.WebhookPatch.method, params);
   }
+  /**
+   * This endpoint deletes a Webhook Endpoint.
+   * @param id
+   */
+
 
   static deleteWebhookEndpoint(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookDelete.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookDelete.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookDelete.url({
+      id
+    }), _Endpoints.default.WebhookDelete.method);
   }
+  /**
+   * This endpoint retrieves the attempts related to this endpoint.
+   * @param id
+   */
+
 
   static getAllWebhookEndpointAttempts(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookEndpointAttempts.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookEndpointAttempts.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve webhook endpoint attempts (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to retrieve webhook endpoint attempts.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookEndpointAttempts.url({
+      id
+    }), _Endpoints.default.WebhookEndpointAttempts.method);
   }
+  /**
+   * This endpoint expires the secret associated with this endpoint.
+   * @param id
+   */
 
-  static expireWebhookSigningSecret(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookExpireSigningSecret.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookExpireSigningSecret.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
-  }
 
-  static revealWebhookSigningSecret(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookRevealSigningSecret.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookRevealSigningSecret.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action(Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
+  static expireWebhookSigningSecret(id) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookExpireSigningSecret.url({
+      id
+    }), _Endpoints.default.WebhookExpireSigningSecret.method);
+  }
+  /**
+   * This endpoint reveals the secret associated with this endpoint.
+   * @param id
+   * @param password
+   */
+
+
+  static revealWebhookSigningSecret(id, password) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookRevealSigningSecret.url({
+      id
+    }), _Endpoints.default.WebhookRevealSigningSecret.method, password ? {
+      password: password
+    } : null);
+  }
+  /**
+   * This endpoint resends the event specified as parameter to the endpoint specified by the id parameter.
+   * @param id
+   * @param event
+   */
+
+
+  static resendWebhookEndpointEvent(id, event) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookResendEndpointEvent.url({
+      id
+    }), _Endpoints.default.WebhookResendEndpointEvent.method, {
+      event: event
     });
   }
+  /**
+   * This endpoint resends the events specified as parameters to the endpoint specified by the id parameter.
+   * @param id
+   * @param event
+   */
 
-  static resendWebhookEndpointEvent(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookResendEndpointEvent.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookResendEndpointEvent.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
-  }
 
-  static resendMultipleWebhookEndpointEvent(id) {
-    return _client.default.request({
-      url: _Endpoints.default.WebhookResendMultipleEndpointEvent.url({
-        id
-      }),
-      method: _Endpoints.default.WebhookResendMultipleEndpointEvent.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res.data);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
+  static resendMultipleWebhookEndpointEvent(id, event) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookResendMultipleEndpointEvent.url({
+      id
+    }), _Endpoints.default.WebhookResendMultipleEndpointEvent.method, {
+      event: event
     });
   }
 
@@ -245,20 +160,20 @@ class WebhookService {
     return WebhookApiClient.getAllWebhookEvents();
   }
 
-  static async createWebhookEndpoint() {
-    return WebhookApiClient.createWebhookEndpoint();
+  static async createWebhookEndpoint(params) {
+    return WebhookApiClient.createWebhookEndpoint(params);
   }
 
   static async getASpecificWebhookEndpoint(id) {
     return WebhookApiClient.getASpecificWebhookEndpoint(id);
   }
 
-  static async updateASpecificWebhookEndpoint(id) {
-    return WebhookApiClient.updateASpecificWebhookEndpoint(id);
+  static async updateASpecificWebhookEndpoint(id, params) {
+    return WebhookApiClient.updateASpecificWebhookEndpoint(id, params);
   }
 
-  static async updateASingleWebhookEndpointField(id) {
-    return WebhookApiClient.updateASingleWebhookEndpointField(id);
+  static async updateASingleWebhookEndpointField(id, params) {
+    return WebhookApiClient.updateASingleWebhookEndpointField(id, params);
   }
 
   static async deleteWebhookEndpoint(id) {
@@ -273,16 +188,16 @@ class WebhookService {
     return WebhookApiClient.expireWebhookSigningSecret(id);
   }
 
-  static async revealWebhookSigningSecret(id) {
-    return WebhookApiClient.revealWebhookSigningSecret(id);
+  static async revealWebhookSigningSecret(id, password) {
+    return WebhookApiClient.revealWebhookSigningSecret(id, password);
   }
 
-  static async resendWebhookEndpointEvent(id) {
-    return WebhookApiClient.resendWebhookEndpointEvent(id);
+  static async resendWebhookEndpointEvent(id, event) {
+    return WebhookApiClient.resendWebhookEndpointEvent(id, event);
   }
 
-  static async resendMultipleWebhookEndpointEvent(id) {
-    return WebhookApiClient.resendMultipleWebhookEndpointEvent(id);
+  static async resendMultipleWebhookEndpointEvent(id, event) {
+    return WebhookApiClient.resendMultipleWebhookEndpointEvent(id, event);
   }
 
 }

package/lib/cjs/types/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+exports.__esModule = true;
+
+var _paginatedResponse = require("./paginatedResponse");
+
+exports.SCPaginatedResponse = _paginatedResponse.SCPaginatedResponse;
+
+var _webhook = require("./webhook");
+
+exports.WebhookParamType = _webhook.WebhookParamType;
+exports.WebhookEventsType = _webhook.WebhookEventsType;

package/lib/cjs/types/paginatedResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/lib/cjs/types/webhook.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/lib/cjs/utils/apiRequest.js

@@ -0,0 +1,26 @@
+"use strict";
+
+exports.__esModule = true;
+exports.apiRequest = apiRequest;
+
+var _client = _interopRequireDefault(require("../client"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function apiRequest(url, method, data) {
+  return _client.default.request({
+    url,
+    method,
+    data: data != null ? data : null
+  }).then(res => {
+    if (res.status >= 300) {
+      console.log(`Unable to ${method} ${url} (Response code: ${res.status}).`);
+      return Promise.reject(res);
+    }
+
+    return Promise.resolve(res.data);
+  }).catch(error => {
+    console.log(`Unable to ${method} ${url} ${error}`);
+    return Promise.reject(error);
+  });
+}

package/lib/esm/constants/Endpoints.js

@@ -14,6 +14,14 @@ const Endpoints = {
     method: 'POST'
   },
 
+  /**
+   * Dynamic Preference Endpoints
+   */
+  Preferences: {
+    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/'),
+    method: 'GET'
+  },
+
   /**
    * SSO Endpoints
    */
@@ -26,22 +34,6 @@ const Endpoints = {
     method: 'POST'
   },
 
-  /**
-   * Dynamic Preference Endpoints
-   */
-  Preferences: {
-    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/'),
-    method: 'GET'
-  },
-  PreferencesSearch: {
-    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/search/'),
-    method: 'GET'
-  },
-  SpecificPreference: {
-    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/$(id)/'),
-    method: 'GET'
-  },
-
   /**
    * Features Endpoints
    * */

package/lib/esm/index.js

@@ -22,6 +22,10 @@ var _token = require("./utils/token");
 exports.generateJWTToken = _token.generateJWTToken;
 exports.parseJwt = _token.parseJwt;
 
+var _apiRequest = require("./utils/apiRequest");
+
+exports.apiRequest = _apiRequest.apiRequest;
+
 var _category = _interopRequireWildcard(require("./services/category"));
 
 exports.CategoryService = _category.default;
@@ -52,12 +56,6 @@ exports.DataPortabilityService = _data_portability.default;
 exports.DataPortabilityApiClient = _data_portability.DataPortabilityApiClient;
 exports.DataPortabilityApiClientInterface = _data_portability.DataPortabilityApiClientInterface;
 
-var _dynamic_preference = _interopRequireWildcard(require("./services/dynamic_preference"));
-
-exports.DynamicPreferenceService = _dynamic_preference.default;
-exports.DynamicPreferenceApiClient = _dynamic_preference.DynamicPreferenceApiClient;
-exports.DynamicPreferenceApiClientInterface = _dynamic_preference.DynamicPreferenceApiClientInterface;
-
 var _embed = _interopRequireWildcard(require("./services/embed"));
 
 exports.EmbedService = _embed.default;
@@ -178,6 +176,12 @@ exports.WebhookService = _webhook.default;
 exports.WebhookApiClient = _webhook.WebhookApiClient;
 exports.WebhookApiClientInterface = _webhook.WebhookApiClientInterface;
 
+var _types = require("./types");
+
+exports.SCPaginatedResponse = _types.SCPaginatedResponse;
+exports.WebhookParamType = _types.WebhookParamType;
+exports.WebhookEventsType = _types.WebhookEventsType;
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }