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.
- locale -> The locale under which your application is hosted. Example en-us.
- guid -> The guid under which your application is hosted.
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 index from "./index";

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

options.token = "<<Provide Auth Token>>";
options.guid = "<<Provide the Guid of the Website>>";
options.locale = "<<Provide the locale of the Website>>"; //Example: en-us

//Initialize the Method Class
let contentMethods = new index.ContentMethods(options);

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

//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.
`groupingID`	`number`	Path of the folder in Agility where the file(s) needs to be uploaded.

Returns: A collection of Media class Object.

deleteFile

Parameter	Type	Description
`mediaID`	`number`	The mediaID of the asset which needs to be deleted.
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.

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.

Returns: An object of AssetMediaList class.

getAssetByID

Parameter	Type	Description
`mediaID`	`number`	The mediaID of the requested asset.

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

getAssetByUrl

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

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.

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.

Returns: A object of Container class.

getContainerByReferenceName

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

Returns: A object of Container class.

getContainerSecurity

Parameter	Type	Description
`id`	`number`	The container id of the requested container.

Returns: A object of Container class.

getContainerList

Returns: A collection object of Container class.

getNotificationList

Parameter	Type	Description
`id`	`number`	The container id of the requested container.

Returns: A collection object of Notification class.

saveContainer

Parameter	Type	Description
`container`	`Container`	A Container type object to create or update a container.

Returns: An object of Container class.

deleteContainer

Parameter	Type	Description
`id`	`number`	The container id of the requested container.

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.

Returns: An object of ContentItem class.