@contentstack/management
Version:
The Content Management API is used to manage the content of your Contentstack account
322 lines (314 loc) • 12.7 kB
JavaScript
import _defineProperty from "@babel/runtime/helpers/defineProperty";
import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
import _regeneratorRuntime from "@babel/runtime/regenerator";
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
import cloneDeep from 'lodash/cloneDeep';
import { create, update, deleteEntity, fetch, upload, parseData, fetchAll } from '../../entity';
import error from '../../core/contentstackError';
import FormData from 'form-data';
import { createReadStream } from 'fs';
/**
* A webhook is a mechanism that sends real-time information to any third-party app or service to keep your application in sync with your Contentstack account. Webhooks allow you to specify a URL to which you would like Contentstack to post data when an event happens. Read more about <a href='https://www.contentstack.com/docs/developers/set-up-webhooks'>Webhooks</a>.
* @namespace Webhook
*/
export function Webhook(http) {
var _this = this;
var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
this.stackHeaders = data.stackHeaders;
this.urlPath = "/webhooks";
if (data.webhook) {
Object.assign(this, cloneDeep(data.webhook));
this.urlPath = "/webhooks/".concat(this.uid);
/**
* @description The Update Webhook call lets you update the name and description of an existing Webhook.
* @memberof Webhook
* @func update
* @returns {Promise<Webhook.Webhook>} Promise for Webhook instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).webhook('webhook_uid').fetch()
* .then((webhook) => {
* webhook.title = 'My New Webhook'
* webhook.description = 'Webhook description'
* return webhook.update()
* })
* .then((webhook) => console.log(webhook))
*
*/
this.update = update(http, 'webhook');
/**
* @description The Delete Webhook call is used to delete an existing Webhook permanently from your Stack.
* @memberof Webhook
* @func delete
* @returns {Object} Response Object.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).webhook('webhook_uid').delete()
* .then((response) => console.log(response.notice))
*/
this["delete"] = deleteEntity(http);
/**
* @description The fetch Webhook call fetches Webhook details.
* @memberof Webhook
* @func fetch
* @returns {Promise<Webhook.Webhook>} Promise for Webhook instance
* @param {Object=} param - Query parameters
* @prop {Int} param.version - Enter the version number of the webhook you want to retrieve.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).webhook('webhook_uid').fetch()
* .then((webhook) => console.log(webhook))
*
*/
this.fetch = fetch(http, 'webhook');
/**
* @description The Get executions of a webhook call provides the execution details of a specific webhook, which includes the execution UID.
* @memberof Webhook
* @func executions
* @async
* @param {Object=} params - Query parameters.
* @prop {Number=} params.skip - To skip number of data.
* @prop {Number=} params.limit - To limit number of results.
* @returns {Promise<Object>} Response object for webhook execution
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).webhook('webhook_uid').executions()
* .then((webhook) => console.log(webhook))
*/
this.executions = /*#__PURE__*/function () {
var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(params) {
var headers, response, _t;
return _regeneratorRuntime.wrap(function (_context) {
while (1) switch (_context.prev = _context.next) {
case 0:
headers = {};
if (_this.stackHeaders) {
headers.headers = _this.stackHeaders;
}
if (params) {
headers.params = _objectSpread({}, cloneDeep(params));
}
_context.prev = 1;
_context.next = 2;
return http.get("".concat(_this.urlPath, "/executions"), headers);
case 2:
response = _context.sent;
if (!response.data) {
_context.next = 3;
break;
}
return _context.abrupt("return", response.data);
case 3:
throw error(response);
case 4:
_context.next = 6;
break;
case 5:
_context.prev = 5;
_t = _context["catch"](1);
throw error(_t);
case 6:
case "end":
return _context.stop();
}
}, _callee, null, [[1, 5]]);
}));
return function (_x) {
return _ref.apply(this, arguments);
};
}();
/**
* @description The Retry webhook execution call retries a failed webhook execution.
* @memberof Webhook
* @func retry
* @async
* @param {String} executionUid execution UID that you receive when you execute the 'Get executions of webhooks' call.
* @returns {Promise<Object>} Response Object.
*/
this.retry = /*#__PURE__*/function () {
var _ref2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2(executionUid) {
var headers, response, _t2;
return _regeneratorRuntime.wrap(function (_context2) {
while (1) switch (_context2.prev = _context2.next) {
case 0:
headers = {};
if (_this.stackHeaders) {
headers.headers = _this.stackHeaders;
}
_context2.prev = 1;
_context2.next = 2;
return http.post("".concat(_this.urlPath, "/retry"), {
execution_uid: executionUid
}, headers);
case 2:
response = _context2.sent;
if (!response.data) {
_context2.next = 3;
break;
}
return _context2.abrupt("return", response.data);
case 3:
throw error(response);
case 4:
_context2.next = 6;
break;
case 5:
_context2.prev = 5;
_t2 = _context2["catch"](1);
throw error(_t2);
case 6:
case "end":
return _context2.stop();
}
}, _callee2, null, [[1, 5]]);
}));
return function (_x2) {
return _ref2.apply(this, arguments);
};
}();
} else {
/**
* @description The Create a webhook request allows you to create a new webhook in a specific stack.
* @memberof Webhook
* @func create
* @returns {Promise<Webhook.Webhook>} Promise for Webhook instance
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
* const webhook = {
* name: 'Test',
* destinations: [{
* target_url: 'http://example.com',
* http_basic_auth: 'basic',
* http_basic_password: 'test',
* custom_header: [{
* header_name: 'Custom',
* value: 'testing'
* }]
* }],
* channels: [
* 'assets.create'
* ],
* retry_policy: 'manual',
* disabled: false
* }
* client.stack().webhook().create({ webhook })
* .then((webhook) => console.log(webhook))
*/
this.create = create({
http: http
});
/**
* @description The Get all Webhook call lists all Webhooks from Stack.
* @memberof Webhook
* @func fetchAll
* @param {Object=} param - Query parameters.
* @prop {Number=} param.limit - The limit parameter will return a specific number of webhooks in the output.
* @prop {Number=} param.skip - The skip parameter will skip a specific number of webhooks in the output.
* @prop {String=} param.asc - When fetching webhooks, you can sort them in the ascending order with respect to the value of a specific field in the response body.
* @prop {String=} param.desc - When fetching webhooks, you can sort them in the descending order with respect to the value of a specific field in the response body.
* @prop {Boolean=} param.include_count - To retrieve the count of webhooks.
* @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).webhook().fetchAll()
* .then((collection) => console.log(collection))
*
*/
this.fetchAll = fetchAll(http, WebhookCollection);
}
/**
* @description The 'Import Webhook' section consists of the following two requests that will help you to import new Webhooks or update existing ones by uploading JSON files.
* @memberof Webhook
* @func import
* @async
* @param {Object} data - Import data object.
* @prop {string} data.webhook - Path to webhook file.
* @returns {Promise<Webhook.Webhook>} Promise for Webhook instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* const data = {
* webhook: 'path/to/file.json',
* }
* // Import a Webhook
* client.stack({ api_key: 'api_key'}).webhook().import(data)
* .then((webhook) => console.log(webhook))
*
* // Import an Existing Webhook
* client.stack({ api_key: 'api_key'}).webhook('webhook_uid').import(data)
* .then((webhook) => console.log(webhook))
*/
this["import"] = /*#__PURE__*/function () {
var _ref3 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee3(data) {
var response, _t3;
return _regeneratorRuntime.wrap(function (_context3) {
while (1) switch (_context3.prev = _context3.next) {
case 0:
_context3.prev = 0;
_context3.next = 1;
return upload({
http: http,
urlPath: "".concat(_this.urlPath, "/import"),
stackHeaders: _this.stackHeaders,
formData: createFormData(data)
});
case 1:
response = _context3.sent;
if (!response.data) {
_context3.next = 2;
break;
}
return _context3.abrupt("return", new _this.constructor(http, parseData(response, _this.stackHeaders)));
case 2:
throw error(response);
case 3:
_context3.next = 5;
break;
case 4:
_context3.prev = 4;
_t3 = _context3["catch"](0);
throw error(_t3);
case 5:
case "end":
return _context3.stop();
}
}, _callee3, null, [[0, 4]]);
}));
return function (_x3) {
return _ref3.apply(this, arguments);
};
}();
return this;
}
export function WebhookCollection(http, data) {
var obj = cloneDeep(data.webhooks) || [];
var webhookCollection = obj.map(function (userdata) {
return new Webhook(http, {
webhook: userdata,
stackHeaders: data.stackHeaders
});
});
return webhookCollection;
}
export function createFormData(data) {
return function () {
var formData = new FormData();
var uploadStream = createReadStream(data.webhook);
formData.append('webhook', uploadStream);
return formData;
};
}