@cherryin/api-client 0.0.1 → 0.0.3
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 +73 -11
- package/README.md +110 -16
- package/api.ts +3348 -749
- package/dist/api.d.ts +2027 -624
- package/dist/api.js +2827 -921
- package/dist/esm/api.d.ts +2027 -624
- package/dist/esm/api.js +2800 -899
- package/docs/AIModelAdminServiceApi.md +53 -0
- package/docs/AIModelCheckConnectionResponse.md +25 -0
- package/docs/AIModelCheckItem.md +32 -0
- package/docs/AIModelCheckResult.md +23 -0
- 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/Auth2Account.md +33 -0
- package/docs/Auth2Admin.md +33 -0
- package/docs/Auth2AdminServiceApi.md +469 -0
- package/docs/Auth2AdminSession.md +35 -0
- package/docs/{AuthTokenPair.md → Auth2IdToken.md} +10 -8
- package/docs/Auth2Session.md +35 -0
- package/docs/Auth2User.md +33 -0
- package/docs/Auth2UserServiceApi.md +1203 -0
- package/docs/AuthAdminChangePasswordRequest.md +24 -0
- package/docs/AuthAdminChangePasswordResponse.md +26 -0
- package/docs/AuthAdminGetSessionResponse.md +26 -0
- package/docs/AuthAdminListSessionsResponse.md +24 -0
- package/docs/AuthAdminRevokeOtherSessionsResponse.md +24 -0
- package/docs/{UserAuthFlowInitResponseOAuthResult.md → AuthAdminRevokeSessionRequest.md} +5 -5
- package/docs/AuthAdminRevokeSessionResponse.md +24 -0
- package/docs/AuthAdminRevokeSessionsResponse.md +24 -0
- package/docs/AuthAdminSignInEmailRequest.md +26 -0
- package/docs/AuthAdminSignInEmailResponse.md +26 -0
- package/docs/AuthAdminSignOutResponse.md +24 -0
- package/docs/AuthAdminUpdateUserRequest.md +22 -0
- package/docs/AuthAdminUpdateUserResponse.md +24 -0
- package/docs/AuthChangeEmailRequest.md +22 -0
- package/docs/AuthChangeEmailResponse.md +26 -0
- package/docs/AuthChangePasswordRequest.md +24 -0
- package/docs/AuthChangePasswordResponse.md +26 -0
- package/docs/AuthDeleteUserRequest.md +24 -0
- package/docs/AuthDeleteUserResponse.md +24 -0
- package/docs/AuthGetAccessTokenRequest.md +24 -0
- package/docs/AuthGetAccessTokenResponse.md +34 -0
- package/docs/AuthGetAccountInfoResponse.md +24 -0
- package/docs/AuthGetSessionResponse.md +26 -0
- package/docs/AuthLinkSocialRequest.md +30 -0
- package/docs/AuthLinkSocialResponse.md +28 -0
- package/docs/AuthListAccountsResponse.md +24 -0
- package/docs/AuthListSessionsResponse.md +24 -0
- package/docs/AuthRefreshTokenRequest.md +24 -0
- package/docs/AuthRefreshTokenResponse.md +34 -0
- package/docs/AuthRequestPasswordResetRequest.md +22 -0
- package/docs/{UserAuthFlowOAuthCallbackRequest.md → AuthRequestPasswordResetResponse.md} +7 -7
- package/docs/AuthResetPasswordRequest.md +22 -0
- package/docs/{AdminAuthFlowInitResponse.md → AuthResetPasswordResponse.md} +5 -5
- package/docs/AuthRevokeOtherSessionsResponse.md +24 -0
- package/docs/{UserAuthInfo.md → AuthRevokeSessionRequest.md} +5 -5
- package/docs/AuthRevokeSessionResponse.md +24 -0
- package/docs/AuthRevokeSessionsResponse.md +24 -0
- package/docs/AuthSendVerificationEmailRequest.md +22 -0
- package/docs/{UserAuthFlowOAuthCallbackResponse.md → AuthSendVerificationEmailResponse.md} +5 -7
- package/docs/AuthSignInEmailRequest.md +26 -0
- package/docs/AuthSignInEmailResponse.md +30 -0
- package/docs/AuthSignInSocialRequest.md +30 -0
- package/docs/AuthSignInSocialResponse.md +30 -0
- package/docs/AuthSignOutResponse.md +24 -0
- package/docs/AuthSignUpEmailRequest.md +32 -0
- package/docs/AuthSignUpEmailResponse.md +28 -0
- package/docs/AuthUnlinkAccountRequest.md +22 -0
- package/docs/AuthUnlinkAccountResponse.md +24 -0
- package/docs/AuthUpdateUserRequest.md +22 -0
- package/docs/AuthUpdateUserResponse.md +24 -0
- package/docs/AuthVerifyEmailResponse.md +24 -0
- package/docs/ConfigItem.md +32 -0
- package/docs/ConfigItemHistory.md +22 -0
- 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/RemoteConfigAdminServiceApi.md +287 -0
- package/docs/RemoteConfigItemCreateRequest.md +20 -0
- package/docs/RemoteConfigItemCreateResponse.md +24 -0
- package/docs/RemoteConfigItemDeleteRequest.md +20 -0
- package/docs/RemoteConfigItemDeleteResponse.md +22 -0
- package/docs/RemoteConfigItemGetResponse.md +24 -0
- package/docs/RemoteConfigItemListResponse.md +26 -0
- package/docs/RemoteConfigItemUpdateRequest.md +22 -0
- package/docs/RemoteConfigItemUpdateResponse.md +24 -0
- package/docs/UserInfo.md +14 -8
- package/docs/UserPayServiceApi.md +12 -3
- package/git_push.sh +1 -1
- package/package.json +2 -2
- package/docs/AdminAuthServiceApi.md +0 -81
- package/docs/AuthFlowResult.md +0 -23
- package/docs/UserAuthFlowCodeResponse.md +0 -26
- package/docs/UserAuthFlowInitResponse.md +0 -28
- package/docs/UserAuthServiceApi.md +0 -279
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AuthVerifyEmailResponse
|
|
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** | [**Auth2User**](Auth2User.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AuthVerifyEmailResponse } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: AuthVerifyEmailResponse = {
|
|
18
|
+
code,
|
|
19
|
+
message,
|
|
20
|
+
user,
|
|
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,32 @@
|
|
|
1
|
+
# ConfigItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**key** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**values** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
11
|
+
**payload** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
12
|
+
**createdAt** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**updatedAt** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**deletedAt** | **string** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { ConfigItem } from '@cherryin/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: ConfigItem = {
|
|
22
|
+
id,
|
|
23
|
+
key,
|
|
24
|
+
values,
|
|
25
|
+
payload,
|
|
26
|
+
createdAt,
|
|
27
|
+
updatedAt,
|
|
28
|
+
deletedAt,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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
|
+
# ConfigItemHistory
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**item** | [**ConfigItem**](ConfigItem.md) | | [optional] [default to undefined]
|
|
9
|
+
**history** | [**Array<ConfigItem>**](ConfigItem.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ConfigItemHistory } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: ConfigItemHistory = {
|
|
17
|
+
item,
|
|
18
|
+
history,
|
|
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)
|
|
@@ -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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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** |
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [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,287 @@
|
|
|
1
|
+
# RemoteConfigAdminServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**remoteConfigAdminServiceRemoteConfigItemCreate**](#remoteconfigadminserviceremoteconfigitemcreate) | **POST** /admin/remote-config/create | |
|
|
8
|
+
|[**remoteConfigAdminServiceRemoteConfigItemDelete**](#remoteconfigadminserviceremoteconfigitemdelete) | **DELETE** /admin/remote-config/delete | |
|
|
9
|
+
|[**remoteConfigAdminServiceRemoteConfigItemGet**](#remoteconfigadminserviceremoteconfigitemget) | **GET** /admin/remote-config/get | |
|
|
10
|
+
|[**remoteConfigAdminServiceRemoteConfigItemList**](#remoteconfigadminserviceremoteconfigitemlist) | **GET** /admin/remote-config/list | |
|
|
11
|
+
|[**remoteConfigAdminServiceRemoteConfigItemUpdate**](#remoteconfigadminserviceremoteconfigitemupdate) | **POST** /admin/remote-config/update | |
|
|
12
|
+
|
|
13
|
+
# **remoteConfigAdminServiceRemoteConfigItemCreate**
|
|
14
|
+
> RemoteConfigItemCreateResponse remoteConfigAdminServiceRemoteConfigItemCreate(remoteConfigItemCreateRequest)
|
|
15
|
+
|
|
16
|
+
RemoteConfigItemCreate 创建新的 远程配置项 请求路径: POST /admin/remote-config/create 权限要求: 需要管理员权限
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
RemoteConfigAdminServiceApi,
|
|
23
|
+
Configuration,
|
|
24
|
+
RemoteConfigItemCreateRequest
|
|
25
|
+
} from '@cherryin/api-client';
|
|
26
|
+
|
|
27
|
+
const configuration = new Configuration();
|
|
28
|
+
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
29
|
+
|
|
30
|
+
let remoteConfigItemCreateRequest: RemoteConfigItemCreateRequest; //
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemCreate(
|
|
33
|
+
remoteConfigItemCreateRequest
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **remoteConfigItemCreateRequest** | **RemoteConfigItemCreateRequest**| | |
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**RemoteConfigItemCreateResponse**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
No authorization required
|
|
51
|
+
|
|
52
|
+
### HTTP request headers
|
|
53
|
+
|
|
54
|
+
- **Content-Type**: application/json
|
|
55
|
+
- **Accept**: application/json
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### HTTP response details
|
|
59
|
+
| Status code | Description | Response headers |
|
|
60
|
+
|-------------|-------------|------------------|
|
|
61
|
+
|**200** | OK | - |
|
|
62
|
+
|**0** | Default error response | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
66
|
+
# **remoteConfigAdminServiceRemoteConfigItemDelete**
|
|
67
|
+
> RemoteConfigItemDeleteResponse remoteConfigAdminServiceRemoteConfigItemDelete(remoteConfigItemDeleteRequest)
|
|
68
|
+
|
|
69
|
+
RemoteConfigItemDelete 删除已有的 远程配置项 请求路径: POST /admin/remote-config/delete 权限要求: 需要管理员权限
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
RemoteConfigAdminServiceApi,
|
|
76
|
+
Configuration,
|
|
77
|
+
RemoteConfigItemDeleteRequest
|
|
78
|
+
} from '@cherryin/api-client';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
82
|
+
|
|
83
|
+
let remoteConfigItemDeleteRequest: RemoteConfigItemDeleteRequest; //
|
|
84
|
+
|
|
85
|
+
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemDelete(
|
|
86
|
+
remoteConfigItemDeleteRequest
|
|
87
|
+
);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
|Name | Type | Description | Notes|
|
|
93
|
+
|------------- | ------------- | ------------- | -------------|
|
|
94
|
+
| **remoteConfigItemDeleteRequest** | **RemoteConfigItemDeleteRequest**| | |
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
**RemoteConfigItemDeleteResponse**
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
No authorization required
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: application/json
|
|
108
|
+
- **Accept**: application/json
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### HTTP response details
|
|
112
|
+
| Status code | Description | Response headers |
|
|
113
|
+
|-------------|-------------|------------------|
|
|
114
|
+
|**200** | OK | - |
|
|
115
|
+
|**0** | Default error response | - |
|
|
116
|
+
|
|
117
|
+
[[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)
|
|
118
|
+
|
|
119
|
+
# **remoteConfigAdminServiceRemoteConfigItemGet**
|
|
120
|
+
> RemoteConfigItemGetResponse remoteConfigAdminServiceRemoteConfigItemGet()
|
|
121
|
+
|
|
122
|
+
RemoteConfigItemGet 获取指定的 远程配置项 及其历史版本 请求路径: GET /admin/remote-config/get 权限要求: 需要管理员权限
|
|
123
|
+
|
|
124
|
+
### Example
|
|
125
|
+
|
|
126
|
+
```typescript
|
|
127
|
+
import {
|
|
128
|
+
RemoteConfigAdminServiceApi,
|
|
129
|
+
Configuration
|
|
130
|
+
} from '@cherryin/api-client';
|
|
131
|
+
|
|
132
|
+
const configuration = new Configuration();
|
|
133
|
+
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
134
|
+
|
|
135
|
+
let key: string; //@gotags: form:\"key\" binding:\"required\" (optional) (default to undefined)
|
|
136
|
+
let historyLimit: number; //@gotags: form:\"history_limit\" (optional) (default to undefined)
|
|
137
|
+
|
|
138
|
+
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemGet(
|
|
139
|
+
key,
|
|
140
|
+
historyLimit
|
|
141
|
+
);
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
|Name | Type | Description | Notes|
|
|
147
|
+
|------------- | ------------- | ------------- | -------------|
|
|
148
|
+
| **key** | [**string**] | @gotags: form:\"key\" binding:\"required\" | (optional) defaults to undefined|
|
|
149
|
+
| **historyLimit** | [**number**] | @gotags: form:\"history_limit\" | (optional) defaults to undefined|
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
### Return type
|
|
153
|
+
|
|
154
|
+
**RemoteConfigItemGetResponse**
|
|
155
|
+
|
|
156
|
+
### Authorization
|
|
157
|
+
|
|
158
|
+
No authorization required
|
|
159
|
+
|
|
160
|
+
### HTTP request headers
|
|
161
|
+
|
|
162
|
+
- **Content-Type**: Not defined
|
|
163
|
+
- **Accept**: application/json
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
### HTTP response details
|
|
167
|
+
| Status code | Description | Response headers |
|
|
168
|
+
|-------------|-------------|------------------|
|
|
169
|
+
|**200** | OK | - |
|
|
170
|
+
|**0** | Default error response | - |
|
|
171
|
+
|
|
172
|
+
[[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)
|
|
173
|
+
|
|
174
|
+
# **remoteConfigAdminServiceRemoteConfigItemList**
|
|
175
|
+
> RemoteConfigItemListResponse remoteConfigAdminServiceRemoteConfigItemList()
|
|
176
|
+
|
|
177
|
+
RemoteConfigItemList 列出 远程配置项 列表 请求路径: GET /admin/remote-config/list 权限要求: 需要管理员权限
|
|
178
|
+
|
|
179
|
+
### Example
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
import {
|
|
183
|
+
RemoteConfigAdminServiceApi,
|
|
184
|
+
Configuration
|
|
185
|
+
} from '@cherryin/api-client';
|
|
186
|
+
|
|
187
|
+
const configuration = new Configuration();
|
|
188
|
+
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
189
|
+
|
|
190
|
+
let page: number; // (optional) (default to undefined)
|
|
191
|
+
let pageSize: number; // (optional) (default to undefined)
|
|
192
|
+
let keys: Array<string>; // (optional) (default to undefined)
|
|
193
|
+
let keyword: string; // (optional) (default to undefined)
|
|
194
|
+
|
|
195
|
+
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemList(
|
|
196
|
+
page,
|
|
197
|
+
pageSize,
|
|
198
|
+
keys,
|
|
199
|
+
keyword
|
|
200
|
+
);
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
|Name | Type | Description | Notes|
|
|
206
|
+
|------------- | ------------- | ------------- | -------------|
|
|
207
|
+
| **page** | [**number**] | | (optional) defaults to undefined|
|
|
208
|
+
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
|
209
|
+
| **keys** | **Array<string>** | | (optional) defaults to undefined|
|
|
210
|
+
| **keyword** | [**string**] | | (optional) defaults to undefined|
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### Return type
|
|
214
|
+
|
|
215
|
+
**RemoteConfigItemListResponse**
|
|
216
|
+
|
|
217
|
+
### Authorization
|
|
218
|
+
|
|
219
|
+
No authorization required
|
|
220
|
+
|
|
221
|
+
### HTTP request headers
|
|
222
|
+
|
|
223
|
+
- **Content-Type**: Not defined
|
|
224
|
+
- **Accept**: application/json
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
### HTTP response details
|
|
228
|
+
| Status code | Description | Response headers |
|
|
229
|
+
|-------------|-------------|------------------|
|
|
230
|
+
|**200** | OK | - |
|
|
231
|
+
|**0** | Default error response | - |
|
|
232
|
+
|
|
233
|
+
[[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)
|
|
234
|
+
|
|
235
|
+
# **remoteConfigAdminServiceRemoteConfigItemUpdate**
|
|
236
|
+
> RemoteConfigItemUpdateResponse remoteConfigAdminServiceRemoteConfigItemUpdate(remoteConfigItemUpdateRequest)
|
|
237
|
+
|
|
238
|
+
RemoteConfigItemUpdate 更新已有的 远程配置项 请求路径: POST /admin/remote-config/update 权限要求: 需要管理员权限
|
|
239
|
+
|
|
240
|
+
### Example
|
|
241
|
+
|
|
242
|
+
```typescript
|
|
243
|
+
import {
|
|
244
|
+
RemoteConfigAdminServiceApi,
|
|
245
|
+
Configuration,
|
|
246
|
+
RemoteConfigItemUpdateRequest
|
|
247
|
+
} from '@cherryin/api-client';
|
|
248
|
+
|
|
249
|
+
const configuration = new Configuration();
|
|
250
|
+
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
251
|
+
|
|
252
|
+
let remoteConfigItemUpdateRequest: RemoteConfigItemUpdateRequest; //
|
|
253
|
+
|
|
254
|
+
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemUpdate(
|
|
255
|
+
remoteConfigItemUpdateRequest
|
|
256
|
+
);
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### Parameters
|
|
260
|
+
|
|
261
|
+
|Name | Type | Description | Notes|
|
|
262
|
+
|------------- | ------------- | ------------- | -------------|
|
|
263
|
+
| **remoteConfigItemUpdateRequest** | **RemoteConfigItemUpdateRequest**| | |
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### Return type
|
|
267
|
+
|
|
268
|
+
**RemoteConfigItemUpdateResponse**
|
|
269
|
+
|
|
270
|
+
### Authorization
|
|
271
|
+
|
|
272
|
+
No authorization required
|
|
273
|
+
|
|
274
|
+
### HTTP request headers
|
|
275
|
+
|
|
276
|
+
- **Content-Type**: application/json
|
|
277
|
+
- **Accept**: application/json
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
### HTTP response details
|
|
281
|
+
| Status code | Description | Response headers |
|
|
282
|
+
|-------------|-------------|------------------|
|
|
283
|
+
|**200** | OK | - |
|
|
284
|
+
|**0** | Default error response | - |
|
|
285
|
+
|
|
286
|
+
[[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)
|
|
287
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RemoteConfigItemCreateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**item** | [**ConfigItem**](ConfigItem.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { RemoteConfigItemCreateRequest } from '@cherryin/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: RemoteConfigItemCreateRequest = {
|
|
16
|
+
item,
|
|
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,24 @@
|
|
|
1
|
+
# RemoteConfigItemCreateResponse
|
|
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
|
+
**item** | [**ConfigItem**](ConfigItem.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RemoteConfigItemCreateResponse } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: RemoteConfigItemCreateResponse = {
|
|
18
|
+
code,
|
|
19
|
+
message,
|
|
20
|
+
item,
|
|
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,20 @@
|
|
|
1
|
+
# RemoteConfigItemDeleteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**key** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { RemoteConfigItemDeleteRequest } from '@cherryin/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: RemoteConfigItemDeleteRequest = {
|
|
16
|
+
key,
|
|
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
|
+
# RemoteConfigItemDeleteResponse
|
|
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 { RemoteConfigItemDeleteResponse } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: RemoteConfigItemDeleteResponse = {
|
|
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
|
+
# RemoteConfigItemGetResponse
|
|
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
|
+
**data** | [**ConfigItemHistory**](ConfigItemHistory.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RemoteConfigItemGetResponse } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: RemoteConfigItemGetResponse = {
|
|
18
|
+
code,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
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
|
+
# RemoteConfigItemListResponse
|
|
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
|
+
**list** | [**Array<ConfigItem>**](ConfigItem.md) | | [optional] [default to undefined]
|
|
11
|
+
**total** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RemoteConfigItemListResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: RemoteConfigItemListResponse = {
|
|
19
|
+
code,
|
|
20
|
+
message,
|
|
21
|
+
list,
|
|
22
|
+
total,
|
|
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,22 @@
|
|
|
1
|
+
# RemoteConfigItemUpdateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**key** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**item** | [**ConfigItem**](ConfigItem.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RemoteConfigItemUpdateRequest } from '@cherryin/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: RemoteConfigItemUpdateRequest = {
|
|
17
|
+
key,
|
|
18
|
+
item,
|
|
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)
|