@cherryin/passport-api-client 0.1.19 → 0.1.21
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 +6 -0
- package/README.md +14 -4
- package/api.ts +353 -11
- package/dist/api.d.ts +196 -10
- package/dist/api.js +273 -9
- package/dist/esm/api.d.ts +196 -10
- package/dist/esm/api.js +273 -9
- package/docs/PassportAuthEnterpriseBindEmailRequest.md +24 -0
- package/docs/PassportAuthEnterpriseBindEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseBindPhoneRequest.md +22 -0
- package/docs/PassportAuthEnterpriseBindPhoneResponse.md +22 -0
- package/docs/PassportAuthEnterpriseChangeEmailRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangeEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseServiceApi.md +214 -2
- package/package.json +1 -1
|
@@ -4,6 +4,9 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseBindEmail**](#passportauthenterpriseservicepassportauthenterprisebindemail) | **POST** /passport/enterprise/authed/v1/email/bind | 已登录用户绑定邮箱(未绑定邮箱的用户使用)|
|
|
8
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseBindPhone**](#passportauthenterpriseservicepassportauthenterprisebindphone) | **POST** /passport/enterprise/authed/v1/phone/bind | 已登录用户绑定手机号|
|
|
9
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangeEmail**](#passportauthenterpriseservicepassportauthenterprisechangeemail) | **POST** /passport/enterprise/authed/v1/email/change | 已登录用户修改登录邮箱(已绑定邮箱的用户使用)|
|
|
7
10
|
|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword**](#passportauthenterpriseservicepassportauthenterprisechangepassword) | **POST** /passport/enterprise/authed/v1/password/change | 已登录用户修改密码|
|
|
8
11
|
|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone**](#passportauthenterpriseservicepassportauthenterprisechangephone) | **POST** /passport/enterprise/authed/v1/phone/change | 已登录用户更换手机号|
|
|
9
12
|
|[**passportAuthEnterpriseServicePassportAuthEnterpriseDelete**](#passportauthenterpriseservicepassportauthenterprisedelete) | **POST** /passport/enterprise/authed/v1/user/request-delete | 请求删除用户|
|
|
@@ -21,14 +24,171 @@ All URIs are relative to *http://localhost*
|
|
|
21
24
|
|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions**](#passportauthenterpriseservicepassportauthenterpriserevokesessions) | **POST** /passport/enterprise/authed/v1/sessions/revoke-all | 注销所有会话|
|
|
22
25
|
|[**passportAuthEnterpriseServicePassportAuthEnterpriseSignOut**](#passportauthenterpriseservicepassportauthenterprisesignout) | **POST** /passport/enterprise/authed/v1/sign-out | 用户登出|
|
|
23
26
|
|[**passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo**](#passportauthenterpriseservicepassportauthenterpriseupdateinfo) | **POST** /passport/enterprise/authed/v1/user/update-info | 更新用户信息|
|
|
24
|
-
|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail**](#passportauthenterpriseservicepassportauthenterpriseverifyemail) | **POST** /passport/enterprise/
|
|
25
|
-
|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone**](#passportauthenterpriseservicepassportauthenterpriseverifyphone) | **GET** /passport/enterprise/authed/v1/phone/verify |
|
|
27
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail**](#passportauthenterpriseservicepassportauthenterpriseverifyemail) | **POST** /passport/enterprise/authed/v1/email/verify | 已登录用户验证邮箱(不用于登录,而是作为企业认证材料的一部分)|
|
|
28
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone**](#passportauthenterpriseservicepassportauthenterpriseverifyphone) | **GET** /passport/enterprise/authed/v1/phone/verify | 已登录用户验证手机号(不用于登录,而是作为企业认证材料的一部分)|
|
|
29
|
+
|[**passportAuthEnterpriseServicePassportEnterprisePasswordReset**](#passportauthenterpriseservicepassportenterprisepasswordreset) | **POST** /passport/enterprise/auth/v1/password/request-reset | 请求重置密码|
|
|
26
30
|
|[**passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail**](#passportauthenterpriseservicepassportenterprisesendverificationemail) | **POST** /passport/enterprise/auth/v1/verification/send-email | 登录/注册流程中发送验证码|
|
|
27
31
|
|[**passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone**](#passportauthenterpriseservicepassportenterprisesendverificationphone) | **POST** /passport/enterprise/auth/v1/verification/send-phone | 登录/注册流程中发送验证码|
|
|
28
32
|
|[**passportAuthEnterpriseServicePassportEnterpriseSignInEmail**](#passportauthenterpriseservicepassportenterprisesigninemail) | **POST** /passport/enterprise/auth/v1/sign-in/email | 邮箱登录|
|
|
29
33
|
|[**passportAuthEnterpriseServicePassportEnterpriseSignInPhone**](#passportauthenterpriseservicepassportenterprisesigninphone) | **POST** /passport/enterprise/auth/v1/sign-in/phone | 手机登录|
|
|
30
34
|
|[**passportAuthEnterpriseServicePassportEnterpriseSignUpEmail**](#passportauthenterpriseservicepassportenterprisesignupemail) | **POST** /passport/enterprise/auth/v1/sign-up/email | 邮箱注册|
|
|
31
35
|
|
|
36
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseBindEmail**
|
|
37
|
+
> PassportAuthEnterpriseBindEmailResponse passportAuthEnterpriseServicePassportAuthEnterpriseBindEmail(body)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Example
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import {
|
|
44
|
+
PassportAuthEnterpriseServiceApi,
|
|
45
|
+
Configuration,
|
|
46
|
+
PassportAuthEnterpriseBindEmailRequest
|
|
47
|
+
} from '@cherryin/passport-api-client';
|
|
48
|
+
|
|
49
|
+
const configuration = new Configuration();
|
|
50
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
51
|
+
|
|
52
|
+
let body: PassportAuthEnterpriseBindEmailRequest; //
|
|
53
|
+
|
|
54
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseBindEmail(
|
|
55
|
+
body
|
|
56
|
+
);
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
|Name | Type | Description | Notes|
|
|
62
|
+
|------------- | ------------- | ------------- | -------------|
|
|
63
|
+
| **body** | **PassportAuthEnterpriseBindEmailRequest**| | |
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
**PassportAuthEnterpriseBindEmailResponse**
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
No authorization required
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: application/json
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### HTTP response details
|
|
81
|
+
| Status code | Description | Response headers |
|
|
82
|
+
|-------------|-------------|------------------|
|
|
83
|
+
|**200** | A successful response. | - |
|
|
84
|
+
|**0** | An unexpected error response. | - |
|
|
85
|
+
|
|
86
|
+
[[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)
|
|
87
|
+
|
|
88
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseBindPhone**
|
|
89
|
+
> PassportAuthEnterpriseBindPhoneResponse passportAuthEnterpriseServicePassportAuthEnterpriseBindPhone(body)
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Example
|
|
93
|
+
|
|
94
|
+
```typescript
|
|
95
|
+
import {
|
|
96
|
+
PassportAuthEnterpriseServiceApi,
|
|
97
|
+
Configuration,
|
|
98
|
+
PassportAuthEnterpriseBindPhoneRequest
|
|
99
|
+
} from '@cherryin/passport-api-client';
|
|
100
|
+
|
|
101
|
+
const configuration = new Configuration();
|
|
102
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
103
|
+
|
|
104
|
+
let body: PassportAuthEnterpriseBindPhoneRequest; //
|
|
105
|
+
|
|
106
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseBindPhone(
|
|
107
|
+
body
|
|
108
|
+
);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Parameters
|
|
112
|
+
|
|
113
|
+
|Name | Type | Description | Notes|
|
|
114
|
+
|------------- | ------------- | ------------- | -------------|
|
|
115
|
+
| **body** | **PassportAuthEnterpriseBindPhoneRequest**| | |
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
**PassportAuthEnterpriseBindPhoneResponse**
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
No authorization required
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: application/json
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### HTTP response details
|
|
133
|
+
| Status code | Description | Response headers |
|
|
134
|
+
|-------------|-------------|------------------|
|
|
135
|
+
|**200** | A successful response. | - |
|
|
136
|
+
|**0** | An unexpected error response. | - |
|
|
137
|
+
|
|
138
|
+
[[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)
|
|
139
|
+
|
|
140
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseChangeEmail**
|
|
141
|
+
> PassportAuthEnterpriseChangeEmailResponse passportAuthEnterpriseServicePassportAuthEnterpriseChangeEmail(body)
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
### Example
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
import {
|
|
148
|
+
PassportAuthEnterpriseServiceApi,
|
|
149
|
+
Configuration,
|
|
150
|
+
PassportAuthEnterpriseChangeEmailRequest
|
|
151
|
+
} from '@cherryin/passport-api-client';
|
|
152
|
+
|
|
153
|
+
const configuration = new Configuration();
|
|
154
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
155
|
+
|
|
156
|
+
let body: PassportAuthEnterpriseChangeEmailRequest; //
|
|
157
|
+
|
|
158
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseChangeEmail(
|
|
159
|
+
body
|
|
160
|
+
);
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Parameters
|
|
164
|
+
|
|
165
|
+
|Name | Type | Description | Notes|
|
|
166
|
+
|------------- | ------------- | ------------- | -------------|
|
|
167
|
+
| **body** | **PassportAuthEnterpriseChangeEmailRequest**| | |
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Return type
|
|
171
|
+
|
|
172
|
+
**PassportAuthEnterpriseChangeEmailResponse**
|
|
173
|
+
|
|
174
|
+
### Authorization
|
|
175
|
+
|
|
176
|
+
No authorization required
|
|
177
|
+
|
|
178
|
+
### HTTP request headers
|
|
179
|
+
|
|
180
|
+
- **Content-Type**: application/json
|
|
181
|
+
- **Accept**: application/json
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### HTTP response details
|
|
185
|
+
| Status code | Description | Response headers |
|
|
186
|
+
|-------------|-------------|------------------|
|
|
187
|
+
|**200** | A successful response. | - |
|
|
188
|
+
|**0** | An unexpected error response. | - |
|
|
189
|
+
|
|
190
|
+
[[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)
|
|
191
|
+
|
|
32
192
|
# **passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword**
|
|
33
193
|
> PassportAuthEnterpriseChangePasswordResponse passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword(body)
|
|
34
194
|
|
|
@@ -985,6 +1145,58 @@ No authorization required
|
|
|
985
1145
|
- **Accept**: application/json
|
|
986
1146
|
|
|
987
1147
|
|
|
1148
|
+
### HTTP response details
|
|
1149
|
+
| Status code | Description | Response headers |
|
|
1150
|
+
|-------------|-------------|------------------|
|
|
1151
|
+
|**200** | A successful response. | - |
|
|
1152
|
+
|**0** | An unexpected error response. | - |
|
|
1153
|
+
|
|
1154
|
+
[[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)
|
|
1155
|
+
|
|
1156
|
+
# **passportAuthEnterpriseServicePassportEnterprisePasswordReset**
|
|
1157
|
+
> PassportEnterprisePasswordResetResponse passportAuthEnterpriseServicePassportEnterprisePasswordReset(body)
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
### Example
|
|
1161
|
+
|
|
1162
|
+
```typescript
|
|
1163
|
+
import {
|
|
1164
|
+
PassportAuthEnterpriseServiceApi,
|
|
1165
|
+
Configuration,
|
|
1166
|
+
PassportEnterprisePasswordResetRequest
|
|
1167
|
+
} from '@cherryin/passport-api-client';
|
|
1168
|
+
|
|
1169
|
+
const configuration = new Configuration();
|
|
1170
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
1171
|
+
|
|
1172
|
+
let body: PassportEnterprisePasswordResetRequest; //
|
|
1173
|
+
|
|
1174
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterprisePasswordReset(
|
|
1175
|
+
body
|
|
1176
|
+
);
|
|
1177
|
+
```
|
|
1178
|
+
|
|
1179
|
+
### Parameters
|
|
1180
|
+
|
|
1181
|
+
|Name | Type | Description | Notes|
|
|
1182
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1183
|
+
| **body** | **PassportEnterprisePasswordResetRequest**| | |
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
### Return type
|
|
1187
|
+
|
|
1188
|
+
**PassportEnterprisePasswordResetResponse**
|
|
1189
|
+
|
|
1190
|
+
### Authorization
|
|
1191
|
+
|
|
1192
|
+
No authorization required
|
|
1193
|
+
|
|
1194
|
+
### HTTP request headers
|
|
1195
|
+
|
|
1196
|
+
- **Content-Type**: application/json
|
|
1197
|
+
- **Accept**: application/json
|
|
1198
|
+
|
|
1199
|
+
|
|
988
1200
|
### HTTP response details
|
|
989
1201
|
| Status code | Description | Response headers |
|
|
990
1202
|
|-------------|-------------|------------------|
|