@cherryin/api-client 0.0.8 → 0.0.9

package/docs/PassportAuthAdminServiceApi.md

@@ -0,0 +1,469 @@
+# PassportAuthAdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**passportAuthAdminServicePassportAuthAdminChangePassword**](#passportauthadminservicepassportauthadminchangepassword) | **POST** /passport/admin/authed/change-password | |
+|[**passportAuthAdminServicePassportAuthAdminGetSession**](#passportauthadminservicepassportauthadmingetsession) | **GET** /passport/admin/authed/get-session | |
+|[**passportAuthAdminServicePassportAuthAdminListSessions**](#passportauthadminservicepassportauthadminlistsessions) | **GET** /passport/admin/authed/list-sessions | |
+|[**passportAuthAdminServicePassportAuthAdminRevokeOtherSessions**](#passportauthadminservicepassportauthadminrevokeothersessions) | **POST** /passport/admin/authed/revoke-other-sessions | |
+|[**passportAuthAdminServicePassportAuthAdminRevokeSession**](#passportauthadminservicepassportauthadminrevokesession) | **POST** /passport/admin/authed/revoke-session | |
+|[**passportAuthAdminServicePassportAuthAdminRevokeSessions**](#passportauthadminservicepassportauthadminrevokesessions) | **POST** /passport/admin/authed/revoke-sessions | |
+|[**passportAuthAdminServicePassportAuthAdminSignInEmail**](#passportauthadminservicepassportauthadminsigninemail) | **POST** /passport/admin/auth/sign-in/email | |
+|[**passportAuthAdminServicePassportAuthAdminSignOut**](#passportauthadminservicepassportauthadminsignout) | **POST** /passport/admin/authed/sign-out | |
+|[**passportAuthAdminServicePassportAuthAdminUpdateUser**](#passportauthadminservicepassportauthadminupdateuser) | **POST** /passport/admin/authed/update-user | |
+
+# **passportAuthAdminServicePassportAuthAdminChangePassword**
+> PassportAuthAdminChangePasswordResponse passportAuthAdminServicePassportAuthAdminChangePassword(passportAuthAdminChangePasswordRequest)
+
+============ 密码管理 ============
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration,
+    PassportAuthAdminChangePasswordRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let passportAuthAdminChangePasswordRequest: PassportAuthAdminChangePasswordRequest; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminChangePassword(
+    passportAuthAdminChangePasswordRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthAdminChangePasswordRequest** | **PassportAuthAdminChangePasswordRequest**|  | |
+
+
+### Return type
+
+**PassportAuthAdminChangePasswordResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminGetSession**
+> PassportAuthAdminGetSessionResponse passportAuthAdminServicePassportAuthAdminGetSession()
+
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminGetSession();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**PassportAuthAdminGetSessionResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminListSessions**
+> PassportAuthAdminListSessionsResponse passportAuthAdminServicePassportAuthAdminListSessions()
+
+============ 会话管理 ============
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminListSessions();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**PassportAuthAdminListSessionsResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminRevokeOtherSessions**
+> PassportAuthAdminRevokeOtherSessionsResponse passportAuthAdminServicePassportAuthAdminRevokeOtherSessions(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let body: object; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminRevokeOtherSessions(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**PassportAuthAdminRevokeOtherSessionsResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminRevokeSession**
+> PassportAuthAdminRevokeSessionResponse passportAuthAdminServicePassportAuthAdminRevokeSession(passportAuthAdminRevokeSessionRequest)
+
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration,
+    PassportAuthAdminRevokeSessionRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let passportAuthAdminRevokeSessionRequest: PassportAuthAdminRevokeSessionRequest; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminRevokeSession(
+    passportAuthAdminRevokeSessionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthAdminRevokeSessionRequest** | **PassportAuthAdminRevokeSessionRequest**|  | |
+
+
+### Return type
+
+**PassportAuthAdminRevokeSessionResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminRevokeSessions**
+> PassportAuthAdminRevokeSessionsResponse passportAuthAdminServicePassportAuthAdminRevokeSessions(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let body: object; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminRevokeSessions(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**PassportAuthAdminRevokeSessionsResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminSignInEmail**
+> PassportAuthAdminSignInEmailResponse passportAuthAdminServicePassportAuthAdminSignInEmail(passportAuthAdminSignInEmailRequest)
+
+============ 认证 ============
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration,
+    PassportAuthAdminSignInEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let passportAuthAdminSignInEmailRequest: PassportAuthAdminSignInEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminSignInEmail(
+    passportAuthAdminSignInEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthAdminSignInEmailRequest** | **PassportAuthAdminSignInEmailRequest**|  | |
+
+
+### Return type
+
+**PassportAuthAdminSignInEmailResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminSignOut**
+> PassportAuthAdminSignOutResponse passportAuthAdminServicePassportAuthAdminSignOut(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let body: object; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminSignOut(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**PassportAuthAdminSignOutResponse**
+
+### 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)
+
+# **passportAuthAdminServicePassportAuthAdminUpdateUser**
+> PassportAuthAdminUpdateUserResponse passportAuthAdminServicePassportAuthAdminUpdateUser(passportAuthAdminUpdateUserRequest)
+
+============ 管理员信息管理 ============
+
+### Example
+
+```typescript
+import {
+    PassportAuthAdminServiceApi,
+    Configuration,
+    PassportAuthAdminUpdateUserRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthAdminServiceApi(configuration);
+
+let passportAuthAdminUpdateUserRequest: PassportAuthAdminUpdateUserRequest; //
+
+const { status, data } = await apiInstance.passportAuthAdminServicePassportAuthAdminUpdateUser(
+    passportAuthAdminUpdateUserRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthAdminUpdateUserRequest** | **PassportAuthAdminUpdateUserRequest**|  | |
+
+
+### Return type
+
+**PassportAuthAdminUpdateUserResponse**
+
+### 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/PassportAuthAdminSignInEmailRequest.md

@@ -0,0 +1,26 @@
+# PassportAuthAdminSignInEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**session_type** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminSignInEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminSignInEmailRequest = {
+    email,
+    password,
+    session_type,
+    remember_me,
+};
+```
+
+[[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/PassportAuthAdminSignInEmailResponse.md

@@ -0,0 +1,26 @@
+# PassportAuthAdminSignInEmailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**user** | [**AuthAdminUser**](AuthAdminUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminSignInEmailResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminSignInEmailResponse = {
+    code,
+    message,
+    token,
+    user,
+};
+```
+
+[[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/PassportAuthAdminSignOutResponse.md

@@ -0,0 +1,22 @@
+# PassportAuthAdminSignOutResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminSignOutResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminSignOutResponse = {
+    code,
+    message,
+};
+```
+
+[[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/PassportAuthAdminUpdateUserRequest.md

@@ -0,0 +1,22 @@
+# PassportAuthAdminUpdateUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**image** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminUpdateUserRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminUpdateUserRequest = {
+    name,
+    image,
+};
+```
+
+[[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/PassportAuthAdminUpdateUserResponse.md

@@ -0,0 +1,24 @@
+# PassportAuthAdminUpdateUserResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**user** | [**AuthAdminUser**](AuthAdminUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminUpdateUserResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminUpdateUserResponse = {
+    code,
+    message,
+    user,
+};
+```
+
+[[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/PassportAuthUserChangeEmailRequest.md

@@ -0,0 +1,24 @@
+# PassportAuthUserChangeEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**new_email** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserChangeEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserChangeEmailRequest = {
+    app_ids,
+    new_email,
+    callback_url,
+};
+```
+
+[[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/PassportAuthUserChangeEmailResponse.md

@@ -0,0 +1,24 @@
+# PassportAuthUserChangeEmailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserChangeEmailResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserChangeEmailResponse = {
+    code,
+    message,
+    users,
+};
+```
+
+[[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/PassportAuthUserChangePasswordRequest.md

@@ -0,0 +1,26 @@
+# PassportAuthUserChangePasswordRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**new_password** | **string** |  | [optional] [default to undefined]
+**current_password** | **string** |  | [optional] [default to undefined]
+**revoke_other_sessions** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserChangePasswordRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserChangePasswordRequest = {
+    app_ids,
+    new_password,
+    current_password,
+    revoke_other_sessions,
+};
+```
+
+[[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/PassportAuthUserChangePasswordResponse.md

@@ -0,0 +1,26 @@
+# PassportAuthUserChangePasswordResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserChangePasswordResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserChangePasswordResponse = {
+    code,
+    message,
+    token,
+    users,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)