@agility/management-sdk 0.1.2 → 0.1.4-beta.1

package/dist/models/assetGalleries.d.ts

@@ -0,0 +1,5 @@
+import { assetMediaGrouping } from "./assetMediaGrouping";
+export declare class assetGalleries {
+    totalCount: number | null;
+    assetMediaGroupings: (assetMediaGrouping | null)[];
+}

package/dist/models/assetGalleries.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetGalleries = void 0;
+var assetGalleries = /** @class */ (function () {
+    function assetGalleries() {
+    }
+    return assetGalleries;
+}());
+exports.assetGalleries = assetGalleries;

package/dist/models/assetMediaGrouping.d.ts

@@ -0,0 +1,17 @@
+import { AssetGroupingType } from "../enums/assetGroupingType";
+import { assetMediaGroupingMetaData } from "./assetMediaGroupingMetaData";
+export declare class assetMediaGrouping {
+    mediaGroupingID: number | null;
+    groupingType: AssetGroupingType | null;
+    groupingTypeID: number | null;
+    name: string | null;
+    description: string | null;
+    modifiedBy: number | null;
+    modifiedByName: string | null;
+    modifiedOn: string | null;
+    isDeleted: boolean;
+    isFolder: boolean;
+    metaData: {
+        [key: string]: assetMediaGroupingMetaData;
+    };
+}

package/dist/models/assetMediaGrouping.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetMediaGrouping = void 0;
+var assetMediaGrouping = /** @class */ (function () {
+    function assetMediaGrouping() {
+    }
+    return assetMediaGrouping;
+}());
+exports.assetMediaGrouping = assetMediaGrouping;

package/dist/models/assetMediaGroupingMetaData.d.ts

@@ -0,0 +1,4 @@
+export declare class assetMediaGroupingMetaData {
+    key: string;
+    value: string;
+}

package/dist/models/assetMediaGroupingMetaData.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetMediaGroupingMetaData = void 0;
+var assetMediaGroupingMetaData = /** @class */ (function () {
+    function assetMediaGroupingMetaData() {
+    }
+    return assetMediaGroupingMetaData;
+}());
+exports.assetMediaGroupingMetaData = assetMediaGroupingMetaData;

package/dist/models/authTokens.d.ts

@@ -0,0 +1,73 @@
+/**
+ * OAuth token response from token exchange
+ */
+export interface OAuthTokenResponse {
+    access_token: string;
+    refresh_token?: string;
+    expires_in: number;
+    token_type: string;
+    scope?: string;
+}
+/**
+ * OAuth authorization URL generation options
+ */
+export interface AuthUrlOptions {
+    redirectUri: string;
+    scope?: string;
+    state?: string;
+    responseType?: string;
+    region?: string;
+}
+/**
+ * OAuth token exchange request parameters
+ */
+export interface TokenExchangeRequest {
+    code: string;
+    redirectUri: string;
+    grantType?: string;
+}
+/**
+ * OAuth token refresh request parameters
+ */
+export interface TokenRefreshRequest {
+    refreshToken: string;
+    grantType?: string;
+}
+/**
+ * OAuth token validation response
+ */
+export interface TokenValidationResponse {
+    active: boolean;
+    exp?: number;
+    iat?: number;
+    scope?: string;
+    sub?: string;
+    aud?: string[];
+}
+/**
+ * OAuth error response
+ */
+export interface OAuthErrorResponse {
+    error: string;
+    error_description?: string;
+    error_uri?: string;
+}
+/**
+ * Token manager configuration
+ */
+export interface TokenManagerConfig {
+    accessToken: string;
+    refreshToken?: string;
+    expiresAt?: number;
+    region?: string;
+}
+/**
+ * Authentication state information
+ */
+export interface AuthState {
+    isAuthenticated: boolean;
+    token?: string;
+    expiresAt?: number;
+    scope?: string;
+    refreshToken?: string;
+}

package/dist/models/authTokens.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/batch.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Batch = void 0;
-class Batch {
-}
+var Batch = /** @class */ (function () {
+    function Batch() {
+    }
+    return Batch;
+}());
 exports.Batch = Batch;

package/dist/models/batchItem.d.ts

@@ -10,4 +10,5 @@ export declare class BatchItem {
     createdOn: string;
     createdBy: number;
     createdByName: string;
+    errorMessage: string | null;
 }

package/dist/models/batchItem.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchItem = void 0;
-class BatchItem {
-}
+var BatchItem = /** @class */ (function () {
+    function BatchItem() {
+    }
+    return BatchItem;
+}());
 exports.BatchItem = BatchItem;

package/dist/models/batchRequests.d.ts

@@ -0,0 +1,67 @@
+import { BatchOperationType } from "../enums/batchOperationType";
+import { BatchItemType } from "../enums/batchItemType";
+/**
+ * Request model for creating a new batch.
+ */
+export interface CreateBatchRequest {
+    /**
+     * Custom name for the batch. If not provided, defaults to "Custom Batch".
+     */
+    batchName?: string;
+    /**
+     * Default operation type for the batch.
+     * If not provided, defaults to Publish (1).
+     */
+    operationType?: BatchOperationType;
+    /**
+     * Whether the batch should be private (visible only to the creator).
+     * If not provided, defaults to true.
+     */
+    isPrivate?: boolean;
+    /**
+     * Optional comments or notes about the batch.
+     */
+    comments?: string;
+}
+/**
+ * Request model for adding a reference to an existing item to a batch.
+ */
+export interface AddBatchItemRequest {
+    /**
+     * The type of item to add to the batch.
+     */
+    itemType: BatchItemType;
+    /**
+     * The ID of the existing item to add to the batch.
+     * For Content Items: use the ContentID of an existing content item
+     * For Page Items: use the PageID of an existing page
+     */
+    itemID: number;
+    /**
+     * The language code for the item (e.g., "en-us", "fr-ca", "es-mx").
+     */
+    languageCode: string;
+    /**
+     * Optional display title for the item in the batch for identification purposes.
+     */
+    itemTitle?: string;
+}
+/**
+ * Request model for adding multiple items to a batch at once.
+ */
+export interface AddBatchItemsRequest {
+    /**
+     * Array of items to add to the batch.
+     * Each item must reference an existing content item or page in your CMS.
+     */
+    items: AddBatchItemRequest[];
+}
+/**
+ * Request model for processing a batch with optional comments.
+ */
+export interface ProcessBatchRequest {
+    /**
+     * Optional comments for the batch operation (for audit trail).
+     */
+    comments?: string;
+}

package/dist/models/batchRequests.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/batchTypes.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Response model containing all batch-related enum types for developer discovery.
+ */
+export interface BatchTypesResponse {
+    /**
+     * Available item types that can be added to batches.
+     */
+    itemTypes: EnumInfo[];
+    /**
+     * All available batch operation types (includes workflow and other operations).
+     */
+    operationTypes: EnumInfo[];
+    /**
+     * Workflow-specific operation types (subset of operationTypes).
+     */
+    workflowOperations: EnumInfo[];
+    /**
+     * Available batch states during lifecycle.
+     */
+    states: EnumInfo[];
+}
+/**
+ * Information about an enum value including value and name.
+ */
+export interface EnumInfo {
+    /**
+     * The numeric value of the enum.
+     */
+    value: number;
+    /**
+     * The string name of the enum value (e.g., "ContentItem", "Publish").
+     */
+    name: string;
+}

package/dist/models/batchTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/container.d.ts

@@ -1,4 +1,5 @@
 import { ContentViewColumn } from "./contentViewColumn";
+import { ContentDefinitionTypeID } from "./contentDefinitionTypeID";
 export declare class Container {
     columns: ContentViewColumn[];
     contentViewID: number | null;
@@ -30,7 +31,7 @@ export declare class Container {
     enableAPIOutput: boolean | null;
     commentsRecordTypeName: string | null;
     numRowsInListing: number | null;
-    contentDefinitionTypeID: number | null;
+    contentDefinitionTypeID: ContentDefinitionTypeID | null;
     fullSyncModDate: string | null;
     confirmSharingOnPublish: boolean | null;
     contentTemplateName: string | null;

package/dist/models/container.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Container = void 0;
-class Container {
-}
+var Container = /** @class */ (function () {
+    function Container() {
+    }
+    return Container;
+}());
 exports.Container = Container;

package/dist/models/contentDefinitionTypeID.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Enum representing the content definition type ID values in Agility CMS
+ */
+export declare enum ContentDefinitionTypeID {
+    /**
+     * List type content definition (0)
+     */
+    List = 0,
+    /**
+     * Single item type content definition (1)
+     */
+    SingleItem = 1,
+    /**
+     * Component type content definition (2)
+     */
+    Component = 2
+}

package/dist/models/contentDefinitionTypeID.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentDefinitionTypeID = void 0;
+/**
+ * Enum representing the content definition type ID values in Agility CMS
+ */
+var ContentDefinitionTypeID;
+(function (ContentDefinitionTypeID) {
+    /**
+     * List type content definition (0)
+     */
+    ContentDefinitionTypeID[ContentDefinitionTypeID["List"] = 0] = "List";
+    /**
+     * Single item type content definition (1)
+     */
+    ContentDefinitionTypeID[ContentDefinitionTypeID["SingleItem"] = 1] = "SingleItem";
+    /**
+     * Component type content definition (2)
+     */
+    ContentDefinitionTypeID[ContentDefinitionTypeID["Component"] = 2] = "Component";
+})(ContentDefinitionTypeID || (exports.ContentDefinitionTypeID = ContentDefinitionTypeID = {}));

package/dist/models/contentItem.js

@@ -1,18 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentList = exports.ContentScripts = exports.SeoProperties = exports.ContentItemProperties = exports.ContentItem = void 0;
-class ContentItem {
-}
+var ContentItem = /** @class */ (function () {
+    function ContentItem() {
+    }
+    return ContentItem;
+}());
 exports.ContentItem = ContentItem;
-class ContentItemProperties {
-}
+var ContentItemProperties = /** @class */ (function () {
+    function ContentItemProperties() {
+    }
+    return ContentItemProperties;
+}());
 exports.ContentItemProperties = ContentItemProperties;
-class SeoProperties {
-}
+var SeoProperties = /** @class */ (function () {
+    function SeoProperties() {
+    }
+    return SeoProperties;
+}());
 exports.SeoProperties = SeoProperties;
-class ContentScripts {
-}
+var ContentScripts = /** @class */ (function () {
+    function ContentScripts() {
+    }
+    return ContentScripts;
+}());
 exports.ContentScripts = ContentScripts;
-class ContentList {
-}
+var ContentList = /** @class */ (function () {
+    function ContentList() {
+    }
+    return ContentList;
+}());
 exports.ContentList = ContentList;

package/dist/models/contentItemHistory.d.ts

@@ -0,0 +1,20 @@
+export declare class ContentItemHistoryResponse {
+    items: ContentItemHistory[];
+    totalCount: number;
+}
+export declare class ContentItemHistory {
+    contentItemID: number;
+    stateID: number;
+    state: string | null;
+    createdDate: string;
+    createdBy: string | null;
+    createdByUserID: number;
+    createdByServerUserID: number;
+    createdByUserEmail: string | null;
+    releaseDate: string;
+    pullDate: string;
+    commentID: number;
+    comment: string | null;
+    pinned: boolean;
+    versionNumber: number;
+}

package/dist/models/contentItemHistory.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentItemHistory = exports.ContentItemHistoryResponse = void 0;
+var ContentItemHistoryResponse = /** @class */ (function () {
+    function ContentItemHistoryResponse() {
+    }
+    return ContentItemHistoryResponse;
+}());
+exports.ContentItemHistoryResponse = ContentItemHistoryResponse;
+var ContentItemHistory = /** @class */ (function () {
+    function ContentItemHistory() {
+    }
+    return ContentItemHistory;
+}());
+exports.ContentItemHistory = ContentItemHistory;

package/dist/models/contentListFilterModel.d.ts

@@ -0,0 +1,26 @@
+export declare class ContentListFilterModel {
+    sortIDs: number[];
+    modifiedByIds: number[];
+    dateRange: DateRangeFilter | null;
+    stateIds: number[];
+    fieldFilters: FieldFilter[];
+    genericSearch: string;
+}
+export declare class DateRangeFilter {
+    startDate: string | null;
+    endDate: string | null;
+}
+export declare class NumRangeFilter {
+    fromNum: number;
+    toNum: number;
+}
+export declare class FieldFilterValue {
+    stringValue: string | null;
+    dateRangeValue: DateRangeFilter | null;
+    numRangeValue: NumRangeFilter | null;
+    boolValue: boolean | null;
+}
+export declare class FieldFilter {
+    field: string | null;
+    value: FieldFilterValue | null;
+}

package/dist/models/contentListFilterModel.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldFilter = exports.FieldFilterValue = exports.NumRangeFilter = exports.DateRangeFilter = exports.ContentListFilterModel = void 0;
+var ContentListFilterModel = /** @class */ (function () {
+    function ContentListFilterModel() {
+    }
+    return ContentListFilterModel;
+}());
+exports.ContentListFilterModel = ContentListFilterModel;
+var DateRangeFilter = /** @class */ (function () {
+    function DateRangeFilter() {
+    }
+    return DateRangeFilter;
+}());
+exports.DateRangeFilter = DateRangeFilter;
+var NumRangeFilter = /** @class */ (function () {
+    function NumRangeFilter() {
+    }
+    return NumRangeFilter;
+}());
+exports.NumRangeFilter = NumRangeFilter;
+var FieldFilterValue = /** @class */ (function () {
+    function FieldFilterValue() {
+    }
+    return FieldFilterValue;
+}());
+exports.FieldFilterValue = FieldFilterValue;
+var FieldFilter = /** @class */ (function () {
+    function FieldFilter() {
+    }
+    return FieldFilter;
+}());
+exports.FieldFilter = FieldFilter;

package/dist/models/contentSectionDefaultModule.d.ts

@@ -0,0 +1,7 @@
+export declare class ContentSectionDefaultModule {
+    title: string | null;
+    pageItemTemplateDefaultModuleID: number | null;
+    contentDefinitionID: number | null;
+    pageItemTemplateID: number | null;
+    autoCreate: boolean;
+}

package/dist/models/contentSectionDefaultModule.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentSectionDefaultModule = void 0;
+var ContentSectionDefaultModule = /** @class */ (function () {
+    function ContentSectionDefaultModule() {
+    }
+    return ContentSectionDefaultModule;
+}());
+exports.ContentSectionDefaultModule = ContentSectionDefaultModule;

package/dist/models/contentSectionDefinition.d.ts

@@ -0,0 +1,35 @@
+import { PageItemTemplateType } from "../enums/pageItemTemplateType";
+import { ContentSectionDefaultModule } from "./contentSectionDefaultModule";
+import { SharedModule } from "./sharedModule";
+export declare class ContentSectionDefinition {
+    defaultModules: ContentSectionDefaultModule[];
+    sharedModules: SharedModule[];
+    pageItemTemplateID: number | null;
+    pageTemplateID: number | null;
+    pageItemTemplateName: string | null;
+    pageItemTemplateReferenceName: string | null;
+    pageItemTemplateType: PageItemTemplateType;
+    pageItemTemplateTypeName: string | null;
+    itemOrder: number | null;
+    moduleOrder: number | null;
+    contentViewID: number | null;
+    contentReferenceName: string | null;
+    contentDefinitionID: number | null;
+    contentViewName: string | null;
+    itemContainerID: number | null;
+    publishContentItemID: number | null;
+    releaseDate: string;
+    pullDate: string;
+    isShared: boolean;
+    isSharedTemplate: boolean;
+    enablePersonalization: boolean;
+    doesPageTemplateHavePages: boolean;
+    moduleID: number | null;
+    contentDefinitionTitle: string | null;
+    userControlPath: string | null;
+    templateMarkup: string | null;
+    sortExpression: string | null;
+    filterExpression: string | null;
+    contentTemplateID: number | null;
+    contentTemplateName: string | null;
+}

package/dist/models/contentSectionDefinition.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentSectionDefinition = void 0;
+var ContentSectionDefinition = /** @class */ (function () {
+    function ContentSectionDefinition() {
+    }
+    return ContentSectionDefinition;
+}());
+exports.ContentSectionDefinition = ContentSectionDefinition;

package/dist/models/contentViewColumn.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentViewColumn = void 0;
-class ContentViewColumn {
-}
+var ContentViewColumn = /** @class */ (function () {
+    function ContentViewColumn() {
+    }
+    return ContentViewColumn;
+}());
 exports.ContentViewColumn = ContentViewColumn;

package/dist/models/exception.js

@@ -1,10 +1,28 @@
 "use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Exception = void 0;
-class Exception extends Error {
-    constructor(message, inner) {
-        super(message);
-        this.innerError = inner;
+var Exception = /** @class */ (function (_super) {
+    __extends(Exception, _super);
+    function Exception(message, inner) {
+        var _this = _super.call(this, message) || this;
+        _this.innerError = inner;
+        return _this;
     }
-}
+    return Exception;
+}(Error));
 exports.Exception = Exception;

package/dist/models/instanceRole.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InstanceRole = void 0;
-class InstanceRole {
-}
+var InstanceRole = /** @class */ (function () {
+    function InstanceRole() {
+    }
+    return InstanceRole;
+}());
 exports.InstanceRole = InstanceRole;

package/dist/models/instanceUser.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InstanceUser = void 0;
-class InstanceUser {
-}
+var InstanceUser = /** @class */ (function () {
+    function InstanceUser() {
+    }
+    return InstanceUser;
+}());
 exports.InstanceUser = InstanceUser;

package/dist/models/itemComments.d.ts

@@ -0,0 +1,14 @@
+export declare class ItemComment {
+    createdOn: string;
+    createdBy: string;
+    createdByUserID: number;
+    createdByServerUserID: number;
+    commentID: number;
+    commentText: string;
+    pinned: boolean;
+    emailAddress: string;
+}
+export declare class ItemComments {
+    items: ItemComment[];
+    totalCount: number;
+}

package/dist/models/itemComments.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemComments = exports.ItemComment = void 0;
+var ItemComment = /** @class */ (function () {
+    function ItemComment() {
+    }
+    return ItemComment;
+}());
+exports.ItemComment = ItemComment;
+var ItemComments = /** @class */ (function () {
+    function ItemComments() {
+    }
+    return ItemComments;
+}());
+exports.ItemComments = ItemComments;