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

ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.134.1

Browse Source
This commit is contained in:
speakeasybot
2024-01-10 15:48:00 +00:00
parent 0231c2a428
commit 2af51a7827
589 changed files with 45363 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docs/sdks/notifications/README.md Normal file
View File

@@ -0,0 +1,84 @@
# Notifications
(*notifications*)
### Available Operations
* [getNotifications](#getnotifications) - Get the notifications that belong to the current user
* [markNotificationsAsRead](#marknotificationsasread) - Mark notifications as read
## getNotifications
Get the notifications that belong to the current user
### Example Usage
```typescript
import { SDK } from "openapi";
async function run() {
const sdk = new SDK();
const res = await sdk.notifications.getNotifications();
if (res.statusCode == 200) {
// handle response
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
### Response
**Promise<[operations.GetNotificationsResponse](../../sdk/models/operations/getnotificationsresponse.md)>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## markNotificationsAsRead
Mark notifications as read
### Example Usage
```typescript
import { SDK } from "openapi";
async function run() {
const sdk = new SDK();
const res = await sdk.notifications.markNotificationsAsRead({});
if (res.statusCode == 200) {
// handle response
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.MarkNotificationsAsReadRequestBody](../../sdk/models/operations/marknotificationsasreadrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
### Response
**Promise<[operations.MarkNotificationsAsReadResponse](../../sdk/models/operations/marknotificationsasreadresponse.md)>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |