@cherryin/api-client 0.0.20 → 0.1.1

package/docs/Auth2AdminServiceApi.md

@@ -0,0 +1,469 @@
+# Auth2AdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**auth2AdminServiceAuthAdminChangePassword**](#auth2adminserviceauthadminchangepassword) | **POST** /admin/authed/change-password | |
+|[**auth2AdminServiceAuthAdminGetSession**](#auth2adminserviceauthadmingetsession) | **GET** /admin/authed/get-session | |
+|[**auth2AdminServiceAuthAdminListSessions**](#auth2adminserviceauthadminlistsessions) | **GET** /admin/authed/list-sessions | |
+|[**auth2AdminServiceAuthAdminRevokeOtherSessions**](#auth2adminserviceauthadminrevokeothersessions) | **POST** /admin/authed/revoke-other-sessions | |
+|[**auth2AdminServiceAuthAdminRevokeSession**](#auth2adminserviceauthadminrevokesession) | **POST** /admin/authed/revoke-session | |
+|[**auth2AdminServiceAuthAdminRevokeSessions**](#auth2adminserviceauthadminrevokesessions) | **POST** /admin/authed/revoke-sessions | |
+|[**auth2AdminServiceAuthAdminSignInEmail**](#auth2adminserviceauthadminsigninemail) | **POST** /admin/auth/sign-in/email | |
+|[**auth2AdminServiceAuthAdminSignOut**](#auth2adminserviceauthadminsignout) | **POST** /admin/authed/sign-out | |
+|[**auth2AdminServiceAuthAdminUpdateUser**](#auth2adminserviceauthadminupdateuser) | **POST** /admin/authed/update-user | |
+
+# **auth2AdminServiceAuthAdminChangePassword**
+> AuthAdminChangePasswordResponse auth2AdminServiceAuthAdminChangePassword(authAdminChangePasswordRequest)
+
+============ 密码管理 ============
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration,
+    AuthAdminChangePasswordRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let authAdminChangePasswordRequest: AuthAdminChangePasswordRequest; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminChangePassword(
+    authAdminChangePasswordRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **authAdminChangePasswordRequest** | **AuthAdminChangePasswordRequest**|  | |
+
+
+### Return type
+
+**AuthAdminChangePasswordResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminGetSession**
+> AuthAdminGetSessionResponse auth2AdminServiceAuthAdminGetSession()
+
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminGetSession();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuthAdminGetSessionResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminListSessions**
+> AuthAdminListSessionsResponse auth2AdminServiceAuthAdminListSessions()
+
+============ 会话管理 ============
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminListSessions();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuthAdminListSessionsResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminRevokeOtherSessions**
+> AuthAdminRevokeOtherSessionsResponse auth2AdminServiceAuthAdminRevokeOtherSessions(body)
+
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let body: object; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminRevokeOtherSessions(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**AuthAdminRevokeOtherSessionsResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminRevokeSession**
+> AuthAdminRevokeSessionResponse auth2AdminServiceAuthAdminRevokeSession(authAdminRevokeSessionRequest)
+
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration,
+    AuthAdminRevokeSessionRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let authAdminRevokeSessionRequest: AuthAdminRevokeSessionRequest; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminRevokeSession(
+    authAdminRevokeSessionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **authAdminRevokeSessionRequest** | **AuthAdminRevokeSessionRequest**|  | |
+
+
+### Return type
+
+**AuthAdminRevokeSessionResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminRevokeSessions**
+> AuthAdminRevokeSessionsResponse auth2AdminServiceAuthAdminRevokeSessions(body)
+
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let body: object; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminRevokeSessions(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**AuthAdminRevokeSessionsResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminSignInEmail**
+> AuthAdminSignInEmailResponse auth2AdminServiceAuthAdminSignInEmail(authAdminSignInEmailRequest)
+
+============ 认证 ============
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration,
+    AuthAdminSignInEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let authAdminSignInEmailRequest: AuthAdminSignInEmailRequest; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminSignInEmail(
+    authAdminSignInEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **authAdminSignInEmailRequest** | **AuthAdminSignInEmailRequest**|  | |
+
+
+### Return type
+
+**AuthAdminSignInEmailResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminSignOut**
+> AuthAdminSignOutResponse auth2AdminServiceAuthAdminSignOut(body)
+
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let body: object; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminSignOut(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**AuthAdminSignOutResponse**
+
+### 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)
+
+# **auth2AdminServiceAuthAdminUpdateUser**
+> AuthAdminUpdateUserResponse auth2AdminServiceAuthAdminUpdateUser(authAdminUpdateUserRequest)
+
+============ 管理员信息管理 ============
+
+### Example
+
+```typescript
+import {
+    Auth2AdminServiceApi,
+    Configuration,
+    AuthAdminUpdateUserRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new Auth2AdminServiceApi(configuration);
+
+let authAdminUpdateUserRequest: AuthAdminUpdateUserRequest; //
+
+const { status, data } = await apiInstance.auth2AdminServiceAuthAdminUpdateUser(
+    authAdminUpdateUserRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **authAdminUpdateUserRequest** | **AuthAdminUpdateUserRequest**|  | |
+
+
+### Return type
+
+**AuthAdminUpdateUserResponse**
+
+### 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)
+

package/docs/Auth2AdminSession.md

@@ -0,0 +1,35 @@
+# Auth2AdminSession
+
+管理员会话信息 (映射 db.UserSession)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**ip_address** | **string** |  | [optional] [default to undefined]
+**user_agent** | **string** |  | [optional] [default to undefined]
+**user_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Auth2AdminSession } from '@cherryin/api-client';
+
+const instance: Auth2AdminSession = {
+    id,
+    token,
+    expires_at,
+    created_at,
+    updated_at,
+    ip_address,
+    user_agent,
+    user_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{AuthIdToken.md → Auth2IdToken.md}

@@ -1,4 +1,4 @@
-# AuthIdToken
+# Auth2IdToken
 
 社交登录 ID Token
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { AuthIdToken } from '@cherryin/api-client';
+import { Auth2IdToken } from '@cherryin/api-client';
 
-const instance: AuthIdToken = {
+const instance: Auth2IdToken = {
     token,
     nonce,
     access_token,

package/docs/Auth2Session.md

@@ -0,0 +1,35 @@
+# Auth2Session
+
+会话信息 (映射 db.UserSession)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**ip_address** | **string** |  | [optional] [default to undefined]
+**user_agent** | **string** |  | [optional] [default to undefined]
+**user_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Auth2Session } from '@cherryin/api-client';
+
+const instance: Auth2Session = {
+    id,
+    token,
+    expires_at,
+    created_at,
+    updated_at,
+    ip_address,
+    user_agent,
+    user_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Auth2User.md

@@ -0,0 +1,33 @@
+# Auth2User
+
+用户信息
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**email_verified** | **boolean** |  | [optional] [default to undefined]
+**image** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Auth2User } from '@cherryin/api-client';
+
+const instance: Auth2User = {
+    id,
+    name,
+    email,
+    email_verified,
+    image,
+    created_at,
+    updated_at,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)