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

package/dist/types/contentItem.d.ts

@@ -0,0 +1,37 @@
+export interface ContentItem {
+    contentID: number;
+    properties: ContentItemProperties;
+    fields: {
+        [key: string]: any;
+    };
+    seo: SeoProperties | null;
+    scripts: ContentScripts | null;
+}
+export interface ContentItemProperties {
+    state: number | null;
+    modifiedBy: number | null;
+    modified: string | null;
+    pullDate: string | null;
+    releaseDate: string | null;
+    versionID: number | null;
+    referenceName: string | null;
+    definitionName: string | null;
+    itemOrder: number | null;
+}
+export interface SeoProperties {
+    metaDescription: string | null;
+    metaKeywords: string | null;
+    metaHTML: string | null;
+    menuVisible: boolean | null;
+    sitemapVisible: boolean | null;
+}
+export interface ContentScripts {
+    top: string | null;
+    bottom: string | null;
+}
+export interface ContentList {
+    recordOffset: number | null;
+    totalCount: number | null;
+    pageSize: number | null;
+    items: any[] | null;
+}

package/dist/types/contentItem.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentItem.js.map

package/dist/types/contentItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentItem.js","sourceRoot":"","sources":["../../src/types/contentItem.ts"],"names":[],"mappings":""}

package/dist/types/contentItemHistory.d.ts

@@ -0,0 +1,20 @@
+export interface ContentItemHistoryResponse {
+    items: ContentItemHistory[];
+    totalCount: number;
+}
+export interface 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/types/contentItemHistory.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentItemHistory.js.map

package/dist/types/contentItemHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentItemHistory.js","sourceRoot":"","sources":["../../src/types/contentItemHistory.ts"],"names":[],"mappings":""}

package/dist/types/contentListFilterModel.d.ts

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

package/dist/types/contentListFilterModel.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentListFilterModel.js.map

package/dist/types/contentListFilterModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentListFilterModel.js","sourceRoot":"","sources":["../../src/types/contentListFilterModel.ts"],"names":[],"mappings":""}

package/dist/types/contentSectionDefaultModule.d.ts

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

package/dist/types/contentSectionDefaultModule.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentSectionDefaultModule.js.map

package/dist/types/contentSectionDefaultModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentSectionDefaultModule.js","sourceRoot":"","sources":["../../src/types/contentSectionDefaultModule.ts"],"names":[],"mappings":""}

package/dist/types/contentSectionDefinition.d.ts

@@ -0,0 +1,35 @@
+import { PageItemTemplateType } from "../enums/pageItemTemplateType";
+import { ContentSectionDefaultModule } from "./contentSectionDefaultModule";
+import { SharedModule } from "./sharedModule";
+export interface 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/types/contentSectionDefinition.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentSectionDefinition.js.map

package/dist/types/contentSectionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentSectionDefinition.js","sourceRoot":"","sources":["../../src/types/contentSectionDefinition.ts"],"names":[],"mappings":""}

package/dist/types/contentViewColumn.d.ts

@@ -0,0 +1,8 @@
+export interface ContentViewColumn {
+    sortOrder: number | null;
+    fieldName: string | null;
+    label: string | null;
+    isDefaultSort: boolean | null;
+    sortDirection: string | null;
+    typeName: string | null;
+}

package/dist/types/contentViewColumn.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentViewColumn.js.map

package/dist/types/contentViewColumn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentViewColumn.js","sourceRoot":"","sources":["../../src/types/contentViewColumn.ts"],"names":[],"mappings":""}

package/dist/types/instanceRole.d.ts

@@ -0,0 +1,7 @@
+export interface InstanceRole {
+    roleID: number;
+    isGlobalRole: boolean;
+    sort: number;
+    role: string | null;
+    name: string | null;
+}

package/dist/types/instanceRole.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=instanceRole.js.map

package/dist/types/instanceRole.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instanceRole.js","sourceRoot":"","sources":["../../src/types/instanceRole.ts"],"names":[],"mappings":""}

package/dist/types/instanceUser.d.ts

@@ -0,0 +1,14 @@
+import { InstanceRole } from "./instanceRole";
+import { InstancePermission } from "./websiteUser";
+export interface InstanceUser {
+    userID: number;
+    emailAddress: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    isDeleted: boolean;
+    isTeamUser: boolean;
+    defaultUILanguage: string | null;
+    userName: string;
+    instanceRoles: InstanceRole[];
+    instancePermissions: InstancePermission[];
+}

package/dist/types/instanceUser.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=instanceUser.js.map

package/dist/types/instanceUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instanceUser.js","sourceRoot":"","sources":["../../src/types/instanceUser.ts"],"names":[],"mappings":""}

package/dist/types/itemComments.d.ts

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

package/dist/types/itemComments.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=itemComments.js.map

package/dist/types/itemComments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"itemComments.js","sourceRoot":"","sources":["../../src/types/itemComments.ts"],"names":[],"mappings":""}

package/dist/types/listParams.d.ts

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

package/dist/types/listParams.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=listParams.js.map

package/dist/types/listParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listParams.js","sourceRoot":"","sources":["../../src/types/listParams.ts"],"names":[],"mappings":""}

package/dist/types/locales.d.ts

@@ -0,0 +1 @@
+export type Locales = string[];

package/dist/types/locales.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=locales.js.map

package/dist/types/locales.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locales.js","sourceRoot":"","sources":["../../src/types/locales.ts"],"names":[],"mappings":""}

package/dist/types/media.d.ts

@@ -0,0 +1,30 @@
+export interface Media {
+    hasChildren: boolean;
+    mediaID: number;
+    fileName: string;
+    containerID: number;
+    containerOriginUrl: string;
+    containerEdgeUrl: string;
+    originKey: string;
+    modifiedBy: number | null;
+    modifiedByName: string | null;
+    dateModified: string | null;
+    size: number;
+    isFolder: boolean;
+    isDeleted: boolean;
+    mediaGroupingID: number;
+    mediaGroupingName: string | null;
+    mediaGroupingSortOrder: number;
+    contentType: string;
+    gridThumbnailID: number | null;
+    gridThumbnailSuffix: string | null;
+    rowNumber: number | null;
+    originUrl: string;
+    edgeUrl: string;
+    isImage: boolean | null;
+    isSvg: boolean | null;
+}
+export interface AssetMediaList {
+    assetMedias: (Media | null)[];
+    totalCount: number | null;
+}

package/dist/types/media.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=media.js.map

package/dist/types/media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media.js","sourceRoot":"","sources":["../../src/types/media.ts"],"names":[],"mappings":""}

package/dist/types/model.d.ts

@@ -0,0 +1,30 @@
+export interface Model {
+    id: number | null;
+    lastModifiedDate: string | null;
+    displayName: string | null;
+    referenceName: string | null;
+    lastModifiedBy: string | null;
+    fields: ModelField[];
+    lastModifiedAuthorID: number | null;
+    description: string | null;
+    allowTagging: boolean | null;
+    contentDefinitionTypeName: string | null;
+    isPublished: boolean | null;
+    wasUnpublished: boolean | null;
+}
+export interface ModelField {
+    name: string | null;
+    label: string | null;
+    type: string | null;
+    settings: {
+        [key: string]: string;
+    };
+    labelHelpDescription: string | null;
+    itemOrder: number | null;
+    designerOnly: boolean | null;
+    isDataField: boolean | null;
+    editable: boolean | null;
+    hiddenField: boolean | null;
+    fieldID: string | null;
+    description: string | null;
+}

package/dist/types/model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=model.js.map

package/dist/types/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/types/model.ts"],"names":[],"mappings":""}

package/dist/types/notification.d.ts

@@ -0,0 +1,13 @@
+export interface Notification {
+    notificationID: number | null;
+    userID: number | null;
+    contentViewID: number | null;
+    pageItemContainerID: number | null;
+    createdAuthorID: number | null;
+    createdDate: string | null;
+    userName: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    emailAddress: string | null;
+    notificationTypeName: string | null;
+}

package/dist/types/notification.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=notification.js.map

package/dist/types/notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../src/types/notification.ts"],"names":[],"mappings":""}

package/dist/types/options.d.ts

@@ -0,0 +1,7 @@
+export interface Options {
+    token: string;
+    baseUrl?: string | null;
+    refresh_token?: string;
+    duration?: number;
+    retryCount?: number;
+}

package/dist/types/options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=options.js.map

package/dist/types/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/types/options.ts"],"names":[],"mappings":""}

package/dist/types/pageHistory.d.ts

@@ -0,0 +1,21 @@
+export interface 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 interface PageHistoryResponse {
+    items: PageHistory[];
+    totalCount: number;
+}

package/dist/types/pageHistory.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pageHistory.js.map

package/dist/types/pageHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageHistory.js","sourceRoot":"","sources":["../../src/types/pageHistory.ts"],"names":[],"mappings":""}

package/dist/types/pageItem.d.ts

@@ -0,0 +1,56 @@
+import { SeoProperties } from "./contentItem";
+export interface PageItem {
+    pageID: number | null;
+    name: string | null;
+    path: string | null;
+    title: string | null;
+    menuText: string | null;
+    pageType: string | null;
+    templateName: string | null;
+    redirectUrl: string | null;
+    securePage: boolean | null;
+    excludeFromOutputCache: boolean | null;
+    visible: PageVisible | null;
+    seo: SeoProperties | null;
+    scripts: PageScripts | null;
+    dynamic: PageDynamic | null;
+    properties: PageItemProperties | null;
+    zones: {
+        [key: string]: PageModule[];
+    } | null;
+    parentPageID: number | null;
+    placeBeforePageItemID: number | null;
+    channelID: number | null;
+    releaseDate: string | null;
+    pullDate: string | null;
+}
+export interface PageVisible {
+    menu: boolean | null;
+    sitemap: boolean | null;
+}
+export interface PageScripts {
+    excludedFromGlobal: boolean;
+    top: string | null;
+    bottom: string | null;
+}
+export interface PageDynamic {
+    referenceName: string | null;
+    fieldName: string | null;
+    titleFormula: string | null;
+    menuTextFormula: string | null;
+    pageNameFormula: string | null;
+    visibleOnMenu: boolean | null;
+    visibleOnSitemap: boolean | null;
+}
+export interface PageItemProperties {
+    state: number | null;
+    modified: string | null;
+    versionID: number | null;
+}
+export interface PageModule {
+    module: string | null;
+    item: any | null;
+}
+export interface Dictionary<T> {
+    [Key: string]: T;
+}

package/dist/types/pageItem.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pageItem.js.map

package/dist/types/pageItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageItem.js","sourceRoot":"","sources":["../../src/types/pageItem.ts"],"names":[],"mappings":""}

package/dist/types/pageModel.d.ts

@@ -0,0 +1,14 @@
+import { ContentSectionDefinition } from "./contentSectionDefinition";
+export interface 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/types/pageModel.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pageModel.js.map

package/dist/types/pageModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageModel.js","sourceRoot":"","sources":["../../src/types/pageModel.ts"],"names":[],"mappings":""}

package/dist/types/serverUser.d.ts

@@ -0,0 +1,21 @@
+import { WebsiteListing } from "./websiteListing";
+export interface ServerUser {
+    userID: number;
+    userName: string | null;
+    emailAddress: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    isInternalUser: boolean;
+    isSuspended: boolean;
+    isProfileComplete: boolean;
+    adminAccess: boolean;
+    currentWebsite: string | null;
+    userTypeID: number;
+    timeZoneRegion: string | null;
+    password: string | null;
+    passwordQuestion: string | null;
+    passwordAnswer: string | null;
+    websiteAccess: WebsiteListing[];
+    jobRole: string | null;
+    createdDate: string | null;
+}

package/dist/types/serverUser.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=serverUser.js.map

package/dist/types/serverUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serverUser.js","sourceRoot":"","sources":["../../src/types/serverUser.ts"],"names":[],"mappings":""}

package/dist/types/sharedModule.d.ts

@@ -0,0 +1,7 @@
+export interface SharedModule {
+    pageItemTemplateID: number | null;
+    contentTemplateID: number | null;
+    name: string | null;
+    contentDefinitionID: number | null;
+    autoCreate: boolean;
+}

package/dist/types/sharedModule.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sharedModule.js.map

package/dist/types/sharedModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedModule.js","sourceRoot":"","sources":["../../src/types/sharedModule.ts"],"names":[],"mappings":""}

package/dist/types/sitemap.d.ts

@@ -0,0 +1,20 @@
+export interface Sitemap {
+    digitalChannelID: number | null;
+    name: string | null;
+    digitalChannelTypeName: string | null;
+    isDefaultChannel: boolean;
+    pages: (SitemapItem | null)[];
+}
+export interface SitemapItem {
+    pageID: number | null;
+    parentPageID: number | null;
+    pageName: string | null;
+    title: string | null;
+    pageType: string | null;
+    languageCode: string | null;
+    pageMode: number | null;
+    dynamicPageContentReferenceName: string | null;
+    dynamicPageContentViewFieldName: string | null;
+    uRL: string | null;
+    childPages: (SitemapItem | null)[];
+}

package/dist/types/sitemap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sitemap.js.map

package/dist/types/sitemap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap.js","sourceRoot":"","sources":["../../src/types/sitemap.ts"],"names":[],"mappings":""}

package/dist/types/tokenResponseData.d.ts

@@ -0,0 +1,10 @@
+export interface TokenResponseData {
+    partitionKey: string;
+    rowKey: string;
+    access_token: string;
+    refresh_token: string;
+    token_type?: string;
+    expires_in?: number;
+    timestamp?: Date;
+    etag?: string;
+}

package/dist/types/tokenResponseData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tokenResponseData.js.map

package/dist/types/tokenResponseData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenResponseData.js","sourceRoot":"","sources":["../../src/types/tokenResponseData.ts"],"names":[],"mappings":""}

package/dist/types/webhook.d.ts

@@ -0,0 +1,9 @@
+export interface Webhook {
+    name: string | null;
+    url: string | null;
+    instanceGuid: string | null;
+    enabled: boolean;
+    contentWorkflowEvents: boolean;
+    contentPublishEvents: boolean;
+    contentSaveEvents: boolean;
+}