@agility/management-sdk 0.1.26 → 0.1.31

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 (170) hide show
  1. package/.cursor/manifest.md +98 -0
  2. package/.env +92 -0
  3. package/README.md +238 -471
  4. package/dist/apiClient.js.map +1 -0
  5. package/dist/apiMethods/assetMethods.js +38 -38
  6. package/dist/apiMethods/assetMethods.js.map +1 -0
  7. package/dist/apiMethods/batchMethods.d.ts +32 -1
  8. package/dist/apiMethods/batchMethods.js +239 -9
  9. package/dist/apiMethods/batchMethods.js.map +1 -0
  10. package/dist/apiMethods/clientInstance.d.ts +1 -1
  11. package/dist/apiMethods/clientInstance.js +12 -11
  12. package/dist/apiMethods/clientInstance.js.map +1 -0
  13. package/dist/apiMethods/containerMethods.d.ts +8 -1
  14. package/dist/apiMethods/containerMethods.js +27 -20
  15. package/dist/apiMethods/containerMethods.js.map +1 -0
  16. package/dist/apiMethods/contentMethods.d.ts +8 -8
  17. package/dist/apiMethods/contentMethods.js +100 -68
  18. package/dist/apiMethods/contentMethods.js.map +1 -0
  19. package/dist/apiMethods/instanceMethods.js +3 -3
  20. package/dist/apiMethods/instanceMethods.js.map +1 -0
  21. package/dist/apiMethods/instanceUserMethods.js +10 -10
  22. package/dist/apiMethods/instanceUserMethods.js.map +1 -0
  23. package/dist/apiMethods/modelMethods.js +13 -13
  24. package/dist/apiMethods/modelMethods.js.map +1 -0
  25. package/dist/apiMethods/pageMethods.d.ts +7 -7
  26. package/dist/apiMethods/pageMethods.js +98 -67
  27. package/dist/apiMethods/pageMethods.js.map +1 -0
  28. package/dist/apiMethods/serverUserMethods.js +4 -4
  29. package/dist/apiMethods/serverUserMethods.js.map +1 -0
  30. package/dist/apiMethods/webhookMethods.js +11 -11
  31. package/dist/apiMethods/webhookMethods.js.map +1 -0
  32. package/dist/enums/assetGroupingType.js +1 -1
  33. package/dist/enums/assetGroupingType.js.map +1 -0
  34. package/dist/enums/batchItemType.d.ts +7 -0
  35. package/dist/enums/batchItemType.js +11 -0
  36. package/dist/enums/batchOperationType.js +1 -1
  37. package/dist/enums/batchOperationType.js.map +1 -0
  38. package/dist/enums/batchState..js +1 -1
  39. package/dist/enums/batchState.d.ts +7 -0
  40. package/dist/enums/batchState.js +12 -0
  41. package/dist/enums/batchState.js.map +1 -0
  42. package/dist/enums/pageItemTemplateType.js +1 -1
  43. package/dist/enums/pageItemTemplateType.js.map +1 -0
  44. package/dist/enums/workflowOperationType.d.ts +26 -0
  45. package/dist/enums/workflowOperationType.js +30 -0
  46. package/dist/errors/exception.d.ts +4 -0
  47. package/dist/errors/exception.js +11 -0
  48. package/dist/errors/exception.js.map +1 -0
  49. package/dist/index.d.ts +6 -0
  50. package/dist/index.js +11 -1
  51. package/dist/index.js.map +1 -0
  52. package/dist/models/batchItem.d.ts +1 -0
  53. package/dist/models/batchRequests.d.ts +67 -0
  54. package/dist/models/batchRequests.js +2 -0
  55. package/dist/models/batchTypes.d.ts +34 -0
  56. package/dist/models/batchTypes.js +2 -0
  57. package/dist/models/container.d.ts +2 -1
  58. package/dist/models/contentDefinitionTypeID.d.ts +17 -0
  59. package/dist/models/contentDefinitionTypeID.js +21 -0
  60. package/dist/models/exception.js +2 -0
  61. package/dist/models/locales.js +2 -0
  62. package/dist/tests/authHelper.d.ts +2 -0
  63. package/dist/tests/authHelper.js +14 -0
  64. package/dist/tests/authHelper.js.map +1 -0
  65. package/dist/tests/config/apiClient.config.d.ts +16 -0
  66. package/dist/tests/config/apiClient.config.js +84 -0
  67. package/dist/tests/config/apiClient.config.js.map +1 -0
  68. package/dist/tests/config/test.config.d.ts +24 -0
  69. package/dist/tests/config/test.config.js +47 -0
  70. package/dist/tests/config/test.config.js.map +1 -0
  71. package/dist/types/apiResponse.d.ts +13 -0
  72. package/dist/types/apiResponse.js +3 -0
  73. package/dist/types/apiResponse.js.map +1 -0
  74. package/dist/types/assetContainer.d.ts +7 -0
  75. package/dist/types/assetContainer.js +3 -0
  76. package/dist/types/assetContainer.js.map +1 -0
  77. package/dist/types/assetGalleries.d.ts +5 -0
  78. package/dist/types/assetGalleries.js +3 -0
  79. package/dist/types/assetGalleries.js.map +1 -0
  80. package/dist/types/assetMediaGrouping.d.ts +17 -0
  81. package/dist/types/assetMediaGrouping.js +3 -0
  82. package/dist/types/assetMediaGrouping.js.map +1 -0
  83. package/dist/types/assetMediaGroupingMetaData.d.ts +4 -0
  84. package/dist/types/assetMediaGroupingMetaData.js +3 -0
  85. package/dist/types/assetMediaGroupingMetaData.js.map +1 -0
  86. package/dist/types/batch.d.ts +29 -0
  87. package/dist/types/batch.js +3 -0
  88. package/dist/types/batch.js.map +1 -0
  89. package/dist/types/batchItem.d.ts +13 -0
  90. package/dist/types/batchItem.js +3 -0
  91. package/dist/types/batchItem.js.map +1 -0
  92. package/dist/types/container.d.ts +47 -0
  93. package/dist/types/container.js +3 -0
  94. package/dist/types/container.js.map +1 -0
  95. package/dist/types/contentItem.d.ts +37 -0
  96. package/dist/types/contentItem.js +3 -0
  97. package/dist/types/contentItem.js.map +1 -0
  98. package/dist/types/contentItemHistory.d.ts +20 -0
  99. package/dist/types/contentItemHistory.js +3 -0
  100. package/dist/types/contentItemHistory.js.map +1 -0
  101. package/dist/types/contentListFilterModel.d.ts +26 -0
  102. package/dist/types/contentListFilterModel.js +3 -0
  103. package/dist/types/contentListFilterModel.js.map +1 -0
  104. package/dist/types/contentSectionDefaultModule.d.ts +7 -0
  105. package/dist/types/contentSectionDefaultModule.js +3 -0
  106. package/dist/types/contentSectionDefaultModule.js.map +1 -0
  107. package/dist/types/contentSectionDefinition.d.ts +35 -0
  108. package/dist/types/contentSectionDefinition.js +3 -0
  109. package/dist/types/contentSectionDefinition.js.map +1 -0
  110. package/dist/types/contentViewColumn.d.ts +8 -0
  111. package/dist/types/contentViewColumn.js +3 -0
  112. package/dist/types/contentViewColumn.js.map +1 -0
  113. package/dist/types/instanceRole.d.ts +7 -0
  114. package/dist/types/instanceRole.js +3 -0
  115. package/dist/types/instanceRole.js.map +1 -0
  116. package/dist/types/instanceUser.d.ts +14 -0
  117. package/dist/types/instanceUser.js +3 -0
  118. package/dist/types/instanceUser.js.map +1 -0
  119. package/dist/types/itemComments.d.ts +14 -0
  120. package/dist/types/itemComments.js +3 -0
  121. package/dist/types/itemComments.js.map +1 -0
  122. package/dist/types/listParams.d.ts +9 -0
  123. package/dist/types/listParams.js +3 -0
  124. package/dist/types/listParams.js.map +1 -0
  125. package/dist/types/locales.d.ts +1 -0
  126. package/dist/types/locales.js +3 -0
  127. package/dist/types/locales.js.map +1 -0
  128. package/dist/types/media.d.ts +30 -0
  129. package/dist/types/media.js +3 -0
  130. package/dist/types/media.js.map +1 -0
  131. package/dist/types/model.d.ts +30 -0
  132. package/dist/types/model.js +3 -0
  133. package/dist/types/model.js.map +1 -0
  134. package/dist/types/notification.d.ts +13 -0
  135. package/dist/types/notification.js +3 -0
  136. package/dist/types/notification.js.map +1 -0
  137. package/dist/types/options.d.ts +7 -0
  138. package/dist/types/options.js +3 -0
  139. package/dist/types/options.js.map +1 -0
  140. package/dist/types/pageHistory.d.ts +21 -0
  141. package/dist/types/pageHistory.js +3 -0
  142. package/dist/types/pageHistory.js.map +1 -0
  143. package/dist/types/pageItem.d.ts +56 -0
  144. package/dist/types/pageItem.js +3 -0
  145. package/dist/types/pageItem.js.map +1 -0
  146. package/dist/types/pageModel.d.ts +14 -0
  147. package/dist/types/pageModel.js +3 -0
  148. package/dist/types/pageModel.js.map +1 -0
  149. package/dist/types/serverUser.d.ts +21 -0
  150. package/dist/types/serverUser.js +3 -0
  151. package/dist/types/serverUser.js.map +1 -0
  152. package/dist/types/sharedModule.d.ts +7 -0
  153. package/dist/types/sharedModule.js +3 -0
  154. package/dist/types/sharedModule.js.map +1 -0
  155. package/dist/types/sitemap.d.ts +20 -0
  156. package/dist/types/sitemap.js +3 -0
  157. package/dist/types/sitemap.js.map +1 -0
  158. package/dist/types/tokenResponseData.d.ts +10 -0
  159. package/dist/types/tokenResponseData.js +3 -0
  160. package/dist/types/tokenResponseData.js.map +1 -0
  161. package/dist/types/webhook.d.ts +9 -0
  162. package/dist/types/webhook.js +3 -0
  163. package/dist/types/webhook.js.map +1 -0
  164. package/dist/types/websiteListing.d.ts +16 -0
  165. package/dist/types/websiteListing.js +3 -0
  166. package/dist/types/websiteListing.js.map +1 -0
  167. package/dist/types/websiteUser.d.ts +22 -0
  168. package/dist/types/websiteUser.js +3 -0
  169. package/dist/types/websiteUser.js.map +1 -0
  170. package/package.json +1 -1
@@ -0,0 +1,56 @@
1
+ import { SeoProperties } from "./contentItem";
2
+ export interface PageItem {
3
+ pageID: number | null;
4
+ name: string | null;
5
+ path: string | null;
6
+ title: string | null;
7
+ menuText: string | null;
8
+ pageType: string | null;
9
+ templateName: string | null;
10
+ redirectUrl: string | null;
11
+ securePage: boolean | null;
12
+ excludeFromOutputCache: boolean | null;
13
+ visible: PageVisible | null;
14
+ seo: SeoProperties | null;
15
+ scripts: PageScripts | null;
16
+ dynamic: PageDynamic | null;
17
+ properties: PageItemProperties | null;
18
+ zones: {
19
+ [key: string]: PageModule[];
20
+ } | null;
21
+ parentPageID: number | null;
22
+ placeBeforePageItemID: number | null;
23
+ channelID: number | null;
24
+ releaseDate: string | null;
25
+ pullDate: string | null;
26
+ }
27
+ export interface PageVisible {
28
+ menu: boolean | null;
29
+ sitemap: boolean | null;
30
+ }
31
+ export interface PageScripts {
32
+ excludedFromGlobal: boolean;
33
+ top: string | null;
34
+ bottom: string | null;
35
+ }
36
+ export interface PageDynamic {
37
+ referenceName: string | null;
38
+ fieldName: string | null;
39
+ titleFormula: string | null;
40
+ menuTextFormula: string | null;
41
+ pageNameFormula: string | null;
42
+ visibleOnMenu: boolean | null;
43
+ visibleOnSitemap: boolean | null;
44
+ }
45
+ export interface PageItemProperties {
46
+ state: number | null;
47
+ modified: string | null;
48
+ versionID: number | null;
49
+ }
50
+ export interface PageModule {
51
+ module: string | null;
52
+ item: any | null;
53
+ }
54
+ export interface Dictionary<T> {
55
+ [Key: string]: T;
56
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=pageItem.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pageItem.js","sourceRoot":"","sources":["../../src/types/pageItem.ts"],"names":[],"mappings":""}
@@ -0,0 +1,14 @@
1
+ import { ContentSectionDefinition } from "./contentSectionDefinition";
2
+ export interface PageModel {
3
+ doesPageTemplateHavePages: boolean;
4
+ pageTemplateID: number | null;
5
+ digitalChannelTypeID: number | null;
6
+ digitalChannelTypeName: string | null;
7
+ agilityCode: boolean;
8
+ pageTemplateName: string | null;
9
+ relativeURL: string | null;
10
+ pageNames: string | null;
11
+ isDeleted: boolean;
12
+ previewUrl: string | null;
13
+ contentSectionDefinitions: (ContentSectionDefinition | null)[] | null;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=pageModel.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pageModel.js","sourceRoot":"","sources":["../../src/types/pageModel.ts"],"names":[],"mappings":""}
@@ -0,0 +1,21 @@
1
+ import { WebsiteListing } from "./websiteListing";
2
+ export interface ServerUser {
3
+ userID: number;
4
+ userName: string | null;
5
+ emailAddress: string | null;
6
+ firstName: string | null;
7
+ lastName: string | null;
8
+ isInternalUser: boolean;
9
+ isSuspended: boolean;
10
+ isProfileComplete: boolean;
11
+ adminAccess: boolean;
12
+ currentWebsite: string | null;
13
+ userTypeID: number;
14
+ timeZoneRegion: string | null;
15
+ password: string | null;
16
+ passwordQuestion: string | null;
17
+ passwordAnswer: string | null;
18
+ websiteAccess: WebsiteListing[];
19
+ jobRole: string | null;
20
+ createdDate: string | null;
21
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=serverUser.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serverUser.js","sourceRoot":"","sources":["../../src/types/serverUser.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ export interface SharedModule {
2
+ pageItemTemplateID: number | null;
3
+ contentTemplateID: number | null;
4
+ name: string | null;
5
+ contentDefinitionID: number | null;
6
+ autoCreate: boolean;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sharedModule.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sharedModule.js","sourceRoot":"","sources":["../../src/types/sharedModule.ts"],"names":[],"mappings":""}
@@ -0,0 +1,20 @@
1
+ export interface Sitemap {
2
+ digitalChannelID: number | null;
3
+ name: string | null;
4
+ digitalChannelTypeName: string | null;
5
+ isDefaultChannel: boolean;
6
+ pages: (SitemapItem | null)[];
7
+ }
8
+ export interface SitemapItem {
9
+ pageID: number | null;
10
+ parentPageID: number | null;
11
+ pageName: string | null;
12
+ title: string | null;
13
+ pageType: string | null;
14
+ languageCode: string | null;
15
+ pageMode: number | null;
16
+ dynamicPageContentReferenceName: string | null;
17
+ dynamicPageContentViewFieldName: string | null;
18
+ uRL: string | null;
19
+ childPages: (SitemapItem | null)[];
20
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sitemap.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitemap.js","sourceRoot":"","sources":["../../src/types/sitemap.ts"],"names":[],"mappings":""}
@@ -0,0 +1,10 @@
1
+ export interface TokenResponseData {
2
+ partitionKey: string;
3
+ rowKey: string;
4
+ access_token: string;
5
+ refresh_token: string;
6
+ token_type?: string;
7
+ expires_in?: number;
8
+ timestamp?: Date;
9
+ etag?: string;
10
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=tokenResponseData.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tokenResponseData.js","sourceRoot":"","sources":["../../src/types/tokenResponseData.ts"],"names":[],"mappings":""}
@@ -0,0 +1,9 @@
1
+ export interface Webhook {
2
+ name: string | null;
3
+ url: string | null;
4
+ instanceGuid: string | null;
5
+ enabled: boolean;
6
+ contentWorkflowEvents: boolean;
7
+ contentPublishEvents: boolean;
8
+ contentSaveEvents: boolean;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=webhook.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"webhook.js","sourceRoot":"","sources":["../../src/types/webhook.ts"],"names":[],"mappings":""}
@@ -0,0 +1,16 @@
1
+ export interface WebsiteListing {
2
+ orgCode: string | null;
3
+ orgName: string | null;
4
+ websiteName: string | null;
5
+ websiteNameStripped: string | null;
6
+ displayName: string | null;
7
+ guid: string | null;
8
+ websiteID: number;
9
+ isCurrent: boolean;
10
+ managerUrl: string | null;
11
+ version: string | null;
12
+ isOwner: boolean;
13
+ isDormant: boolean;
14
+ isRestoring: boolean;
15
+ teamID: number | null;
16
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=websiteListing.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"websiteListing.js","sourceRoot":"","sources":["../../src/types/websiteListing.ts"],"names":[],"mappings":""}
@@ -0,0 +1,22 @@
1
+ import { InstanceRole } from "./instanceRole";
2
+ export interface WebsiteUser {
3
+ userID: number | null;
4
+ userName: string | null;
5
+ firstName: string | null;
6
+ lastName: string | null;
7
+ emailAddress: string | null;
8
+ isDeleted: boolean;
9
+ fullName: string | null;
10
+ isTeamUser: boolean;
11
+ isSuspended: boolean;
12
+ teamID: number | null;
13
+ userRoles: InstanceRole[];
14
+ userPermissions: InstancePermission[];
15
+ loginDate: string | null;
16
+ isOrgAdmin: boolean;
17
+ }
18
+ export interface InstancePermission {
19
+ permissionType: string | null;
20
+ permissionID: number;
21
+ name: string | null;
22
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=websiteUser.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"websiteUser.js","sourceRoot":"","sources":["../../src/types/websiteUser.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agility/management-sdk",
3
- "version": "0.1.26",
3
+ "version": "0.1.31",
4
4
  "description": "Agility CMS Tyescript SDK for Management API.",
5
5
  "repository": {
6
6
  "type": "git",