first version
This commit is contained in:
342
docs/NotificationApi.md
Normal file
342
docs/NotificationApi.md
Normal file
@@ -0,0 +1,342 @@
|
||||
# \NotificationApi
|
||||
|
||||
All URIs are relative to *http://127.0.0.1:80*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**AnswerApiV1NotificationPageGet**](NotificationApi.md#AnswerApiV1NotificationPageGet) | **Get** /answer/api/v1/notification/page | get notification list
|
||||
[**AnswerApiV1NotificationReadStateAllPut**](NotificationApi.md#AnswerApiV1NotificationReadStateAllPut) | **Put** /answer/api/v1/notification/read/state/all | ClearUnRead
|
||||
[**AnswerApiV1NotificationReadStatePut**](NotificationApi.md#AnswerApiV1NotificationReadStatePut) | **Put** /answer/api/v1/notification/read/state | ClearUnRead
|
||||
[**AnswerApiV1NotificationStatusGet**](NotificationApi.md#AnswerApiV1NotificationStatusGet) | **Get** /answer/api/v1/notification/status | GetRedDot
|
||||
[**AnswerApiV1NotificationStatusPut**](NotificationApi.md#AnswerApiV1NotificationStatusPut) | **Put** /answer/api/v1/notification/status | DelRedDot
|
||||
|
||||
|
||||
|
||||
## AnswerApiV1NotificationPageGet
|
||||
|
||||
> HandlerRespBody AnswerApiV1NotificationPageGet(ctx).Type_(type_).Page(page).PageSize(pageSize).Execute()
|
||||
|
||||
get notification list
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
type_ := "type__example" // string | type
|
||||
page := int32(56) // int32 | page size (optional)
|
||||
pageSize := int32(56) // int32 | page size (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.NotificationApi.AnswerApiV1NotificationPageGet(context.Background()).Type_(type_).Page(page).PageSize(pageSize).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `NotificationApi.AnswerApiV1NotificationPageGet``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerApiV1NotificationPageGet`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `NotificationApi.AnswerApiV1NotificationPageGet`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerApiV1NotificationPageGetRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**type_** | **string** | type |
|
||||
**page** | **int32** | page size |
|
||||
**pageSize** | **int32** | page size |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## AnswerApiV1NotificationReadStateAllPut
|
||||
|
||||
> HandlerRespBody AnswerApiV1NotificationReadStateAllPut(ctx).Data(data).Execute()
|
||||
|
||||
ClearUnRead
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
data := *openapiclient.NewSchemaNotificationClearRequest() // SchemaNotificationClearRequest | NotificationClearRequest
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.NotificationApi.AnswerApiV1NotificationReadStateAllPut(context.Background()).Data(data).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `NotificationApi.AnswerApiV1NotificationReadStateAllPut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerApiV1NotificationReadStateAllPut`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `NotificationApi.AnswerApiV1NotificationReadStateAllPut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerApiV1NotificationReadStateAllPutRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**data** | [**SchemaNotificationClearRequest**](SchemaNotificationClearRequest.md) | NotificationClearRequest |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## AnswerApiV1NotificationReadStatePut
|
||||
|
||||
> HandlerRespBody AnswerApiV1NotificationReadStatePut(ctx).Data(data).Execute()
|
||||
|
||||
ClearUnRead
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
data := *openapiclient.NewSchemaNotificationClearIDRequest() // SchemaNotificationClearIDRequest | NotificationClearIDRequest
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.NotificationApi.AnswerApiV1NotificationReadStatePut(context.Background()).Data(data).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `NotificationApi.AnswerApiV1NotificationReadStatePut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerApiV1NotificationReadStatePut`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `NotificationApi.AnswerApiV1NotificationReadStatePut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerApiV1NotificationReadStatePutRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**data** | [**SchemaNotificationClearIDRequest**](SchemaNotificationClearIDRequest.md) | NotificationClearIDRequest |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## AnswerApiV1NotificationStatusGet
|
||||
|
||||
> HandlerRespBody AnswerApiV1NotificationStatusGet(ctx).Execute()
|
||||
|
||||
GetRedDot
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.NotificationApi.AnswerApiV1NotificationStatusGet(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `NotificationApi.AnswerApiV1NotificationStatusGet``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerApiV1NotificationStatusGet`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `NotificationApi.AnswerApiV1NotificationStatusGet`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerApiV1NotificationStatusGetRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## AnswerApiV1NotificationStatusPut
|
||||
|
||||
> HandlerRespBody AnswerApiV1NotificationStatusPut(ctx).Data(data).Execute()
|
||||
|
||||
DelRedDot
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
data := *openapiclient.NewSchemaNotificationClearRequest() // SchemaNotificationClearRequest | NotificationClearRequest
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.NotificationApi.AnswerApiV1NotificationStatusPut(context.Background()).Data(data).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `NotificationApi.AnswerApiV1NotificationStatusPut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerApiV1NotificationStatusPut`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `NotificationApi.AnswerApiV1NotificationStatusPut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerApiV1NotificationStatusPutRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**data** | [**SchemaNotificationClearRequest**](SchemaNotificationClearRequest.md) | NotificationClearRequest |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
Reference in New Issue
Block a user