@agility/management-sdk 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +395 -395
  2. package/dist/apiMethods/assetMethods.d.ts +14 -14
  3. package/dist/apiMethods/assetMethods.js +95 -95
  4. package/dist/apiMethods/batchMethods.d.ts +11 -11
  5. package/dist/apiMethods/batchMethods.js +65 -65
  6. package/dist/apiMethods/clientInstance.d.ts +8 -8
  7. package/dist/apiMethods/clientInstance.js +77 -77
  8. package/dist/apiMethods/containerMethods.d.ts +16 -16
  9. package/dist/apiMethods/containerMethods.js +105 -105
  10. package/dist/apiMethods/contentMethods.d.ts +20 -20
  11. package/dist/apiMethods/contentMethods.js +175 -175
  12. package/dist/apiMethods/instanceUserMethods.d.ts +13 -13
  13. package/dist/apiMethods/instanceUserMethods.js +57 -57
  14. package/dist/apiMethods/modelMethods.d.ts +13 -13
  15. package/dist/apiMethods/modelMethods.js +81 -81
  16. package/dist/apiMethods/pageMethods.d.ts +20 -20
  17. package/dist/apiMethods/pageMethods.js +159 -159
  18. package/dist/enums/batchOperationType.d.ts +19 -19
  19. package/dist/enums/batchOperationType.js +23 -23
  20. package/dist/enums/batchState..d.ts +7 -7
  21. package/dist/enums/batchState..js +11 -11
  22. package/dist/index.d.ts +21 -21
  23. package/dist/index.js +33 -37
  24. package/dist/models/batch.d.ts +29 -29
  25. package/dist/models/batch.js +6 -6
  26. package/dist/models/batchItem.d.ts +13 -13
  27. package/dist/models/batchItem.js +6 -6
  28. package/dist/models/container.d.ts +47 -47
  29. package/dist/models/container.js +6 -6
  30. package/dist/models/contentItem.d.ts +37 -37
  31. package/dist/models/contentItem.js +18 -18
  32. package/dist/models/contentViewColumn.d.ts +8 -8
  33. package/dist/models/contentViewColumn.js +6 -6
  34. package/dist/models/exception.d.ts +4 -4
  35. package/dist/models/exception.js +10 -10
  36. package/dist/models/instanceRole.d.ts +7 -7
  37. package/dist/models/instanceRole.js +6 -6
  38. package/dist/models/instanceUser.d.ts +14 -14
  39. package/dist/models/instanceUser.js +6 -6
  40. package/dist/models/media.d.ts +30 -30
  41. package/dist/models/media.js +9 -9
  42. package/dist/models/model.d.ts +30 -30
  43. package/dist/models/model.js +9 -9
  44. package/dist/models/notification.d.ts +13 -13
  45. package/dist/models/notification.js +6 -6
  46. package/dist/models/options.d.ts +10 -10
  47. package/dist/models/options.js +25 -25
  48. package/dist/models/pageItem.d.ts +56 -56
  49. package/dist/models/pageItem.js +21 -21
  50. package/dist/models/sitemap.d.ts +20 -20
  51. package/dist/models/sitemap.js +9 -9
  52. package/dist/models/websiteUser.d.ts +22 -22
  53. package/dist/models/websiteUser.js +9 -9
  54. package/license.txt +20 -20
  55. package/package.json +39 -39
  56. package/tsconfig.json +14 -14
@@ -1,13 +1,13 @@
1
- export declare class BatchItem {
2
- batchItemID: number | null;
3
- batchID: number | null;
4
- itemTypeName: string;
5
- itemID: number;
6
- languageCode: string;
7
- processedItemVersionID: number | null;
8
- itemTitle: string;
9
- itemNull: boolean;
10
- createdOn: string;
11
- createdBy: number;
12
- createdByName: string;
13
- }
1
+ export declare class BatchItem {
2
+ batchItemID: number | null;
3
+ batchID: number | null;
4
+ itemTypeName: string;
5
+ itemID: number;
6
+ languageCode: string;
7
+ processedItemVersionID: number | null;
8
+ itemTitle: string;
9
+ itemNull: boolean;
10
+ createdOn: string;
11
+ createdBy: number;
12
+ createdByName: string;
13
+ }
@@ -1,6 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BatchItem = void 0;
4
- class BatchItem {
5
- }
6
- exports.BatchItem = BatchItem;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BatchItem = void 0;
4
+ class BatchItem {
5
+ }
6
+ exports.BatchItem = BatchItem;
@@ -1,47 +1,47 @@
1
- import { ContentViewColumn } from "./contentViewColumn";
2
- export declare class Container {
3
- columns: ContentViewColumn[];
4
- contentViewID: number | null;
5
- contentDefinitionID: number | null;
6
- contentDefinitionName: string | null;
7
- referenceName: string | null;
8
- contentViewName: string | null;
9
- contentDefinitionType: number;
10
- requiresApproval: boolean | null;
11
- lastModifiedDate: string | null;
12
- lastModifiedOn: string | null;
13
- lastModifiedBy: string | null;
14
- isShared: boolean | null;
15
- isDynamicPageList: boolean | null;
16
- disablePublishFromList: boolean | null;
17
- contentViewCategoryID: number | null;
18
- contentViewCategoryReferenceName: string | null;
19
- contentViewCategoryName: string | null;
20
- title: string | null;
21
- defaultPage: string | null;
22
- isPublished: boolean | null;
23
- schemaTitle: string | null;
24
- allowClientSideSave: boolean | null;
25
- defaultSortColumn: string | null;
26
- defaultSortDirection: string | null;
27
- usageCount: number | null;
28
- isDeleted: boolean | null;
29
- enableRSSOutput: boolean | null;
30
- enableAPIOutput: boolean | null;
31
- commentsRecordTypeName: string | null;
32
- numRowsInListing: number | null;
33
- contentDefinitionTypeID: number | null;
34
- fullSyncModDate: string | null;
35
- confirmSharingOnPublish: boolean | null;
36
- contentTemplateName: string | null;
37
- currentUserCanDelete: boolean | null;
38
- currentUserCanEdit: boolean | null;
39
- currentUserCanDesign: boolean | null;
40
- currentUserCanManage: boolean | null;
41
- currentUserCanContribute: boolean | null;
42
- currentUserCanPublish: boolean | null;
43
- defaultListingPage: string | null;
44
- defaultDetailsPage: string | null;
45
- defaultDetailsPageQueryString: string;
46
- isListItem: boolean | null;
47
- }
1
+ import { ContentViewColumn } from "./contentViewColumn";
2
+ export declare class Container {
3
+ columns: ContentViewColumn[];
4
+ contentViewID: number | null;
5
+ contentDefinitionID: number | null;
6
+ contentDefinitionName: string | null;
7
+ referenceName: string | null;
8
+ contentViewName: string | null;
9
+ contentDefinitionType: number;
10
+ requiresApproval: boolean | null;
11
+ lastModifiedDate: string | null;
12
+ lastModifiedOn: string | null;
13
+ lastModifiedBy: string | null;
14
+ isShared: boolean | null;
15
+ isDynamicPageList: boolean | null;
16
+ disablePublishFromList: boolean | null;
17
+ contentViewCategoryID: number | null;
18
+ contentViewCategoryReferenceName: string | null;
19
+ contentViewCategoryName: string | null;
20
+ title: string | null;
21
+ defaultPage: string | null;
22
+ isPublished: boolean | null;
23
+ schemaTitle: string | null;
24
+ allowClientSideSave: boolean | null;
25
+ defaultSortColumn: string | null;
26
+ defaultSortDirection: string | null;
27
+ usageCount: number | null;
28
+ isDeleted: boolean | null;
29
+ enableRSSOutput: boolean | null;
30
+ enableAPIOutput: boolean | null;
31
+ commentsRecordTypeName: string | null;
32
+ numRowsInListing: number | null;
33
+ contentDefinitionTypeID: number | null;
34
+ fullSyncModDate: string | null;
35
+ confirmSharingOnPublish: boolean | null;
36
+ contentTemplateName: string | null;
37
+ currentUserCanDelete: boolean | null;
38
+ currentUserCanEdit: boolean | null;
39
+ currentUserCanDesign: boolean | null;
40
+ currentUserCanManage: boolean | null;
41
+ currentUserCanContribute: boolean | null;
42
+ currentUserCanPublish: boolean | null;
43
+ defaultListingPage: string | null;
44
+ defaultDetailsPage: string | null;
45
+ defaultDetailsPageQueryString: string;
46
+ isListItem: boolean | null;
47
+ }
@@ -1,6 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Container = void 0;
4
- class Container {
5
- }
6
- exports.Container = Container;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Container = void 0;
4
+ class Container {
5
+ }
6
+ exports.Container = Container;
@@ -1,37 +1,37 @@
1
- export declare class ContentItem {
2
- contentID: number;
3
- properties: ContentItemProperties;
4
- fields: {
5
- [key: string]: any;
6
- };
7
- seo: SeoProperties | null;
8
- scripts: ContentScripts | null;
9
- }
10
- export declare class ContentItemProperties {
11
- state: number | null;
12
- modifiedBy: number | null;
13
- modified: string | null;
14
- pullDate: string | null;
15
- releaseDate: string | null;
16
- versionID: number | null;
17
- referenceName: string | null;
18
- definitionName: string | null;
19
- itemOrder: number | null;
20
- }
21
- export declare class SeoProperties {
22
- metaDescription: string | null;
23
- metaKeywords: string | null;
24
- metaHTML: string | null;
25
- menuVisible: boolean | null;
26
- sitemapVisible: boolean | null;
27
- }
28
- export declare class ContentScripts {
29
- top: string | null;
30
- bottom: string | null;
31
- }
32
- export declare class ContentList {
33
- recordOffset: number | null;
34
- totalCount: number | null;
35
- pageSize: number | null;
36
- items: any[] | null;
37
- }
1
+ export declare class ContentItem {
2
+ contentID: number;
3
+ properties: ContentItemProperties;
4
+ fields: {
5
+ [key: string]: any;
6
+ };
7
+ seo: SeoProperties | null;
8
+ scripts: ContentScripts | null;
9
+ }
10
+ export declare class ContentItemProperties {
11
+ state: number | null;
12
+ modifiedBy: number | null;
13
+ modified: string | null;
14
+ pullDate: string | null;
15
+ releaseDate: string | null;
16
+ versionID: number | null;
17
+ referenceName: string | null;
18
+ definitionName: string | null;
19
+ itemOrder: number | null;
20
+ }
21
+ export declare class SeoProperties {
22
+ metaDescription: string | null;
23
+ metaKeywords: string | null;
24
+ metaHTML: string | null;
25
+ menuVisible: boolean | null;
26
+ sitemapVisible: boolean | null;
27
+ }
28
+ export declare class ContentScripts {
29
+ top: string | null;
30
+ bottom: string | null;
31
+ }
32
+ export declare class ContentList {
33
+ recordOffset: number | null;
34
+ totalCount: number | null;
35
+ pageSize: number | null;
36
+ items: any[] | null;
37
+ }
@@ -1,18 +1,18 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ContentList = exports.ContentScripts = exports.SeoProperties = exports.ContentItemProperties = exports.ContentItem = void 0;
4
- class ContentItem {
5
- }
6
- exports.ContentItem = ContentItem;
7
- class ContentItemProperties {
8
- }
9
- exports.ContentItemProperties = ContentItemProperties;
10
- class SeoProperties {
11
- }
12
- exports.SeoProperties = SeoProperties;
13
- class ContentScripts {
14
- }
15
- exports.ContentScripts = ContentScripts;
16
- class ContentList {
17
- }
18
- exports.ContentList = ContentList;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ContentList = exports.ContentScripts = exports.SeoProperties = exports.ContentItemProperties = exports.ContentItem = void 0;
4
+ class ContentItem {
5
+ }
6
+ exports.ContentItem = ContentItem;
7
+ class ContentItemProperties {
8
+ }
9
+ exports.ContentItemProperties = ContentItemProperties;
10
+ class SeoProperties {
11
+ }
12
+ exports.SeoProperties = SeoProperties;
13
+ class ContentScripts {
14
+ }
15
+ exports.ContentScripts = ContentScripts;
16
+ class ContentList {
17
+ }
18
+ exports.ContentList = ContentList;
@@ -1,8 +1,8 @@
1
- export declare class ContentViewColumn {
2
- sortOrder: number | null;
3
- fieldName: string | null;
4
- label: string | null;
5
- isDefaultSort: boolean | null;
6
- sortDirection: string | null;
7
- typeName: string | null;
8
- }
1
+ export declare class ContentViewColumn {
2
+ sortOrder: number | null;
3
+ fieldName: string | null;
4
+ label: string | null;
5
+ isDefaultSort: boolean | null;
6
+ sortDirection: string | null;
7
+ typeName: string | null;
8
+ }
@@ -1,6 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ContentViewColumn = void 0;
4
- class ContentViewColumn {
5
- }
6
- exports.ContentViewColumn = ContentViewColumn;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ContentViewColumn = void 0;
4
+ class ContentViewColumn {
5
+ }
6
+ exports.ContentViewColumn = ContentViewColumn;
@@ -1,4 +1,4 @@
1
- export declare class Exception extends Error {
2
- constructor(message: string, inner?: Error);
3
- innerError?: Error;
4
- }
1
+ export declare class Exception extends Error {
2
+ constructor(message: string, inner?: Error);
3
+ innerError?: Error;
4
+ }
@@ -1,10 +1,10 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Exception = void 0;
4
- class Exception extends Error {
5
- constructor(message, inner) {
6
- super(message);
7
- this.innerError = inner;
8
- }
9
- }
10
- exports.Exception = Exception;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Exception = void 0;
4
+ class Exception extends Error {
5
+ constructor(message, inner) {
6
+ super(message);
7
+ this.innerError = inner;
8
+ }
9
+ }
10
+ exports.Exception = Exception;
@@ -1,7 +1,7 @@
1
- export declare class InstanceRole {
2
- roleID: number;
3
- isGlobalRole: boolean;
4
- sort: number;
5
- role: string | null;
6
- name: string | null;
7
- }
1
+ export declare class InstanceRole {
2
+ roleID: number;
3
+ isGlobalRole: boolean;
4
+ sort: number;
5
+ role: string | null;
6
+ name: string | null;
7
+ }
@@ -1,6 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InstanceRole = void 0;
4
- class InstanceRole {
5
- }
6
- exports.InstanceRole = InstanceRole;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.InstanceRole = void 0;
4
+ class InstanceRole {
5
+ }
6
+ exports.InstanceRole = InstanceRole;
@@ -1,14 +1,14 @@
1
- import { InstanceRole } from "./instanceRole";
2
- import { InstancePermission } from "./websiteUser";
3
- export declare class InstanceUser {
4
- userID: number;
5
- emailAddress: string | null;
6
- firstName: string | null;
7
- lastName: string | null;
8
- isDeleted: boolean;
9
- isTeamUser: boolean;
10
- defaultUILanguage: string | null;
11
- userName: string;
12
- instanceRoles: InstanceRole[];
13
- instancePermissions: InstancePermission[];
14
- }
1
+ import { InstanceRole } from "./instanceRole";
2
+ import { InstancePermission } from "./websiteUser";
3
+ export declare class InstanceUser {
4
+ userID: number;
5
+ emailAddress: string | null;
6
+ firstName: string | null;
7
+ lastName: string | null;
8
+ isDeleted: boolean;
9
+ isTeamUser: boolean;
10
+ defaultUILanguage: string | null;
11
+ userName: string;
12
+ instanceRoles: InstanceRole[];
13
+ instancePermissions: InstancePermission[];
14
+ }
@@ -1,6 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InstanceUser = void 0;
4
- class InstanceUser {
5
- }
6
- exports.InstanceUser = InstanceUser;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.InstanceUser = void 0;
4
+ class InstanceUser {
5
+ }
6
+ exports.InstanceUser = InstanceUser;
@@ -1,30 +1,30 @@
1
- export declare class Media {
2
- hasChildren: boolean;
3
- mediaID: number;
4
- fileName: string;
5
- containerID: number;
6
- containerOriginUrl: string;
7
- containerEdgeUrl: string;
8
- originKey: string;
9
- modifiedBy: number | null;
10
- modifiedByName: string | null;
11
- dateModified: string | null;
12
- size: number;
13
- isFolder: boolean;
14
- isDeleted: boolean;
15
- mediaGroupingID: number;
16
- mediaGroupingName: string | null;
17
- mediaGroupingSortOrder: number;
18
- contentType: string;
19
- gridThumbnailID: number | null;
20
- gridThumbnailSuffix: string | null;
21
- rowNumber: number | null;
22
- originUrl: string;
23
- edgeUrl: string;
24
- isImage: boolean | null;
25
- isSvg: boolean | null;
26
- }
27
- export declare class AssetMediaList {
28
- assetMedias: (Media | null)[];
29
- totalCount: number | null;
30
- }
1
+ export declare class Media {
2
+ hasChildren: boolean;
3
+ mediaID: number;
4
+ fileName: string;
5
+ containerID: number;
6
+ containerOriginUrl: string;
7
+ containerEdgeUrl: string;
8
+ originKey: string;
9
+ modifiedBy: number | null;
10
+ modifiedByName: string | null;
11
+ dateModified: string | null;
12
+ size: number;
13
+ isFolder: boolean;
14
+ isDeleted: boolean;
15
+ mediaGroupingID: number;
16
+ mediaGroupingName: string | null;
17
+ mediaGroupingSortOrder: number;
18
+ contentType: string;
19
+ gridThumbnailID: number | null;
20
+ gridThumbnailSuffix: string | null;
21
+ rowNumber: number | null;
22
+ originUrl: string;
23
+ edgeUrl: string;
24
+ isImage: boolean | null;
25
+ isSvg: boolean | null;
26
+ }
27
+ export declare class AssetMediaList {
28
+ assetMedias: (Media | null)[];
29
+ totalCount: number | null;
30
+ }
@@ -1,9 +1,9 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AssetMediaList = exports.Media = void 0;
4
- class Media {
5
- }
6
- exports.Media = Media;
7
- class AssetMediaList {
8
- }
9
- exports.AssetMediaList = AssetMediaList;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AssetMediaList = exports.Media = void 0;
4
+ class Media {
5
+ }
6
+ exports.Media = Media;
7
+ class AssetMediaList {
8
+ }
9
+ exports.AssetMediaList = AssetMediaList;
@@ -1,30 +1,30 @@
1
- export declare class Model {
2
- id: number | null;
3
- lastModifiedDate: string | null;
4
- displayName: string | null;
5
- referenceName: string | null;
6
- lastModifiedBy: string | null;
7
- fields: ModelField[];
8
- lastModifiedAuthorID: number | null;
9
- description: string | null;
10
- allowTagging: boolean | null;
11
- contentDefinitionTypeName: string | null;
12
- isPublished: boolean | null;
13
- wasUnpublished: boolean | null;
14
- }
15
- export declare class ModelField {
16
- name: string | null;
17
- label: string | null;
18
- type: string | null;
19
- settings: {
20
- [key: string]: string;
21
- };
22
- labelHelpDescription: string | null;
23
- itemOrder: number | null;
24
- designerOnly: boolean | null;
25
- isDataField: boolean | null;
26
- editable: boolean | null;
27
- hiddenField: boolean | null;
28
- fieldID: string | null;
29
- description: string | null;
30
- }
1
+ export declare class Model {
2
+ id: number | null;
3
+ lastModifiedDate: string | null;
4
+ displayName: string | null;
5
+ referenceName: string | null;
6
+ lastModifiedBy: string | null;
7
+ fields: ModelField[];
8
+ lastModifiedAuthorID: number | null;
9
+ description: string | null;
10
+ allowTagging: boolean | null;
11
+ contentDefinitionTypeName: string | null;
12
+ isPublished: boolean | null;
13
+ wasUnpublished: boolean | null;
14
+ }
15
+ export declare class ModelField {
16
+ name: string | null;
17
+ label: string | null;
18
+ type: string | null;
19
+ settings: {
20
+ [key: string]: string;
21
+ };
22
+ labelHelpDescription: string | null;
23
+ itemOrder: number | null;
24
+ designerOnly: boolean | null;
25
+ isDataField: boolean | null;
26
+ editable: boolean | null;
27
+ hiddenField: boolean | null;
28
+ fieldID: string | null;
29
+ description: string | null;
30
+ }
@@ -1,9 +1,9 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ModelField = exports.Model = void 0;
4
- class Model {
5
- }
6
- exports.Model = Model;
7
- class ModelField {
8
- }
9
- exports.ModelField = ModelField;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ModelField = exports.Model = void 0;
4
+ class Model {
5
+ }
6
+ exports.Model = Model;
7
+ class ModelField {
8
+ }
9
+ exports.ModelField = ModelField;
@@ -1,13 +1,13 @@
1
- export declare class Notification {
2
- notificationID: number | null;
3
- userID: number | null;
4
- contentViewID: number | null;
5
- pageItemContainerID: number | null;
6
- createdAuthorID: number | null;
7
- createdDate: string | null;
8
- userName: string | null;
9
- firstName: string | null;
10
- lastName: string | null;
11
- emailAddress: string | null;
12
- notificationTypeName: string | null;
13
- }
1
+ export declare class Notification {
2
+ notificationID: number | null;
3
+ userID: number | null;
4
+ contentViewID: number | null;
5
+ pageItemContainerID: number | null;
6
+ createdAuthorID: number | null;
7
+ createdDate: string | null;
8
+ userName: string | null;
9
+ firstName: string | null;
10
+ lastName: string | null;
11
+ emailAddress: string | null;
12
+ notificationTypeName: string | null;
13
+ }
@@ -1,6 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Notification = void 0;
4
- class Notification {
5
- }
6
- exports.Notification = Notification;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Notification = void 0;
4
+ class Notification {
5
+ }
6
+ exports.Notification = Notification;
@@ -1,10 +1,10 @@
1
- export declare class Options {
2
- locale: string | null;
3
- token: string | null;
4
- baseUrl: string | null;
5
- guid: string;
6
- refresh_token: string | null;
7
- duration: number | 3000;
8
- retryCount: number | 500;
9
- determineBaseUrl(guid: string): string;
10
- }
1
+ export declare class Options {
2
+ locale: string | null;
3
+ token: string | null;
4
+ baseUrl: string | null;
5
+ guid: string;
6
+ refresh_token: string | null;
7
+ duration: number | 3000;
8
+ retryCount: number | 500;
9
+ determineBaseUrl(guid: string): string;
10
+ }