@adobe/reactor-sdk/lib/cjs/libraries.cjs

JavaScript SDK for the Reactor API

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.addDataElementRelationshipsToLibrary = addDataElementRelationshipsToLibrary;
exports.addExtensionRelationshipsToLibrary = addExtensionRelationshipsToLibrary;
exports.addRuleRelationshipsToLibrary = addRuleRelationshipsToLibrary;
exports.createLibrary = createLibrary;
exports.createNoteForLibrary = createNoteForLibrary;
exports.deleteLibrary = deleteLibrary;
exports.getEnvironmentForLibrary = getEnvironmentForLibrary;
exports.getEnvironmentRelationshipForLibrary = getEnvironmentRelationshipForLibrary;
exports.getLibrary = getLibrary;
exports.getPropertyForLibrary = getPropertyForLibrary;
exports.getUpstreamLibraryForLibrary = getUpstreamLibraryForLibrary;
exports.listDataElementRelationshipsForLibrary = listDataElementRelationshipsForLibrary;
exports.listDataElementsForLibrary = listDataElementsForLibrary;
exports.listExtensionRelationshipsForLibrary = listExtensionRelationshipsForLibrary;
exports.listExtensionsForLibrary = listExtensionsForLibrary;
exports.listLibrariesForProperty = listLibrariesForProperty;
exports.listRuleRelationshipsForLibrary = listRuleRelationshipsForLibrary;
exports.listRulesForLibrary = listRulesForLibrary;
exports.publishLibrary = publishLibrary;
exports.removeDataElementRelationshipsFromLibrary = removeDataElementRelationshipsFromLibrary;
exports.removeEnvironmentRelationshipFromLibrary = removeEnvironmentRelationshipFromLibrary;
exports.removeExtensionRelationshipsFromLibrary = removeExtensionRelationshipsFromLibrary;
exports.removeRuleRelationshipsFromLibrary = removeRuleRelationshipsFromLibrary;
exports.replaceDataElementRelationshipsForLibrary = replaceDataElementRelationshipsForLibrary;
exports.replaceExtensionRelationshipsForLibrary = replaceExtensionRelationshipsForLibrary;
exports.replaceRuleRelationshipsForLibrary = replaceRuleRelationshipsForLibrary;
exports.setEnvironmentRelationshipForLibrary = setEnvironmentRelationshipForLibrary;
exports.transitionLibrary = transitionLibrary;
exports.updateLibrary = updateLibrary;
/*
Copyright 2019 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/

// Libraries
// https://developer.adobelaunch.com/api/libraries

// Add DataElement relationships to a Library
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/data_elements/add_relationships/
// Example `deList` value:
//   [
//     { "DE0123456789012345678901", type: "data_elements"],
//     { "DE1234567890123456789012", type: "data_elements"],
//   ]
function addDataElementRelationshipsToLibrary(libraryId, deList) {
  return this.post(`/libraries/${libraryId}/relationships/data_elements`, {
    data: deList
  });
}

// Add Extension relationships to a Library
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/extensions/add_relationships/
// Example `exList` value:
//   [
//     { "EX0123456789012345678901", type: "extensions"],
//     { "EX1234567890123456789012", type: "extensions"],
//   ]
function addExtensionRelationshipsToLibrary(libraryId, exList) {
  return this.post(`/libraries/${libraryId}/relationships/extensions`, {
    data: exList
  });
}

// Add Rule relationships to a Library
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/rules/add_relationships/
// Example `rlList` value:
//   [
//     { "RL0123456789012345678901", type: "rules"],
//     { "RL1234567890123456789012", type: "rules"],
//   ]
function addRuleRelationshipsToLibrary(libraryId, rlList) {
  return this.post(`/libraries/${libraryId}/relationships/rules`, {
    data: rlList
  });
}

// Create a Library
// https://developer.adobelaunch.com/api/libraries/create/
function createLibrary(propertyId, library) {
  return this.post(`/properties/${propertyId}/libraries`, {
    data: library
  });
}

// Delete a Library
function deleteLibrary(libraryId) {
  return this.delete(`/libraries/${libraryId}`);
}

// Get the Environment
// https://developer.adobelaunch.com/api/libraries/fetch_environment/
function getEnvironmentForLibrary(libraryId) {
  return this.get(`/libraries/${libraryId}/environment`);
}

// Get the Environment relationship
// https://developer.adobelaunch.com/api/libraries/fetch_environment_relationship/
function getEnvironmentRelationshipForLibrary(libraryId) {
  return this.get(`/libraries/${libraryId}/relationships/environment`);
}

// Get a Library
// https://developer.adobelaunch.com/api/libraries/fetch/
function getLibrary(libraryId) {
  return this.get(`/libraries/${libraryId}`);
}

// Get the Property
// https://developer.adobelaunch.com/api/libraries/property/
function getPropertyForLibrary(libraryId) {
  return this.get(`/libraries/${libraryId}/property`);
}

// Get the upstream Library
// https://developer.adobelaunch.com/api/libraries/upstream/
function getUpstreamLibraryForLibrary(libraryId) {
  return this.get(`/libraries/${libraryId}/upstream_library`);
}

// List DataElements
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/data_elements/list_related/
function listDataElementsForLibrary(libraryId, queryParams) {
  return this.get(`/libraries/${libraryId}/data_elements`, queryParams);
}

// List DataElement relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/data_elements/list_relationships/
function listDataElementRelationshipsForLibrary(libraryId, queryParams) {
  return this.get(`/libraries/${libraryId}/relationships/data_elements`, queryParams);
}

// List Extensions
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/extensions/list_related/
function listExtensionsForLibrary(libraryId, queryParams) {
  return this.get(`/libraries/${libraryId}/extensions`, queryParams);
}

// List Extension relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/extensions/list_relationships/
function listExtensionRelationshipsForLibrary(libraryId, queryParams) {
  return this.get(`/libraries/${libraryId}/relationships/extensions`, queryParams);
}

// List Libraries for a Property
// https://developer.adobelaunch.com/api/libraries/
function listLibrariesForProperty(propertyId, queryParams) {
  return this.get(`/properties/${propertyId}/libraries`, queryParams);
}

// List Rule relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/rules/list_relationships/
function listRuleRelationshipsForLibrary(libraryId, queryParams) {
  return this.get(`/libraries/${libraryId}/relationships/rules`, queryParams);
}

// List Rules
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/rules/list_related/
function listRulesForLibrary(libraryId, queryParams) {
  return this.get(`/libraries/${libraryId}/rules`, queryParams);
}

// Publish a Library
// https://developer.adobelaunch.com/api/libraries/publish/
function publishLibrary(libraryId) {
  // NOTE: The Library's Environment must be of type Production, and the build
  // must succeed; otherwise, this will *not* generate a state transition to
  // 'published'.
  return this.createBuild(libraryId);
}

// Remove DataElement relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/data_elements/remove_relationships/
// Example `deList` value:
//   [
//     { "DE0123456789012345678901", type: "data_elements"],
//     { "DE1234567890123456789012", type: "data_elements"],
//   ]
function removeDataElementRelationshipsFromLibrary(libraryId, deList) {
  return this.delete(`/libraries/${libraryId}/relationships/data_elements`, {
    data: deList
  });
}

// Remove Extension relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/extensions/remove_relationships/
// Example `exList` value:
//   [
//     { "EX0123456789012345678901", type: "extensions"],
//     { "EX1234567890123456789012", type: "extensions"],
//   ]
function removeExtensionRelationshipsFromLibrary(libraryId, exList) {
  return this.delete(`/libraries/${libraryId}/relationships/extensions`, {
    data: exList
  });
}

// Remove Environment relationship
// https://developer.adobelaunch.com/api/libraries/delete_environment_relationship/
function removeEnvironmentRelationshipFromLibrary(libraryId, environmentId) {
  return this.delete(`/libraries/${libraryId}/relationships/environment`, {
    data: {
      id: environmentId,
      type: 'environments'
    },
    id: libraryId
  });
}

// Remove Rule relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/rules/remove_relationships/
// Example `rules` value:
//   [
//     { "RL0123456789012345678901", type: "rules"],
//     { "RL1234567890123456789012", type: "rules"],
//   ]
function removeRuleRelationshipsFromLibrary(libraryId, rules) {
  return this.delete(`/libraries/${libraryId}/relationships/rules`, {
    data: rules
  });
}

// Replace Extension relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/extensions/replace_relationships/
// Example `exList` value:
//   [
//     { "EX0123456789012345678901", type: "extensions"],
//     { "EX1234567890123456789012", type: "extensions"],
//   ]
function replaceExtensionRelationshipsForLibrary(libraryId, exList) {
  return this.patch(`/libraries/${libraryId}/relationships/extensions`, {
    data: exList
  });
}

// Replace DataElement relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/data_elements/replace_relationships/
// Example `deList` value:
//   [
//     { "DE0123456789012345678901", type: "data_elements"],
//     { "DE1234567890123456789012", type: "data_elements"],
//   ]
function replaceDataElementRelationshipsForLibrary(libraryId, deList) {
  return this.patch(`/libraries/${libraryId}/relationships/data_elements`, {
    data: deList
  });
}

// Replace Rule relationships
// https://developer.adobelaunch.com/api/reference/1.0/libraries/relationships/rules/replace_relationships/
// Example `rlList` value:
//   [
//     { "RL0123456789012345678901", type: "rules"],
//     { "RL1234567890123456789012", type: "rules"],
//   ]
function replaceRuleRelationshipsForLibrary(libraryId, rlList) {
  return this.patch(`/libraries/${libraryId}/relationships/rules`, {
    data: rlList
  });
}

// Set Environment relationship for a Library
// https://developer.adobelaunch.com/api/libraries/set_environment_relationship/
function setEnvironmentRelationshipForLibrary(libraryId, environmentId) {
  return this.patch(`/libraries/${libraryId}/relationships/environment`, {
    data: {
      id: environmentId,
      type: 'environments'
    },
    id: libraryId
  });
}

// Transition a Library
// https://developer.adobelaunch.com/api/libraries/transition/
// `action` must be 'submit', 'approve', 'reject', or 'develop'
function transitionLibrary(libraryId, action) {
  return this.patch(`/libraries/${libraryId}`, {
    data: {
      id: libraryId,
      type: 'libraries',
      meta: {
        action
      }
    }
  });
}

// Update a Library
// https://developer.adobelaunch.com/api/libraries/update/
function updateLibrary(libraryPatch) {
  return this.patch(`/libraries/${libraryPatch.id}`, {
    data: libraryPatch
  });
}

// Create a note for Library
// https://developer.adobelaunch.com/api/libraries/:library_id/notes
function createNoteForLibrary(libraryId, note) {
  return this.post(`/libraries/${libraryId}/notes`, {
    data: note
  });
}
//# sourceMappingURL=libraries.cjs.map