@contentstack/management/dist/es-modules/stack/workflow/publishRules/index.js

The Content Management API is used to manage the content of your Contentstack account

import cloneDeep from 'lodash/cloneDeep';
import { create, update, deleteEntity, fetch, fetchAll } from '../../../entity';

/**
 * PublishRules is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly. Read more about <a href='https://www.contentstack.com/docs/developers/set-up-workflows-and-publish-rules'>PublishRules and Publish Rules</a>.
 * @namespace PublishRules
 */

export function PublishRules(http) {
  var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  this.stackHeaders = data.stackHeaders;
  this.urlPath = "/workflows/publishing_rules";
  if (data.publishing_rule) {
    Object.assign(this, cloneDeep(data.publishing_rule));
    this.urlPath = "/workflows/publishing_rules/".concat(this.uid);

    /**
     * @description The Update Publish Rules request allows you to add a publish rule stage or update the details of the existing stages of a publish rule.
     * @memberof PublishRules
     * @func update
     * @returns {Promise<PublishRules>} Promise for PublishRules instance
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     *
     * client.stack({ api_key: 'api_key'}).publishRules('publish_rules_uid').fetch()
     * .then((publish_rules) => {
     *  publish_rules.name = 'My New Publish Rules'
     *  publish_rules.description = 'Publish Rules description'
     *  return publish_rules.update()
     * })
     * .then((publish_rules) => console.log(publish_rules))
     *
     */
    this.update = update(http, 'publishing_rule');

    /**
     * @description The Delete Publish Rules call is used to delete an existing Publish Rule permanently from your Stack.
     * @memberof PublishRules
     * @func delete
     * @returns {Promise<Object>} Response Object.
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     *
     * client.stack({ api_key: 'api_key'}).publishRules('publish_rules_uid').delete()
     * .then((response) => console.log(response.notice))
     */
    this["delete"] = deleteEntity(http);

    /**
     * @description The fetch Publish Rules call retrieves the comprehensive details of a specific Publish Rule of a stack.
     * @memberof PublishRules
     * @func fetch
     * @returns {Promise<PublishRules>} Promise for PublishRules instance
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     *
     * client.stack({ api_key: 'api_key'}).publishRules('publish_rules_uid').fetch()
     * .then((publish_rules) => console.log(publish_rules))
     *
     */
    this.fetch = fetch(http, 'publishing_rule');
  } else {
    /**
     * @description The Create Publish Rules request allows you to create a publish rule for a stack.
     * @memberof PublishRules
     * @func create
     * @returns {Promise<PublishRules>} Promise for PublishRules instance
     *
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     * const publishing_rule = {
     *    "publish rules": "publish rules_uid",
     *        "actions": [],
     *        "content_types": ["$all"],
     *        "locales": ["en-us"],
     *        "environment": "environment_uid",
     *        "approvers": {
     *        "users": ["user_uid"],
     *        "roles": ["role_uid"],
     *        "publish_rules_stage": "publish_rules_stage_uid",
     *        "disable_approver_publishing": false
     *    }
     * client.stack().publishRules().create({ publishing_rule })
     * .then((publishRules) => console.log(publishRules))
     */
    this.create = create({
      http: http
    });

    /**
     * @description The Get all Publish Rules request retrieves the details of all the Publish Rules of a stack.
     * @memberof PublishRules
     * @func fetchAll
     * @param {String} content_types Enter a comma-separated list of content type UIDs for filtering publish rules on its basis.
     * @param {Number} limit The limit parameter will return a specific number of Publish Rules in the output.
     * @param {Number} skip The skip parameter will skip a specific number of Publish Rules in the output.
     * @param {Boolean} include_count To retrieve the count of Publish Rules.
     * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     *
     * client.stack({ api_key: 'api_key'}).publishRules().fetchAll({ content_types: 'content_type_uid1,content_type_uid2' })
     * .then((collection) => console.log(collection))
     *
     */
    this.fetchAll = fetchAll(http, PublishRulesCollection);
  }
}
export function PublishRulesCollection(http, data) {
  var obj = cloneDeep(data.publishing_rules) || [];
  return obj.map(function (userdata) {
    return new PublishRules(http, {
      publishing_rule: userdata,
      stackHeaders: data.stackHeaders
    });
  });
}