@cherryin/api-client 0.0.3 → 0.0.4
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 -73
- package/README.md +16 -110
- package/api.ts +749 -3348
- package/dist/api.d.ts +614 -2017
- package/dist/api.js +922 -2828
- package/dist/esm/api.d.ts +614 -2017
- package/dist/esm/api.js +902 -2803
- package/docs/AIModelAdminServiceApi.md +0 -53
- package/docs/AIModelCreateResponse.md +2 -2
- package/docs/AIModelDeleteResponse.md +2 -2
- package/docs/AIModelDisableResponse.md +2 -2
- package/docs/AIModelGetResponse.md +2 -2
- package/docs/AIModelListResponse.md +2 -2
- package/docs/AIModelPublishResponse.md +2 -2
- package/docs/AIModelUpdateResponse.md +2 -2
- package/docs/{AuthResetPasswordResponse.md → AdminAuthFlowInitResponse.md} +5 -5
- package/docs/AdminAuthServiceApi.md +81 -0
- package/docs/AuthFlowResult.md +23 -0
- package/docs/{Auth2IdToken.md → AuthTokenPair.md} +8 -10
- package/docs/ProviderCreateResponse.md +2 -2
- package/docs/ProviderDeleteResponse.md +2 -2
- package/docs/ProviderGetResponse.md +2 -2
- package/docs/ProviderListResponse.md +2 -2
- package/docs/ProviderModelCreateResponse.md +2 -2
- package/docs/ProviderModelDeleteResponse.md +2 -2
- package/docs/ProviderModelGetResponse.md +2 -2
- package/docs/ProviderModelListResponse.md +2 -2
- package/docs/ProviderModelUpdateResponse.md +2 -2
- package/docs/ProviderUpdateResponse.md +2 -2
- package/docs/UserAuthFlowCodeResponse.md +26 -0
- package/docs/UserAuthFlowInitResponse.md +28 -0
- package/docs/{RemoteConfigItemDeleteRequest.md → UserAuthFlowInitResponseOAuthResult.md} +5 -5
- package/docs/{AuthRequestPasswordResetResponse.md → UserAuthFlowOAuthCallbackRequest.md} +7 -7
- package/docs/{AuthSendVerificationEmailResponse.md → UserAuthFlowOAuthCallbackResponse.md} +7 -5
- package/docs/{AuthRevokeSessionRequest.md → UserAuthInfo.md} +5 -5
- package/docs/UserAuthServiceApi.md +279 -0
- package/docs/UserInfo.md +8 -14
- package/docs/UserPayServiceApi.md +3 -12
- package/package.json +1 -1
- package/docs/AIModelCheckConnectionResponse.md +0 -25
- package/docs/AIModelCheckItem.md +0 -32
- package/docs/AIModelCheckResult.md +0 -23
- package/docs/Auth2Account.md +0 -33
- package/docs/Auth2Admin.md +0 -33
- package/docs/Auth2AdminServiceApi.md +0 -469
- package/docs/Auth2AdminSession.md +0 -35
- package/docs/Auth2Session.md +0 -35
- package/docs/Auth2User.md +0 -33
- package/docs/Auth2UserServiceApi.md +0 -1203
- package/docs/AuthAdminChangePasswordRequest.md +0 -24
- package/docs/AuthAdminChangePasswordResponse.md +0 -26
- package/docs/AuthAdminGetSessionResponse.md +0 -26
- package/docs/AuthAdminListSessionsResponse.md +0 -24
- package/docs/AuthAdminRevokeOtherSessionsResponse.md +0 -24
- package/docs/AuthAdminRevokeSessionRequest.md +0 -20
- package/docs/AuthAdminRevokeSessionResponse.md +0 -24
- package/docs/AuthAdminRevokeSessionsResponse.md +0 -24
- package/docs/AuthAdminSignInEmailRequest.md +0 -26
- package/docs/AuthAdminSignInEmailResponse.md +0 -26
- package/docs/AuthAdminSignOutResponse.md +0 -24
- package/docs/AuthAdminUpdateUserRequest.md +0 -22
- package/docs/AuthAdminUpdateUserResponse.md +0 -24
- package/docs/AuthChangeEmailRequest.md +0 -22
- package/docs/AuthChangeEmailResponse.md +0 -26
- package/docs/AuthChangePasswordRequest.md +0 -24
- package/docs/AuthChangePasswordResponse.md +0 -26
- package/docs/AuthDeleteUserRequest.md +0 -24
- package/docs/AuthDeleteUserResponse.md +0 -24
- package/docs/AuthGetAccessTokenRequest.md +0 -24
- package/docs/AuthGetAccessTokenResponse.md +0 -34
- package/docs/AuthGetAccountInfoResponse.md +0 -24
- package/docs/AuthGetSessionResponse.md +0 -26
- package/docs/AuthLinkSocialRequest.md +0 -30
- package/docs/AuthLinkSocialResponse.md +0 -28
- package/docs/AuthListAccountsResponse.md +0 -24
- package/docs/AuthListSessionsResponse.md +0 -24
- package/docs/AuthRefreshTokenRequest.md +0 -24
- package/docs/AuthRefreshTokenResponse.md +0 -34
- package/docs/AuthRequestPasswordResetRequest.md +0 -22
- package/docs/AuthResetPasswordRequest.md +0 -22
- package/docs/AuthRevokeOtherSessionsResponse.md +0 -24
- package/docs/AuthRevokeSessionResponse.md +0 -24
- package/docs/AuthRevokeSessionsResponse.md +0 -24
- package/docs/AuthSendVerificationEmailRequest.md +0 -22
- package/docs/AuthSignInEmailRequest.md +0 -26
- package/docs/AuthSignInEmailResponse.md +0 -30
- package/docs/AuthSignInSocialRequest.md +0 -30
- package/docs/AuthSignInSocialResponse.md +0 -30
- package/docs/AuthSignOutResponse.md +0 -24
- package/docs/AuthSignUpEmailRequest.md +0 -32
- package/docs/AuthSignUpEmailResponse.md +0 -28
- package/docs/AuthUnlinkAccountRequest.md +0 -22
- package/docs/AuthUnlinkAccountResponse.md +0 -24
- package/docs/AuthUpdateUserRequest.md +0 -22
- package/docs/AuthUpdateUserResponse.md +0 -24
- package/docs/AuthVerifyEmailResponse.md +0 -24
- package/docs/ConfigItem.md +0 -32
- package/docs/ConfigItemHistory.md +0 -22
- package/docs/RemoteConfigAdminServiceApi.md +0 -287
- package/docs/RemoteConfigItemCreateRequest.md +0 -20
- package/docs/RemoteConfigItemCreateResponse.md +0 -24
- package/docs/RemoteConfigItemDeleteResponse.md +0 -22
- package/docs/RemoteConfigItemGetResponse.md +0 -24
- package/docs/RemoteConfigItemListResponse.md +0 -26
- package/docs/RemoteConfigItemUpdateRequest.md +0 -22
- package/docs/RemoteConfigItemUpdateResponse.md +0 -24
|
@@ -4,7 +4,6 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**aIModelAdminServiceAIModelCheckConnection**](#aimodeladminserviceaimodelcheckconnection) | **GET** /admin/ai-model/check/connection | |
|
|
8
7
|
|[**aIModelAdminServiceAIModelCreate**](#aimodeladminserviceaimodelcreate) | **POST** /admin/ai-model/create | |
|
|
9
8
|
|[**aIModelAdminServiceAIModelDelete**](#aimodeladminserviceaimodeldelete) | **POST** /admin/ai-model/delete | |
|
|
10
9
|
|[**aIModelAdminServiceAIModelDisable**](#aimodeladminserviceaimodeldisable) | **POST** /admin/ai-model/disable | |
|
|
@@ -13,58 +12,6 @@ All URIs are relative to *http://localhost*
|
|
|
13
12
|
|[**aIModelAdminServiceAIModelPublish**](#aimodeladminserviceaimodelpublish) | **POST** /admin/ai-model/publish | |
|
|
14
13
|
|[**aIModelAdminServiceAIModelUpdate**](#aimodeladminserviceaimodelupdate) | **POST** /admin/ai-model/update | |
|
|
15
14
|
|
|
16
|
-
# **aIModelAdminServiceAIModelCheckConnection**
|
|
17
|
-
> AIModelCheckConnectionResponse aIModelAdminServiceAIModelCheckConnection()
|
|
18
|
-
|
|
19
|
-
AIModelCheckConnection 检查 AIModel 的连接性
|
|
20
|
-
|
|
21
|
-
### Example
|
|
22
|
-
|
|
23
|
-
```typescript
|
|
24
|
-
import {
|
|
25
|
-
AIModelAdminServiceApi,
|
|
26
|
-
Configuration
|
|
27
|
-
} from '@cherryin/api-client';
|
|
28
|
-
|
|
29
|
-
const configuration = new Configuration();
|
|
30
|
-
const apiInstance = new AIModelAdminServiceApi(configuration);
|
|
31
|
-
|
|
32
|
-
let aiModelNames: Array<string>; // (optional) (default to undefined)
|
|
33
|
-
|
|
34
|
-
const { status, data } = await apiInstance.aIModelAdminServiceAIModelCheckConnection(
|
|
35
|
-
aiModelNames
|
|
36
|
-
);
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
### Parameters
|
|
40
|
-
|
|
41
|
-
|Name | Type | Description | Notes|
|
|
42
|
-
|------------- | ------------- | ------------- | -------------|
|
|
43
|
-
| **aiModelNames** | **Array<string>** | | (optional) defaults to undefined|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
### Return type
|
|
47
|
-
|
|
48
|
-
**AIModelCheckConnectionResponse**
|
|
49
|
-
|
|
50
|
-
### Authorization
|
|
51
|
-
|
|
52
|
-
No authorization required
|
|
53
|
-
|
|
54
|
-
### HTTP request headers
|
|
55
|
-
|
|
56
|
-
- **Content-Type**: Not defined
|
|
57
|
-
- **Accept**: application/json
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### HTTP response details
|
|
61
|
-
| Status code | Description | Response headers |
|
|
62
|
-
|-------------|-------------|------------------|
|
|
63
|
-
|**200** | OK | - |
|
|
64
|
-
|**0** | Default error response | - |
|
|
65
|
-
|
|
66
|
-
[[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)
|
|
67
|
-
|
|
68
15
|
# **aIModelAdminServiceAIModelCreate**
|
|
69
16
|
> AIModelCreateResponse aIModelAdminServiceAIModelCreate(aIModelCreateRequest)
|
|
70
17
|
|
|
@@ -6,8 +6,8 @@ AIModelCreateResponse 创建 AIModel 的响应 Response message for AI model cr
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**AIModel**](AIModel.md) | data 创建成功后返回的 AIModel 信息 AIModel information returned after successful creation | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ AIModelDeleteResponse 删除 AIModel 的响应 Response message for AI model de
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ AIModelDisableResponse 禁用 AIModel 的响应 Response message for AI model d
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**AIModel**](AIModel.md) | data 禁用后的 AIModel 信息 Disabled AI model information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ AIModelGetResponse 获取单个 AIModel 的响应 Response message for AI model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**AIModel**](AIModel.md) | data AIModel 信息 AIModel information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ AIModelListResponse 分页查询 AIModel 列表的响应 Response message for A
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**list** | [**Array<AIModel>**](AIModel.md) | list AIModel 列表 List of AI models | [optional] [default to undefined]
|
|
12
12
|
**total** | **string** | total 符合条件的 AIModel 总数 Total number of AI models matching the filter criteria | [optional] [default to undefined]
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ AIModelPublishResponse 发布 AIModel 的响应 Response message for AI model p
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**AIModel**](AIModel.md) | data 发布后的 AIModel 信息 Published AI model information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ AIModelUpdateResponse 更新 AIModel 的响应 Response message for AI model up
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**AIModel**](AIModel.md) | data 更新后的 AIModel 信息 Updated AI model information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AdminAuthFlowInitResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | 对于部分流程(例如邮箱密码登录),只需要 init 即可完成授权登录态,则会直接返回 AuthData 否则需要继续走完后续流程和调用相关接口. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { AdminAuthFlowInitResponse } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: AdminAuthFlowInitResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
|
-
|
|
20
|
+
auth_result,
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# AdminAuthServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**adminAuthServiceAdminAuthFlowInit**](#adminauthserviceadminauthflowinit) | **POST** /admin/auth/init | |
|
|
8
|
+
|
|
9
|
+
# **adminAuthServiceAdminAuthFlowInit**
|
|
10
|
+
> AdminAuthFlowInitResponse adminAuthServiceAdminAuthFlowInit()
|
|
11
|
+
|
|
12
|
+
管理员登录
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
AdminAuthServiceApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@cherryin/api-client';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new AdminAuthServiceApi(configuration);
|
|
24
|
+
|
|
25
|
+
let authType: number; // (optional) (default to undefined)
|
|
26
|
+
let authAction: number; // (optional) (default to undefined)
|
|
27
|
+
let payloadEmailPayloadUserEmail: string; // (optional) (default to undefined)
|
|
28
|
+
let payloadEmailPayloadUserPasswordEncrypt: string; // (optional) (default to undefined)
|
|
29
|
+
let authAt: string; // (optional) (default to undefined)
|
|
30
|
+
let nonce: string; // (optional) (default to undefined)
|
|
31
|
+
let signature: string; //加密方式: step1: 拼接一个字符串: s = \"cherryin_admin:{auth_type}:{auth_action}:{auth_at}:{nonce}:{payload.k1}:{payload.k2}:...}\" step2: md5(s) step3: hex_encode(step2) Payload 字段参与加密的字段如下: AuthType=Email:(空字符串也需要拼接) * UserEmail | UserPasswordEncrypt | DisplayName AuthType=OAuth2: * Platform ) (optional) (default to undefined)
|
|
32
|
+
let sessionType: string; //enum string: - tenant_admin - sys_admin (optional) (default to undefined)
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.adminAuthServiceAdminAuthFlowInit(
|
|
35
|
+
authType,
|
|
36
|
+
authAction,
|
|
37
|
+
payloadEmailPayloadUserEmail,
|
|
38
|
+
payloadEmailPayloadUserPasswordEncrypt,
|
|
39
|
+
authAt,
|
|
40
|
+
nonce,
|
|
41
|
+
signature,
|
|
42
|
+
sessionType
|
|
43
|
+
);
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
|Name | Type | Description | Notes|
|
|
49
|
+
|------------- | ------------- | ------------- | -------------|
|
|
50
|
+
| **authType** | [**number**] | | (optional) defaults to undefined|
|
|
51
|
+
| **authAction** | [**number**] | | (optional) defaults to undefined|
|
|
52
|
+
| **payloadEmailPayloadUserEmail** | [**string**] | | (optional) defaults to undefined|
|
|
53
|
+
| **payloadEmailPayloadUserPasswordEncrypt** | [**string**] | | (optional) defaults to undefined|
|
|
54
|
+
| **authAt** | [**string**] | | (optional) defaults to undefined|
|
|
55
|
+
| **nonce** | [**string**] | | (optional) defaults to undefined|
|
|
56
|
+
| **signature** | [**string**] | 加密方式: step1: 拼接一个字符串: s = \"cherryin_admin:{auth_type}:{auth_action}:{auth_at}:{nonce}:{payload.k1}:{payload.k2}:...}\" step2: md5(s) step3: hex_encode(step2) Payload 字段参与加密的字段如下: AuthType=Email:(空字符串也需要拼接) * UserEmail | UserPasswordEncrypt | DisplayName AuthType=OAuth2: * Platform ) | (optional) defaults to undefined|
|
|
57
|
+
| **sessionType** | [**string**] | enum string: - tenant_admin - sys_admin | (optional) defaults to undefined|
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
**AdminAuthFlowInitResponse**
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
No authorization required
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: Not defined
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### HTTP response details
|
|
75
|
+
| Status code | Description | Response headers |
|
|
76
|
+
|-------------|-------------|------------------|
|
|
77
|
+
|**200** | OK | - |
|
|
78
|
+
|**0** | Default error response | - |
|
|
79
|
+
|
|
80
|
+
[[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)
|
|
81
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AuthFlowResult
|
|
2
|
+
|
|
3
|
+
AuthFlowResult 授权登录态获取成功后的数据
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**is_authed** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**auth_tokens** | [**AuthTokenPair**](AuthTokenPair.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AuthFlowResult } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: AuthFlowResult = {
|
|
18
|
+
is_authed,
|
|
19
|
+
auth_tokens,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,28 +1,26 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AuthTokenPair
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AuthTokenPair 登录态授权 AT + RT
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**token** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**nonce** | **string** | | [optional] [default to undefined]
|
|
11
9
|
**access_token** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**access_expires_at** | **string** | | [optional] [default to undefined]
|
|
12
11
|
**refresh_token** | **string** | | [optional] [default to undefined]
|
|
13
|
-
**
|
|
12
|
+
**refresh_expires_at** | **string** | | [optional] [default to undefined]
|
|
14
13
|
|
|
15
14
|
## Example
|
|
16
15
|
|
|
17
16
|
```typescript
|
|
18
|
-
import {
|
|
17
|
+
import { AuthTokenPair } from '@cherryin/api-client';
|
|
19
18
|
|
|
20
|
-
const instance:
|
|
21
|
-
token,
|
|
22
|
-
nonce,
|
|
19
|
+
const instance: AuthTokenPair = {
|
|
23
20
|
access_token,
|
|
21
|
+
access_expires_at,
|
|
24
22
|
refresh_token,
|
|
25
|
-
|
|
23
|
+
refresh_expires_at,
|
|
26
24
|
};
|
|
27
25
|
```
|
|
28
26
|
|
|
@@ -6,8 +6,8 @@ ProviderCreateResponse 创建 Provider 的响应 Response message for provider
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**Provider**](Provider.md) | data 创建成功后返回的 Provider 信息 Provider information returned after successful creation | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ ProviderDeleteResponse 删除 Provider 的响应 Response message for provider
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ ProviderGetResponse 获取单个 Provider 的响应 Response message for provid
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**Provider**](Provider.md) | data Provider 信息 Provider information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ ProviderListResponse 分页查询 Provider 列表的响应 Response message for
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**list** | [**Array<Provider>**](Provider.md) | list Provider 列表 List of providers | [optional] [default to undefined]
|
|
12
12
|
**total** | **string** | total 符合条件的 Provider 总数 Total number of providers matching the filter criteria | [optional] [default to undefined]
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ ProviderModelCreateResponse 创建 ProviderModel 的响应 Response message for
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**ProviderModel**](ProviderModel.md) | data 创建成功后返回的 ProviderModel 信息 ProviderModel information returned after successful creation | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ ProviderModelDeleteResponse 删除 ProviderModel 的响应 Response message for
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ ProviderModelGetResponse 获取单个 ProviderModel 的响应 Response message
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**ProviderModel**](ProviderModel.md) | data ProviderModel 信息 ProviderModel information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ ProviderModelListResponse 分页查询 ProviderModel 列表的响应 Response m
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**list** | [**Array<ProviderModel>**](ProviderModel.md) | list ProviderModel 列表 List of provider models | [optional] [default to undefined]
|
|
12
12
|
**total** | **string** | total 符合条件的 ProviderModel 总数 Total number of provider models matching the filter criteria | [optional] [default to undefined]
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ ProviderModelUpdateResponse 更新 ProviderModel 的响应 Response message for
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**ProviderModel**](ProviderModel.md) | data 更新后的 ProviderModel 信息 Updated provider model information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,8 +6,8 @@ ProviderUpdateResponse 更新 Provider 的响应 Response message for provider
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
|
|
11
11
|
**data** | [**Provider**](Provider.md) | data 更新后的 Provider 信息 Updated provider information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UserAuthFlowCodeResponse
|
|
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
|
+
**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | 如果验证通过立刻下发登录态,则会通过这个返回鉴权的 AuthToken 如果注册成功,还需要登录,则不会下发 | [optional] [default to undefined]
|
|
11
|
+
**user_info** | [**UserAuthInfo**](UserAuthInfo.md) | 注册成功后返回的用户信息 | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { UserAuthFlowCodeResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: UserAuthFlowCodeResponse = {
|
|
19
|
+
code,
|
|
20
|
+
message,
|
|
21
|
+
auth_result,
|
|
22
|
+
user_info,
|
|
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,28 @@
|
|
|
1
|
+
# UserAuthFlowInitResponse
|
|
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
|
+
**oauth_result** | [**UserAuthFlowInitResponseOAuthResult**](UserAuthFlowInitResponseOAuthResult.md) | for AuthType=OAuth2 才会返回 | [optional] [default to undefined]
|
|
11
|
+
**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | 对于部分流程,只需要 init 即可完成授权登录态,则会直接返回 AuthData 否则需要继续走完后续流程和调用相关接口 | [optional] [default to undefined]
|
|
12
|
+
**user_info** | [**UserAuthInfo**](UserAuthInfo.md) | 注册成功后返回的用户信息 | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { UserAuthFlowInitResponse } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: UserAuthFlowInitResponse = {
|
|
20
|
+
code,
|
|
21
|
+
message,
|
|
22
|
+
oauth_result,
|
|
23
|
+
auth_result,
|
|
24
|
+
user_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)
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UserAuthFlowInitResponseOAuthResult
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**oauth_url** | **string** | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { UserAuthFlowInitResponseOAuthResult } from '@cherryin/api-client';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
15
|
+
const instance: UserAuthFlowInitResponseOAuthResult = {
|
|
16
|
+
oauth_url,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UserAuthFlowOAuthCallbackRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -6,18 +6,18 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**
|
|
10
|
-
**
|
|
9
|
+
**state** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**platform** | **number** | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { UserAuthFlowOAuthCallbackRequest } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: UserAuthFlowOAuthCallbackRequest = {
|
|
18
18
|
code,
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
state,
|
|
20
|
+
platform,
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UserAuthFlowOAuthCallbackResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,17 +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
|
-
**
|
|
10
|
+
**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | | [optional] [default to undefined]
|
|
11
|
+
**user_info** | [**UserAuthInfo**](UserAuthInfo.md) | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
14
15
|
```typescript
|
|
15
|
-
import {
|
|
16
|
+
import { UserAuthFlowOAuthCallbackResponse } from '@cherryin/api-client';
|
|
16
17
|
|
|
17
|
-
const instance:
|
|
18
|
+
const instance: UserAuthFlowOAuthCallbackResponse = {
|
|
18
19
|
code,
|
|
19
20
|
message,
|
|
20
|
-
|
|
21
|
+
auth_result,
|
|
22
|
+
user_info,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UserAuthInfo
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**user_info** | [**UserInfo**](UserInfo.md) | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { UserAuthInfo } from '@cherryin/api-client';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
15
|
+
const instance: UserAuthInfo = {
|
|
16
|
+
user_info,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|