Files
openapi-go-answer/docs/UserAPI.md
2023-09-26 16:20:01 +08:00

1397 lines
39 KiB
Markdown

# \UserAPI
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**AnswerApiV1PersonalUserInfoGet**](UserAPI.md#AnswerApiV1PersonalUserInfoGet) | **Get** /answer/api/v1/personal/user/info | GetOtherUserInfoByUsername
[**AnswerApiV1UserActionRecordGet**](UserAPI.md#AnswerApiV1UserActionRecordGet) | **Get** /answer/api/v1/user/action/record | ActionRecord
[**AnswerApiV1UserEmailChangeCodePost**](UserAPI.md#AnswerApiV1UserEmailChangeCodePost) | **Post** /answer/api/v1/user/email/change/code | send email to the user email then change their email
[**AnswerApiV1UserEmailPut**](UserAPI.md#AnswerApiV1UserEmailPut) | **Put** /answer/api/v1/user/email | user change email verification
[**AnswerApiV1UserEmailVerificationPost**](UserAPI.md#AnswerApiV1UserEmailVerificationPost) | **Post** /answer/api/v1/user/email/verification | UserVerifyEmail
[**AnswerApiV1UserEmailVerificationSendPost**](UserAPI.md#AnswerApiV1UserEmailVerificationSendPost) | **Post** /answer/api/v1/user/email/verification/send | UserVerifyEmailSend
[**AnswerApiV1UserInfoGet**](UserAPI.md#AnswerApiV1UserInfoGet) | **Get** /answer/api/v1/user/info | GetUserInfoByUserID
[**AnswerApiV1UserInfoPut**](UserAPI.md#AnswerApiV1UserInfoPut) | **Put** /answer/api/v1/user/info | UserUpdateInfo update user info
[**AnswerApiV1UserInfoSearchGet**](UserAPI.md#AnswerApiV1UserInfoSearchGet) | **Get** /answer/api/v1/user/info/search | SearchUserListByName
[**AnswerApiV1UserInterfacePut**](UserAPI.md#AnswerApiV1UserInterfacePut) | **Put** /answer/api/v1/user/interface | UserUpdateInterface update user interface config
[**AnswerApiV1UserLoginEmailPost**](UserAPI.md#AnswerApiV1UserLoginEmailPost) | **Post** /answer/api/v1/user/login/email | UserEmailLogin
[**AnswerApiV1UserLogoutGet**](UserAPI.md#AnswerApiV1UserLogoutGet) | **Get** /answer/api/v1/user/logout | user logout
[**AnswerApiV1UserNotificationConfigPost**](UserAPI.md#AnswerApiV1UserNotificationConfigPost) | **Post** /answer/api/v1/user/notification/config | get user's notification config
[**AnswerApiV1UserNotificationConfigPut**](UserAPI.md#AnswerApiV1UserNotificationConfigPut) | **Put** /answer/api/v1/user/notification/config | update user's notification config
[**AnswerApiV1UserNotificationUnsubscribePut**](UserAPI.md#AnswerApiV1UserNotificationUnsubscribePut) | **Put** /answer/api/v1/user/notification/unsubscribe | unsubscribe notification
[**AnswerApiV1UserPasswordPut**](UserAPI.md#AnswerApiV1UserPasswordPut) | **Put** /answer/api/v1/user/password | UserModifyPassWord
[**AnswerApiV1UserPasswordReplacementPost**](UserAPI.md#AnswerApiV1UserPasswordReplacementPost) | **Post** /answer/api/v1/user/password/replacement | UseRePassWord
[**AnswerApiV1UserPasswordResetPost**](UserAPI.md#AnswerApiV1UserPasswordResetPost) | **Post** /answer/api/v1/user/password/reset | RetrievePassWord
[**AnswerApiV1UserRankingGet**](UserAPI.md#AnswerApiV1UserRankingGet) | **Get** /answer/api/v1/user/ranking | get user ranking
[**AnswerApiV1UserRegisterCaptchaGet**](UserAPI.md#AnswerApiV1UserRegisterCaptchaGet) | **Get** /answer/api/v1/user/register/captcha | UserRegisterCaptcha
[**AnswerApiV1UserRegisterEmailPost**](UserAPI.md#AnswerApiV1UserRegisterEmailPost) | **Post** /answer/api/v1/user/register/email | UserRegisterByEmail
## AnswerApiV1PersonalUserInfoGet
> AnswerApiV1PersonalUserInfoGet200Response AnswerApiV1PersonalUserInfoGet(ctx).Username(username).Execute()
GetOtherUserInfoByUsername
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
username := "username_example" // string | username
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1PersonalUserInfoGet(context.Background()).Username(username).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1PersonalUserInfoGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1PersonalUserInfoGet`: AnswerApiV1PersonalUserInfoGet200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1PersonalUserInfoGet`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1PersonalUserInfoGetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **string** | username |
### Return type
[**AnswerApiV1PersonalUserInfoGet200Response**](AnswerApiV1PersonalUserInfoGet200Response.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)
## AnswerApiV1UserActionRecordGet
> AnswerApiV1UserActionRecordGet200Response AnswerApiV1UserActionRecordGet(ctx).Action(action).Execute()
ActionRecord
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
action := "action_example" // string | action
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserActionRecordGet(context.Background()).Action(action).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserActionRecordGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserActionRecordGet`: AnswerApiV1UserActionRecordGet200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserActionRecordGet`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserActionRecordGetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**action** | **string** | action |
### Return type
[**AnswerApiV1UserActionRecordGet200Response**](AnswerApiV1UserActionRecordGet200Response.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
[[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)
## AnswerApiV1UserEmailChangeCodePost
> HandlerRespBody AnswerApiV1UserEmailChangeCodePost(ctx).Data(data).Execute()
send email to the user email then change their email
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserChangeEmailSendCodeReq("EMail_example") // SchemaUserChangeEmailSendCodeReq | UserChangeEmailSendCodeReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserEmailChangeCodePost(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserEmailChangeCodePost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserEmailChangeCodePost`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserEmailChangeCodePost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserEmailChangeCodePostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserChangeEmailSendCodeReq**](SchemaUserChangeEmailSendCodeReq.md) | UserChangeEmailSendCodeReq |
### Return type
[**HandlerRespBody**](HandlerRespBody.md)
### Authorization
No authorization required
### 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)
## AnswerApiV1UserEmailPut
> HandlerRespBody AnswerApiV1UserEmailPut(ctx).Data(data).Execute()
user change email verification
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserChangeEmailVerifyReq("Code_example") // SchemaUserChangeEmailVerifyReq | UserChangeEmailVerifyReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserEmailPut(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserEmailPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserEmailPut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserEmailPut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserEmailPutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserChangeEmailVerifyReq**](SchemaUserChangeEmailVerifyReq.md) | UserChangeEmailVerifyReq |
### 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)
## AnswerApiV1UserEmailVerificationPost
> AnswerApiV1UserEmailVerificationPost200Response AnswerApiV1UserEmailVerificationPost(ctx).Code(code).Execute()
UserVerifyEmail
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
code := "code_example" // string | code
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserEmailVerificationPost(context.Background()).Code(code).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserEmailVerificationPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserEmailVerificationPost`: AnswerApiV1UserEmailVerificationPost200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserEmailVerificationPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserEmailVerificationPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**code** | **string** | code |
### Return type
[**AnswerApiV1UserEmailVerificationPost200Response**](AnswerApiV1UserEmailVerificationPost200Response.md)
### Authorization
No authorization required
### 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)
## AnswerApiV1UserEmailVerificationSendPost
> string AnswerApiV1UserEmailVerificationSendPost(ctx).CaptchaId(captchaId).CaptchaCode(captchaCode).Execute()
UserVerifyEmailSend
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
captchaId := "captchaId_example" // string | captcha_id (optional)
captchaCode := "captchaCode_example" // string | captcha_code (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserEmailVerificationSendPost(context.Background()).CaptchaId(captchaId).CaptchaCode(captchaCode).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserEmailVerificationSendPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserEmailVerificationSendPost`: string
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserEmailVerificationSendPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserEmailVerificationSendPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**captchaId** | **string** | captcha_id |
**captchaCode** | **string** | captcha_code |
### Return type
**string**
### 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)
## AnswerApiV1UserInfoGet
> AnswerApiV1UserInfoGet200Response AnswerApiV1UserInfoGet(ctx).Execute()
GetUserInfoByUserID
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserInfoGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserInfoGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserInfoGet`: AnswerApiV1UserInfoGet200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserInfoGet`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserInfoGetRequest struct via the builder pattern
### Return type
[**AnswerApiV1UserInfoGet200Response**](AnswerApiV1UserInfoGet200Response.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)
## AnswerApiV1UserInfoPut
> HandlerRespBody AnswerApiV1UserInfoPut(ctx).Authorization(authorization).Data(data).Execute()
UserUpdateInfo update user info
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
authorization := "authorization_example" // string | access-token
data := *openapiclient.NewSchemaUpdateInfoRequest() // SchemaUpdateInfoRequest | UpdateInfoRequest
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserInfoPut(context.Background()).Authorization(authorization).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserInfoPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserInfoPut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserInfoPut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserInfoPutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**authorization** | **string** | access-token |
**data** | [**SchemaUpdateInfoRequest**](SchemaUpdateInfoRequest.md) | UpdateInfoRequest |
### 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)
## AnswerApiV1UserInfoSearchGet
> AnswerApiV1PersonalUserInfoGet200Response AnswerApiV1UserInfoSearchGet(ctx).Username(username).Execute()
SearchUserListByName
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
username := "username_example" // string | username
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserInfoSearchGet(context.Background()).Username(username).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserInfoSearchGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserInfoSearchGet`: AnswerApiV1PersonalUserInfoGet200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserInfoSearchGet`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserInfoSearchGetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **string** | username |
### Return type
[**AnswerApiV1PersonalUserInfoGet200Response**](AnswerApiV1PersonalUserInfoGet200Response.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)
## AnswerApiV1UserInterfacePut
> HandlerRespBody AnswerApiV1UserInterfacePut(ctx).Authorization(authorization).Data(data).Execute()
UserUpdateInterface update user interface config
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
authorization := "authorization_example" // string | access-token
data := *openapiclient.NewSchemaUpdateUserInterfaceRequest("Language_example") // SchemaUpdateUserInterfaceRequest | UpdateInfoRequest
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserInterfacePut(context.Background()).Authorization(authorization).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserInterfacePut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserInterfacePut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserInterfacePut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserInterfacePutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**authorization** | **string** | access-token |
**data** | [**SchemaUpdateUserInterfaceRequest**](SchemaUpdateUserInterfaceRequest.md) | UpdateInfoRequest |
### 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)
## AnswerApiV1UserLoginEmailPost
> AnswerApiV1UserEmailVerificationPost200Response AnswerApiV1UserLoginEmailPost(ctx).Data(data).Execute()
UserEmailLogin
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserEmailLoginReq("EMail_example", "Pass_example") // SchemaUserEmailLoginReq | UserEmailLogin
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserLoginEmailPost(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserLoginEmailPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserLoginEmailPost`: AnswerApiV1UserEmailVerificationPost200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserLoginEmailPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserLoginEmailPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserEmailLoginReq**](SchemaUserEmailLoginReq.md) | UserEmailLogin |
### Return type
[**AnswerApiV1UserEmailVerificationPost200Response**](AnswerApiV1UserEmailVerificationPost200Response.md)
### Authorization
No authorization required
### 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)
## AnswerApiV1UserLogoutGet
> HandlerRespBody AnswerApiV1UserLogoutGet(ctx).Execute()
user logout
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserLogoutGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserLogoutGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserLogoutGet`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserLogoutGet`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserLogoutGetRequest struct via the builder pattern
### Return type
[**HandlerRespBody**](HandlerRespBody.md)
### Authorization
No authorization required
### 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)
## AnswerApiV1UserNotificationConfigPost
> AnswerApiV1UserNotificationConfigPost200Response AnswerApiV1UserNotificationConfigPost(ctx).Execute()
get user's notification config
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserNotificationConfigPost(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserNotificationConfigPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserNotificationConfigPost`: AnswerApiV1UserNotificationConfigPost200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserNotificationConfigPost`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserNotificationConfigPostRequest struct via the builder pattern
### Return type
[**AnswerApiV1UserNotificationConfigPost200Response**](AnswerApiV1UserNotificationConfigPost200Response.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)
## AnswerApiV1UserNotificationConfigPut
> HandlerRespBody AnswerApiV1UserNotificationConfigPut(ctx).Data(data).Execute()
update user's notification config
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUpdateUserNotificationConfigReq() // SchemaUpdateUserNotificationConfigReq | UpdateUserNotificationConfigReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserNotificationConfigPut(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserNotificationConfigPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserNotificationConfigPut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserNotificationConfigPut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserNotificationConfigPutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUpdateUserNotificationConfigReq**](SchemaUpdateUserNotificationConfigReq.md) | UpdateUserNotificationConfigReq |
### 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)
## AnswerApiV1UserNotificationUnsubscribePut
> HandlerRespBody AnswerApiV1UserNotificationUnsubscribePut(ctx).Data(data).Execute()
unsubscribe notification
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserUnsubscribeNotificationReq("Code_example") // SchemaUserUnsubscribeNotificationReq | UserUnsubscribeNotificationReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserNotificationUnsubscribePut(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserNotificationUnsubscribePut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserNotificationUnsubscribePut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserNotificationUnsubscribePut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserNotificationUnsubscribePutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserUnsubscribeNotificationReq**](SchemaUserUnsubscribeNotificationReq.md) | UserUnsubscribeNotificationReq |
### Return type
[**HandlerRespBody**](HandlerRespBody.md)
### Authorization
No authorization required
### 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)
## AnswerApiV1UserPasswordPut
> HandlerRespBody AnswerApiV1UserPasswordPut(ctx).Data(data).Execute()
UserModifyPassWord
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserModifyPasswordReq("Pass_example") // SchemaUserModifyPasswordReq | UserModifyPasswordReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserPasswordPut(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserPasswordPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserPasswordPut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserPasswordPut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserPasswordPutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserModifyPasswordReq**](SchemaUserModifyPasswordReq.md) | UserModifyPasswordReq |
### 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)
## AnswerApiV1UserPasswordReplacementPost
> string AnswerApiV1UserPasswordReplacementPost(ctx).Data(data).Execute()
UseRePassWord
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserRePassWordRequest("Code_example", "Pass_example") // SchemaUserRePassWordRequest | UserRePassWordRequest
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserPasswordReplacementPost(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserPasswordReplacementPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserPasswordReplacementPost`: string
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserPasswordReplacementPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserPasswordReplacementPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserRePassWordRequest**](SchemaUserRePassWordRequest.md) | UserRePassWordRequest |
### Return type
**string**
### Authorization
No authorization required
### 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)
## AnswerApiV1UserPasswordResetPost
> string AnswerApiV1UserPasswordResetPost(ctx).Data(data).Execute()
RetrievePassWord
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserRetrievePassWordRequest("EMail_example") // SchemaUserRetrievePassWordRequest | UserRetrievePassWordRequest
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserPasswordResetPost(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserPasswordResetPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserPasswordResetPost`: string
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserPasswordResetPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserPasswordResetPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserRetrievePassWordRequest**](SchemaUserRetrievePassWordRequest.md) | UserRetrievePassWordRequest |
### Return type
**string**
### Authorization
No authorization required
### 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)
## AnswerApiV1UserRankingGet
> AnswerApiV1UserRankingGet200Response AnswerApiV1UserRankingGet(ctx).Execute()
get user ranking
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserRankingGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserRankingGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserRankingGet`: AnswerApiV1UserRankingGet200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserRankingGet`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserRankingGetRequest struct via the builder pattern
### Return type
[**AnswerApiV1UserRankingGet200Response**](AnswerApiV1UserRankingGet200Response.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)
## AnswerApiV1UserRegisterCaptchaGet
> AnswerApiV1UserEmailVerificationPost200Response AnswerApiV1UserRegisterCaptchaGet(ctx).Execute()
UserRegisterCaptcha
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserRegisterCaptchaGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserRegisterCaptchaGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserRegisterCaptchaGet`: AnswerApiV1UserEmailVerificationPost200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserRegisterCaptchaGet`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserRegisterCaptchaGetRequest struct via the builder pattern
### Return type
[**AnswerApiV1UserEmailVerificationPost200Response**](AnswerApiV1UserEmailVerificationPost200Response.md)
### Authorization
No authorization required
### 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)
## AnswerApiV1UserRegisterEmailPost
> AnswerApiV1UserEmailVerificationPost200Response AnswerApiV1UserRegisterEmailPost(ctx).Data(data).Execute()
UserRegisterByEmail
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "git.ncc.cx/package/openapi-go-answer"
)
func main() {
data := *openapiclient.NewSchemaUserRegisterReq("EMail_example", "Name_example", "Pass_example") // SchemaUserRegisterReq | UserRegisterReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserAPI.AnswerApiV1UserRegisterEmailPost(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.AnswerApiV1UserRegisterEmailPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerApiV1UserRegisterEmailPost`: AnswerApiV1UserEmailVerificationPost200Response
fmt.Fprintf(os.Stdout, "Response from `UserAPI.AnswerApiV1UserRegisterEmailPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerApiV1UserRegisterEmailPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUserRegisterReq**](SchemaUserRegisterReq.md) | UserRegisterReq |
### Return type
[**AnswerApiV1UserEmailVerificationPost200Response**](AnswerApiV1UserEmailVerificationPost200Response.md)
### Authorization
No authorization required
### 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)