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

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/batchItem.d.ts

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

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/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/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/exception.js

@@ -7,6 +7,8 @@ var __extends = (this && this.__extends) || (function () {
         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 __());

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;

package/dist/models/listParams.d.ts

@@ -0,0 +1,9 @@
+export declare class ListParams {
+    filter: string;
+    fields: string;
+    sortDirection: string;
+    sortField: string;
+    showDeleted: boolean;
+    take: number;
+    skip: number;
+}

package/dist/models/listParams.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListParams = void 0;
+var ListParams = /** @class */ (function () {
+    function ListParams() {
+        this.filter = '';
+        this.fields = '';
+        this.sortDirection = '';
+        this.sortField = '';
+        this.showDeleted = false;
+        this.take = 50;
+        this.skip = 0;
+    }
+    return ListParams;
+}());
+exports.ListParams = ListParams;

package/dist/models/locales.d.ts

@@ -0,0 +1,3 @@
+export declare class Locales extends Array<string> {
+    constructor(...items: string[]);
+}

package/dist/models/locales.js

@@ -0,0 +1,30 @@
+"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.Locales = void 0;
+var Locales = /** @class */ (function (_super) {
+    __extends(Locales, _super);
+    function Locales() {
+        var items = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            items[_i] = arguments[_i];
+        }
+        return _super.apply(this, items) || this;
+    }
+    return Locales;
+}(Array));
+exports.Locales = Locales;

package/dist/models/options.d.ts

@@ -1,10 +1,7 @@
 export declare class Options {
-    locale: string | null;
-    token: string | null;
+    token: string;
     baseUrl: string | null;
-    guid: string;
-    refresh_token: string | null;
+    refresh_token: string;
     duration: number | 3000;
     retryCount: number | 500;
-    determineBaseUrl(guid: string): string;
 }

package/dist/models/options.js

@@ -4,25 +4,6 @@ exports.Options = void 0;
 var Options = /** @class */ (function () {
     function Options() {
     }
-    Options.prototype.determineBaseUrl = function (guid) {
-        var seperator = guid.split('-');
-        if (seperator[1] === 'd') {
-            return "https://mgmt-dev.aglty.io";
-        }
-        else if (seperator[1] === 'u') {
-            return "https://mgmt.aglty.io";
-        }
-        else if (seperator[1] === 'ca') {
-            return "https://mgmt-ca.aglty.io";
-        }
-        else if (seperator[1] === 'eu') {
-            return "https://mgmt-aus.aglty.io";
-        }
-        else if (seperator[1] === 'aus') {
-            return "https://mgmt-aus.aglty.io";
-        }
-        return "https://mgmt.aglty.io";
-    };
     return Options;
 }());
 exports.Options = Options;

package/dist/models/pageHistory.d.ts

@@ -0,0 +1,21 @@
+export declare class PageHistory {
+    PageItemID: number;
+    ContentItemID: number;
+    StateID: number;
+    State: string;
+    CreatedDate: string;
+    CreatedBy: string;
+    CreatedByUserID: number;
+    CreatedByUserEmail: string;
+    CreatedByServerUserID: number;
+    ReleaseDate: string;
+    PullDate: string;
+    CommentID: number;
+    Comment: string;
+    Pinned: boolean;
+    VersionNumber: number;
+}
+export declare class PageHistoryResponse {
+    items: PageHistory[];
+    totalCount: number;
+}

package/dist/models/pageHistory.js

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

package/dist/models/pageModel.d.ts

@@ -0,0 +1,14 @@
+import { ContentSectionDefinition } from "./contentSectionDefinition";
+export declare class PageModel {
+    doesPageTemplateHavePages: boolean;
+    pageTemplateID: number | null;
+    digitalChannelTypeID: number | null;
+    digitalChannelTypeName: string | null;
+    agilityCode: boolean;
+    pageTemplateName: string | null;
+    relativeURL: string | null;
+    pageNames: string | null;
+    isDeleted: boolean;
+    previewUrl: string | null;
+    contentSectionDefinitions: (ContentSectionDefinition | null)[] | null;
+}

package/dist/models/pageModel.js

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