@agility/management-sdk 0.1.30 → 0.1.31

package/README.md

@@ -4,8 +4,10 @@
 
 - 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.
+- **Content and Page Creation** - Create individual or multiple content items and pages (which automatically get added to batches).
+- **Essential batch workflow operations** - Perform publish, unpublish, approve, decline, and request approval operations on existing batches.
 - Ability to generate Content in bulk for a Website.
+- **Strongly typed TypeScript interfaces** for all batch operations with comprehensive error handling.
 
 ## Getting Started
 
@@ -22,6 +24,10 @@ The authentication process uses OAuth 2.0 and requires multiple steps:
 1. First, initiate the authorization flow by making a GET request to the authorization endpoint:
 ```javascript
 const authUrl = 'https://mgmt.aglty.io/oauth/authorize';
+
+//if you wish to implement offline access using refresh tokens, use this URL (enables refresh tokens)
+//const authUrl = 'https://mgmt.aglty.io/oauth/authorize?scope=offline-access '; 
+
 const params = new URLSearchParams({
   response_type: 'code',
   redirect_uri: 'YOUR_REDIRECT_URI',
@@ -50,7 +56,7 @@ const { access_token, refresh_token, expires_in } = await response.json();
 
 3. Use the obtained token to initialize the SDK:
 ```javascript
-import * as mgmtApi from "./index";
+import * as mgmtApi from "@agility/management-sdk";
 
 // Initialize the Options Class with your authentication token
 let options = new mgmtApi.Options();
@@ -88,11 +94,10 @@ Note:
 - Store refresh tokens securely and never expose them in client-side code
 - Implement proper error handling for authentication failures
 
-4. 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
 ```Javascript
-import * as mgmtApi from "./index";
+import * as mgmtApi from "@agility/management-sdk";
 
 //initialize the Options Class
 let options = new mgmtApi.Options();
@@ -112,6 +117,26 @@ var contentItem = await apiClient.contentMethods.getContentItem(22,guid, locale)
 //To log the response of the contentItem object in console.
 console.log(JSON.stringify(contentItem));
 ```
+
+## Understanding Agility CMS Batch Architecture
+
+Agility CMS uses a simple approach for working with content and batches:
+
+### Content/Page Creation (Handled by Respective Controllers)
+- **contentMethods.saveContentItem()** - Creates a single new content item and adds it to a batch
+- **contentMethods.saveContentItems()** - Creates multiple new content items and adds them to a batch  
+- **pageMethods.savePage()** - Creates a new page and adds it to a batch
+- These methods create the content AND automatically handle batch creation/management
+
+### Batch Workflow Operations (Handled by Batch Controller)
+- **batchMethods.publishBatch()** - Publishes all items in an existing batch
+- **batchMethods.unpublishBatch()** - Unpublishes all items in an existing batch
+- **batchMethods.approveBatch()** - Approves all items in an existing batch
+- **batchMethods.declineBatch()** - Declines all items in an existing batch
+- **batchMethods.requestApprovalBatch()** - Requests approval for all items in an existing batch
+- **batchMethods.getBatch()** - Retrieves details of an existing batch
+- **batchMethods.getBatchTypes()** - Retrieves all batch-related enum types for developer discovery
+
 ## Class AssetMethods
 This class is used to perform operations related to Assets. The following are the methods: -
 
@@ -240,539 +265,281 @@ Returns: An object of ```Media``` class with the information of the 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.|
-| `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.
-
-### publishContent
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentID` | `number` | The contentid of the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### unPublishContent
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentID` | `number` | The contentid of the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### contentRequestApproval
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentID` | `number` | The contentid of the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### approveContent
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentID` | `number` | The contentid of the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### declineContent
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentID` | `number` | The contentid of the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### saveContentItem
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentItem` | `ContentItem` | A contentItem object to create or update a content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### saveContentItems
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentItems` | `ContentItem[]` | A collection of contentItems object to create or update multiple contents.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### deleteContent
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `contentID` | `number` | The contentid of the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```contentID``` of the requested content.
-
-### getContentItems
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `referenceName` | `string` | The reference name of the container for the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `listParams` | `ListParams` | The parameters list to apply filter on the content list.|
-
-Returns: An object of ```ContentList``` class of the requested content.
-
-### getContentList
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `referenceName` | `string` | The reference name of the container for the requested content.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `listParams` | `ListParams` | The parameters list to apply filter on the content list.|
-| `filterObject` | `ContentListFilterModel` | To apply filter at the field level.|
-
-Returns: An object of ```ContentList``` class of the requested content.
-
-### getContentHistory
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `locale` | `string` | Current website locale.|
-| `guid` | `string` | Current website guid.|
-| `contentID` | `number` | The contentID of the requested content.|
-| `take` | `number` | The number of items per record set default value 50.|
-| `skip` | `number` | The skip level on the record set default value 0.|
-
-Returns: An object of ```ContentItemHistory``` class of the requested content history.
-
-### getContentComments
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `locale` | `string` | Current website locale.|
-| `guid` | `string` | Current website guid.|
-| `contentID` | `number` | The contentID of the requested content.|
-| `take` | `number` | The number of items per record set default value 50.|
-| `skip` | `number` | The skip level on the record set default value 0.|
+This class is used to perform **workflow operations** on existing batches. 
 
-Returns: An object of ```ItemComments``` class of the requested content comments.
+**Important**: To CREATE new content or pages, use `contentMethods.saveContentItem(s)` or `pageMethods.savePage()` instead. These batch methods are for managing workflow operations (publish, unpublish, approve, etc.) on existing batches.
 
-## Class InstanceUserMethods
-This class is used to perform operations related to User. The following are the methods: -
-
-### getUsers
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-Returns: A collection of ```WebsiteUser``` class of the requested content.
-
-### saveUser
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `emailAddress` | `string` | The email address of the requested user.|
-| `roles` | `InstanceRole[]` | Collection object of InstanceRole class for the requested user.|
-| `guid` | `string` | Current website guid.|
-| `firstName` | `string` | The first name of the requested user.|
-| `lastName` | `string` | The last name of the requested user.|
-
-Returns: An object of the ```InstanceUser``` class.
-
-### deleteUser
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `userID` | `number` | The userID of the requested user.|
-| `guid` | `string` | Current website guid.|
-
-Returns: A ```string``` response if a user has been deleted.
-
-## Class ModelMethods
-This class is used to perform operations related to Models. The following are the methods: -
-
-### getContentModel
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `id` | `number` | The id of the requested model.|
-| `guid` | `string` | Current website guid.|
-
-Returns: An object of ```Model``` class.
-
-### GetModelByReferenceName
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `referenceName` | `string` | The referenceName of the requested model.|
-| `guid` | `string` | The guid of the requested model.|
-
-### getContentModules
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `includeDefaults` | `bool` | Boolean value to include defaults.|
-| `guid` | `string` | Current website guid.|
-| `includeModules` | `bool` | Boolean value to include modules.|
-
-Returns: A collection object of ```Model``` class.
-
-### getPageModules
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `includeDefault` | `bool` | Boolean value to include defaults.|
-| `guid` | `string` | Current website guid.|
-
-Returns: A collection object of ```Model``` class.
-
-### saveModel
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `model` | `Model` | The object of Model to for the requested model.|
-| `guid` | `string` | Current website guid.|
-
-Returns: An object of ```Model``` class.
-
-### deleteModel
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `id` | `number` | The id for the requested model.|
-| `guid` | `string` | Current website guid.|
-
-Returns: A ```string``` response if a model is deleted.
-
-## Class PageMethods
-This class is used to perform operations related to Pages. The following are the methods: -
-
-### getSitemap
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-Returns: A collection object of ```Sitemap``` class.
-
-### getPageTemplates
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `includeModuleZones` | `boolean` | To include zones in the result set.|
-| `searchFilter` | `string` | To apply search criteria on the requested page template.|
-Returns: A collection object of ```PageModel``` class.
+### getBatch
+Retrieves details of an existing batch.
 
-### getPageTemplate
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
+| `batchID` | `number` | The batchID of the requested batch.|
 | `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `pageTemplateId` | `number` | The pageTemplateId of the requested page template.|
-Returns: An object of ```PageModel``` class.
+| `expandItems` | `boolean` | *(Optional)* Whether to include full item details. Default: `true`|
 
-### getPageTemplateName
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `templateName` | `string` | The templateName of the requested page template.|
-Returns: An object of ```PageModel``` class.
+Returns: An object of ```Batch``` class.
 
-### deletePageTemplate
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `pageTemplateId` | `string` | The pageTemplateId of the requested page template.|
+```javascript
+// Get batch with full item details (default)
+const batch = await apiClient.batchMethods.getBatch(123, guid);
 
-### getPageItemTemplates
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `id` | `number` | The id of the requested page template.|
-Returns: A collection of ```ContentSectionDefinition``` class.
+// Get basic batch information only (performance optimization)
+const batchBasic = await apiClient.batchMethods.getBatch(123, guid, false);
+```
 
-### savePageTemplate
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `pageModel` | `PageModel` | The pageModel object of the requested page template.|
-Returns: An object of ```PageModel``` class.
+### publishBatch
+Publishes all items in an existing batch.
 
-### getPage
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The id of the requested page.|
+| `batchID` | `number` | The batchID of the batch to publish.|
 | `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
+| `returnBatchId` | `boolean` | *(Optional)* If `true`, returns batch ID immediately. If `false` (default), waits for completion.|
 
-Returns: An object of ```PageItem``` class.
+Returns: A ```number``` representing the batch ID.
 
-### publishPage
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The pageID of the requested page.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```pageID``` of the requested page.
+```javascript
+// Publish batch and wait for completion (default)
+const batchId = await apiClient.batchMethods.publishBatch(123, guid);
 
-### unPublishPage
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The pageID of the requested page.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
+// Publish batch and return immediately for custom polling
+const batchId = await apiClient.batchMethods.publishBatch(123, guid, true);
+```
 
-Returns: An array of ```pageID``` of the requested page.
+### unpublishBatch
+Unpublishes all items in an existing batch.
 
-### deletePage
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The pageID of the requested page.|
+| `batchID` | `number` | The batchID of the batch to unpublish.|
 | `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```pageID``` of the requested page.
+| `returnBatchId` | `boolean` | *(Optional)* If `true`, returns batch ID immediately. If `false` (default), waits for completion.|
 
-### approvePage
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The pageID of the requested page.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
+Returns: A ```number``` representing the batch ID.
 
-Returns: An array of ```pageID``` of the requested page.
+### approveBatch
+Approves all items in an existing batch.
 
-### declinePage
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The pageID of the requested page.|
+| `batchID` | `number` | The batchID of the batch to approve.|
 | `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
+| `returnBatchId` | `boolean` | *(Optional)* If `true`, returns batch ID immediately. If `false` (default), waits for completion.|
 
-Returns: An array of ```pageID``` of the requested page.
+Returns: A ```number``` representing the batch ID.
 
-### pageRequestApproval
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `pageID` | `number` | The pageID of the requested page.|
-| `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `comments` | `string` | Additional comments for a batch request.|
-
-Returns: An array of ```pageID``` of the requested page.
+### declineBatch
+Declines all items in an existing batch.
 
-### savePage
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
-| `pageItem` | `PageItem` | The object of PageItem class for the requested Page.|
+| `batchID` | `number` | The batchID of the batch to decline.|
 | `guid` | `string` | Current website guid.|
-| `locale` | `string` | Current website locale.|
-| `parentPageID` | `number` | The id of the parent page.|
-| `placeBeforePageItemID` | `number` | The id of the page before the page.|
+| `returnBatchId` | `boolean` | *(Optional)* If `true`, returns batch ID immediately. If `false` (default), waits for completion.|
 
-Returns: An array of ```pageID``` of the requested page.
-
-### getPageHistory
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `locale` | `string` | Current website locale.|
-| `guid` | `string` | Current website guid.|
-| `pageID` | `number` | The pageID of the requested page.|
-| `take` | `number` | The number of items per record set default value 50.|
-| `skip` | `number` | The skip level on the record set default value 0.|
+Returns: A ```number``` representing the batch ID.
 
-Returns: An object of ```PageHistory``` class of the requested page history.
+### requestApprovalBatch
+Requests approval for all items in an existing batch.
 
-### getPageComments
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
-| `locale` | `string` | Current website locale.|
+| `batchID` | `number` | The batchID of the batch to request approval for.|
 | `guid` | `string` | Current website guid.|
-| `pageID` | `number` | The pageID of the requested page.|
-| `take` | `number` | The number of items per record set default value 50.|
-| `skip` | `number` | The skip level on the record set default value 0.|
-
-Returns: An object of ```ItemComments``` class of the requested page comments.
+| `returnBatchId` | `boolean` | *(Optional)* If `true`, returns batch ID immediately. If `false` (default), waits for completion.|
 
-## Class ServerUserMethods
-This class is used to perform operations related to Server User. The following are the methods: -
-
-### me
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
+Returns: A ```number``` representing the batch ID.
 
-Returns: An object of ```ServerUser``` class of the requested user.
+### getBatchTypes
+Retrieves all batch-related enum types for developer discovery and dynamic UI population.
 
-### you
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
 | `guid` | `string` | Current website guid.|
-| `serverUserID` | `number` | Current website guid.|
 
-Returns: An object of ```ServerUser``` class of the requested user.
+Returns: A ```BatchTypesResponse``` object containing all enum types.
 
-## Class WebhookMethods
-This class is used to perform operations related to Webhooks in the agility instance. The following are the methods: -
+```javascript
+// Get all batch types for dynamic UI population
+const types = await apiClient.batchMethods.getBatchTypes(guid);
+
+// Create dropdown options for item types
+const itemTypeOptions = types.itemTypes.map(type => ({
+    label: type.name,
+    value: type.value
+}));
+
+// Validate operation type
+const isValidWorkflowOperation = (value) => 
+    types.workflowOperations.some(op => op.value === value);
+
+// Access specific enum data
+console.log('Available item types:', types.itemTypes);
+console.log('Available workflow operations:', types.workflowOperations);  
+console.log('Available batch states:', types.states);
+console.log('All operation types:', types.operationTypes);
+```
 
-### webhookList
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `take` | `number` | The number of items per record set default value 20.|
-| `skip` | `number` | The skip level on the record set default value 0.|
+**Response Structure:**
+```typescript
+interface BatchTypesResponse {
+    itemTypes: EnumInfo[];         // Page, ContentItem, ContentList, Tag, ModuleDef
+    operationTypes: EnumInfo[];    // All operation types 
+    workflowOperations: EnumInfo[]; // Publish, Unpublish, Approve, Decline, RequestApproval
+    states: EnumInfo[];            // None, Pending, InProcess, Processed, Deleted
+}
+
+interface EnumInfo {
+    value: number;      // Numeric enum value
+    name: string;       // String name (e.g., "Publish")
+    description: string; // Human-readable description
+}
+```
 
-Returns: A list of webhooks configured in the instance.
+**Benefits:**
+- 🎨 **Dynamic UI Population** - Frontend dropdowns populate automatically
+- ✅ **Client Validation** - Validate inputs against live API data
+- 🔍 **API Discovery** - Explore options without reading docs
+- 🚀 **Future-Proof** - New enum values appear automatically
+
+## Complete Workflow Example
+
+Here's a complete example showing how to work with batches:
+
+```typescript
+import { ApiClient } from '@agility/management-sdk';
+
+const client = new ApiClient({ token: 'your-token' });
+const guid = 'your-instance-guid';
+const locale = 'en-us';
+
+// Get batch types for dynamic UI and validation
+const batchTypes = await client.batchMethods.getBatchTypes(guid);
+console.log('Available batch types loaded:', batchTypes);
+
+// Create NEW content items (handled by content controller)
+// This automatically creates and manages batches
+const newContentBatchID = await client.contentMethods.saveContentItem(locale, {
+    properties: {
+        referenceName: 'blog-post',
+        definitionName: 'BlogPost',
+        state: 2
+    },
+    fields: {
+        title: 'My New Blog Post',
+        content: 'This is the blog post content...'
+    }
+});
 
-### saveWebhook
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `webhook` | `Webhook` | An object of Webhook type with the webhook data.|
+// Create NEW page (handled by page controller)  
+// This automatically creates and manages batches
+const newPageBatchID = await client.pageMethods.savePage(locale, {
+    name: 'new-product-page',
+    title: 'New Product Page',
+    menuText: 'New Product',
+    pageType: 'static',
+    templateName: 'Product Template',
+    parentPageID: -1
+});
 
-Returns: An object with the created Webhook.
+// Retrieve details of an existing batch
+const batchDetails = await client.batchMethods.getBatch(newContentBatchID, guid);
+console.log('Batch details:', batchDetails);
 
-### getWebhook
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `webhookID` | `string` | The webhookID of the requested webhook.|
+// Perform workflow operations on existing batches
+await client.batchMethods.publishBatch(newContentBatchID, guid);
+await client.batchMethods.approveBatch(newPageBatchID, guid);
 
-Returns: An object with the requested Webhook.
+// Or use immediate return for custom polling
+const batchId = await client.batchMethods.publishBatch(newContentBatchID, guid, true);
+console.log('Batch submitted for publishing:', batchId);
 
-### deleteWebhook
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
-| `webhookID` | `string` | The webhookID of the requested webhook.|
+console.log('All operations completed successfully!');
+```
 
-## Class Instance
+## Summary: Complete BatchMethods API
+
+The `BatchMethods` class provides **7 essential methods** for batch workflow management:
+
+### **Batch Operations (7 methods)**
+- `getBatch()` - Retrieve batch details and status
+- `publishBatch()` - Publish all items in a batch
+- `unpublishBatch()` - Unpublish all items in a batch
+- `approveBatch()` - Approve all items in a batch
+- `declineBatch()` - Decline all items in a batch
+- `requestApprovalBatch()` - Request approval for all items in a batch
+- `getBatchTypes()` - Get all enum types for dynamic UIs
+
+**Developer Experience Features:**
+- 🎨 **Dynamic UI Support** - `getBatchTypes()` populates dropdowns automatically
+- ✅ **Strong Typing** - Full TypeScript support with intellisense
+- 🔄 **Auto-Retry Logic** - Built-in polling for operation completion
+- 📚 **Self-Documenting** - Enum discovery eliminates hard-coded values
+- ⚡ **Streamlined API** - Focused on essential batch workflow operations
+
+## TypeScript Interfaces
+
+### Batch Response Interfaces
+
+```typescript
+interface BatchTypesResponse {
+    itemTypes: EnumInfo[];         // Page, ContentItem, ContentList, Tag, ModuleDef
+    operationTypes: EnumInfo[];    // All operation types 
+    workflowOperations: EnumInfo[]; // Publish, Unpublish, Approve, Decline, RequestApproval
+    states: EnumInfo[];            // None, Pending, InProcess, Processed, Deleted
+}
+
+interface EnumInfo {
+    value: number;      // Numeric enum value
+    name: string;       // String name (e.g., "Publish")
+    description: string; // Human-readable description
+}
+```
 
-### getLocales
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `guid` | `string` | Current website guid.|
+## Available Enums
 
-Returns: An array of locales. ex. ['en-us','fr-ca']
+### WorkflowOperationType (for batch processing)
+> **Note**: In the API documentation (Swagger UI), these operations appear as descriptive dropdown options (Publish, Unpublish, Approve, Decline, RequestApproval) instead of numbers.
 
-## Running the SDK Locally
+- `Publish = 1`
+- `Unpublish = 2` 
+- `Approve = 3`
+- `Decline = 4`
+- `RequestApproval = 5`
 
-- `npm run clean`
-- `npm run prepare`
-- `npm run build`
+### BatchItemType
+> **Note**: In the API documentation (Swagger UI), these appear as descriptive dropdown options (Page, ContentItem, ContentList, Tag, ModuleDef) instead of numbers.
 
-## How It Works
+- `Page = 1`
+- `ContentItem = 2`
+- `ContentList = 3`
+- `Tag = 4`
+- `ModuleDef = 5`
 
-- [How Pages Work](https://help.agilitycms.com/hc/en-us/articles/4404222849677)
-- [How Page Modules Work](https://help.agilitycms.com/hc/en-us/articles/4404222989453)
-- [How Page Templates Work](https://help.agilitycms.com/hc/en-us/articles/4404229108877)
+### BatchState
+> **Note**: In the API documentation (Swagger UI), these appear as descriptive names (None, Pending, InProcess, Processed, Deleted) instead of numbers.
 
-## Resources
+- `None = 0` - Batch created but not submitted for processing
+- `Pending = 1` - Batch is pending processing
+- `InProcess = 2` - Batch is currently being processed  
+- `Processed = 3` - Batch has been processed successfully
+- `Deleted = 4` - Batch has been deleted
 
-### Agility CMS
+## Error Handling
 
-- [Official site](https://agilitycms.com)
-- [Documentation](https://help.agilitycms.com/hc/en-us)
+All methods throw exceptions on failure:
 
-### Community
+```typescript
+try {
+    const batch = await client.batchMethods.getBatch(123, 'instance-guid');
+} catch (error) {
+    console.error('Failed to get batch:', error.message);
+}
+```
 
-- [Official Slack](https://join.slack.com/t/agilitycommunity/shared_invite/enQtNzI2NDc3MzU4Njc2LWI2OTNjZTI3ZGY1NWRiNTYzNmEyNmI0MGZlZTRkYzI3NmRjNzkxYmI5YTZjNTg2ZTk4NGUzNjg5NzY3OWViZGI)
-- [Blog](https://agilitycms.com/resources/posts)
-- [GitHub](https://github.com/agility)
-- [Forums](https://help.agilitycms.com/hc/en-us/community/topics)
-- [Facebook](https://www.facebook.com/AgilityCMS/)
-- [Twitter](https://twitter.com/AgilityCMS)
+## License
 
-## Feedback and Questions
+MIT
 
-If you have feedback or questions about this starter, please use the [Github Issues](https://github.com/agility/agility-cms-management-sdk-typescript/issues) on this repo, join our [Community Slack Channel](https://join.slack.com/t/agilitycommunity/shared_invite/enQtNzI2NDc3MzU4Njc2LWI2OTNjZTI3ZGY1NWRiNTYzNmEyNmI0MGZlZTRkYzI3NmRjNzkxYmI5YTZjNTg2ZTk4NGUzNjg5NzY3OWViZGI) or create a post on the [Agility Developer Community](https://help.agilitycms.com/hc/en-us/community/topics).
+If you have feedback or questions about this starter, please use the [Github Issues](https://github.com/agility/agility-cms-management-sdk-typescript/issues) on this repo, join our [Community Slack Channel](https://join.slack.com/t/agilitycommunity/shared_invite/enQtNzI2NDc3MzU4Njc2LWI2OTNjZTI3ZGY1NWRiNTYzNmEyNmI0MGZlZTRkYzI3NmRjNzkxYmI5YTZjNTg2ZTk4NGUzNjg5NzY3OWViZGI) or create a post on the [Agility Developer Community](https://help.agilitycms.com/hc/en-us/community/topics).