@agility/management-sdk 0.1.35 → 0.1.37

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 (261) hide show
  1. package/README.md +371 -317
  2. package/dist/apiMethods/clientInstance.d.ts +2 -0
  3. package/dist/apiMethods/clientInstance.js +11 -2
  4. package/dist/apiMethods/containerMethods.d.ts +3 -0
  5. package/dist/apiMethods/containerMethods.js +43 -9
  6. package/dist/apiMethods/contentMethods.d.ts +12 -0
  7. package/dist/apiMethods/contentMethods.js +119 -48
  8. package/dist/apiMethods/pageMethods.d.ts +12 -0
  9. package/dist/apiMethods/pageMethods.js +88 -34
  10. package/dist/enums/contentViewType.d.ts +6 -0
  11. package/dist/enums/contentViewType.js +10 -0
  12. package/dist/index.d.ts +2 -0
  13. package/dist/index.js +2 -0
  14. package/dist/models/pagedResult.d.ts +4 -0
  15. package/dist/models/pagedResult.js +2 -0
  16. package/dist/util/queryString.d.ts +8 -0
  17. package/dist/util/queryString.js +27 -0
  18. package/docs/asset-methods.md +381 -381
  19. package/docs/auth-component.md +360 -360
  20. package/docs/auth.md +593 -593
  21. package/docs/batch-methods.md +243 -243
  22. package/docs/cicd.md +606 -606
  23. package/docs/container-methods.md +267 -267
  24. package/docs/content-methods.md +491 -422
  25. package/docs/instance-methods.md +104 -104
  26. package/docs/instance-user-methods.md +230 -230
  27. package/docs/model-methods.md +433 -433
  28. package/docs/multi-instance-operations.md +191 -191
  29. package/docs/page-methods.md +737 -670
  30. package/docs/server-user-methods.md +279 -279
  31. package/docs/webhook-methods.md +451 -451
  32. package/license.txt +20 -20
  33. package/package.json +40 -40
  34. package/tsconfig.json +14 -14
  35. package/.cursor/api-coverage.md +0 -217
  36. package/.cursor/api-documentation-manifest.md +0 -275
  37. package/.cursor/api-functions-analysis.md +0 -111
  38. package/.cursor/breakout-manifest.md +0 -278
  39. package/.cursor/docs-final-check.md +0 -269
  40. package/.cursor/github-actions-improvements.md +0 -76
  41. package/.cursor/hardening.md +0 -271
  42. package/.cursor/linting-fix.md +0 -160
  43. package/.cursor/manifest.md +0 -243
  44. package/.cursor/mocks.md +0 -100
  45. package/.cursor/test-coverage.md +0 -841
  46. package/.env +0 -92
  47. package/coverage/base.css +0 -224
  48. package/coverage/block-navigation.js +0 -87
  49. package/coverage/coverage-summary.json +0 -43
  50. package/coverage/favicon.png +0 -0
  51. package/coverage/index.html +0 -161
  52. package/coverage/lcov-report/base.css +0 -224
  53. package/coverage/lcov-report/block-navigation.js +0 -87
  54. package/coverage/lcov-report/favicon.png +0 -0
  55. package/coverage/lcov-report/index.html +0 -161
  56. package/coverage/lcov-report/prettify.css +0 -1
  57. package/coverage/lcov-report/prettify.js +0 -2
  58. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  59. package/coverage/lcov-report/sorter.js +0 -210
  60. package/coverage/lcov-report/src/apiClient.ts.html +0 -199
  61. package/coverage/lcov-report/src/apiMethods/assetMethods.ts.html +0 -682
  62. package/coverage/lcov-report/src/apiMethods/batchMethods.ts.html +0 -736
  63. package/coverage/lcov-report/src/apiMethods/clientInstance.ts.html +0 -403
  64. package/coverage/lcov-report/src/apiMethods/containerMethods.ts.html +0 -460
  65. package/coverage/lcov-report/src/apiMethods/contentMethods.ts.html +0 -1183
  66. package/coverage/lcov-report/src/apiMethods/index.html +0 -266
  67. package/coverage/lcov-report/src/apiMethods/instanceMethods.ts.html +0 -160
  68. package/coverage/lcov-report/src/apiMethods/instanceUserMethods.ts.html +0 -268
  69. package/coverage/lcov-report/src/apiMethods/modelMethods.ts.html +0 -352
  70. package/coverage/lcov-report/src/apiMethods/pageMethods.ts.html +0 -1276
  71. package/coverage/lcov-report/src/apiMethods/serverUserMethods.ts.html +0 -196
  72. package/coverage/lcov-report/src/apiMethods/webhookMethods.ts.html +0 -271
  73. package/coverage/lcov-report/src/enums/batchItemType.ts.html +0 -106
  74. package/coverage/lcov-report/src/enums/batchOperationType.ts.html +0 -142
  75. package/coverage/lcov-report/src/enums/batchState..ts.html +0 -106
  76. package/coverage/lcov-report/src/enums/index.html +0 -161
  77. package/coverage/lcov-report/src/enums/workflowOperationType.ts.html +0 -175
  78. package/coverage/lcov-report/src/index.html +0 -116
  79. package/coverage/lcov-report/src/models/assetContainer.ts.html +0 -106
  80. package/coverage/lcov-report/src/models/assetGalleries.ts.html +0 -103
  81. package/coverage/lcov-report/src/models/assetMediaGrouping.ts.html +0 -136
  82. package/coverage/lcov-report/src/models/assetMediaGroupingMetaData.ts.html +0 -97
  83. package/coverage/lcov-report/src/models/batch.ts.html +0 -178
  84. package/coverage/lcov-report/src/models/batchItem.ts.html +0 -127
  85. package/coverage/lcov-report/src/models/container.ts.html +0 -232
  86. package/coverage/lcov-report/src/models/contentDefinitionTypeID.ts.html +0 -142
  87. package/coverage/lcov-report/src/models/contentItem.ts.html +0 -202
  88. package/coverage/lcov-report/src/models/contentSectionDefaultModule.ts.html +0 -106
  89. package/coverage/lcov-report/src/models/contentSectionDefinition.ts.html +0 -196
  90. package/coverage/lcov-report/src/models/contentViewColumn.ts.html +0 -109
  91. package/coverage/lcov-report/src/models/exception.ts.html +0 -109
  92. package/coverage/lcov-report/src/models/index.html +0 -476
  93. package/coverage/lcov-report/src/models/instanceRole.ts.html +0 -106
  94. package/coverage/lcov-report/src/models/instanceUser.ts.html +0 -130
  95. package/coverage/lcov-report/src/models/locales.ts.html +0 -100
  96. package/coverage/lcov-report/src/models/media.ts.html +0 -178
  97. package/coverage/lcov-report/src/models/model.ts.html +0 -172
  98. package/coverage/lcov-report/src/models/notification.ts.html +0 -124
  99. package/coverage/lcov-report/src/models/options.ts.html +0 -109
  100. package/coverage/lcov-report/src/models/pageItem.ts.html +0 -268
  101. package/coverage/lcov-report/src/models/pageModel.ts.html +0 -130
  102. package/coverage/lcov-report/src/models/sharedModule.ts.html +0 -106
  103. package/coverage/lcov-report/src/models/sitemap.ts.html +0 -148
  104. package/coverage/lcov-report/src/models/websiteUser.ts.html +0 -157
  105. package/coverage/lcov.info +0 -1459
  106. package/coverage/prettify.css +0 -1
  107. package/coverage/prettify.js +0 -2
  108. package/coverage/sort-arrow-sprite.png +0 -0
  109. package/coverage/sorter.js +0 -210
  110. package/coverage/src/apiClient.ts.html +0 -199
  111. package/coverage/src/apiMethods/assetMethods.ts.html +0 -682
  112. package/coverage/src/apiMethods/batchMethods.ts.html +0 -736
  113. package/coverage/src/apiMethods/clientInstance.ts.html +0 -403
  114. package/coverage/src/apiMethods/containerMethods.ts.html +0 -460
  115. package/coverage/src/apiMethods/contentMethods.ts.html +0 -1183
  116. package/coverage/src/apiMethods/index.html +0 -266
  117. package/coverage/src/apiMethods/instanceMethods.ts.html +0 -160
  118. package/coverage/src/apiMethods/instanceUserMethods.ts.html +0 -268
  119. package/coverage/src/apiMethods/modelMethods.ts.html +0 -352
  120. package/coverage/src/apiMethods/pageMethods.ts.html +0 -1276
  121. package/coverage/src/apiMethods/serverUserMethods.ts.html +0 -196
  122. package/coverage/src/apiMethods/webhookMethods.ts.html +0 -271
  123. package/coverage/src/enums/batchItemType.ts.html +0 -106
  124. package/coverage/src/enums/batchOperationType.ts.html +0 -142
  125. package/coverage/src/enums/batchState..ts.html +0 -106
  126. package/coverage/src/enums/index.html +0 -161
  127. package/coverage/src/enums/workflowOperationType.ts.html +0 -175
  128. package/coverage/src/index.html +0 -116
  129. package/coverage/src/models/assetContainer.ts.html +0 -106
  130. package/coverage/src/models/assetGalleries.ts.html +0 -103
  131. package/coverage/src/models/assetMediaGrouping.ts.html +0 -136
  132. package/coverage/src/models/assetMediaGroupingMetaData.ts.html +0 -97
  133. package/coverage/src/models/batch.ts.html +0 -178
  134. package/coverage/src/models/batchItem.ts.html +0 -127
  135. package/coverage/src/models/container.ts.html +0 -232
  136. package/coverage/src/models/contentDefinitionTypeID.ts.html +0 -142
  137. package/coverage/src/models/contentItem.ts.html +0 -202
  138. package/coverage/src/models/contentSectionDefaultModule.ts.html +0 -106
  139. package/coverage/src/models/contentSectionDefinition.ts.html +0 -196
  140. package/coverage/src/models/contentViewColumn.ts.html +0 -109
  141. package/coverage/src/models/exception.ts.html +0 -109
  142. package/coverage/src/models/index.html +0 -476
  143. package/coverage/src/models/instanceRole.ts.html +0 -106
  144. package/coverage/src/models/instanceUser.ts.html +0 -130
  145. package/coverage/src/models/locales.ts.html +0 -100
  146. package/coverage/src/models/media.ts.html +0 -178
  147. package/coverage/src/models/model.ts.html +0 -172
  148. package/coverage/src/models/notification.ts.html +0 -124
  149. package/coverage/src/models/options.ts.html +0 -109
  150. package/coverage/src/models/pageItem.ts.html +0 -268
  151. package/coverage/src/models/pageModel.ts.html +0 -130
  152. package/coverage/src/models/sharedModule.ts.html +0 -106
  153. package/coverage/src/models/sitemap.ts.html +0 -148
  154. package/coverage/src/models/websiteUser.ts.html +0 -157
  155. package/dist/.tsbuildinfo +0 -1
  156. package/dist/apiClient.d.ts.map +0 -1
  157. package/dist/apiClient.js.map +0 -1
  158. package/dist/apiMethods/assetMethods.d.ts.map +0 -1
  159. package/dist/apiMethods/assetMethods.js.map +0 -1
  160. package/dist/apiMethods/batchMethods.d.ts.map +0 -1
  161. package/dist/apiMethods/batchMethods.js.map +0 -1
  162. package/dist/apiMethods/clientInstance.d.ts.map +0 -1
  163. package/dist/apiMethods/clientInstance.js.map +0 -1
  164. package/dist/apiMethods/containerMethods.d.ts.map +0 -1
  165. package/dist/apiMethods/containerMethods.js.map +0 -1
  166. package/dist/apiMethods/contentMethods.d.ts.map +0 -1
  167. package/dist/apiMethods/contentMethods.js.map +0 -1
  168. package/dist/apiMethods/instanceMethods.d.ts.map +0 -1
  169. package/dist/apiMethods/instanceMethods.js.map +0 -1
  170. package/dist/apiMethods/instanceUserMethods.d.ts.map +0 -1
  171. package/dist/apiMethods/instanceUserMethods.js.map +0 -1
  172. package/dist/apiMethods/modelMethods.d.ts.map +0 -1
  173. package/dist/apiMethods/modelMethods.js.map +0 -1
  174. package/dist/apiMethods/pageMethods.d.ts.map +0 -1
  175. package/dist/apiMethods/pageMethods.js.map +0 -1
  176. package/dist/apiMethods/serverUserMethods.d.ts.map +0 -1
  177. package/dist/apiMethods/serverUserMethods.js.map +0 -1
  178. package/dist/apiMethods/webhookMethods.d.ts.map +0 -1
  179. package/dist/apiMethods/webhookMethods.js.map +0 -1
  180. package/dist/enums/assetGroupingType.d.ts.map +0 -1
  181. package/dist/enums/assetGroupingType.js.map +0 -1
  182. package/dist/enums/batchItemType.d.ts.map +0 -1
  183. package/dist/enums/batchItemType.js.map +0 -1
  184. package/dist/enums/batchOperationType.d.ts.map +0 -1
  185. package/dist/enums/batchOperationType.js.map +0 -1
  186. package/dist/enums/batchState..d.ts.map +0 -1
  187. package/dist/enums/batchState..js.map +0 -1
  188. package/dist/enums/pageItemTemplateType.d.ts.map +0 -1
  189. package/dist/enums/pageItemTemplateType.js.map +0 -1
  190. package/dist/enums/workflowOperationType.d.ts.map +0 -1
  191. package/dist/enums/workflowOperationType.js.map +0 -1
  192. package/dist/index.d.ts.map +0 -1
  193. package/dist/index.js.map +0 -1
  194. package/dist/models/assetContainer.d.ts.map +0 -1
  195. package/dist/models/assetContainer.js.map +0 -1
  196. package/dist/models/assetGalleries.d.ts.map +0 -1
  197. package/dist/models/assetGalleries.js.map +0 -1
  198. package/dist/models/assetMediaGrouping.d.ts.map +0 -1
  199. package/dist/models/assetMediaGrouping.js.map +0 -1
  200. package/dist/models/assetMediaGroupingMetaData.d.ts.map +0 -1
  201. package/dist/models/assetMediaGroupingMetaData.js.map +0 -1
  202. package/dist/models/batch.d.ts.map +0 -1
  203. package/dist/models/batch.js.map +0 -1
  204. package/dist/models/batchItem.d.ts.map +0 -1
  205. package/dist/models/batchItem.js.map +0 -1
  206. package/dist/models/batchTypes.d.ts.map +0 -1
  207. package/dist/models/batchTypes.js.map +0 -1
  208. package/dist/models/container.d.ts.map +0 -1
  209. package/dist/models/container.js.map +0 -1
  210. package/dist/models/contentDefinitionTypeID.d.ts.map +0 -1
  211. package/dist/models/contentDefinitionTypeID.js.map +0 -1
  212. package/dist/models/contentItem.d.ts.map +0 -1
  213. package/dist/models/contentItem.js.map +0 -1
  214. package/dist/models/contentItemHistory.d.ts.map +0 -1
  215. package/dist/models/contentItemHistory.js.map +0 -1
  216. package/dist/models/contentListFilterModel.d.ts.map +0 -1
  217. package/dist/models/contentListFilterModel.js.map +0 -1
  218. package/dist/models/contentSectionDefaultModule.d.ts.map +0 -1
  219. package/dist/models/contentSectionDefaultModule.js.map +0 -1
  220. package/dist/models/contentSectionDefinition.d.ts.map +0 -1
  221. package/dist/models/contentSectionDefinition.js.map +0 -1
  222. package/dist/models/contentViewColumn.d.ts.map +0 -1
  223. package/dist/models/contentViewColumn.js.map +0 -1
  224. package/dist/models/exception.d.ts.map +0 -1
  225. package/dist/models/exception.js.map +0 -1
  226. package/dist/models/instanceRole.d.ts.map +0 -1
  227. package/dist/models/instanceRole.js.map +0 -1
  228. package/dist/models/instanceUser.d.ts.map +0 -1
  229. package/dist/models/instanceUser.js.map +0 -1
  230. package/dist/models/itemComments.d.ts.map +0 -1
  231. package/dist/models/itemComments.js.map +0 -1
  232. package/dist/models/listParams.d.ts.map +0 -1
  233. package/dist/models/listParams.js.map +0 -1
  234. package/dist/models/locales.d.ts.map +0 -1
  235. package/dist/models/locales.js.map +0 -1
  236. package/dist/models/media.d.ts.map +0 -1
  237. package/dist/models/media.js.map +0 -1
  238. package/dist/models/model.d.ts.map +0 -1
  239. package/dist/models/model.js.map +0 -1
  240. package/dist/models/notification.d.ts.map +0 -1
  241. package/dist/models/notification.js.map +0 -1
  242. package/dist/models/options.d.ts.map +0 -1
  243. package/dist/models/options.js.map +0 -1
  244. package/dist/models/pageHistory.d.ts.map +0 -1
  245. package/dist/models/pageHistory.js.map +0 -1
  246. package/dist/models/pageItem.d.ts.map +0 -1
  247. package/dist/models/pageItem.js.map +0 -1
  248. package/dist/models/pageModel.d.ts.map +0 -1
  249. package/dist/models/pageModel.js.map +0 -1
  250. package/dist/models/serverUser.d.ts.map +0 -1
  251. package/dist/models/serverUser.js.map +0 -1
  252. package/dist/models/sharedModule.d.ts.map +0 -1
  253. package/dist/models/sharedModule.js.map +0 -1
  254. package/dist/models/sitemap.d.ts.map +0 -1
  255. package/dist/models/sitemap.js.map +0 -1
  256. package/dist/models/webhook.d.ts.map +0 -1
  257. package/dist/models/webhook.js.map +0 -1
  258. package/dist/models/websiteListing.d.ts.map +0 -1
  259. package/dist/models/websiteListing.js.map +0 -1
  260. package/dist/models/websiteUser.d.ts.map +0 -1
  261. package/dist/models/websiteUser.js.map +0 -1
package/license.txt CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) [year] [fullname]
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ MIT License
2
+
3
+ Copyright (c) [year] [fullname]
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
package/package.json CHANGED
@@ -1,41 +1,41 @@
1
- {
2
- "name": "@agility/management-sdk",
3
- "version": "0.1.35",
4
- "description": "Agility CMS Tyescript SDK for Management API.",
5
- "repository": {
6
- "type": "git",
7
- "url": "https://github.com/agility/agility-cms-management-sdk-typescript.git"
8
- },
9
- "bugs": {
10
- "url": "https://github.com/agility/agility-cms-management-sdk-typescript/issues"
11
- },
12
- "homepage": "https://github.com/agility/agility-cms-management-sdk-typescript#readme",
13
- "main": "dist/index.js",
14
- "scripts": {
15
- "clean": "git clean -Xf && rm -rf ./dist",
16
- "build": "tsc",
17
- "prepare": "yarn build",
18
- "test": "echo \"Error: no test specified\" && exit 1"
19
- },
20
- "keywords": [
21
- "typescript",
22
- "agility",
23
- "cms",
24
- "headlesscms",
25
- "management-api"
26
- ],
27
- "author": "Agility CMS",
28
- "contributors": [
29
- "Joel Varty",
30
- "Mohit Vashishtha",
31
- "Kevin Tran",
32
- "Aaron Taylor"
33
- ],
34
- "license": "MIT",
35
- "dependencies": {
36
- "axios": "^0.27.2"
37
- },
38
- "devDependencies": {
39
- "@types/node": "^18.11.9"
40
- }
1
+ {
2
+ "name": "@agility/management-sdk",
3
+ "version": "0.1.37",
4
+ "description": "Agility CMS Tyescript SDK for Management API.",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/agility/agility-cms-management-sdk-typescript.git"
8
+ },
9
+ "bugs": {
10
+ "url": "https://github.com/agility/agility-cms-management-sdk-typescript/issues"
11
+ },
12
+ "homepage": "https://github.com/agility/agility-cms-management-sdk-typescript#readme",
13
+ "main": "dist/index.js",
14
+ "scripts": {
15
+ "clean": "git clean -Xf && rm -rf ./dist",
16
+ "build": "tsc",
17
+ "prepare": "yarn build",
18
+ "test": "echo \"Error: no test specified\" && exit 1"
19
+ },
20
+ "keywords": [
21
+ "typescript",
22
+ "agility",
23
+ "cms",
24
+ "headlesscms",
25
+ "management-api"
26
+ ],
27
+ "author": "Agility CMS",
28
+ "contributors": [
29
+ "Joel Varty",
30
+ "Mohit Vashishtha",
31
+ "Kevin Tran",
32
+ "Aaron Taylor"
33
+ ],
34
+ "license": "MIT",
35
+ "dependencies": {
36
+ "axios": "^0.27.2"
37
+ },
38
+ "devDependencies": {
39
+ "@types/node": "^18.11.9"
40
+ }
41
41
  }
package/tsconfig.json CHANGED
@@ -1,15 +1,15 @@
1
- {
2
- "compilerOptions": {
3
- "module" : "commonjs",
4
- "allowJs": true,
5
- "declaration": true,
6
- "jsx": "react",
7
- "target": "es5",
8
- "outDir": "./dist/",
9
- "lib": ["es2016", "dom"],
10
- "esModuleInterop": true,
11
- "skipLibCheck": true,
12
- "allowSyntheticDefaultImports": true
13
- },
14
- "include": ["src", "src/apiClient.ts"]
1
+ {
2
+ "compilerOptions": {
3
+ "module" : "commonjs",
4
+ "allowJs": true,
5
+ "declaration": true,
6
+ "jsx": "react",
7
+ "target": "es5",
8
+ "outDir": "./dist/",
9
+ "lib": ["es2016", "dom"],
10
+ "esModuleInterop": true,
11
+ "skipLibCheck": true,
12
+ "allowSyntheticDefaultImports": true
13
+ },
14
+ "include": ["src", "src/apiClient.ts"]
15
15
  }
@@ -1,217 +0,0 @@
1
- # API Methods Test Coverage Report
2
-
3
- ## 🎯 **Current Status: 146/146 Tests Passing (100%) 🎉**
4
-
5
- ### 📊 **Coverage Summary**
6
-
7
- | API Method Class | Unit Tests | Integration Tests | Status | Methods Covered |
8
- |------------------|------------|-------------------|--------|-----------------|
9
- | **ModelMethods** | ✅ 16/16 | ✅ Diagnostic | **COMPLETE** | 6/6 methods |
10
- | **AssetMethods** | ✅ 24/24 | ✅ Gallery Tests | **COMPLETE** | 15/15 methods |
11
- | **ContainerMethods** | ✅ 16/16 | ✅ Diagnostic | **COMPLETE** | 8/8 methods |
12
- | **WebhookMethods** | ✅ 14/14 | ❌ None | **UNIT ONLY** | 4/4 methods |
13
- | **BatchMethods** | ✅ 19/19 | ❌ None | **UNIT ONLY** | 7/7 methods |
14
- | **InstanceUserMethods** | ✅ 12/12 | ❌ None | **UNIT ONLY** | 3/3 methods |
15
- | **ServerUserMethods** | ✅ 12/12 | ❌ None | **UNIT ONLY** | 2/2 methods |
16
- | **InstanceMethods** | ❌ None | ✅ Basic Auth | **INTEGRATION ONLY** | 1/1 methods |
17
- | **ContentMethods** | 🔄 Disabled | ✅ Basic Tests | **PARTIAL** | ~15 methods |
18
- | **PageMethods** | 🔄 Disabled | ❌ None | **PARTIAL** | ~20 methods |
19
-
20
- ---
21
-
22
- ## ✅ **FULLY COVERED (3/10 classes)**
23
-
24
- ### 🏆 **ModelMethods** - Content Model Operations
25
- **Unit Tests: 16/16 ✅ | Integration: Diagnostic ✅**
26
- - `getContentModel(id, guid)` - Retrieve model by ID
27
- - `getModelByReferenceName(name, guid)` - Retrieve by reference name
28
- - `getContentModules(includeDefaults, guid, includeModules)` - Get content modules
29
- - `getPageModules(includeDefault, guid)` - Get page modules
30
- - `saveModel(model, guid)` - Create/update model
31
- - `deleteModel(id, guid)` - Delete model
32
-
33
- ### 🏆 **AssetMethods** - Asset & Gallery Management
34
- **Unit Tests: 24/24 ✅ | Integration: Gallery Tests ✅**
35
- - **Gallery Operations:**
36
- - `getGalleries(guid, search?, pageSize?, rowIndex?)` - List galleries
37
- - `getGalleryById(guid, id)` - Get gallery by ID
38
- - `getGalleryByName(guid, name)` - Get gallery by name
39
- - `saveGallery(guid, gallery)` - Create/update gallery
40
- - `deleteGallery(guid, id)` - Delete gallery
41
- - **Asset Operations:**
42
- - `getMediaList(pageSize, recordOffset, guid)` - List assets
43
- - `getAssetByID(mediaID, guid)` - Get asset by ID
44
- - `getAssetByUrl(url, guid)` - Get asset by URL
45
- - `deleteFile(mediaID, guid)` - Delete asset
46
- - `moveFile(mediaID, newFolder, guid)` - Move asset
47
- - **Folder Operations:**
48
- - `createFolder(originKey, guid)` - Create folder
49
- - `renameFolder(folderName, newFolderName, guid, mediaID)` - Rename folder
50
- - `deleteFolder(originKey, guid, mediaID)` - Delete folder
51
- - **File Operations:**
52
- - `upload(formData, agilityFolderPath, guid, groupingID)` - Upload files
53
- - **Container Operations:**
54
- - `getDefaultContainer(guid)` - Get default container
55
-
56
- ### 🏆 **ContainerMethods** - Container Management
57
- **Unit Tests: 16/16 ✅ | Integration: Diagnostic ✅**
58
- - `getContainerList(guid)` - List all containers
59
- - `getContainerByID(id, guid)` - Get container by ID
60
- - `getContainerByReferenceName(name, guid)` - Get by reference name (returns null for 404)
61
- - `getContainersByModel(modelId, guid)` - Get containers by model
62
- - `getContainerSecurity(id, guid)` - Get container security
63
- - `getNotificationList(id, guid)` - Get container notifications
64
- - `saveContainer(container, guid, forceReferenceName?)` - Create/update container
65
- - `deleteContainer(id, guid)` - Delete container
66
-
67
- ### 🏆 **WebhookMethods** - Webhook Operations
68
- **Unit Tests: 14/14 ✅ | Integration: None**
69
- - `webhookList(guid, take?, token?)` - List webhooks
70
- - `getWebhook(guid, webhookID)` - Get webhook by ID
71
- - `saveWebhook(guid, webhook)` - Create/update webhook
72
- - `deleteWebhook(guid, webhookID)` - Delete webhook
73
-
74
- ---
75
-
76
- ## 🔄 **UNIT ONLY COVERED (4/10 classes)**
77
-
78
- ### ⚡ **BatchMethods** - Batch Processing
79
- **Unit Tests: 19/19 ✅ | Integration: None**
80
- - `getBatch(batchID, guid, expandItems?)` - Get batch by ID
81
- - `publishBatch(batchID, guid, returnBatchId?)` - Publish batch
82
- - `unpublishBatch(batchID, guid, returnBatchId?)` - Unpublish batch
83
- - `approveBatch(batchID, guid, returnBatchId?)` - Approve batch
84
- - `declineBatch(batchID, guid, returnBatchId?)` - Decline batch
85
- - `requestApprovalBatch(batchID, guid, returnBatchId?)` - Request approval
86
- - `getBatchTypes(guid)` - Get batch enum types
87
-
88
- ### ⚡ **InstanceUserMethods** - User Management
89
- **Unit Tests: 12/12 ✅ | Integration: None**
90
- - `getUsers(guid)` - Get instance users
91
- - `saveUser(emailAddress, roles, guid, firstName?, lastName?)` - Create/update user
92
- - `deleteUser(userId, guid)` - Delete user
93
-
94
- ### ⚡ **ServerUserMethods** - Server User Operations
95
- **Unit Tests: 12/12 ✅ | Integration: None**
96
- - `me(guid)` - Get current user info
97
- - `you(guid, serverUserID)` - Get specific user info
98
-
99
- ---
100
-
101
- ## 🔄 **PARTIALLY COVERED (2/10 classes)**
102
-
103
- ### ⚠️ **ContentMethods** - Content Item Operations
104
- **Unit Tests: Disabled 🔄 | Integration: Basic ✅**
105
-
106
- **Available Methods (~15 methods):**
107
- - `getContentItem(contentID, guid, locale)` - Get content item
108
- - `getContentItems(referenceName, guid, locale, listParams)` - Get content list
109
- - `getContentList(referenceName, guid, locale, listParams, filter?)` - Get filtered content
110
- - `saveContentItem(contentItem, guid, locale, returnBatchId?)` - Create/update content
111
- - `saveContentItems(contentItems, guid, locale, returnBatchId?)` - Bulk save
112
- - `publishContent(contentID, guid, locale, comments?, returnBatchId?)` - Publish content
113
- - `unPublishContent(contentID, guid, locale, comments?, returnBatchId?)` - Unpublish
114
- - `approveContent(contentID, guid, locale, comments?, returnBatchId?)` - Approve
115
- - `declineContent(contentID, guid, locale, comments?, returnBatchId?)` - Decline
116
- - `contentRequestApproval(contentID, guid, locale, comments?, returnBatchId?)` - Request approval
117
- - `deleteContent(contentID, guid, locale, comments?, returnBatchId?)` - Delete
118
- - `getContentHistory(locale, guid, contentID, take?, skip?)` - Get history
119
- - `getContentComments(locale, guid, contentID, take?, skip?)` - Get comments
120
-
121
- **Issues:** Most methods require `locale` parameter, complex batch operations with async polling
122
-
123
- ### ⚠️ **PageMethods** - Page Operations
124
- **Unit Tests: Disabled 🔄 | Integration: None**
125
-
126
- **Available Methods (~20 methods):**
127
- - **Page Operations:**
128
- - `getPage(pageID, guid, locale)` - Get page by ID
129
- - `savePage(pageItem, guid, locale, parentPageID?, placeBeforePageItemID?, returnBatchId?, pageIDInOtherLocale?, otherLocale?)` - Create/update page
130
- - `deletePage(pageID, guid, locale, comments?, returnBatchId?)` - Delete page
131
- - **Page Workflow:**
132
- - `publishPage(pageID, guid, locale, comments?, returnBatchId?)` - Publish page
133
- - `unPublishPage(pageID, guid, locale, comments?, returnBatchId?)` - Unpublish
134
- - `approvePage(pageID, guid, locale, comments?, returnBatchId?)` - Approve
135
- - `declinePage(pageID, guid, locale, comments?, returnBatchId?)` - Decline
136
- - `pageRequestApproval(pageID, guid, locale, comments?, returnBatchId?)` - Request approval
137
- - **Page Templates:**
138
- - `getPageTemplates(guid, locale, includeModuleZones, searchFilter?)` - List templates
139
- - `getPageTemplate(guid, locale, pageTemplateId)` - Get template by ID
140
- - `getPageTemplateName(guid, locale, templateName)` - Get template by name
141
- - `savePageTemplate(guid, locale, pageModel)` - Create/update template
142
- - `deletePageTemplate(guid, locale, pageTemplateId)` - Delete template
143
- - `getPageItemTemplates(guid, locale, id)` - Get page item templates
144
- - **Other Operations:**
145
- - `getSitemap(guid, locale)` - Get sitemap
146
- - `getPageHistory(locale, guid, pageID, take?, skip?)` - Get page history
147
- - `getPageComments(locale, guid, pageID, take?, skip?)` - Get page comments
148
-
149
- **Issues:** All methods require `locale` parameter, complex batch operations
150
-
151
- ### ⚠️ **BatchMethods** - Batch Processing
152
- **Unit Tests: Disabled 🔄 | Integration: None**
153
-
154
- **Available Methods (~7 methods):**
155
- - `getBatch(batchID, guid, expandItems?)` - Get batch by ID
156
- - `publishBatch(batchID, guid, returnBatchId?)` - Publish batch
157
- - `unpublishBatch(batchID, guid, returnBatchId?)` - Unpublish batch
158
- - `approveBatch(batchID, guid, returnBatchId?)` - Approve batch
159
- - `declineBatch(batchID, guid, returnBatchId?)` - Decline batch
160
- - `requestApprovalBatch(batchID, guid, returnBatchId?)` - Request approval
161
- - `getBatchTypes(guid)` - Get batch enum types
162
-
163
- ---
164
-
165
- ## ❌ **NO COVERAGE (3/10 classes)**
166
-
167
- ### 🔴 **InstanceMethods** - Instance Configuration
168
- **Unit Tests: None | Integration: Basic Auth Only ✅**
169
- - `getLocales(guid)` - Get available locales *(covered in integration)*
170
-
171
- ### 🔴 **InstanceUserMethods** - User Management
172
- **Unit Tests: None | Integration: None**
173
- - `getUsers(guid)` - Get instance users
174
- - `saveUser(emailAddress, roles, guid, firstName?, lastName?)` - Create/update user
175
- - `deleteUser(userId, guid)` - Delete user
176
-
177
- ### 🔴 **ServerUserMethods** - Server User Operations
178
- **Unit Tests: None | Integration: None**
179
- - `me(guid)` - Get current user info
180
- - `you(guid, serverUserID)` - Get specific user info
181
-
182
- ---
183
-
184
- ## 🎯 **RECOMMENDATIONS**
185
-
186
- ### **Priority 1: Complete Existing Coverage**
187
- 1. **Fix ContentMethods Unit Tests** - Add `locale` parameters, fix method signatures
188
- 2. **Fix PageMethods Unit Tests** - Add `locale` parameters, remove non-existent methods
189
- 3. **Fix BatchMethods Unit Tests** - Simple fixes, only a few real methods
190
-
191
- ### **Priority 2: Add Missing Coverage**
192
- 1. **InstanceUserMethods** - User management operations
193
- 2. **ServerUserMethods** - Server user operations
194
- 3. **InstanceMethods** - Add unit tests (currently only integration)
195
-
196
- ### **Priority 3: Enhance Integration Coverage**
197
- 1. **WebhookMethods** - Add integration tests
198
- 2. **ContentMethods** - Expand integration tests
199
- 3. **PageMethods** - Add integration tests
200
- 4. **BatchMethods** - Add integration tests
201
-
202
- ---
203
-
204
- ## 📈 **CURRENT METRICS**
205
-
206
- - **Total API Classes**: 10
207
- - **Fully Covered Classes**: 3 (30%) - Both unit + integration
208
- - **Unit Only Covered Classes**: 4 (40%) - Comprehensive unit coverage
209
- - **Partially Covered Classes**: 2 (20%) - ContentMethods, PageMethods
210
- - **Integration Only Classes**: 1 (10%) - InstanceMethods
211
- - **Total Unit Tests**: 113 (100% passing) ⬆️ +43 tests!
212
- - **Total Integration Tests**: 33 (100% passing)
213
- - **Overall Test Success Rate**: 146/146 (100%) 🎉 ⬆️ +43 tests!
214
-
215
- **🚀 Major Achievement**: Added 43 new unit tests covering BatchMethods, InstanceUserMethods, and ServerUserMethods!
216
-
217
- **Next Goal**: Fix ContentMethods and PageMethods disabled unit test suites to reach 9/10 classes with unit coverage!
@@ -1,275 +0,0 @@
1
- # API Methods Documentation Manifest - Modular Structure
2
-
3
- ## Overview
4
- Comprehensive documentation restructure for all API method classes in `/src/apiMethods/` folder. This manifest organizes the work into a modular documentation system with separate files for each method class, improving navigation and maintainability.
5
-
6
- ## New Documentation Structure
7
-
8
- ### Main README.md
9
- - **Concise Overview** - Introduction, getting started, authentication
10
- - **Method Class Index** - Links to individual documentation files
11
- - **Quick Reference** - Brief description of each method class
12
- - **Global Examples** - Cross-method workflow examples
13
-
14
- ### Individual Method Documentation (`./docs/`)
15
- Each method class gets its own documentation file following this structure:
16
-
17
- ```
18
- ./docs/
19
- ├── asset-methods.md # AssetMethods - File and media management
20
- ├── batch-methods.md # BatchMethods - Batch workflow operations
21
- ├── container-methods.md # ContainerMethods - Container management
22
- ├── content-methods.md # ContentMethods - Content item operations
23
- ├── instance-methods.md # InstanceMethods - Instance-level operations
24
- ├── instance-user-methods.md # InstanceUserMethods - Instance user management
25
- ├── model-methods.md # ModelMethods - Content model operations
26
- ├── page-methods.md # PageMethods - Page management operations
27
- ├── server-user-methods.md # ServerUserMethods - Server user operations
28
- └── webhook-methods.md # WebhookMethods - Webhook management
29
- ```
30
-
31
- ### Individual File Structure Template
32
- ```markdown
33
- # Agility CMS & Management API TypeScript SDK
34
-
35
- ## [Method Class Name] Methods
36
-
37
- [Description of the method class and its purpose]
38
-
39
- **Important Notes:**
40
- - Key information about the class
41
- - Usage patterns and best practices
42
-
43
- ### Function List
44
- - [functionName1](#functionname1) - Brief description
45
- - [functionName2](#functionname2) - Brief description
46
-
47
- ### [Function Documentation]
48
- [All function details with examples]
49
-
50
- ---
51
-
52
- ## Navigation
53
- - [← Back to Main Documentation](../README.md)
54
- - [AssetMethods](./asset-methods.md)
55
- - [BatchMethods](./batch-methods.md)
56
- - [ContainerMethods](./container-methods.md)
57
- - [ContentMethods](./content-methods.md)
58
- - [InstanceMethods](./instance-methods.md)
59
- - [InstanceUserMethods](./instance-user-methods.md)
60
- - [ModelMethods](./model-methods.md)
61
- - [PageMethods](./page-methods.md)
62
- - [ServerUserMethods](./server-user-methods.md)
63
- - [WebhookMethods](./webhook-methods.md)
64
- ```
65
-
66
- ## Method Classes Overview
67
- 1. **AssetMethods** (15 functions) - File and media management operations
68
- 2. **BatchMethods** (7 functions) - Batch workflow operations
69
- 3. **ContainerMethods** (8 functions) - Container management operations
70
- 4. **ContentMethods** (13 functions) - Content item operations
71
- 5. **InstanceMethods** (1 function) - Instance-level operations
72
- 6. **InstanceUserMethods** (3 functions) - Instance user management
73
- 7. **ModelMethods** (6 functions) - Content model operations
74
- 8. **PageMethods** (17 functions) - Page management operations
75
- 9. **ServerUserMethods** (2 functions) - Server user operations
76
- 10. **WebhookMethods** (4 functions) - Webhook management operations
77
-
78
- ## Benefits of Modular Structure
79
- - ✅ **Better Navigation** - Easy to find specific method documentation
80
- - ✅ **Improved Maintainability** - Individual files are easier to update
81
- - ✅ **Faster Loading** - Users only load documentation they need
82
- - ✅ **Better GitHub Experience** - Each file has reasonable size for web viewing
83
- - ✅ **Searchability** - Easier to search within specific method documentation
84
- - ✅ **Professional Structure** - Follows modern API documentation patterns
85
-
86
- ## Implementation Phases
87
-
88
- ### Phase 1: Modular Structure Setup
89
- - [x] ✅ Create `./docs/` directory structure
90
- - [x] ✅ Design individual file templates with navigation
91
- - [x] ✅ Restructure main README to be concise with method index
92
- - [ ] Set up cross-linking between documentation files
93
-
94
- ### Phase 2: AssetMethods Documentation (`./docs/asset-methods.md`)
95
- - [x] ✅ Create asset-methods.md file with 15 functions
96
- - [x] ✅ Move existing AssetMethods documentation to new file
97
- - [x] ✅ Add function list table of contents
98
- - [x] ✅ Add navigation footer
99
- - Functions: deleteFile, moveFile, getMediaList, getGalleries, getGalleryById, getGalleryByName, getDefaultContainer, saveGallery, deleteGallery, getAssetByID, getAssetByUrl, upload, createFolder, deleteFolder, renameFolder
100
-
101
- ### Phase 3: BatchMethods Documentation (`./docs/batch-methods.md`)
102
- - [ ] Create batch-methods.md file with 7 functions
103
- - [ ] Move existing BatchMethods documentation to new file
104
- - [ ] Add function list table of contents
105
- - [ ] Add navigation footer
106
- - Functions: getBatch, publishBatch, unpublishBatch, approveBatch, declineBatch, requestApprovalBatch, getBatchTypes
107
-
108
- ### Phase 4: ContainerMethods Documentation (`./docs/container-methods.md`)
109
- - [ ] Create container-methods.md file with 8 functions
110
- - [ ] Move existing ContainerMethods documentation to new file
111
- - [ ] Add function list table of contents
112
- - [ ] Add navigation footer
113
- - Functions: getContainerByID, getContainersByModel, getContainerByReferenceName, getContainerSecurity, getContainerList, getNotificationList, saveContainer, deleteContainer
114
-
115
- ### Phase 5: ContentMethods Documentation (`./docs/content-methods.md`)
116
- - [ ] Create content-methods.md file with 13 functions
117
- - [ ] Document all functions with returnBatchId flag support
118
- - [ ] Add function list table of contents
119
- - [ ] Add navigation footer
120
- - Functions: getContentItem, publishContent, unPublishContent, contentRequestApproval, approveContent, declineContent, deleteContent, saveContentItem, saveContentItems, getContentItems, getContentList, getContentHistory, getContentComments
121
-
122
- ### Phase 6: InstanceMethods Documentation (`./docs/instance-methods.md`)
123
- - [ ] Create instance-methods.md file with 1 function
124
- - [ ] Document getLocales function
125
- - [ ] Add function list table of contents
126
- - [ ] Add navigation footer
127
- - Functions: getLocales
128
-
129
- ### Phase 7: InstanceUserMethods Documentation (`./docs/instance-user-methods.md`)
130
- - [ ] Create instance-user-methods.md file with 3 functions
131
- - [ ] Document all user management functions
132
- - [ ] Add function list table of contents
133
- - [ ] Add navigation footer
134
- - Functions: getUsers, saveUser, deleteUser
135
-
136
- ### Phase 8: ModelMethods Documentation (`./docs/model-methods.md`)
137
- - [ ] Create model-methods.md file with 6 functions
138
- - [ ] Document all content model functions
139
- - [ ] Add function list table of contents
140
- - [ ] Add navigation footer
141
- - Functions: getContentModel, getModelByReferenceName, getContentModules, getPageModules, saveModel, deleteModel
142
-
143
- ### Phase 9: PageMethods Documentation (`./docs/page-methods.md`)
144
- - [ ] Create page-methods.md file with 17 functions
145
- - [ ] Document all functions with returnBatchId flag support
146
- - [ ] Add function list table of contents
147
- - [ ] Add navigation footer
148
- - Functions: getSitemap, getPageTemplates, getPageTemplate, getPageTemplateName, deletePageTemplate, getPageItemTemplates, savePageTemplate, getPage, publishPage, unPublishPage, pageRequestApproval, approvePage, declinePage, deletePage, savePage, getPageHistory, getPageComments
149
-
150
- ### Phase 10: ServerUserMethods Documentation (`./docs/server-user-methods.md`)
151
- - [ ] Create server-user-methods.md file with 2 functions
152
- - [ ] Document server user functions
153
- - [ ] Add function list table of contents
154
- - [ ] Add navigation footer
155
- - Functions: me, you
156
-
157
- ### Phase 11: WebhookMethods Documentation (`./docs/webhook-methods.md`)
158
- - [ ] Create webhook-methods.md file with 4 functions
159
- - [ ] Document all webhook functions
160
- - [ ] Add function list table of contents
161
- - [ ] Add navigation footer
162
- - Functions: webhookList, saveWebhook, getWebhook, deleteWebhook
163
-
164
- ### Phase 12: Final Review & Polish
165
- - [ ] Review cross-linking between all documentation files
166
- - [ ] Ensure consistent formatting across all method files
167
- - [ ] Validate all navigation links work correctly
168
- - [ ] Test all code examples
169
- - [ ] Final proofreading across all documentation files
170
- - [ ] Update main README with final method index
171
-
172
- ## Documentation Template Standards
173
-
174
- ### Main README Template
175
- ```markdown
176
- # Agility CMS & Management API TypeScript SDK
177
-
178
- ## Table of Contents
179
- - [Getting Started](#getting-started)
180
- - [API Method Classes](#api-method-classes)
181
- - [Examples](#examples)
182
-
183
- ## Getting Started
184
- [Authentication and setup information]
185
-
186
- ## API Method Classes
187
- - [AssetMethods](./docs/asset-methods.md) - File and media management (15 functions)
188
- - [BatchMethods](./docs/batch-methods.md) - Batch workflow operations (7 functions)
189
- - [ContainerMethods](./docs/container-methods.md) - Container management (8 functions)
190
- - [ContentMethods](./docs/content-methods.md) - Content item operations (13 functions)
191
- - [InstanceMethods](./docs/instance-methods.md) - Instance-level operations (1 function)
192
- - [InstanceUserMethods](./docs/instance-user-methods.md) - Instance user management (3 functions)
193
- - [ModelMethods](./docs/model-methods.md) - Content model operations (6 functions)
194
- - [PageMethods](./docs/page-methods.md) - Page management operations (17 functions)
195
- - [ServerUserMethods](./docs/server-user-methods.md) - Server user operations (2 functions)
196
- - [WebhookMethods](./docs/webhook-methods.md) - Webhook management (4 functions)
197
-
198
- ## Examples
199
- [Cross-method workflow examples]
200
- ```
201
-
202
- ### Individual Method File Template
203
- ```markdown
204
- # Agility CMS & Management API TypeScript SDK
205
-
206
- ## [MethodName] Methods
207
-
208
- Brief description of the method class purpose and scope.
209
-
210
- **Important Notes:**
211
- - Key information about the class
212
- - Usage patterns and best practices
213
-
214
- ### Function List
215
- - [functionName1](#functionname1) - Brief description
216
- - [functionName2](#functionname2) - Brief description
217
-
218
- ### [functionName]
219
- Brief description of what this function does.
220
-
221
- | Parameter | Type | Required | Description |
222
- |-----------|------|----------|-------------|
223
- | `param1` | `type` | Yes | Description |
224
- | `param2` | `type` | No | Description *(Optional)* |
225
-
226
- **Returns:** `ReturnType` - Description of what is returned
227
-
228
- **Usage Example:**
229
- ```typescript
230
- // Example usage
231
- const result = await apiClient.methodName.functionName(param1, param2);
232
- ```
233
-
234
- **Error Handling:**
235
- - Throws `Exception` when [condition]
236
-
237
- ---
238
-
239
- ## Navigation
240
- - [← Back to Main Documentation](../README.md)
241
- - [AssetMethods](./asset-methods.md)
242
- - [BatchMethods](./batch-methods.md)
243
- - [ContainerMethods](./container-methods.md)
244
- - [ContentMethods](./content-methods.md)
245
- - [InstanceMethods](./instance-methods.md)
246
- - [InstanceUserMethods](./instance-user-methods.md)
247
- - [ModelMethods](./model-methods.md)
248
- - [PageMethods](./page-methods.md)
249
- - [ServerUserMethods](./server-user-methods.md)
250
- - [WebhookMethods](./webhook-methods.md)
251
- ```
252
-
253
- ### Key Features to Highlight
254
- - **Modular Structure:** Easy navigation between method documentation
255
- - **Batch Methods:** Emphasize returnBatchId flags for advanced users
256
- - **Optional Parameters:** Clear indication of default values
257
- - **Return Types:** Precise type information
258
- - **Error Scenarios:** Common error conditions and handling
259
- - **Navigation:** Consistent cross-linking between all documentation files
260
-
261
- ## Progress Tracking
262
- - **Total Functions:** 76 functions across 10 method classes
263
- - **Total Documentation Files:** 10 individual method documentation files + 1 main README
264
- - **Completed:** 2 files (Main README restructure + AssetMethods complete)
265
- - **Remaining:** 9 files (9 method docs remaining)
266
- - **Current Phase:** Phase 3 (BatchMethods Documentation)
267
-
268
- ## Success Criteria
269
- - [ ] All 76 functions documented across 10 individual method files
270
- - [ ] Consistent formatting and navigation across all documentation files
271
- - [ ] Main README with clean method index and links to all documentation
272
- - [ ] Cross-linking navigation between all documentation files
273
- - [ ] All code examples tested and functional
274
- - [ ] Improved readability and developer experience with modular structure
275
- - [ ] Professional documentation structure following modern API documentation patterns