npm - @cherryin/api-client - Versions diffs - 0.0.20 → 0.1.1 - Mend

@cherryin/api-client 0.0.20 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (323) hide show

package/docs/PassportAuthEnterpriseServiceApi.md DELETED Viewed

@@ -1,1170 +0,0 @@
-# PassportAuthEnterpriseServiceApi
-All URIs are relative to *http://localhost*
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword**](#passportauthenterpriseservicepassportauthenterprisechangepassword) | **POST** /passport/enterprise/authed/v1/password/change | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone**](#passportauthenterpriseservicepassportauthenterprisechangephone) | **POST** /passport/enterprise/authed/v1/phone/change | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseDelete**](#passportauthenterpriseservicepassportauthenterprisedelete) | **POST** /passport/enterprise/authed/v1/user/request-delete | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseGetSession**](#passportauthenterpriseservicepassportauthenterprisegetsession) | **GET** /passport/enterprise/authed/v1/session/get | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet**](#passportauthenterpriseservicepassportauthenterpriseinfoget) | **GET** /passport/enterprise/authed/v1/user/info | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseListSessions**](#passportauthenterpriseservicepassportauthenterpriselistsessions) | **GET** /passport/enterprise/authed/v1/sessions/list | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload**](#passportauthenterpriseservicepassportauthenterprisematerialupload) | **POST** /passport/enterprise/authed/v1/materials/upload | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState**](#passportauthenterpriseservicepassportauthenterprisematerialverifystate) | **POST** /passport/enterprise/authed/v1/materials/verified-state | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken**](#passportauthenterpriseservicepassportauthenterpriserefreshtoken) | **POST** /passport/enterprise/authed/v1/session/refresh-token | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword**](#passportauthenterpriseservicepassportauthenterpriseresetpassword) | **POST** /passport/enterprise/authed/v1/password/request-reset | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions**](#passportauthenterpriseservicepassportauthenterpriserevokeothersessions) | **POST** /passport/enterprise/authed/v1/sessions/revoke-other | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession**](#passportauthenterpriseservicepassportauthenterpriserevokesession) | **POST** /passport/enterprise/authed/v1/session/revoke | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions**](#passportauthenterpriseservicepassportauthenterpriserevokesessions) | **POST** /passport/enterprise/authed/v1/sessions/revoke-all | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseSignOut**](#passportauthenterpriseservicepassportauthenterprisesignout) | **POST** /passport/enterprise/authed/v1/sign-out | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo**](#passportauthenterpriseservicepassportauthenterpriseupdateinfo) | **POST** /passport/enterprise/authed/v1/user/update-info | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail**](#passportauthenterpriseservicepassportauthenterpriseverifyemail) | **POST** /passport/enterprise/auth/v1/password/request-reset | |
-|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone**](#passportauthenterpriseservicepassportauthenterpriseverifyphone) | **GET** /passport/enterprise/authed/v1/phone/verify | |
-|[**passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail**](#passportauthenterpriseservicepassportenterprisesendverificationemail) | **POST** /passport/enterprise/auth/v1/verification/send-email | |
-|[**passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone**](#passportauthenterpriseservicepassportenterprisesendverificationphone) | **POST** /passport/enterprise/auth/v1/verification/send-phone | |
-|[**passportAuthEnterpriseServicePassportEnterpriseSignInEmail**](#passportauthenterpriseservicepassportenterprisesigninemail) | **POST** /passport/enterprise/auth/v1/sign-in/email | |
-|[**passportAuthEnterpriseServicePassportEnterpriseSignInPhone**](#passportauthenterpriseservicepassportenterprisesigninphone) | **POST** /passport/enterprise/auth/v1/sign-in/phone | |
-|[**passportAuthEnterpriseServicePassportEnterpriseSignUpEmail**](#passportauthenterpriseservicepassportenterprisesignupemail) | **POST** /passport/enterprise/auth/v1/sign-up/email | |
-# **passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword**
-> PassportAuthEnterpriseChangePasswordResponse passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword(passportAuthEnterpriseChangePasswordRequest)
-已登录用户修改密码
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseChangePasswordRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseChangePasswordRequest: PassportAuthEnterpriseChangePasswordRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword(
-    passportAuthEnterpriseChangePasswordRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseChangePasswordRequest** | **PassportAuthEnterpriseChangePasswordRequest**|  | |
-### Return type
-**PassportAuthEnterpriseChangePasswordResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone**
-> PassportAuthEnterpriseChangePhoneResponse passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone(passportAuthEnterpriseChangePhoneRequest)
-已登录用户更换手机号
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseChangePhoneRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseChangePhoneRequest: PassportAuthEnterpriseChangePhoneRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone(
-    passportAuthEnterpriseChangePhoneRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseChangePhoneRequest** | **PassportAuthEnterpriseChangePhoneRequest**|  | |
-### Return type
-**PassportAuthEnterpriseChangePhoneResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseDelete**
-> PassportAuthEnterpriseDeleteResponse passportAuthEnterpriseServicePassportAuthEnterpriseDelete(passportAuthEnterpriseDeleteRequest)
-请求删除用户
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseDeleteRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseDeleteRequest: PassportAuthEnterpriseDeleteRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseDelete(
-    passportAuthEnterpriseDeleteRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseDeleteRequest** | **PassportAuthEnterpriseDeleteRequest**|  | |
-### Return type
-**PassportAuthEnterpriseDeleteResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseGetSession**
-> PassportAuthEnterpriseGetSessionResponse passportAuthEnterpriseServicePassportAuthEnterpriseGetSession()
-获取当前会话信息
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseGetSession();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-**PassportAuthEnterpriseGetSessionResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet**
-> PassportAuthEnterpriseInfoGetResponse passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet()
-获取用户信息
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-**PassportAuthEnterpriseInfoGetResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseListSessions**
-> PassportAuthEnterpriseListSessionsResponse passportAuthEnterpriseServicePassportAuthEnterpriseListSessions()
-获取当前用户的所有会话列表
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseListSessions();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-**PassportAuthEnterpriseListSessionsResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload**
-> PassportAuthEnterpriseMaterialUploadResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload(passportAuthEnterpriseMaterialUploadRequest)
-上传企业认证材料
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseMaterialUploadRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseMaterialUploadRequest: PassportAuthEnterpriseMaterialUploadRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload(
-    passportAuthEnterpriseMaterialUploadRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseMaterialUploadRequest** | **PassportAuthEnterpriseMaterialUploadRequest**|  | |
-### Return type
-**PassportAuthEnterpriseMaterialUploadResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState**
-> PassportAuthEnterpriseMaterialVerifyStateResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState(body)
-获取企业认证材料审核状态
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let body: object; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-**PassportAuthEnterpriseMaterialVerifyStateResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken**
-> PassportAuthEnterpriseRefreshTokenResponse passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken(passportAuthEnterpriseRefreshTokenRequest)
-会话 token 刷新
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseRefreshTokenRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseRefreshTokenRequest: PassportAuthEnterpriseRefreshTokenRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken(
-    passportAuthEnterpriseRefreshTokenRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseRefreshTokenRequest** | **PassportAuthEnterpriseRefreshTokenRequest**|  | |
-### Return type
-**PassportAuthEnterpriseRefreshTokenResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword**
-> PassportAuthEnterpriseResetPasswordResponse passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword(passportAuthEnterpriseResetPasswordRequest)
-已登录用户重置密码
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseResetPasswordRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseResetPasswordRequest: PassportAuthEnterpriseResetPasswordRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword(
-    passportAuthEnterpriseResetPasswordRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseResetPasswordRequest** | **PassportAuthEnterpriseResetPasswordRequest**|  | |
-### Return type
-**PassportAuthEnterpriseResetPasswordResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions**
-> PassportAuthEnterpriseRevokeOtherSessionsResponse passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions(body)
-注销其他会话
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let body: object; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-**PassportAuthEnterpriseRevokeOtherSessionsResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession**
-> PassportAuthEnterpriseRevokeSessionResponse passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession(passportAuthEnterpriseRevokeSessionRequest)
-注销指定会话
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseRevokeSessionRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseRevokeSessionRequest: PassportAuthEnterpriseRevokeSessionRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession(
-    passportAuthEnterpriseRevokeSessionRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseRevokeSessionRequest** | **PassportAuthEnterpriseRevokeSessionRequest**|  | |
-### Return type
-**PassportAuthEnterpriseRevokeSessionResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions**
-> PassportAuthEnterpriseRevokeSessionsResponse passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions(body)
-注销所有会话
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let body: object; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-**PassportAuthEnterpriseRevokeSessionsResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseSignOut**
-> PassportAuthEnterpriseSignOutResponse passportAuthEnterpriseServicePassportAuthEnterpriseSignOut(passportAuthEnterpriseSignOutRequest)
-用户登出
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseSignOutRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseSignOutRequest: PassportAuthEnterpriseSignOutRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseSignOut(
-    passportAuthEnterpriseSignOutRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseSignOutRequest** | **PassportAuthEnterpriseSignOutRequest**|  | |
-### Return type
-**PassportAuthEnterpriseSignOutResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo**
-> PassportAuthEnterpriseUpdateInfoResponse passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo(passportAuthEnterpriseUpdateInfoRequest)
-更新用户信息
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseUpdateInfoRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseUpdateInfoRequest: PassportAuthEnterpriseUpdateInfoRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo(
-    passportAuthEnterpriseUpdateInfoRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseUpdateInfoRequest** | **PassportAuthEnterpriseUpdateInfoRequest**|  | |
-### Return type
-**PassportAuthEnterpriseUpdateInfoResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail**
-> PassportAuthEnterpriseVerifyEmailResponse passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail(passportAuthEnterpriseVerifyEmailRequest)
-已登录用户验证邮箱
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportAuthEnterpriseVerifyEmailRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportAuthEnterpriseVerifyEmailRequest: PassportAuthEnterpriseVerifyEmailRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail(
-    passportAuthEnterpriseVerifyEmailRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportAuthEnterpriseVerifyEmailRequest** | **PassportAuthEnterpriseVerifyEmailRequest**|  | |
-### Return type
-**PassportAuthEnterpriseVerifyEmailResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone**
-> PassportAuthEnterpriseVerifyPhoneResponse passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone()
-已登录用户验证手机号
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let phone: string; // (optional) (default to undefined)
-let verifyCode: string; // (optional) (default to undefined)
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone(
-    phone,
-    verifyCode
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **phone** | [**string**] |  | (optional) defaults to undefined|
-| **verifyCode** | [**string**] |  | (optional) defaults to undefined|
-### Return type
-**PassportAuthEnterpriseVerifyPhoneResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail**
-> PassportEnterpriseSendVerificationEmailResponse passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail(passportEnterpriseSendVerificationEmailRequest)
-登录/注册流程中发送验证码
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportEnterpriseSendVerificationEmailRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportEnterpriseSendVerificationEmailRequest: PassportEnterpriseSendVerificationEmailRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail(
-    passportEnterpriseSendVerificationEmailRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportEnterpriseSendVerificationEmailRequest** | **PassportEnterpriseSendVerificationEmailRequest**|  | |
-### Return type
-**PassportEnterpriseSendVerificationEmailResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone**
-> PassportEnterpriseSendVerificationPhoneResponse passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone(passportEnterpriseSendVerificationPhoneRequest)
-登录/注册流程中发送验证码
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportEnterpriseSendVerificationPhoneRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportEnterpriseSendVerificationPhoneRequest: PassportEnterpriseSendVerificationPhoneRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone(
-    passportEnterpriseSendVerificationPhoneRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportEnterpriseSendVerificationPhoneRequest** | **PassportEnterpriseSendVerificationPhoneRequest**|  | |
-### Return type
-**PassportEnterpriseSendVerificationPhoneResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportEnterpriseSignInEmail**
-> PassportEnterpriseSignInEmailResponse passportAuthEnterpriseServicePassportEnterpriseSignInEmail(passportEnterpriseSignInEmailRequest)
-邮箱登录
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportEnterpriseSignInEmailRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportEnterpriseSignInEmailRequest: PassportEnterpriseSignInEmailRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSignInEmail(
-    passportEnterpriseSignInEmailRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportEnterpriseSignInEmailRequest** | **PassportEnterpriseSignInEmailRequest**|  | |
-### Return type
-**PassportEnterpriseSignInEmailResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportEnterpriseSignInPhone**
-> PassportEnterpriseSignInPhoneResponse passportAuthEnterpriseServicePassportEnterpriseSignInPhone(passportEnterpriseSignInPhoneRequest)
-手机登录
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportEnterpriseSignInPhoneRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportEnterpriseSignInPhoneRequest: PassportEnterpriseSignInPhoneRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSignInPhone(
-    passportEnterpriseSignInPhoneRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportEnterpriseSignInPhoneRequest** | **PassportEnterpriseSignInPhoneRequest**|  | |
-### Return type
-**PassportEnterpriseSignInPhoneResponse**
-### 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)
-# **passportAuthEnterpriseServicePassportEnterpriseSignUpEmail**
-> PassportEnterpriseSignUpEmailResponse passportAuthEnterpriseServicePassportEnterpriseSignUpEmail(passportEnterpriseSignUpEmailRequest)
-邮箱注册
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseServiceApi,
-    Configuration,
-    PassportEnterpriseSignUpEmailRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
-let passportEnterpriseSignUpEmailRequest: PassportEnterpriseSignUpEmailRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSignUpEmail(
-    passportEnterpriseSignUpEmailRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportEnterpriseSignUpEmailRequest** | **PassportEnterpriseSignUpEmailRequest**|  | |
-### Return type
-**PassportEnterpriseSignUpEmailResponse**
-### 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)