@agility/management-sdk NPM

Agility CMS & Management API TypeScript SDK

About the Management API SDK

Provides a facility to developers to use the new Agility Management API more effectively.
Provides methods to perform operations on Assets, Batches, Containers, Content, Models, Pages, and Users.
Supports the creation of Pages and Content in batches.
Ability to generate Content in bulk for a Website.

Getting Started

Prerequisites

Clone the repository agility-cms-management-sdk-typescript.
Import the index file to make use of the Options class.
Create an object of the Options class to provide values of -
- token -> Bearer token to authenticate a Rest Request to perform an operation.
Create an object of Method class(es), which can be used to create and perform operations. Following is the description of Classes and their respective methods -

Making a Request

import * as mgmtApi from "./index";

//initialize the Options Class
let options = new mgmtApi.Options();

options.token = "<<Provide Auth Token>>"
//Initialize the APIClient Class
let apiClient = new mgmtApi.ApiClient(options);

let guid = "<<Provide the Guid of the Website>>";
let locale = "<<Provide the locale of the Website>>"; //Example: en-us



//make the request: get a content item with the ID '22'
var contentItem = await apiClient.contentMethods.getContentItem(22,guid, locale);

//To log the response of the contentItem object in console.
console.log(JSON.stringify(contentItem));

Class AssetMethods

This class is used to perform operations related to Assets. The following are the methods: -

upload

Parameter	Type	Description
`formData`	`FormData`	This is an object of type FormData where files can be posted eg : `const file = fs.readFileSync(<<Local File>>, null);const form = new FormData(); form.append('files',file,'<<File Name>>');`
`agilityFolderPath`	`string`	Path of the folder in Agility where the file(s) needs to be uploaded.
`guid`	`string`	Current website guid.
`groupingID`	`number`	Path of the folder in Agility where the file(s) needs to be uploaded.

Returns: A collection of Media class Object.

createFolder

Parameter	Type	Description
`originKey`	`string`	The origin key of the requested folder.
`guid`	`string`	Current website guid.

Returns: A collection of Media class Object.

deleteFolder

Parameter	Type	Description
`originKey`	`string`	The origin key of the requested folder.
`guid`	`string`	Current website guid.
`mediaID`	`number`	The mediaID of the folder that needs to be deleted.

renameFolder

Parameter	Type	Description
`folderName`	`string`	The original folder name.
`newFolderName`	`string`	The new folder name.
`guid`	`string`	Current website guid.
`mediaID`	`number`	The mediaID of the folder that needs to be renamed.

deleteFile

Parameter	Type	Description
`mediaID`	`number`	The mediaID of the asset which needs to be deleted.
`guid`	`string`	Current website guid.

Returns A string response if a file has been deleted.

moveFile

Parameter	Type	Description
`mediaID`	`number`	The mediaID of the file that needs to be moved.
`newFolder`	`string`	The new location (in Agility) where the file needs to be moved.
`guid`	`string`	Current website guid.

Returns: An object of Media class with the new location of the file.

getMediaList

Parameter	Type	Description
`pageSize`	`number`	The page size on which the assets needs to selected.
`recordOffset`	`number`	The record offset value to skip search results.
`guid`	`string`	Current website guid.

Returns: An object of AssetMediaList class.

getGalleryById

Parameter	Type	Description
`guid`	`string`	Current website guid.
`id`	`number`	The ID of the requested gallery.

Returns: An object of assetMediaGrouping class.

getGalleryByName

Parameter	Type	Description
`guid`	`string`	Current website guid.
`galleryName`	`string`	The name of the requested gallery.

Returns: An object of assetMediaGrouping class.

getDefaultContainer

Parameter	Type	Description
`guid`	`string`	Current website guid.

Returns: An object of assetContainer class.

getGalleries

Parameter	Type	Description
`guid`	`string`	Current website guid.
`search`	`string`	String to search a specific gallery item.
`pageSize`	`number`	The pageSize on which the galleries needs to be selected.
`rowIndex`	`number`	The rowIndex value for the resultant record set.

Returns: An object of assetGalleries class.

saveGallery

Parameter	Type	Description
`guid`	`string`	Current website guid.
`gallery`	`assetMediaGrouping`	Object of AssetMediaGrouping class.

Returns: An object of assetMediaGrouping class.

deleteGallery

Parameter	Type	Description
`guid`	`string`	Current website guid.
`id`	`number`	The id of the gallery to be deleted.

A string response if the gallery has been deleted.

getAssetByID

Parameter	Type	Description
`mediaID`	`number`	The mediaID of the requested asset.
`guid`	`string`	Current website guid.

Returns: An object of Media class with the information of the asset.

getAssetByUrl

Parameter	Type	Description
`url`	`string`	The url of the requested asset.
`guid`	`string`	Current website guid.

Returns: An object of Media class with the information of the asset.

Class BatchMethods

This class is used to perform operations related to Batches. The following are the methods: -

getBatch

Parameter	Type	Description
`id`	`number`	The batchID of the requested batch.
`guid`	`string`	Current website guid.

Returns: A object of Batch class.

Class ContainerMethods

This class is used to perform operations related to Containers. The following are the methods: -

getContainerByID

Parameter	Type	Description
`id`	`number`	The container id of the requested container.
`guid`	`string`	Current website guid.

Returns: A object of Container class.

getContainersByModel

Parameter	Type	Description
`modelId`	`number`	The model id of the requested container.
`guid`	`string`	Current website guid.

Returns: A object of Container class.

getContainerByReferenceName

Parameter	Type	Description
`referenceName`	`string`	The container reference name of the requested container.
`guid`	`string`	Current website guid.

Returns: A object of Container class.

getContainerSecurity

Parameter	Type	Description
`id`	`number`	The container id of the requested container.
`guid`	`string`	Current website guid.

Returns: A object of Container class.

getContainerList

Parameter	Type	Description
`guid`	`string`	Current website guid.

Returns: A collection object of Container class.

getNotificationList

Parameter	Type	Description
`id`	`number`	The container id of the requested container.
`guid`	`string`	Current website guid.

Returns: A collection object of Notification class.

saveContainer

Parameter	Type	Description
`container`	`Container`	A Container type object to create or update a container.
`guid`	`string`	Current website guid.

Returns: An object of Container class.

deleteContainer

Parameter	Type	Description
`id`	`number`	The container id of the requested container.
`guid`	`string`	Current website guid.

Returns: A string response if a container has been deleted.

Class ContentMethods

This class is used to perform operations related to Content. The following are the methods: -

getContentItem

Parameter	Type	Description
`contentID`	`number`	The contentid of the requested content.
`guid`	`string`	Current website guid.
`locale`	`string`	Current website locale.

Returns: An object of ContentItem class.