LukeParke/discoursejs
1
0
Fork 0
mirror of https://github.com/LukeHagar/discoursejs.git synced 2025-12-06 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.378.0

Browse Source
This commit is contained in:
speakeasybot
2024-08-24 00:23:32 +00:00
parent 7268c99acb
commit 7721c1cc96
23 changed files with 238 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/sdks/notifications/README.md
View File

@@ -1,6 +1,8 @@
# Notifications
(*notifications*)
## Overview
### Available Operations
* [getNotifications](#getnotifications) - Get the notifications that belong to the current user
@@ -27,7 +29,6 @@ async function run() {
run();
```
### Standalone function
The standalone function version of this method:
@@ -64,16 +65,17 @@ run();
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
**Promise\<[operations.GetNotificationsResponseBody](../../sdk/models/operations/getnotificationsresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## markNotificationsAsRead
Mark notifications as read
@@ -95,7 +97,6 @@ async function run() {
run();
```
### Standalone function
The standalone function version of this method:
@@ -133,10 +134,10 @@ run();
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
**Promise\<[operations.MarkNotificationsAsReadResponseBody](../../sdk/models/operations/marknotificationsasreadresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |