@cherryin/api-client 0.0.9 → 0.0.11
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.
- package/.openapi-generator/FILES +125 -46
- package/README.md +202 -87
- package/api.ts +4701 -1302
- package/dist/api.d.ts +3501 -1543
- package/dist/api.js +3191 -890
- package/dist/esm/api.d.ts +3501 -1543
- package/dist/esm/api.js +3191 -894
- package/docs/AIModelAdminServiceApi.md +6 -6
- package/docs/AdminEnterpriseMaterials.md +24 -0
- package/docs/AdminEnterpriseUser.md +24 -0
- package/docs/AdminEnterpriseUserMaterials.md +22 -0
- package/docs/AdminPassportItem.md +24 -0
- package/docs/AdminUserItem.md +26 -0
- package/docs/AuthAdminSession.md +39 -0
- package/docs/AuthAdminUser.md +2 -2
- package/docs/AuthEnterpriseMaterials.md +33 -0
- package/docs/AuthEnterpriseSession.md +37 -0
- package/docs/AuthEnterpriseUser.md +37 -0
- package/docs/AuthPassport.md +8 -8
- package/docs/AuthUser.md +10 -10
- package/docs/AuthUserMethod.md +8 -8
- package/docs/AuthUserSession.md +10 -6
- package/docs/ConfigItem.md +4 -0
- package/docs/PassportAdminSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAdminSendVerificationEmailResponse.md +22 -0
- package/docs/{PassportAuthAdminSignInEmailRequest.md → PassportAdminSignInEmailRequest.md} +7 -5
- package/docs/PassportAdminSignInEmailResponse.md +26 -0
- package/docs/PassportAuthAdminChangePasswordResponse.md +2 -2
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +28 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +22 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewResponse.md +22 -0
- package/docs/{PassportAuthAdminSignInEmailResponse.md → PassportAuthAdminGetInfoResponse.md} +3 -5
- package/docs/PassportAuthAdminGetSessionResponse.md +1 -1
- package/docs/PassportAuthAdminListSessionsResponse.md +1 -1
- package/docs/PassportAuthAdminPassportDisableRequest.md +22 -0
- package/docs/PassportAuthAdminPassportDisableResponse.md +22 -0
- package/docs/PassportAuthAdminPassportListRequest.md +28 -0
- package/docs/PassportAuthAdminPassportListResponse.md +28 -0
- package/docs/PassportAuthAdminPassportModifyInfoRequest.md +28 -0
- package/docs/{PassportAuthUserRevokeOtherSessionsResponse.md → PassportAuthAdminPassportModifyInfoResponse.md} +5 -5
- package/docs/PassportAuthAdminServiceApi.md +637 -37
- package/docs/{PassportAuthAdminUpdateUserRequest.md → PassportAuthAdminUpdateInfoRequest.md} +5 -5
- package/docs/{PassportAuthAdminUpdateUserResponse.md → PassportAuthAdminUpdateInfoResponse.md} +3 -3
- package/docs/PassportAuthAdminUserDisableRequest.md +26 -0
- package/docs/{PassportAuthUserRevokeSessionsResponse.md → PassportAuthAdminUserDisableResponse.md} +3 -3
- package/docs/PassportAuthAdminUserListRequest.md +28 -0
- package/docs/PassportAuthAdminUserListResponse.md +28 -0
- package/docs/PassportAuthAdminUserModifyInfoRequest.md +32 -0
- package/docs/PassportAuthAdminUserModifyInfoResponse.md +24 -0
- package/docs/PassportAuthAdminUserModifyPermissionRequest.md +22 -0
- package/docs/{PassportAuthUserSendVerificationEmailResponse.md → PassportAuthAdminUserModifyPermissionResponse.md} +5 -3
- package/docs/{PassportAuthUserChangePasswordRequest.md → PassportAuthChangePasswordRequest.md} +3 -3
- package/docs/{PassportAuthUserSignInPhoneResponse.md → PassportAuthChangePasswordResponse.md} +3 -5
- package/docs/{PassportAuthUserDeletePassportRequest.md → PassportAuthDeleteAllRequest.md} +9 -3
- package/docs/PassportAuthDeleteAllResponse.md +22 -0
- package/docs/PassportAuthEnterpriseChangePasswordRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePasswordResponse.md +26 -0
- package/docs/PassportAuthEnterpriseChangePhoneRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePhoneResponse.md +22 -0
- package/docs/PassportAuthEnterpriseDeleteRequest.md +28 -0
- package/docs/PassportAuthEnterpriseDeleteResponse.md +22 -0
- package/docs/PassportAuthEnterpriseGetSessionResponse.md +24 -0
- package/docs/{PassportAuthUserGetAccountInfoResponse.md → PassportAuthEnterpriseInfoGetResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +24 -0
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +26 -0
- package/docs/{PassportAuthUserRequestPasswordResetResponse.md → PassportAuthEnterpriseMaterialUploadResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +24 -0
- package/docs/PassportAuthEnterpriseRefreshTokenRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRefreshTokenResponse.md +24 -0
- package/docs/PassportAuthEnterpriseResetPasswordRequest.md +22 -0
- package/docs/PassportAuthEnterpriseResetPasswordResponse.md +22 -0
- package/docs/{PassportAuthUserDeletePassportResponse.md → PassportAuthEnterpriseRevokeOtherSessionsResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseServiceApi.md +1170 -0
- package/docs/PassportAuthEnterpriseSignOutRequest.md +20 -0
- package/docs/{PassportAuthUserUnlinkAccountResponse.md → PassportAuthEnterpriseSignOutResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +22 -0
- package/docs/{PassportAuthUserChangePasswordResponse.md → PassportAuthEnterpriseUpdateInfoResponse.md} +3 -5
- package/docs/PassportAuthEnterpriseVerifyEmailRequest.md +24 -0
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +22 -0
- package/docs/{PassportAuthUserGetPassportInfoResponse.md → PassportAuthInfoGetResponse.md} +3 -3
- package/docs/{PassportAuthUserLinkSocialRequest.md → PassportAuthLinkSocialRequest.md} +3 -3
- package/docs/{PassportAuthUserLinkSocialResponse.md → PassportAuthLinkSocialResponse.md} +3 -3
- package/docs/{PassportAuthUserListMethodsResponse.md → PassportAuthListMethodsResponse.md} +3 -3
- package/docs/{PassportAuthUserListSessionsResponse.md → PassportAuthListSessionsResponse.md} +3 -3
- package/docs/{PassportAuthUserListAccountsResponse.md → PassportAuthListSocialsResponse.md} +3 -3
- package/docs/PassportAuthRefreshSessionTokenRequest.md +20 -0
- package/docs/PassportAuthRefreshSessionTokenResponse.md +24 -0
- package/docs/{PassportAuthUserResetPasswordRequest.md → PassportAuthResetPasswordRequest.md} +5 -5
- package/docs/PassportAuthResetPasswordResponse.md +22 -0
- package/docs/{PassportAuthUserRevokeOtherSessionsRequest.md → PassportAuthRevokeOtherSessionsRequest.md} +3 -3
- package/docs/{PassportAuthUserDeleteUserResponse.md → PassportAuthRevokeOtherSessionsResponse.md} +3 -3
- package/docs/{PassportAuthUserRevokeSessionRequest.md → PassportAuthRevokeSessionRequest.md} +3 -3
- package/docs/PassportAuthRevokeSessionResponse.md +22 -0
- package/docs/{PassportAuthUserRevokeSessionsRequest.md → PassportAuthRevokeSessionsRequest.md} +3 -3
- package/docs/PassportAuthRevokeSessionsResponse.md +22 -0
- package/docs/{PassportAuthUserSendVerificationEmailRequest.md → PassportAuthSendVerificationEmailRequest.md} +3 -3
- package/docs/PassportAuthSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAuthSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportAuthSendVerificationPhoneResponse.md +22 -0
- package/docs/{PassportAuthUserRefreshTokenRequest.md → PassportAuthSocialGetAccessTokenRequest.md} +3 -3
- package/docs/{PassportAuthUserRefreshTokenResponse.md → PassportAuthSocialGetAccessTokenResponse.md} +3 -3
- package/docs/{PassportAuthUserGetAccessTokenRequest.md → PassportAuthSocialRefreshTokenRequest.md} +3 -3
- package/docs/{PassportAuthUserGetAccessTokenResponse.md → PassportAuthSocialRefreshTokenResponse.md} +3 -3
- package/docs/{PassportAuthUserUnlinkAccountRequest.md → PassportAuthUnlinkSocialRequest.md} +3 -3
- package/docs/PassportAuthUnlinkSocialResponse.md +22 -0
- package/docs/PassportAuthUserChangePhoneRequest.md +4 -4
- package/docs/{PassportAuthUserDeleteUserRequest.md → PassportAuthUserDeleteRequest.md} +9 -3
- package/docs/PassportAuthUserDeleteResponse.md +22 -0
- package/docs/PassportAuthUserGetSessionResponse.md +2 -2
- package/docs/PassportAuthUserInfoGetResponse.md +24 -0
- package/docs/PassportAuthUserServiceApi.md +546 -329
- package/docs/PassportAuthUserSignOutResponse.md +0 -2
- package/docs/{PassportAuthUserUpdateUserRequest.md → PassportAuthUserUpdateInfoRequest.md} +3 -3
- package/docs/{PassportAuthUserUpdateUserResponse.md → PassportAuthUserUpdateInfoResponse.md} +3 -3
- package/docs/{PassportAuthUserRequestPasswordResetRequest.md → PassportAuthUserVerifyEmailRequest.md} +7 -5
- package/docs/PassportAuthUserVerifyEmailResponse.md +0 -2
- package/docs/PassportAuthUserVerifyPhoneRequest.md +24 -0
- package/docs/PassportAuthUserVerifyPhoneResponse.md +0 -2
- package/docs/PassportEnterprisePasswordResetRequest.md +24 -0
- package/docs/{PassportAuthUserSignUpEmailResponse.md → PassportEnterprisePasswordResetResponse.md} +5 -9
- package/docs/PassportEnterpriseSendVerificationEmailRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationEmailResponse.md +22 -0
- package/docs/PassportEnterpriseSendVerificationPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportEnterpriseSignInEmailRequest.md +30 -0
- package/docs/PassportEnterpriseSignInEmailResponse.md +30 -0
- package/docs/PassportEnterpriseSignInPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSignInPhoneResponse.md +26 -0
- package/docs/PassportEnterpriseSignUpEmailRequest.md +34 -0
- package/docs/PassportEnterpriseSignUpEmailResponse.md +26 -0
- package/docs/PassportSendVerificationEmailRequest.md +26 -0
- package/docs/{PassportAuthUserRevokeSessionResponse.md → PassportSendVerificationEmailResponse.md} +3 -3
- package/docs/PassportSendVerificationPhoneRequest.md +26 -0
- package/docs/{PassportAuthUserResetPasswordResponse.md → PassportSendVerificationPhoneResponse.md} +3 -3
- package/docs/{PassportAuthUserOAuthCallbackResponse.md → PassportUserOAuthCallbackResponse.md} +6 -6
- package/docs/PassportUserPasswordResetRequest.md +28 -0
- package/docs/PassportUserPasswordResetResponse.md +26 -0
- package/docs/{PassportAuthUserSignInEmailRequest.md → PassportUserSignInEmailRequest.md} +9 -5
- package/docs/{PassportAuthUserSignInSocialResponse.md → PassportUserSignInEmailResponse.md} +6 -6
- package/docs/{PassportAuthUserSignInPhoneRequest.md → PassportUserSignInPhoneRequest.md} +7 -5
- package/docs/PassportUserSignInPhoneResponse.md +28 -0
- package/docs/{PassportAuthUserSignInSocialRequest.md → PassportUserSignInSocialRequest.md} +5 -5
- package/docs/PassportUserSignInSocialResponse.md +32 -0
- package/docs/{PassportAuthUserSignUpEmailRequest.md → PassportUserSignUpEmailRequest.md} +8 -6
- package/docs/{PassportAuthUserSignInEmailResponse.md → PassportUserSignUpEmailResponse.md} +6 -6
- package/docs/RemoteConfigAdminServiceApi.md +18 -3
- package/docs/RemoteConfigItemGetResponse.md +2 -2
- package/docs/RemoteConfigItemUpdateRequest.md +6 -0
- package/docs/RemoteConfigItemUpdateResponse.md +2 -2
- package/package.json +1 -1
|
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**success** | **boolean** | | [optional] [default to undefined]
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,7 +16,6 @@ import { PassportAuthUserSignOutResponse } from '@cherryin/api-client';
|
|
|
17
16
|
const instance: PassportAuthUserSignOutResponse = {
|
|
18
17
|
code,
|
|
19
18
|
message,
|
|
20
|
-
success,
|
|
21
19
|
};
|
|
22
20
|
```
|
|
23
21
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportAuthUserUpdateInfoRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { PassportAuthUserUpdateInfoRequest } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: PassportAuthUserUpdateInfoRequest = {
|
|
18
18
|
app_ids,
|
|
19
19
|
name,
|
|
20
20
|
avatar_url,
|
package/docs/{PassportAuthUserUpdateUserResponse.md → PassportAuthUserUpdateInfoResponse.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportAuthUserUpdateInfoResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { PassportAuthUserUpdateInfoResponse } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: PassportAuthUserUpdateInfoResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
20
|
users,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportAuthUserVerifyEmailRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,17 +7,19 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
9
|
**email** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
14
15
|
```typescript
|
|
15
|
-
import {
|
|
16
|
+
import { PassportAuthUserVerifyEmailRequest } from '@cherryin/api-client';
|
|
16
17
|
|
|
17
|
-
const instance:
|
|
18
|
+
const instance: PassportAuthUserVerifyEmailRequest = {
|
|
18
19
|
app_ids,
|
|
19
20
|
email,
|
|
20
|
-
|
|
21
|
+
verify_code,
|
|
22
|
+
callback_url,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**users** | [**Array<AuthUser>**](AuthUser.md) | | [optional] [default to undefined]
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,7 +16,6 @@ import { PassportAuthUserVerifyEmailResponse } from '@cherryin/api-client';
|
|
|
17
16
|
const instance: PassportAuthUserVerifyEmailResponse = {
|
|
18
17
|
code,
|
|
19
18
|
message,
|
|
20
|
-
users,
|
|
21
19
|
};
|
|
22
20
|
```
|
|
23
21
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PassportAuthUserVerifyPhoneRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportAuthUserVerifyPhoneRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportAuthUserVerifyPhoneRequest = {
|
|
18
|
+
app_ids,
|
|
19
|
+
phone,
|
|
20
|
+
verify_code,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**users** | [**Array<AuthUser>**](AuthUser.md) | | [optional] [default to undefined]
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,7 +16,6 @@ import { PassportAuthUserVerifyPhoneResponse } from '@cherryin/api-client';
|
|
|
17
16
|
const instance: PassportAuthUserVerifyPhoneResponse = {
|
|
18
17
|
code,
|
|
19
18
|
message,
|
|
20
|
-
users,
|
|
21
19
|
};
|
|
22
20
|
```
|
|
23
21
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PassportEnterprisePasswordResetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
10
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportEnterprisePasswordResetRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportEnterprisePasswordResetRequest = {
|
|
18
|
+
email,
|
|
19
|
+
redirect,
|
|
20
|
+
callback_url,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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/{PassportAuthUserSignUpEmailResponse.md → PassportEnterprisePasswordResetResponse.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportEnterprisePasswordResetResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,23 +7,19 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
11
10
|
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**users** | [**Array<AuthUser>**](AuthUser.md) | | [optional] [default to undefined]
|
|
11
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
14
12
|
|
|
15
13
|
## Example
|
|
16
14
|
|
|
17
15
|
```typescript
|
|
18
|
-
import {
|
|
16
|
+
import { PassportEnterprisePasswordResetResponse } from '@cherryin/api-client';
|
|
19
17
|
|
|
20
|
-
const instance:
|
|
18
|
+
const instance: PassportEnterprisePasswordResetResponse = {
|
|
21
19
|
code,
|
|
22
20
|
message,
|
|
23
|
-
redirect,
|
|
24
21
|
url,
|
|
25
|
-
|
|
26
|
-
users,
|
|
22
|
+
redirect,
|
|
27
23
|
};
|
|
28
24
|
```
|
|
29
25
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PassportEnterpriseSendVerificationEmailRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**purpose** | **string** | 验证目的,可选值:verify_email(验证邮箱),change_email(更换邮箱) | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportEnterpriseSendVerificationEmailRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportEnterpriseSendVerificationEmailRequest = {
|
|
18
|
+
email,
|
|
19
|
+
callback_url,
|
|
20
|
+
purpose,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PassportEnterpriseSendVerificationEmailResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PassportEnterpriseSendVerificationEmailResponse } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PassportEnterpriseSendVerificationEmailResponse = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PassportEnterpriseSendVerificationPhoneRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**purpose** | **string** | 验证目的,可选值:verify_phone(验证手机号),change_phone(更换手机号) | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportEnterpriseSendVerificationPhoneRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportEnterpriseSendVerificationPhoneRequest = {
|
|
18
|
+
phone,
|
|
19
|
+
callback_url,
|
|
20
|
+
purpose,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PassportEnterpriseSendVerificationPhoneResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PassportEnterpriseSendVerificationPhoneResponse } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PassportEnterpriseSendVerificationPhoneResponse = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# PassportEnterpriseSignInEmailRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**password** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
|
|
12
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
13
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PassportEnterpriseSignInEmailRequest } from '@cherryin/api-client';
|
|
19
|
+
|
|
20
|
+
const instance: PassportEnterpriseSignInEmailRequest = {
|
|
21
|
+
email,
|
|
22
|
+
password,
|
|
23
|
+
verify_code,
|
|
24
|
+
remember_me,
|
|
25
|
+
redirect,
|
|
26
|
+
callback_url,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# PassportEnterpriseSignInEmailResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**session** | [**AuthEnterpriseSession**](AuthEnterpriseSession.md) | | [optional] [default to undefined]
|
|
13
|
+
**user** | [**AuthEnterpriseUser**](AuthEnterpriseUser.md) | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PassportEnterpriseSignInEmailResponse } from '@cherryin/api-client';
|
|
19
|
+
|
|
20
|
+
const instance: PassportEnterpriseSignInEmailResponse = {
|
|
21
|
+
code,
|
|
22
|
+
message,
|
|
23
|
+
redirect,
|
|
24
|
+
url,
|
|
25
|
+
session,
|
|
26
|
+
user,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PassportEnterpriseSignInPhoneRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**phone** | **string** | 手机号,E164 格式 | [optional] [default to undefined]
|
|
9
|
+
**verify_code** | **string** | 验证码 | [optional] [default to undefined]
|
|
10
|
+
**disable_sign_up** | **boolean** | 登录即注册,开启后默认是通过手机号登录验证通过,没有对应用户时会自动注册新用户 | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportEnterpriseSignInPhoneRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportEnterpriseSignInPhoneRequest = {
|
|
18
|
+
phone,
|
|
19
|
+
verify_code,
|
|
20
|
+
disable_sign_up,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PassportEnterpriseSignInPhoneResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**session** | [**AuthEnterpriseSession**](AuthEnterpriseSession.md) | | [optional] [default to undefined]
|
|
11
|
+
**user** | [**AuthEnterpriseUser**](AuthEnterpriseUser.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportEnterpriseSignInPhoneResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportEnterpriseSignInPhoneResponse = {
|
|
19
|
+
code,
|
|
20
|
+
message,
|
|
21
|
+
session,
|
|
22
|
+
user,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# PassportEnterpriseSignUpEmailRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**password** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**avatar_url** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
14
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { PassportEnterpriseSignUpEmailRequest } from '@cherryin/api-client';
|
|
21
|
+
|
|
22
|
+
const instance: PassportEnterpriseSignUpEmailRequest = {
|
|
23
|
+
email,
|
|
24
|
+
name,
|
|
25
|
+
password,
|
|
26
|
+
verify_code,
|
|
27
|
+
avatar_url,
|
|
28
|
+
redirect,
|
|
29
|
+
callback_url,
|
|
30
|
+
remember_me,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PassportEnterpriseSignUpEmailResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportEnterpriseSignUpEmailResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportEnterpriseSignUpEmailResponse = {
|
|
19
|
+
code,
|
|
20
|
+
message,
|
|
21
|
+
redirect,
|
|
22
|
+
url,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PassportSendVerificationEmailRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**purpose** | **string** | 验证目的,可选值:verify_email(验证邮箱),change_email(更换邮箱) | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportSendVerificationEmailRequest } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportSendVerificationEmailRequest = {
|
|
19
|
+
app_ids,
|
|
20
|
+
email,
|
|
21
|
+
callback_url,
|
|
22
|
+
purpose,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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/{PassportAuthUserRevokeSessionResponse.md → PassportSendVerificationEmailResponse.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportSendVerificationEmailResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { PassportSendVerificationEmailResponse } from '@cherryin/api-client';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: PassportSendVerificationEmailResponse = {
|
|
17
17
|
code,
|
|
18
18
|
message,
|
|
19
19
|
};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PassportSendVerificationPhoneRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**purpose** | **string** | 验证目的,可选值:verify_phone(验证手机号),change_phone(更换手机号) | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportSendVerificationPhoneRequest } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportSendVerificationPhoneRequest = {
|
|
19
|
+
app_ids,
|
|
20
|
+
phone,
|
|
21
|
+
callback_url,
|
|
22
|
+
purpose,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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/{PassportAuthUserResetPasswordResponse.md → PassportSendVerificationPhoneResponse.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportSendVerificationPhoneResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { PassportSendVerificationPhoneResponse } from '@cherryin/api-client';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: PassportSendVerificationPhoneResponse = {
|
|
17
17
|
code,
|
|
18
18
|
message,
|
|
19
19
|
};
|
package/docs/{PassportAuthUserOAuthCallbackResponse.md → PassportUserOAuthCallbackResponse.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassportUserOAuthCallbackResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,16 +11,16 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**url** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
13
13
|
**is_linked** | **boolean** | | [optional] [default to undefined]
|
|
14
|
-
**passport** | [**AuthPassport**](AuthPassport.md) |
|
|
15
|
-
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) |
|
|
16
|
-
**users** | [**Array<AuthUser>**](AuthUser.md) |
|
|
14
|
+
**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
|
|
15
|
+
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
|
|
16
|
+
**users** | [**Array<AuthUser>**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
import {
|
|
21
|
+
import { PassportUserOAuthCallbackResponse } from '@cherryin/api-client';
|
|
22
22
|
|
|
23
|
-
const instance:
|
|
23
|
+
const instance: PassportUserOAuthCallbackResponse = {
|
|
24
24
|
code,
|
|
25
25
|
message,
|
|
26
26
|
token,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PassportUserPasswordResetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
12
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PassportUserPasswordResetRequest } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: PassportUserPasswordResetRequest = {
|
|
20
|
+
app_ids,
|
|
21
|
+
email,
|
|
22
|
+
verify_code,
|
|
23
|
+
redirect,
|
|
24
|
+
callback_url,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PassportUserPasswordResetResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportUserPasswordResetResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportUserPasswordResetResponse = {
|
|
19
|
+
code,
|
|
20
|
+
message,
|
|
21
|
+
url,
|
|
22
|
+
redirect,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|