@cherryin/api-client 0.0.14 → 0.0.16
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 +11 -0
- package/README.md +20 -6
- package/api.ts +295 -11
- package/dist/api.d.ts +174 -7
- package/dist/api.js +190 -4
- package/dist/esm/api.d.ts +174 -7
- package/dist/esm/api.js +190 -4
- package/docs/PassportAuthAdminRPCServiceApi.md +1 -1
- package/docs/PassportAuthEnterpriseRPCServiceApi.md +1 -1
- package/docs/PassportAuthUserRPCServiceApi.md +163 -1
- package/docs/PassportAuthUserServiceApi.md +1 -1
- package/docs/PassportAuthUserUpdateInfoRequest.md +10 -6
- package/docs/PassportSendVerificationEmailRequest.md +1 -1
- package/docs/PassportUserInfoBatchGetRequest.md +24 -0
- package/docs/PassportUserInfoBatchGetResponse.md +24 -0
- package/docs/PassportUserInfoGetRequest.md +24 -0
- package/docs/PassportUserInfoGetResponse.md +24 -0
- package/docs/PassportUserUpdateInfoRequest.md +30 -0
- package/docs/PassportUserUpdateInfoResponse.md +22 -0
- package/docs/UserBasic.md +42 -0
- package/docs/UserExtendInfo.md +20 -0
- package/docs/UserInfoQueryOptions.md +28 -0
- package/docs/UserPaymentInfo.md +20 -0
- package/docs/UserPreferences.md +22 -0
- package/package.json +1 -1
|
@@ -4,7 +4,116 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**passportAuthUserRPCServicePassportUserInfoBatchGet**](#passportauthuserrpcservicepassportuserinfobatchget) | **POST** /passport/authed/v1/users/batch_get | |
|
|
8
|
+
|[**passportAuthUserRPCServicePassportUserInfoGet**](#passportauthuserrpcservicepassportuserinfoget) | **POST** /passport/authed/v1/user/get | |
|
|
9
|
+
|[**passportAuthUserRPCServicePassportUserTokenAuth**](#passportauthuserrpcservicepassportusertokenauth) | **POST** /passport/authed/v1/passports | |
|
|
10
|
+
|[**passportAuthUserRPCServicePassportUserUpdateInfo**](#passportauthuserrpcservicepassportuserupdateinfo) | **POST** /passport/authed/v1/user/update | |
|
|
11
|
+
|
|
12
|
+
# **passportAuthUserRPCServicePassportUserInfoBatchGet**
|
|
13
|
+
> PassportUserInfoBatchGetResponse passportAuthUserRPCServicePassportUserInfoBatchGet(passportUserInfoBatchGetRequest)
|
|
14
|
+
|
|
15
|
+
批量获取用户信息
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
PassportAuthUserRPCServiceApi,
|
|
22
|
+
Configuration,
|
|
23
|
+
PassportUserInfoBatchGetRequest
|
|
24
|
+
} from '@cherryin/api-client';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
|
|
28
|
+
|
|
29
|
+
let passportUserInfoBatchGetRequest: PassportUserInfoBatchGetRequest; //
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserInfoBatchGet(
|
|
32
|
+
passportUserInfoBatchGetRequest
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **passportUserInfoBatchGetRequest** | **PassportUserInfoBatchGetRequest**| | |
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Return type
|
|
44
|
+
|
|
45
|
+
**PassportUserInfoBatchGetResponse**
|
|
46
|
+
|
|
47
|
+
### Authorization
|
|
48
|
+
|
|
49
|
+
No authorization required
|
|
50
|
+
|
|
51
|
+
### HTTP request headers
|
|
52
|
+
|
|
53
|
+
- **Content-Type**: application/json
|
|
54
|
+
- **Accept**: application/json
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### HTTP response details
|
|
58
|
+
| Status code | Description | Response headers |
|
|
59
|
+
|-------------|-------------|------------------|
|
|
60
|
+
|**200** | OK | - |
|
|
61
|
+
|**0** | Default error response | - |
|
|
62
|
+
|
|
63
|
+
[[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)
|
|
64
|
+
|
|
65
|
+
# **passportAuthUserRPCServicePassportUserInfoGet**
|
|
66
|
+
> PassportUserInfoGetResponse passportAuthUserRPCServicePassportUserInfoGet(passportUserInfoGetRequest)
|
|
67
|
+
|
|
68
|
+
获取用户信息
|
|
69
|
+
|
|
70
|
+
### Example
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
import {
|
|
74
|
+
PassportAuthUserRPCServiceApi,
|
|
75
|
+
Configuration,
|
|
76
|
+
PassportUserInfoGetRequest
|
|
77
|
+
} from '@cherryin/api-client';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
|
|
81
|
+
|
|
82
|
+
let passportUserInfoGetRequest: PassportUserInfoGetRequest; //
|
|
83
|
+
|
|
84
|
+
const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserInfoGet(
|
|
85
|
+
passportUserInfoGetRequest
|
|
86
|
+
);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
|Name | Type | Description | Notes|
|
|
92
|
+
|------------- | ------------- | ------------- | -------------|
|
|
93
|
+
| **passportUserInfoGetRequest** | **PassportUserInfoGetRequest**| | |
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
**PassportUserInfoGetResponse**
|
|
99
|
+
|
|
100
|
+
### Authorization
|
|
101
|
+
|
|
102
|
+
No authorization required
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: application/json
|
|
107
|
+
- **Accept**: application/json
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### HTTP response details
|
|
111
|
+
| Status code | Description | Response headers |
|
|
112
|
+
|-------------|-------------|------------------|
|
|
113
|
+
|**200** | OK | - |
|
|
114
|
+
|**0** | Default error response | - |
|
|
115
|
+
|
|
116
|
+
[[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)
|
|
8
117
|
|
|
9
118
|
# **passportAuthUserRPCServicePassportUserTokenAuth**
|
|
10
119
|
> PassportUserTokenAuthResponse passportAuthUserRPCServicePassportUserTokenAuth(passportUserTokenAuthRequest)
|
|
@@ -59,3 +168,56 @@ No authorization required
|
|
|
59
168
|
|
|
60
169
|
[[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)
|
|
61
170
|
|
|
171
|
+
# **passportAuthUserRPCServicePassportUserUpdateInfo**
|
|
172
|
+
> PassportUserUpdateInfoResponse passportAuthUserRPCServicePassportUserUpdateInfo(passportUserUpdateInfoRequest)
|
|
173
|
+
|
|
174
|
+
更新用户信息
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
import {
|
|
180
|
+
PassportAuthUserRPCServiceApi,
|
|
181
|
+
Configuration,
|
|
182
|
+
PassportUserUpdateInfoRequest
|
|
183
|
+
} from '@cherryin/api-client';
|
|
184
|
+
|
|
185
|
+
const configuration = new Configuration();
|
|
186
|
+
const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
|
|
187
|
+
|
|
188
|
+
let passportUserUpdateInfoRequest: PassportUserUpdateInfoRequest; //
|
|
189
|
+
|
|
190
|
+
const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserUpdateInfo(
|
|
191
|
+
passportUserUpdateInfoRequest
|
|
192
|
+
);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
|Name | Type | Description | Notes|
|
|
198
|
+
|------------- | ------------- | ------------- | -------------|
|
|
199
|
+
| **passportUserUpdateInfoRequest** | **PassportUserUpdateInfoRequest**| | |
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
**PassportUserUpdateInfoResponse**
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
No authorization required
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: application/json
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### HTTP response details
|
|
217
|
+
| Status code | Description | Response headers |
|
|
218
|
+
|-------------|-------------|------------------|
|
|
219
|
+
|**200** | OK | - |
|
|
220
|
+
|**0** | Default error response | - |
|
|
221
|
+
|
|
222
|
+
[[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)
|
|
223
|
+
|
|
@@ -34,7 +34,7 @@ All URIs are relative to *http://localhost*
|
|
|
34
34
|
|[**passportAuthUserServicePassportSendVerificationEmail**](#passportauthuserservicepassportsendverificationemail) | **POST** /passport/auth/v1/verification/send-email | |
|
|
35
35
|
|[**passportAuthUserServicePassportSendVerificationPhone**](#passportauthuserservicepassportsendverificationphone) | **POST** /passport/auth/v1/verification/send-phone | |
|
|
36
36
|
|[**passportAuthUserServicePassportUserOAuthCallback**](#passportauthuserservicepassportuseroauthcallback) | **GET** /passport/oauth2/{platform}/callback | |
|
|
37
|
-
|[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/
|
|
37
|
+
|[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/reset | |
|
|
38
38
|
|[**passportAuthUserServicePassportUserSignInEmail**](#passportauthuserservicepassportusersigninemail) | **POST** /passport/auth/v1/sign-in/email | |
|
|
39
39
|
|[**passportAuthUserServicePassportUserSignInPhone**](#passportauthuserservicepassportusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
|
|
40
40
|
|[**passportAuthUserServicePassportUserSignInSocial**](#passportauthuserservicepassportusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
|
|
@@ -5,9 +5,11 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
8
|
+
**user** | [**UserBasic**](UserBasic.md) | | [optional] [default to undefined]
|
|
9
|
+
**settings** | [**UserSettings**](UserSettings.md) | | [optional] [default to undefined]
|
|
10
|
+
**preferences** | [**UserPreferences**](UserPreferences.md) | | [optional] [default to undefined]
|
|
11
|
+
**payment_info** | [**UserPaymentInfo**](UserPaymentInfo.md) | | [optional] [default to undefined]
|
|
12
|
+
**extend_info** | [**UserExtendInfo**](UserExtendInfo.md) | | [optional] [default to undefined]
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -15,9 +17,11 @@ Name | Type | Description | Notes
|
|
|
15
17
|
import { PassportAuthUserUpdateInfoRequest } from '@cherryin/api-client';
|
|
16
18
|
|
|
17
19
|
const instance: PassportAuthUserUpdateInfoRequest = {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
user,
|
|
21
|
+
settings,
|
|
22
|
+
preferences,
|
|
23
|
+
payment_info,
|
|
24
|
+
extend_info,
|
|
21
25
|
};
|
|
22
26
|
```
|
|
23
27
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
9
|
**email** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**callback_url** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**purpose** | **string** |
|
|
11
|
+
**purpose** | **string** | 验证目的, 可选值 - verify_email(验证邮箱) - change_email(更换邮箱) - reset_password (重置密码) | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PassportUserInfoBatchGetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uids** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
**ignore_cache** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**query_options** | [**UserInfoQueryOptions**](UserInfoQueryOptions.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportUserInfoBatchGetRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportUserInfoBatchGetRequest = {
|
|
18
|
+
uids,
|
|
19
|
+
ignore_cache,
|
|
20
|
+
query_options,
|
|
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,24 @@
|
|
|
1
|
+
# PassportUserInfoBatchGetResponse
|
|
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
|
+
**user_info_list** | [**Array<UserInfo>**](UserInfo.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportUserInfoBatchGetResponse } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportUserInfoBatchGetResponse = {
|
|
18
|
+
code,
|
|
19
|
+
message,
|
|
20
|
+
user_info_list,
|
|
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,24 @@
|
|
|
1
|
+
# PassportUserInfoGetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uid** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**ignore_cache** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**query_options** | [**UserInfoQueryOptions**](UserInfoQueryOptions.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportUserInfoGetRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportUserInfoGetRequest = {
|
|
18
|
+
uid,
|
|
19
|
+
ignore_cache,
|
|
20
|
+
query_options,
|
|
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,24 @@
|
|
|
1
|
+
# PassportUserInfoGetResponse
|
|
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
|
+
**user_info** | [**UserInfo**](UserInfo.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PassportUserInfoGetResponse } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PassportUserInfoGetResponse = {
|
|
18
|
+
code,
|
|
19
|
+
message,
|
|
20
|
+
user_info,
|
|
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,30 @@
|
|
|
1
|
+
# PassportUserUpdateInfoRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uid** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**user** | [**UserBasic**](UserBasic.md) | | [optional] [default to undefined]
|
|
10
|
+
**settings** | [**UserSettings**](UserSettings.md) | | [optional] [default to undefined]
|
|
11
|
+
**preferences** | [**UserPreferences**](UserPreferences.md) | | [optional] [default to undefined]
|
|
12
|
+
**payment_info** | [**UserPaymentInfo**](UserPaymentInfo.md) | | [optional] [default to undefined]
|
|
13
|
+
**extend_info** | [**UserExtendInfo**](UserExtendInfo.md) | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PassportUserUpdateInfoRequest } from '@cherryin/api-client';
|
|
19
|
+
|
|
20
|
+
const instance: PassportUserUpdateInfoRequest = {
|
|
21
|
+
uid,
|
|
22
|
+
user,
|
|
23
|
+
settings,
|
|
24
|
+
preferences,
|
|
25
|
+
payment_info,
|
|
26
|
+
extend_info,
|
|
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,22 @@
|
|
|
1
|
+
# PassportUserUpdateInfoResponse
|
|
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 { PassportUserUpdateInfoResponse } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PassportUserUpdateInfoResponse = {
|
|
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,42 @@
|
|
|
1
|
+
# UserBasic
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uid** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**app_id** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**aid** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**avatar_url** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**register_at** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**email_verified_at** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**phone_verified_at** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**app_name** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**user_status** | **number** | | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { UserBasic } from '@cherryin/api-client';
|
|
25
|
+
|
|
26
|
+
const instance: UserBasic = {
|
|
27
|
+
uid,
|
|
28
|
+
app_id,
|
|
29
|
+
aid,
|
|
30
|
+
name,
|
|
31
|
+
email,
|
|
32
|
+
phone,
|
|
33
|
+
avatar_url,
|
|
34
|
+
register_at,
|
|
35
|
+
email_verified_at,
|
|
36
|
+
phone_verified_at,
|
|
37
|
+
app_name,
|
|
38
|
+
user_status,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[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,20 @@
|
|
|
1
|
+
# UserExtendInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**user_groups** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UserExtendInfo } from '@cherryin/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: UserExtendInfo = {
|
|
16
|
+
user_groups,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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,28 @@
|
|
|
1
|
+
# UserInfoQueryOptions
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**opt_include_all** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
**opt_settings** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**opt_preferences** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**opt_payment_info** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
**opt_extend_info** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { UserInfoQueryOptions } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: UserInfoQueryOptions = {
|
|
20
|
+
opt_include_all,
|
|
21
|
+
opt_settings,
|
|
22
|
+
opt_preferences,
|
|
23
|
+
opt_payment_info,
|
|
24
|
+
opt_extend_info,
|
|
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,20 @@
|
|
|
1
|
+
# UserPaymentInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**stripe_customer_id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UserPaymentInfo } from '@cherryin/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: UserPaymentInfo = {
|
|
16
|
+
stripe_customer_id,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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
|
+
# UserPreferences
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**language** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**timezone** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UserPreferences } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: UserPreferences = {
|
|
17
|
+
language,
|
|
18
|
+
timezone,
|
|
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)
|