@cherryin/api-client 0.1.1 → 0.1.3

package/docs/Auth2UserServiceApi.md

@@ -1,1261 +0,0 @@
-# Auth2UserServiceApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**auth2UserServiceAuthChangeEmail**](#auth2userserviceauthchangeemail) | **POST** /authed/v1/change-email | |
-|[**auth2UserServiceAuthChangePassword**](#auth2userserviceauthchangepassword) | **POST** /authed/v1/change-password | |
-|[**auth2UserServiceAuthDeleteUser**](#auth2userserviceauthdeleteuser) | **POST** /authed/v1/delete-user | |
-|[**auth2UserServiceAuthGetAccessToken**](#auth2userserviceauthgetaccesstoken) | **POST** /authed/v1/get-access-token | |
-|[**auth2UserServiceAuthGetAccountInfo**](#auth2userserviceauthgetaccountinfo) | **GET** /authed/v1/account-info | |
-|[**auth2UserServiceAuthGetSession**](#auth2userserviceauthgetsession) | **GET** /authed/v1/get-session | |
-|[**auth2UserServiceAuthLinkSocial**](#auth2userserviceauthlinksocial) | **POST** /authed/v1/link-social | |
-|[**auth2UserServiceAuthListAccounts**](#auth2userserviceauthlistaccounts) | **GET** /authed/v1/list-accounts | |
-|[**auth2UserServiceAuthListSessions**](#auth2userserviceauthlistsessions) | **GET** /authed/v1/list-sessions | |
-|[**auth2UserServiceAuthOAuth2Callback**](#auth2userserviceauthoauth2callback) | **GET** /oauth2/{platform}/callback | |
-|[**auth2UserServiceAuthRefreshToken**](#auth2userserviceauthrefreshtoken) | **POST** /authed/v1/refresh-token | |
-|[**auth2UserServiceAuthRequestPasswordReset**](#auth2userserviceauthrequestpasswordreset) | **POST** /authed/v1/request-password-reset | |
-|[**auth2UserServiceAuthResetPassword**](#auth2userserviceauthresetpassword) | **POST** /authed/v1/reset-password | |
-|[**auth2UserServiceAuthRevokeOtherSessions**](#auth2userserviceauthrevokeothersessions) | **POST** /authed/v1/revoke-other-sessions | |
-|[**auth2UserServiceAuthRevokeSession**](#auth2userserviceauthrevokesession) | **POST** /authed/v1/revoke-session | |
-|[**auth2UserServiceAuthRevokeSessions**](#auth2userserviceauthrevokesessions) | **POST** /authed/v1/revoke-sessions | |
-|[**auth2UserServiceAuthSendVerificationEmail**](#auth2userserviceauthsendverificationemail) | **POST** /authed/v1/send-verification-email | |
-|[**auth2UserServiceAuthSignInEmail**](#auth2userserviceauthsigninemail) | **POST** /auth/v1/sign-in/email | |
-|[**auth2UserServiceAuthSignInSocial**](#auth2userserviceauthsigninsocial) | **POST** /auth/v1/sign-in/social | |
-|[**auth2UserServiceAuthSignOut**](#auth2userserviceauthsignout) | **POST** /authed/v1/sign-out | |
-|[**auth2UserServiceAuthSignUpEmail**](#auth2userserviceauthsignupemail) | **POST** /auth/v1/sign-up/email | |
-|[**auth2UserServiceAuthUnlinkAccount**](#auth2userserviceauthunlinkaccount) | **POST** /authed/v1/unlink-account | |
-|[**auth2UserServiceAuthUpdateUser**](#auth2userserviceauthupdateuser) | **POST** /authed/v1/update-user | |
-|[**auth2UserServiceAuthVerifyEmail**](#auth2userserviceauthverifyemail) | **GET** /authed/v1/verify-email | |
-
-# **auth2UserServiceAuthChangeEmail**
-> AuthChangeEmailResponse auth2UserServiceAuthChangeEmail(authChangeEmailRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthChangeEmailRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authChangeEmailRequest: AuthChangeEmailRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthChangeEmail(
-    authChangeEmailRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authChangeEmailRequest** | **AuthChangeEmailRequest**|  | |
-
-
-### Return type
-
-**AuthChangeEmailResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthChangePassword**
-> AuthChangePasswordResponse auth2UserServiceAuthChangePassword(authChangePasswordRequest)
-
-============ 密码管理 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthChangePasswordRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authChangePasswordRequest: AuthChangePasswordRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthChangePassword(
-    authChangePasswordRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authChangePasswordRequest** | **AuthChangePasswordRequest**|  | |
-
-
-### Return type
-
-**AuthChangePasswordResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthDeleteUser**
-> AuthDeleteUserResponse auth2UserServiceAuthDeleteUser(authDeleteUserRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthDeleteUserRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authDeleteUserRequest: AuthDeleteUserRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthDeleteUser(
-    authDeleteUserRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authDeleteUserRequest** | **AuthDeleteUserRequest**|  | |
-
-
-### Return type
-
-**AuthDeleteUserResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthGetAccessToken**
-> AuthGetAccessTokenResponse auth2UserServiceAuthGetAccessToken(authGetAccessTokenRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthGetAccessTokenRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authGetAccessTokenRequest: AuthGetAccessTokenRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthGetAccessToken(
-    authGetAccessTokenRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authGetAccessTokenRequest** | **AuthGetAccessTokenRequest**|  | |
-
-
-### Return type
-
-**AuthGetAccessTokenResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthGetAccountInfo**
-> AuthGetAccountInfoResponse auth2UserServiceAuthGetAccountInfo()
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-const { status, data } = await apiInstance.auth2UserServiceAuthGetAccountInfo();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AuthGetAccountInfoResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthGetSession**
-> AuthGetSessionResponse auth2UserServiceAuthGetSession()
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-const { status, data } = await apiInstance.auth2UserServiceAuthGetSession();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AuthGetSessionResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthLinkSocial**
-> AuthLinkSocialResponse auth2UserServiceAuthLinkSocial(authLinkSocialRequest)
-
-============ 账号关联 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthLinkSocialRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authLinkSocialRequest: AuthLinkSocialRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthLinkSocial(
-    authLinkSocialRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authLinkSocialRequest** | **AuthLinkSocialRequest**|  | |
-
-
-### Return type
-
-**AuthLinkSocialResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthListAccounts**
-> AuthListAccountsResponse auth2UserServiceAuthListAccounts()
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-const { status, data } = await apiInstance.auth2UserServiceAuthListAccounts();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AuthListAccountsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthListSessions**
-> AuthListSessionsResponse auth2UserServiceAuthListSessions()
-
-============ 会话管理 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-const { status, data } = await apiInstance.auth2UserServiceAuthListSessions();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AuthListSessionsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthOAuth2Callback**
-> AuthOAuth2CallbackResponse auth2UserServiceAuthOAuth2Callback()
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let platform: string; // (default to undefined)
-let code: string; // (optional) (default to undefined)
-let state: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.auth2UserServiceAuthOAuth2Callback(
-    platform,
-    code,
-    state
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **platform** | [**string**] |  | defaults to undefined|
-| **code** | [**string**] |  | (optional) defaults to undefined|
-| **state** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**AuthOAuth2CallbackResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthRefreshToken**
-> AuthRefreshTokenResponse auth2UserServiceAuthRefreshToken(authRefreshTokenRequest)
-
-============ Token 管理 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthRefreshTokenRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authRefreshTokenRequest: AuthRefreshTokenRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthRefreshToken(
-    authRefreshTokenRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authRefreshTokenRequest** | **AuthRefreshTokenRequest**|  | |
-
-
-### Return type
-
-**AuthRefreshTokenResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthRequestPasswordReset**
-> AuthRequestPasswordResetResponse auth2UserServiceAuthRequestPasswordReset(authRequestPasswordResetRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthRequestPasswordResetRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authRequestPasswordResetRequest: AuthRequestPasswordResetRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthRequestPasswordReset(
-    authRequestPasswordResetRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authRequestPasswordResetRequest** | **AuthRequestPasswordResetRequest**|  | |
-
-
-### Return type
-
-**AuthRequestPasswordResetResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthResetPassword**
-> AuthResetPasswordResponse auth2UserServiceAuthResetPassword(authResetPasswordRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthResetPasswordRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authResetPasswordRequest: AuthResetPasswordRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthResetPassword(
-    authResetPasswordRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authResetPasswordRequest** | **AuthResetPasswordRequest**|  | |
-
-
-### Return type
-
-**AuthResetPasswordResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthRevokeOtherSessions**
-> AuthRevokeOtherSessionsResponse auth2UserServiceAuthRevokeOtherSessions(body)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let body: object; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthRevokeOtherSessions(
-    body
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-
-
-### Return type
-
-**AuthRevokeOtherSessionsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthRevokeSession**
-> AuthRevokeSessionResponse auth2UserServiceAuthRevokeSession(authRevokeSessionRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthRevokeSessionRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authRevokeSessionRequest: AuthRevokeSessionRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthRevokeSession(
-    authRevokeSessionRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authRevokeSessionRequest** | **AuthRevokeSessionRequest**|  | |
-
-
-### Return type
-
-**AuthRevokeSessionResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthRevokeSessions**
-> AuthRevokeSessionsResponse auth2UserServiceAuthRevokeSessions(body)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let body: object; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthRevokeSessions(
-    body
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-
-
-### Return type
-
-**AuthRevokeSessionsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthSendVerificationEmail**
-> AuthSendVerificationEmailResponse auth2UserServiceAuthSendVerificationEmail(authSendVerificationEmailRequest)
-
-============ 邮箱验证 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthSendVerificationEmailRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authSendVerificationEmailRequest: AuthSendVerificationEmailRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthSendVerificationEmail(
-    authSendVerificationEmailRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authSendVerificationEmailRequest** | **AuthSendVerificationEmailRequest**|  | |
-
-
-### Return type
-
-**AuthSendVerificationEmailResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthSignInEmail**
-> AuthSignInEmailResponse auth2UserServiceAuthSignInEmail(authSignInEmailRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthSignInEmailRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authSignInEmailRequest: AuthSignInEmailRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthSignInEmail(
-    authSignInEmailRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authSignInEmailRequest** | **AuthSignInEmailRequest**|  | |
-
-
-### Return type
-
-**AuthSignInEmailResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthSignInSocial**
-> AuthSignInSocialResponse auth2UserServiceAuthSignInSocial(authSignInSocialRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthSignInSocialRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authSignInSocialRequest: AuthSignInSocialRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthSignInSocial(
-    authSignInSocialRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authSignInSocialRequest** | **AuthSignInSocialRequest**|  | |
-
-
-### Return type
-
-**AuthSignInSocialResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthSignOut**
-> AuthSignOutResponse auth2UserServiceAuthSignOut(body)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let body: object; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthSignOut(
-    body
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-
-
-### Return type
-
-**AuthSignOutResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthSignUpEmail**
-> AuthSignUpEmailResponse auth2UserServiceAuthSignUpEmail(authSignUpEmailRequest)
-
-============ 认证 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthSignUpEmailRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authSignUpEmailRequest: AuthSignUpEmailRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthSignUpEmail(
-    authSignUpEmailRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authSignUpEmailRequest** | **AuthSignUpEmailRequest**|  | |
-
-
-### Return type
-
-**AuthSignUpEmailResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthUnlinkAccount**
-> AuthUnlinkAccountResponse auth2UserServiceAuthUnlinkAccount(authUnlinkAccountRequest)
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthUnlinkAccountRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authUnlinkAccountRequest: AuthUnlinkAccountRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthUnlinkAccount(
-    authUnlinkAccountRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authUnlinkAccountRequest** | **AuthUnlinkAccountRequest**|  | |
-
-
-### Return type
-
-**AuthUnlinkAccountResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthUpdateUser**
-> AuthUpdateUserResponse auth2UserServiceAuthUpdateUser(authUpdateUserRequest)
-
-============ 用户管理 ============
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration,
-    AuthUpdateUserRequest
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let authUpdateUserRequest: AuthUpdateUserRequest; //
-
-const { status, data } = await apiInstance.auth2UserServiceAuthUpdateUser(
-    authUpdateUserRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authUpdateUserRequest** | **AuthUpdateUserRequest**|  | |
-
-
-### Return type
-
-**AuthUpdateUserResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-
-# **auth2UserServiceAuthVerifyEmail**
-> AuthVerifyEmailResponse auth2UserServiceAuthVerifyEmail()
-
-
-### Example
-
-```typescript
-import {
-    Auth2UserServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new Auth2UserServiceApi(configuration);
-
-let email: string; // (optional) (default to undefined)
-let authCode: string; // (optional) (default to undefined)
-let callbackUrl: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.auth2UserServiceAuthVerifyEmail(
-    email,
-    authCode,
-    callbackUrl
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **email** | [**string**] |  | (optional) defaults to undefined|
-| **authCode** | [**string**] |  | (optional) defaults to undefined|
-| **callbackUrl** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**AuthVerifyEmailResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-
-[[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)
-