@agility/management-sdk 0.1.36 → 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 (259) 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 +100 -46
  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/docs/asset-methods.md +381 -381
  17. package/docs/auth-component.md +360 -360
  18. package/docs/auth.md +593 -593
  19. package/docs/batch-methods.md +243 -243
  20. package/docs/cicd.md +606 -606
  21. package/docs/container-methods.md +267 -267
  22. package/docs/content-methods.md +491 -422
  23. package/docs/instance-methods.md +104 -104
  24. package/docs/instance-user-methods.md +230 -230
  25. package/docs/model-methods.md +433 -433
  26. package/docs/multi-instance-operations.md +191 -191
  27. package/docs/page-methods.md +737 -670
  28. package/docs/server-user-methods.md +279 -279
  29. package/docs/webhook-methods.md +451 -451
  30. package/license.txt +20 -20
  31. package/package.json +40 -40
  32. package/tsconfig.json +14 -14
  33. package/.cursor/api-coverage.md +0 -217
  34. package/.cursor/api-documentation-manifest.md +0 -275
  35. package/.cursor/api-functions-analysis.md +0 -111
  36. package/.cursor/breakout-manifest.md +0 -278
  37. package/.cursor/docs-final-check.md +0 -269
  38. package/.cursor/github-actions-improvements.md +0 -76
  39. package/.cursor/hardening.md +0 -271
  40. package/.cursor/linting-fix.md +0 -160
  41. package/.cursor/manifest.md +0 -243
  42. package/.cursor/mocks.md +0 -100
  43. package/.cursor/test-coverage.md +0 -841
  44. package/.env +0 -92
  45. package/coverage/base.css +0 -224
  46. package/coverage/block-navigation.js +0 -87
  47. package/coverage/coverage-summary.json +0 -43
  48. package/coverage/favicon.png +0 -0
  49. package/coverage/index.html +0 -161
  50. package/coverage/lcov-report/base.css +0 -224
  51. package/coverage/lcov-report/block-navigation.js +0 -87
  52. package/coverage/lcov-report/favicon.png +0 -0
  53. package/coverage/lcov-report/index.html +0 -161
  54. package/coverage/lcov-report/prettify.css +0 -1
  55. package/coverage/lcov-report/prettify.js +0 -2
  56. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  57. package/coverage/lcov-report/sorter.js +0 -210
  58. package/coverage/lcov-report/src/apiClient.ts.html +0 -199
  59. package/coverage/lcov-report/src/apiMethods/assetMethods.ts.html +0 -682
  60. package/coverage/lcov-report/src/apiMethods/batchMethods.ts.html +0 -736
  61. package/coverage/lcov-report/src/apiMethods/clientInstance.ts.html +0 -403
  62. package/coverage/lcov-report/src/apiMethods/containerMethods.ts.html +0 -460
  63. package/coverage/lcov-report/src/apiMethods/contentMethods.ts.html +0 -1183
  64. package/coverage/lcov-report/src/apiMethods/index.html +0 -266
  65. package/coverage/lcov-report/src/apiMethods/instanceMethods.ts.html +0 -160
  66. package/coverage/lcov-report/src/apiMethods/instanceUserMethods.ts.html +0 -268
  67. package/coverage/lcov-report/src/apiMethods/modelMethods.ts.html +0 -352
  68. package/coverage/lcov-report/src/apiMethods/pageMethods.ts.html +0 -1276
  69. package/coverage/lcov-report/src/apiMethods/serverUserMethods.ts.html +0 -196
  70. package/coverage/lcov-report/src/apiMethods/webhookMethods.ts.html +0 -271
  71. package/coverage/lcov-report/src/enums/batchItemType.ts.html +0 -106
  72. package/coverage/lcov-report/src/enums/batchOperationType.ts.html +0 -142
  73. package/coverage/lcov-report/src/enums/batchState..ts.html +0 -106
  74. package/coverage/lcov-report/src/enums/index.html +0 -161
  75. package/coverage/lcov-report/src/enums/workflowOperationType.ts.html +0 -175
  76. package/coverage/lcov-report/src/index.html +0 -116
  77. package/coverage/lcov-report/src/models/assetContainer.ts.html +0 -106
  78. package/coverage/lcov-report/src/models/assetGalleries.ts.html +0 -103
  79. package/coverage/lcov-report/src/models/assetMediaGrouping.ts.html +0 -136
  80. package/coverage/lcov-report/src/models/assetMediaGroupingMetaData.ts.html +0 -97
  81. package/coverage/lcov-report/src/models/batch.ts.html +0 -178
  82. package/coverage/lcov-report/src/models/batchItem.ts.html +0 -127
  83. package/coverage/lcov-report/src/models/container.ts.html +0 -232
  84. package/coverage/lcov-report/src/models/contentDefinitionTypeID.ts.html +0 -142
  85. package/coverage/lcov-report/src/models/contentItem.ts.html +0 -202
  86. package/coverage/lcov-report/src/models/contentSectionDefaultModule.ts.html +0 -106
  87. package/coverage/lcov-report/src/models/contentSectionDefinition.ts.html +0 -196
  88. package/coverage/lcov-report/src/models/contentViewColumn.ts.html +0 -109
  89. package/coverage/lcov-report/src/models/exception.ts.html +0 -109
  90. package/coverage/lcov-report/src/models/index.html +0 -476
  91. package/coverage/lcov-report/src/models/instanceRole.ts.html +0 -106
  92. package/coverage/lcov-report/src/models/instanceUser.ts.html +0 -130
  93. package/coverage/lcov-report/src/models/locales.ts.html +0 -100
  94. package/coverage/lcov-report/src/models/media.ts.html +0 -178
  95. package/coverage/lcov-report/src/models/model.ts.html +0 -172
  96. package/coverage/lcov-report/src/models/notification.ts.html +0 -124
  97. package/coverage/lcov-report/src/models/options.ts.html +0 -109
  98. package/coverage/lcov-report/src/models/pageItem.ts.html +0 -268
  99. package/coverage/lcov-report/src/models/pageModel.ts.html +0 -130
  100. package/coverage/lcov-report/src/models/sharedModule.ts.html +0 -106
  101. package/coverage/lcov-report/src/models/sitemap.ts.html +0 -148
  102. package/coverage/lcov-report/src/models/websiteUser.ts.html +0 -157
  103. package/coverage/lcov.info +0 -1459
  104. package/coverage/prettify.css +0 -1
  105. package/coverage/prettify.js +0 -2
  106. package/coverage/sort-arrow-sprite.png +0 -0
  107. package/coverage/sorter.js +0 -210
  108. package/coverage/src/apiClient.ts.html +0 -199
  109. package/coverage/src/apiMethods/assetMethods.ts.html +0 -682
  110. package/coverage/src/apiMethods/batchMethods.ts.html +0 -736
  111. package/coverage/src/apiMethods/clientInstance.ts.html +0 -403
  112. package/coverage/src/apiMethods/containerMethods.ts.html +0 -460
  113. package/coverage/src/apiMethods/contentMethods.ts.html +0 -1183
  114. package/coverage/src/apiMethods/index.html +0 -266
  115. package/coverage/src/apiMethods/instanceMethods.ts.html +0 -160
  116. package/coverage/src/apiMethods/instanceUserMethods.ts.html +0 -268
  117. package/coverage/src/apiMethods/modelMethods.ts.html +0 -352
  118. package/coverage/src/apiMethods/pageMethods.ts.html +0 -1276
  119. package/coverage/src/apiMethods/serverUserMethods.ts.html +0 -196
  120. package/coverage/src/apiMethods/webhookMethods.ts.html +0 -271
  121. package/coverage/src/enums/batchItemType.ts.html +0 -106
  122. package/coverage/src/enums/batchOperationType.ts.html +0 -142
  123. package/coverage/src/enums/batchState..ts.html +0 -106
  124. package/coverage/src/enums/index.html +0 -161
  125. package/coverage/src/enums/workflowOperationType.ts.html +0 -175
  126. package/coverage/src/index.html +0 -116
  127. package/coverage/src/models/assetContainer.ts.html +0 -106
  128. package/coverage/src/models/assetGalleries.ts.html +0 -103
  129. package/coverage/src/models/assetMediaGrouping.ts.html +0 -136
  130. package/coverage/src/models/assetMediaGroupingMetaData.ts.html +0 -97
  131. package/coverage/src/models/batch.ts.html +0 -178
  132. package/coverage/src/models/batchItem.ts.html +0 -127
  133. package/coverage/src/models/container.ts.html +0 -232
  134. package/coverage/src/models/contentDefinitionTypeID.ts.html +0 -142
  135. package/coverage/src/models/contentItem.ts.html +0 -202
  136. package/coverage/src/models/contentSectionDefaultModule.ts.html +0 -106
  137. package/coverage/src/models/contentSectionDefinition.ts.html +0 -196
  138. package/coverage/src/models/contentViewColumn.ts.html +0 -109
  139. package/coverage/src/models/exception.ts.html +0 -109
  140. package/coverage/src/models/index.html +0 -476
  141. package/coverage/src/models/instanceRole.ts.html +0 -106
  142. package/coverage/src/models/instanceUser.ts.html +0 -130
  143. package/coverage/src/models/locales.ts.html +0 -100
  144. package/coverage/src/models/media.ts.html +0 -178
  145. package/coverage/src/models/model.ts.html +0 -172
  146. package/coverage/src/models/notification.ts.html +0 -124
  147. package/coverage/src/models/options.ts.html +0 -109
  148. package/coverage/src/models/pageItem.ts.html +0 -268
  149. package/coverage/src/models/pageModel.ts.html +0 -130
  150. package/coverage/src/models/sharedModule.ts.html +0 -106
  151. package/coverage/src/models/sitemap.ts.html +0 -148
  152. package/coverage/src/models/websiteUser.ts.html +0 -157
  153. package/dist/.tsbuildinfo +0 -1
  154. package/dist/apiClient.d.ts.map +0 -1
  155. package/dist/apiClient.js.map +0 -1
  156. package/dist/apiMethods/assetMethods.d.ts.map +0 -1
  157. package/dist/apiMethods/assetMethods.js.map +0 -1
  158. package/dist/apiMethods/batchMethods.d.ts.map +0 -1
  159. package/dist/apiMethods/batchMethods.js.map +0 -1
  160. package/dist/apiMethods/clientInstance.d.ts.map +0 -1
  161. package/dist/apiMethods/clientInstance.js.map +0 -1
  162. package/dist/apiMethods/containerMethods.d.ts.map +0 -1
  163. package/dist/apiMethods/containerMethods.js.map +0 -1
  164. package/dist/apiMethods/contentMethods.d.ts.map +0 -1
  165. package/dist/apiMethods/contentMethods.js.map +0 -1
  166. package/dist/apiMethods/instanceMethods.d.ts.map +0 -1
  167. package/dist/apiMethods/instanceMethods.js.map +0 -1
  168. package/dist/apiMethods/instanceUserMethods.d.ts.map +0 -1
  169. package/dist/apiMethods/instanceUserMethods.js.map +0 -1
  170. package/dist/apiMethods/modelMethods.d.ts.map +0 -1
  171. package/dist/apiMethods/modelMethods.js.map +0 -1
  172. package/dist/apiMethods/pageMethods.d.ts.map +0 -1
  173. package/dist/apiMethods/pageMethods.js.map +0 -1
  174. package/dist/apiMethods/serverUserMethods.d.ts.map +0 -1
  175. package/dist/apiMethods/serverUserMethods.js.map +0 -1
  176. package/dist/apiMethods/webhookMethods.d.ts.map +0 -1
  177. package/dist/apiMethods/webhookMethods.js.map +0 -1
  178. package/dist/enums/assetGroupingType.d.ts.map +0 -1
  179. package/dist/enums/assetGroupingType.js.map +0 -1
  180. package/dist/enums/batchItemType.d.ts.map +0 -1
  181. package/dist/enums/batchItemType.js.map +0 -1
  182. package/dist/enums/batchOperationType.d.ts.map +0 -1
  183. package/dist/enums/batchOperationType.js.map +0 -1
  184. package/dist/enums/batchState..d.ts.map +0 -1
  185. package/dist/enums/batchState..js.map +0 -1
  186. package/dist/enums/pageItemTemplateType.d.ts.map +0 -1
  187. package/dist/enums/pageItemTemplateType.js.map +0 -1
  188. package/dist/enums/workflowOperationType.d.ts.map +0 -1
  189. package/dist/enums/workflowOperationType.js.map +0 -1
  190. package/dist/index.d.ts.map +0 -1
  191. package/dist/index.js.map +0 -1
  192. package/dist/models/assetContainer.d.ts.map +0 -1
  193. package/dist/models/assetContainer.js.map +0 -1
  194. package/dist/models/assetGalleries.d.ts.map +0 -1
  195. package/dist/models/assetGalleries.js.map +0 -1
  196. package/dist/models/assetMediaGrouping.d.ts.map +0 -1
  197. package/dist/models/assetMediaGrouping.js.map +0 -1
  198. package/dist/models/assetMediaGroupingMetaData.d.ts.map +0 -1
  199. package/dist/models/assetMediaGroupingMetaData.js.map +0 -1
  200. package/dist/models/batch.d.ts.map +0 -1
  201. package/dist/models/batch.js.map +0 -1
  202. package/dist/models/batchItem.d.ts.map +0 -1
  203. package/dist/models/batchItem.js.map +0 -1
  204. package/dist/models/batchTypes.d.ts.map +0 -1
  205. package/dist/models/batchTypes.js.map +0 -1
  206. package/dist/models/container.d.ts.map +0 -1
  207. package/dist/models/container.js.map +0 -1
  208. package/dist/models/contentDefinitionTypeID.d.ts.map +0 -1
  209. package/dist/models/contentDefinitionTypeID.js.map +0 -1
  210. package/dist/models/contentItem.d.ts.map +0 -1
  211. package/dist/models/contentItem.js.map +0 -1
  212. package/dist/models/contentItemHistory.d.ts.map +0 -1
  213. package/dist/models/contentItemHistory.js.map +0 -1
  214. package/dist/models/contentListFilterModel.d.ts.map +0 -1
  215. package/dist/models/contentListFilterModel.js.map +0 -1
  216. package/dist/models/contentSectionDefaultModule.d.ts.map +0 -1
  217. package/dist/models/contentSectionDefaultModule.js.map +0 -1
  218. package/dist/models/contentSectionDefinition.d.ts.map +0 -1
  219. package/dist/models/contentSectionDefinition.js.map +0 -1
  220. package/dist/models/contentViewColumn.d.ts.map +0 -1
  221. package/dist/models/contentViewColumn.js.map +0 -1
  222. package/dist/models/exception.d.ts.map +0 -1
  223. package/dist/models/exception.js.map +0 -1
  224. package/dist/models/instanceRole.d.ts.map +0 -1
  225. package/dist/models/instanceRole.js.map +0 -1
  226. package/dist/models/instanceUser.d.ts.map +0 -1
  227. package/dist/models/instanceUser.js.map +0 -1
  228. package/dist/models/itemComments.d.ts.map +0 -1
  229. package/dist/models/itemComments.js.map +0 -1
  230. package/dist/models/listParams.d.ts.map +0 -1
  231. package/dist/models/listParams.js.map +0 -1
  232. package/dist/models/locales.d.ts.map +0 -1
  233. package/dist/models/locales.js.map +0 -1
  234. package/dist/models/media.d.ts.map +0 -1
  235. package/dist/models/media.js.map +0 -1
  236. package/dist/models/model.d.ts.map +0 -1
  237. package/dist/models/model.js.map +0 -1
  238. package/dist/models/notification.d.ts.map +0 -1
  239. package/dist/models/notification.js.map +0 -1
  240. package/dist/models/options.d.ts.map +0 -1
  241. package/dist/models/options.js.map +0 -1
  242. package/dist/models/pageHistory.d.ts.map +0 -1
  243. package/dist/models/pageHistory.js.map +0 -1
  244. package/dist/models/pageItem.d.ts.map +0 -1
  245. package/dist/models/pageItem.js.map +0 -1
  246. package/dist/models/pageModel.d.ts.map +0 -1
  247. package/dist/models/pageModel.js.map +0 -1
  248. package/dist/models/serverUser.d.ts.map +0 -1
  249. package/dist/models/serverUser.js.map +0 -1
  250. package/dist/models/sharedModule.d.ts.map +0 -1
  251. package/dist/models/sharedModule.js.map +0 -1
  252. package/dist/models/sitemap.d.ts.map +0 -1
  253. package/dist/models/sitemap.js.map +0 -1
  254. package/dist/models/webhook.d.ts.map +0 -1
  255. package/dist/models/webhook.js.map +0 -1
  256. package/dist/models/websiteListing.d.ts.map +0 -1
  257. package/dist/models/websiteListing.js.map +0 -1
  258. package/dist/models/websiteUser.d.ts.map +0 -1
  259. package/dist/models/websiteUser.js.map +0 -1
@@ -1,423 +1,492 @@
1
- # ContentMethods API Documentation
2
-
3
- The `ContentMethods` class provides comprehensive functionality for managing content items, including creation, publication, approval workflows, and retrieval operations.
4
-
5
- ## Function List
6
-
7
- | Function | Description |
8
- |----------|-------------|
9
- | [getContentItem](#getcontentitem) | Retrieves a specific content item by ID |
10
- | [publishContent](#publishcontent) | Publishes a content item |
11
- | [unPublishContent](#unpublishcontent) | Unpublishes a content item |
12
- | [contentRequestApproval](#contentrequestapproval) | Requests approval for a content item |
13
- | [approveContent](#approvecontent) | Approves a content item |
14
- | [declineContent](#declinecontent) | Declines a content item |
15
- | [deleteContent](#deletecontent) | Deletes a content item |
16
- | [saveContentItem](#savecontentitem) | Saves a single content item |
17
- | [saveContentItems](#savecontentitems) | Saves multiple content items |
18
- | [getContentItems](#getcontentitems) | Retrieves content items with filtering (deprecated) |
19
- | [getContentList](#getcontentlist) | Retrieves content list with advanced filtering |
20
- | [getContentHistory](#getcontenthistory) | Retrieves content item history |
21
- | [getContentComments](#getcontentcomments) | Retrieves content item comments |
22
-
23
- ---
24
-
25
- ## getContentItem
26
-
27
- Retrieves a specific content item by ID and locale.
28
-
29
- ### Parameters
30
-
31
- | Parameter | Type | Required | Description |
32
- |-----------|------|----------|-------------|
33
- | contentID | number | Yes | The ID of the content item to retrieve |
34
- | guid | string | Yes | The website GUID |
35
- | locale | string | Yes | The locale code (e.g., 'en-us') |
36
-
37
- ### Returns
38
-
39
- `Promise<ContentItem>` - The content item object
40
-
41
- ### Usage Example
42
-
43
- ```typescript
44
- const contentItem = await client.contentMethods.getContentItem(123, 'your-guid', 'en-us');
45
- console.log(contentItem.fields.title);
46
- ```
47
-
48
- ---
49
-
50
- ## publishContent
51
-
52
- Publishes a content item through the batch workflow system.
53
-
54
- ### Parameters
55
-
56
- | Parameter | Type | Required | Description |
57
- |-----------|------|----------|-------------|
58
- | contentID | number | Yes | The ID of the content item to publish |
59
- | guid | string | Yes | The website GUID |
60
- | locale | string | Yes | The locale code |
61
- | comments | string | No | Optional comments for the publish operation |
62
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
63
-
64
- ### Returns
65
-
66
- `Promise<number[]>` - Array of content IDs that were published
67
-
68
- ### Usage Example
69
-
70
- ```typescript
71
- // Wait for completion (default)
72
- const publishedIds = await client.contentMethods.publishContent(123, 'your-guid', 'en-us', 'Publishing update');
73
-
74
- // Return batch ID immediately for custom polling
75
- const batchId = await client.contentMethods.publishContent(123, 'your-guid', 'en-us', null, true);
76
- ```
77
-
78
- ---
79
-
80
- ## unPublishContent
81
-
82
- Unpublishes a content item through the batch workflow system.
83
-
84
- ### Parameters
85
-
86
- | Parameter | Type | Required | Description |
87
- |-----------|------|----------|-------------|
88
- | contentID | number | Yes | The ID of the content item to unpublish |
89
- | guid | string | Yes | The website GUID |
90
- | locale | string | Yes | The locale code |
91
- | comments | string | No | Optional comments for the unpublish operation |
92
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
93
-
94
- ### Returns
95
-
96
- `Promise<number[]>` - Array of content IDs that were unpublished
97
-
98
- ### Usage Example
99
-
100
- ```typescript
101
- const unpublishedIds = await client.contentMethods.unPublishContent(123, 'your-guid', 'en-us', 'Temporary unpublish');
102
- ```
103
-
104
- ---
105
-
106
- ## contentRequestApproval
107
-
108
- Requests approval for a content item through the workflow system.
109
-
110
- ### Parameters
111
-
112
- | Parameter | Type | Required | Description |
113
- |-----------|------|----------|-------------|
114
- | contentID | number | Yes | The ID of the content item |
115
- | guid | string | Yes | The website GUID |
116
- | locale | string | Yes | The locale code |
117
- | comments | string | No | Optional comments for the approval request |
118
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
119
-
120
- ### Returns
121
-
122
- `Promise<number[]>` - Array of content IDs that had approval requested
123
-
124
- ### Usage Example
125
-
126
- ```typescript
127
- const requestedIds = await client.contentMethods.contentRequestApproval(123, 'your-guid', 'en-us', 'Ready for review');
128
- ```
129
-
130
- ---
131
-
132
- ## approveContent
133
-
134
- Approves a content item in the workflow system.
135
-
136
- ### Parameters
137
-
138
- | Parameter | Type | Required | Description |
139
- |-----------|------|----------|-------------|
140
- | contentID | number | Yes | The ID of the content item to approve |
141
- | guid | string | Yes | The website GUID |
142
- | locale | string | Yes | The locale code |
143
- | comments | string | No | Optional comments for the approval |
144
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
145
-
146
- ### Returns
147
-
148
- `Promise<number[]>` - Array of content IDs that were approved
149
-
150
- ### Usage Example
151
-
152
- ```typescript
153
- const approvedIds = await client.contentMethods.approveContent(123, 'your-guid', 'en-us', 'Approved for publication');
154
- ```
155
-
156
- ---
157
-
158
- ## declineContent
159
-
160
- Declines a content item in the workflow system.
161
-
162
- ### Parameters
163
-
164
- | Parameter | Type | Required | Description |
165
- |-----------|------|----------|-------------|
166
- | contentID | number | Yes | The ID of the content item to decline |
167
- | guid | string | Yes | The website GUID |
168
- | locale | string | Yes | The locale code |
169
- | comments | string | No | Optional comments for the decline |
170
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
171
-
172
- ### Returns
173
-
174
- `Promise<number[]>` - Array of content IDs that were declined
175
-
176
- ### Usage Example
177
-
178
- ```typescript
179
- const declinedIds = await client.contentMethods.declineContent(123, 'your-guid', 'en-us', 'Needs revision');
180
- ```
181
-
182
- ---
183
-
184
- ## deleteContent
185
-
186
- Deletes a content item through the batch workflow system.
187
-
188
- ### Parameters
189
-
190
- | Parameter | Type | Required | Description |
191
- |-----------|------|----------|-------------|
192
- | contentID | number | Yes | The ID of the content item to delete |
193
- | guid | string | Yes | The website GUID |
194
- | locale | string | Yes | The locale code |
195
- | comments | string | No | Optional comments for the deletion |
196
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
197
-
198
- ### Returns
199
-
200
- `Promise<number[]>` - Array of content IDs that were deleted
201
-
202
- ### Usage Example
203
-
204
- ```typescript
205
- const deletedIds = await client.contentMethods.deleteContent(123, 'your-guid', 'en-us', 'Removing outdated content');
206
- ```
207
-
208
- ---
209
-
210
- ## saveContentItem
211
-
212
- Saves a single content item (create or update) through the batch workflow system.
213
-
214
- ### Parameters
215
-
216
- | Parameter | Type | Required | Description |
217
- |-----------|------|----------|-------------|
218
- | contentItem | ContentItem | Yes | The content item object to save |
219
- | guid | string | Yes | The website GUID |
220
- | locale | string | Yes | The locale code |
221
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
222
-
223
- ### Returns
224
-
225
- `Promise<number[]>` - Array of content IDs that were saved
226
-
227
- ### Usage Example
228
-
229
- ```typescript
230
- const contentItem = {
231
- contentID: 0, // 0 for new items
232
- fields: {
233
- title: 'New Article',
234
- content: 'Article content...'
235
- }
236
- };
237
-
238
- const savedIds = await client.contentMethods.saveContentItem(contentItem, 'your-guid', 'en-us');
239
- ```
240
-
241
- ---
242
-
243
- ## saveContentItems
244
-
245
- Saves multiple content items in a single batch operation.
246
-
247
- ### Parameters
248
-
249
- | Parameter | Type | Required | Description |
250
- |-----------|------|----------|-------------|
251
- | contentItems | ContentItem[] | Yes | Array of content item objects to save |
252
- | guid | string | Yes | The website GUID |
253
- | locale | string | Yes | The locale code |
254
- | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
255
-
256
- ### Returns
257
-
258
- `Promise<number[]>` - Array of content IDs that were saved
259
-
260
- ### Usage Example
261
-
262
- ```typescript
263
- const contentItems = [
264
- { contentID: 0, fields: { title: 'Article 1' } },
265
- { contentID: 0, fields: { title: 'Article 2' } }
266
- ];
267
-
268
- const savedIds = await client.contentMethods.saveContentItems(contentItems, 'your-guid', 'en-us');
269
- ```
270
-
271
- ---
272
-
273
- ## getContentItems
274
-
275
- Retrieves content items with basic filtering parameters (deprecated - use getContentList instead).
276
-
277
- ### Parameters
278
-
279
- | Parameter | Type | Required | Description |
280
- |-----------|------|----------|-------------|
281
- | referenceName | string | Yes | The reference name of the content model |
282
- | guid | string | Yes | The website GUID |
283
- | locale | string | Yes | The locale code |
284
- | listParams | ListParams | Yes | Pagination and filtering parameters |
285
-
286
- ### Returns
287
-
288
- `Promise<ContentList>` - The content list with items and pagination info
289
-
290
- ### Usage Example
291
-
292
- ```typescript
293
- const listParams = {
294
- take: 10,
295
- skip: 0,
296
- sortField: 'title',
297
- sortDirection: 'asc'
298
- };
299
-
300
- const contentList = await client.contentMethods.getContentItems('articles', 'your-guid', 'en-us', listParams);
301
- ```
302
-
303
- ---
304
-
305
- ## getContentList
306
-
307
- Retrieves content items with advanced filtering using POST request with filter object.
308
-
309
- ### Parameters
310
-
311
- | Parameter | Type | Required | Description |
312
- |-----------|------|----------|-------------|
313
- | referenceName | string | Yes | The reference name of the content model |
314
- | guid | string | Yes | The website GUID |
315
- | locale | string | Yes | The locale code |
316
- | listParams | ListParams | Yes | Pagination and filtering parameters |
317
- | filterObject | ContentListFilterModel | No | Advanced filter criteria |
318
-
319
- ### Returns
320
-
321
- `Promise<ContentList>` - The content list with items and pagination info
322
-
323
- ### Usage Example
324
-
325
- ```typescript
326
- const listParams = {
327
- take: 20,
328
- skip: 0,
329
- sortField: 'dateCreated',
330
- sortDirection: 'desc',
331
- showDeleted: false
332
- };
333
-
334
- const filterObject = {
335
- publishedState: 'published',
336
- searchText: 'important'
337
- };
338
-
339
- const contentList = await client.contentMethods.getContentList('articles', 'your-guid', 'en-us', listParams, filterObject);
340
- ```
341
-
342
- ---
343
-
344
- ## getContentHistory
345
-
346
- Retrieves the history of changes for a specific content item.
347
-
348
- ### Parameters
349
-
350
- | Parameter | Type | Required | Description |
351
- |-----------|------|----------|-------------|
352
- | locale | string | Yes | The locale code |
353
- | guid | string | Yes | The website GUID |
354
- | contentID | number | Yes | The ID of the content item |
355
- | take | number | No | Number of history entries to retrieve (default: 50) |
356
- | skip | number | No | Number of history entries to skip (default: 0) |
357
-
358
- ### Returns
359
-
360
- `Promise<ContentItemHistory>` - The content item history with pagination
361
-
362
- ### Usage Example
363
-
364
- ```typescript
365
- const history = await client.contentMethods.getContentHistory('en-us', 'your-guid', 123, 25, 0);
366
- console.log(history.items.length);
367
- ```
368
-
369
- ---
370
-
371
- ## getContentComments
372
-
373
- Retrieves comments for a specific content item.
374
-
375
- ### Parameters
376
-
377
- | Parameter | Type | Required | Description |
378
- |-----------|------|----------|-------------|
379
- | locale | string | Yes | The locale code |
380
- | guid | string | Yes | The website GUID |
381
- | contentID | number | Yes | The ID of the content item |
382
- | take | number | No | Number of comments to retrieve (default: 50) |
383
- | skip | number | No | Number of comments to skip (default: 0) |
384
-
385
- ### Returns
386
-
387
- `Promise<ItemComments>` - The content item comments with pagination
388
-
389
- ### Usage Example
390
-
391
- ```typescript
392
- const comments = await client.contentMethods.getContentComments('en-us', 'your-guid', 123, 10, 0);
393
- console.log(comments.items.length);
394
- ```
395
-
396
- ---
397
-
398
- ## Error Handling
399
-
400
- All methods throw `Exception` objects on failure:
401
-
402
- ```typescript
403
- try {
404
- const contentItem = await client.contentMethods.getContentItem(123, 'your-guid', 'en-us');
405
- } catch (error) {
406
- console.error('Failed to get content item:', error.message);
407
- }
408
- ```
409
-
410
- ---
411
-
412
- ## Navigation
413
- - [← Back to Main Documentation](../README.md)
414
- - [Authentication & Setup](./auth.md)
415
- - [AssetMethods](./asset-methods.md)
416
- - [BatchMethods](./batch-methods.md)
417
- - [ContainerMethods](./container-methods.md)
418
- - [InstanceMethods](./instance-methods.md)
419
- - [InstanceUserMethods](./instance-user-methods.md)
420
- - [ModelMethods](./model-methods.md)
421
- - [PageMethods](./page-methods.md)
422
- - [ServerUserMethods](./server-user-methods.md)
1
+ # ContentMethods API Documentation
2
+
3
+ The `ContentMethods` class provides comprehensive functionality for managing content items, including creation, publication, approval workflows, and retrieval operations.
4
+
5
+ ## Function List
6
+
7
+ | Function | Description |
8
+ |----------|-------------|
9
+ | [getContentItem](#getcontentitem) | Retrieves a specific content item by ID |
10
+ | [publishContent](#publishcontent) | Publishes a content item |
11
+ | [unPublishContent](#unpublishcontent) | Unpublishes a content item |
12
+ | [batchWorkflowContent](#batchworkflowcontent) | Batch workflow operation on multiple content items |
13
+ | [contentRequestApproval](#contentrequestapproval) | Requests approval for a content item |
14
+ | [approveContent](#approvecontent) | Approves a content item |
15
+ | [declineContent](#declinecontent) | Declines a content item |
16
+ | [deleteContent](#deletecontent) | Deletes a content item |
17
+ | [saveContentItem](#savecontentitem) | Saves a single content item |
18
+ | [saveContentItems](#savecontentitems) | Saves multiple content items |
19
+ | [getContentItems](#getcontentitems) | Retrieves content items with filtering (deprecated) |
20
+ | [getContentList](#getcontentlist) | Retrieves content list with advanced filtering |
21
+ | [getContentHistory](#getcontenthistory) | Retrieves content item history |
22
+ | [getContentComments](#getcontentcomments) | Retrieves content item comments |
23
+
24
+ ---
25
+
26
+ ## getContentItem
27
+
28
+ Retrieves a specific content item by ID and locale.
29
+
30
+ ### Parameters
31
+
32
+ | Parameter | Type | Required | Description |
33
+ |-----------|------|----------|-------------|
34
+ | contentID | number | Yes | The ID of the content item to retrieve |
35
+ | guid | string | Yes | The website GUID |
36
+ | locale | string | Yes | The locale code (e.g., 'en-us') |
37
+
38
+ ### Returns
39
+
40
+ `Promise<ContentItem>` - The content item object
41
+
42
+ ### Usage Example
43
+
44
+ ```typescript
45
+ const contentItem = await client.contentMethods.getContentItem(123, 'your-guid', 'en-us');
46
+ console.log(contentItem.fields.title);
47
+ ```
48
+
49
+ ---
50
+
51
+ ## publishContent
52
+
53
+ Publishes a content item through the batch workflow system.
54
+
55
+ ### Parameters
56
+
57
+ | Parameter | Type | Required | Description |
58
+ |-----------|------|----------|-------------|
59
+ | contentID | number | Yes | The ID of the content item to publish |
60
+ | guid | string | Yes | The website GUID |
61
+ | locale | string | Yes | The locale code |
62
+ | comments | string | No | Optional comments for the publish operation |
63
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
64
+
65
+ ### Returns
66
+
67
+ `Promise<number[]>` - Array of content IDs that were published
68
+
69
+ ### Usage Example
70
+
71
+ ```typescript
72
+ // Wait for completion (default)
73
+ const publishedIds = await client.contentMethods.publishContent(123, 'your-guid', 'en-us', 'Publishing update');
74
+
75
+ // Return batch ID immediately for custom polling
76
+ const batchId = await client.contentMethods.publishContent(123, 'your-guid', 'en-us', null, true);
77
+ ```
78
+
79
+ ---
80
+
81
+ ## unPublishContent
82
+
83
+ Unpublishes a content item through the batch workflow system.
84
+
85
+ ### Parameters
86
+
87
+ | Parameter | Type | Required | Description |
88
+ |-----------|------|----------|-------------|
89
+ | contentID | number | Yes | The ID of the content item to unpublish |
90
+ | guid | string | Yes | The website GUID |
91
+ | locale | string | Yes | The locale code |
92
+ | comments | string | No | Optional comments for the unpublish operation |
93
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
94
+
95
+ ### Returns
96
+
97
+ `Promise<number[]>` - Array of content IDs that were unpublished
98
+
99
+ ### Usage Example
100
+
101
+ ```typescript
102
+ const unpublishedIds = await client.contentMethods.unPublishContent(123, 'your-guid', 'en-us', 'Temporary unpublish');
103
+ ```
104
+
105
+ ---
106
+
107
+ ## batchWorkflowContent
108
+
109
+ Performs a batch workflow operation on multiple content items. Supports Publish, Unpublish, Approve, Decline, and RequestApproval operations.
110
+
111
+ ### Parameters
112
+
113
+ | Parameter | Type | Required | Description |
114
+ |-----------|------|----------|-------------|
115
+ | contentIDs | number[] | Yes | Array of content IDs to process |
116
+ | guid | string | Yes | The website GUID |
117
+ | locale | string | Yes | The locale code |
118
+ | operation | WorkflowOperationType | Yes | The workflow operation (Publish, Unpublish, Approve, Decline, RequestApproval) |
119
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
120
+
121
+ ### Returns
122
+
123
+ `Promise<number[]>` - Array of content IDs that were processed
124
+
125
+ ### Usage Example
126
+
127
+ ```typescript
128
+ import { WorkflowOperationType } from '@agility/management-sdk';
129
+
130
+ // Publish multiple content items
131
+ const contentIDs = [101, 102, 103];
132
+ const publishedIds = await client.contentMethods.batchWorkflowContent(
133
+ contentIDs,
134
+ 'your-guid',
135
+ 'en-us',
136
+ WorkflowOperationType.Publish
137
+ );
138
+ console.log('Published content IDs:', publishedIds);
139
+
140
+ // Unpublish multiple content items
141
+ const unpublishedIds = await client.contentMethods.batchWorkflowContent(
142
+ contentIDs,
143
+ 'your-guid',
144
+ 'en-us',
145
+ WorkflowOperationType.Unpublish
146
+ );
147
+
148
+ // Request approval for multiple content items
149
+ const approvalRequestedIds = await client.contentMethods.batchWorkflowContent(
150
+ contentIDs,
151
+ 'your-guid',
152
+ 'en-us',
153
+ WorkflowOperationType.RequestApproval
154
+ );
155
+
156
+ // Approve multiple content items
157
+ const approvedIds = await client.contentMethods.batchWorkflowContent(
158
+ contentIDs,
159
+ 'your-guid',
160
+ 'en-us',
161
+ WorkflowOperationType.Approve
162
+ );
163
+
164
+ // Decline multiple content items
165
+ const declinedIds = await client.contentMethods.batchWorkflowContent(
166
+ contentIDs,
167
+ 'your-guid',
168
+ 'en-us',
169
+ WorkflowOperationType.Decline
170
+ );
171
+ ```
172
+
173
+ ---
174
+
175
+ ## contentRequestApproval
176
+
177
+ Requests approval for a content item through the workflow system.
178
+
179
+ ### Parameters
180
+
181
+ | Parameter | Type | Required | Description |
182
+ |-----------|------|----------|-------------|
183
+ | contentID | number | Yes | The ID of the content item |
184
+ | guid | string | Yes | The website GUID |
185
+ | locale | string | Yes | The locale code |
186
+ | comments | string | No | Optional comments for the approval request |
187
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
188
+
189
+ ### Returns
190
+
191
+ `Promise<number[]>` - Array of content IDs that had approval requested
192
+
193
+ ### Usage Example
194
+
195
+ ```typescript
196
+ const requestedIds = await client.contentMethods.contentRequestApproval(123, 'your-guid', 'en-us', 'Ready for review');
197
+ ```
198
+
199
+ ---
200
+
201
+ ## approveContent
202
+
203
+ Approves a content item in the workflow system.
204
+
205
+ ### Parameters
206
+
207
+ | Parameter | Type | Required | Description |
208
+ |-----------|------|----------|-------------|
209
+ | contentID | number | Yes | The ID of the content item to approve |
210
+ | guid | string | Yes | The website GUID |
211
+ | locale | string | Yes | The locale code |
212
+ | comments | string | No | Optional comments for the approval |
213
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
214
+
215
+ ### Returns
216
+
217
+ `Promise<number[]>` - Array of content IDs that were approved
218
+
219
+ ### Usage Example
220
+
221
+ ```typescript
222
+ const approvedIds = await client.contentMethods.approveContent(123, 'your-guid', 'en-us', 'Approved for publication');
223
+ ```
224
+
225
+ ---
226
+
227
+ ## declineContent
228
+
229
+ Declines a content item in the workflow system.
230
+
231
+ ### Parameters
232
+
233
+ | Parameter | Type | Required | Description |
234
+ |-----------|------|----------|-------------|
235
+ | contentID | number | Yes | The ID of the content item to decline |
236
+ | guid | string | Yes | The website GUID |
237
+ | locale | string | Yes | The locale code |
238
+ | comments | string | No | Optional comments for the decline |
239
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
240
+
241
+ ### Returns
242
+
243
+ `Promise<number[]>` - Array of content IDs that were declined
244
+
245
+ ### Usage Example
246
+
247
+ ```typescript
248
+ const declinedIds = await client.contentMethods.declineContent(123, 'your-guid', 'en-us', 'Needs revision');
249
+ ```
250
+
251
+ ---
252
+
253
+ ## deleteContent
254
+
255
+ Deletes a content item through the batch workflow system.
256
+
257
+ ### Parameters
258
+
259
+ | Parameter | Type | Required | Description |
260
+ |-----------|------|----------|-------------|
261
+ | contentID | number | Yes | The ID of the content item to delete |
262
+ | guid | string | Yes | The website GUID |
263
+ | locale | string | Yes | The locale code |
264
+ | comments | string | No | Optional comments for the deletion |
265
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
266
+
267
+ ### Returns
268
+
269
+ `Promise<number[]>` - Array of content IDs that were deleted
270
+
271
+ ### Usage Example
272
+
273
+ ```typescript
274
+ const deletedIds = await client.contentMethods.deleteContent(123, 'your-guid', 'en-us', 'Removing outdated content');
275
+ ```
276
+
277
+ ---
278
+
279
+ ## saveContentItem
280
+
281
+ Saves a single content item (create or update) through the batch workflow system.
282
+
283
+ ### Parameters
284
+
285
+ | Parameter | Type | Required | Description |
286
+ |-----------|------|----------|-------------|
287
+ | contentItem | ContentItem | Yes | The content item object to save |
288
+ | guid | string | Yes | The website GUID |
289
+ | locale | string | Yes | The locale code |
290
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
291
+
292
+ ### Returns
293
+
294
+ `Promise<number[]>` - Array of content IDs that were saved
295
+
296
+ ### Usage Example
297
+
298
+ ```typescript
299
+ const contentItem = {
300
+ contentID: 0, // 0 for new items
301
+ fields: {
302
+ title: 'New Article',
303
+ content: 'Article content...'
304
+ }
305
+ };
306
+
307
+ const savedIds = await client.contentMethods.saveContentItem(contentItem, 'your-guid', 'en-us');
308
+ ```
309
+
310
+ ---
311
+
312
+ ## saveContentItems
313
+
314
+ Saves multiple content items in a single batch operation.
315
+
316
+ ### Parameters
317
+
318
+ | Parameter | Type | Required | Description |
319
+ |-----------|------|----------|-------------|
320
+ | contentItems | ContentItem[] | Yes | Array of content item objects to save |
321
+ | guid | string | Yes | The website GUID |
322
+ | locale | string | Yes | The locale code |
323
+ | returnBatchId | boolean | No | If true, returns batch ID immediately without waiting |
324
+
325
+ ### Returns
326
+
327
+ `Promise<number[]>` - Array of content IDs that were saved
328
+
329
+ ### Usage Example
330
+
331
+ ```typescript
332
+ const contentItems = [
333
+ { contentID: 0, fields: { title: 'Article 1' } },
334
+ { contentID: 0, fields: { title: 'Article 2' } }
335
+ ];
336
+
337
+ const savedIds = await client.contentMethods.saveContentItems(contentItems, 'your-guid', 'en-us');
338
+ ```
339
+
340
+ ---
341
+
342
+ ## getContentItems
343
+
344
+ Retrieves content items with basic filtering parameters (deprecated - use getContentList instead).
345
+
346
+ ### Parameters
347
+
348
+ | Parameter | Type | Required | Description |
349
+ |-----------|------|----------|-------------|
350
+ | referenceName | string | Yes | The reference name of the content model |
351
+ | guid | string | Yes | The website GUID |
352
+ | locale | string | Yes | The locale code |
353
+ | listParams | ListParams | Yes | Pagination and filtering parameters |
354
+
355
+ ### Returns
356
+
357
+ `Promise<ContentList>` - The content list with items and pagination info
358
+
359
+ ### Usage Example
360
+
361
+ ```typescript
362
+ const listParams = {
363
+ take: 10,
364
+ skip: 0,
365
+ sortField: 'title',
366
+ sortDirection: 'asc'
367
+ };
368
+
369
+ const contentList = await client.contentMethods.getContentItems('articles', 'your-guid', 'en-us', listParams);
370
+ ```
371
+
372
+ ---
373
+
374
+ ## getContentList
375
+
376
+ Retrieves content items with advanced filtering using POST request with filter object.
377
+
378
+ ### Parameters
379
+
380
+ | Parameter | Type | Required | Description |
381
+ |-----------|------|----------|-------------|
382
+ | referenceName | string | Yes | The reference name of the content model |
383
+ | guid | string | Yes | The website GUID |
384
+ | locale | string | Yes | The locale code |
385
+ | listParams | ListParams | Yes | Pagination and filtering parameters |
386
+ | filterObject | ContentListFilterModel | No | Advanced filter criteria |
387
+
388
+ ### Returns
389
+
390
+ `Promise<ContentList>` - The content list with items and pagination info
391
+
392
+ ### Usage Example
393
+
394
+ ```typescript
395
+ const listParams = {
396
+ take: 20,
397
+ skip: 0,
398
+ sortField: 'dateCreated',
399
+ sortDirection: 'desc',
400
+ showDeleted: false
401
+ };
402
+
403
+ const filterObject = {
404
+ publishedState: 'published',
405
+ searchText: 'important'
406
+ };
407
+
408
+ const contentList = await client.contentMethods.getContentList('articles', 'your-guid', 'en-us', listParams, filterObject);
409
+ ```
410
+
411
+ ---
412
+
413
+ ## getContentHistory
414
+
415
+ Retrieves the history of changes for a specific content item.
416
+
417
+ ### Parameters
418
+
419
+ | Parameter | Type | Required | Description |
420
+ |-----------|------|----------|-------------|
421
+ | locale | string | Yes | The locale code |
422
+ | guid | string | Yes | The website GUID |
423
+ | contentID | number | Yes | The ID of the content item |
424
+ | take | number | No | Number of history entries to retrieve (default: 50) |
425
+ | skip | number | No | Number of history entries to skip (default: 0) |
426
+
427
+ ### Returns
428
+
429
+ `Promise<ContentItemHistory>` - The content item history with pagination
430
+
431
+ ### Usage Example
432
+
433
+ ```typescript
434
+ const history = await client.contentMethods.getContentHistory('en-us', 'your-guid', 123, 25, 0);
435
+ console.log(history.items.length);
436
+ ```
437
+
438
+ ---
439
+
440
+ ## getContentComments
441
+
442
+ Retrieves comments for a specific content item.
443
+
444
+ ### Parameters
445
+
446
+ | Parameter | Type | Required | Description |
447
+ |-----------|------|----------|-------------|
448
+ | locale | string | Yes | The locale code |
449
+ | guid | string | Yes | The website GUID |
450
+ | contentID | number | Yes | The ID of the content item |
451
+ | take | number | No | Number of comments to retrieve (default: 50) |
452
+ | skip | number | No | Number of comments to skip (default: 0) |
453
+
454
+ ### Returns
455
+
456
+ `Promise<ItemComments>` - The content item comments with pagination
457
+
458
+ ### Usage Example
459
+
460
+ ```typescript
461
+ const comments = await client.contentMethods.getContentComments('en-us', 'your-guid', 123, 10, 0);
462
+ console.log(comments.items.length);
463
+ ```
464
+
465
+ ---
466
+
467
+ ## Error Handling
468
+
469
+ All methods throw `Exception` objects on failure:
470
+
471
+ ```typescript
472
+ try {
473
+ const contentItem = await client.contentMethods.getContentItem(123, 'your-guid', 'en-us');
474
+ } catch (error) {
475
+ console.error('Failed to get content item:', error.message);
476
+ }
477
+ ```
478
+
479
+ ---
480
+
481
+ ## Navigation
482
+ - [← Back to Main Documentation](../README.md)
483
+ - [Authentication & Setup](./auth.md)
484
+ - [AssetMethods](./asset-methods.md)
485
+ - [BatchMethods](./batch-methods.md)
486
+ - [ContainerMethods](./container-methods.md)
487
+ - [InstanceMethods](./instance-methods.md)
488
+ - [InstanceUserMethods](./instance-user-methods.md)
489
+ - [ModelMethods](./model-methods.md)
490
+ - [PageMethods](./page-methods.md)
491
+ - [ServerUserMethods](./server-user-methods.md)
423
492
  - [WebhookMethods](./webhook-methods.md)