@cherryin/api-client 0.0.4 → 0.0.5

package/docs/RemoteConfigAdminServiceApi.md

@@ -0,0 +1,287 @@
+# RemoteConfigAdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**remoteConfigAdminServiceRemoteConfigItemCreate**](#remoteconfigadminserviceremoteconfigitemcreate) | **POST** /admin/remote-config/create | |
+|[**remoteConfigAdminServiceRemoteConfigItemDelete**](#remoteconfigadminserviceremoteconfigitemdelete) | **DELETE** /admin/remote-config/delete | |
+|[**remoteConfigAdminServiceRemoteConfigItemGet**](#remoteconfigadminserviceremoteconfigitemget) | **GET** /admin/remote-config/get | |
+|[**remoteConfigAdminServiceRemoteConfigItemList**](#remoteconfigadminserviceremoteconfigitemlist) | **GET** /admin/remote-config/list | |
+|[**remoteConfigAdminServiceRemoteConfigItemUpdate**](#remoteconfigadminserviceremoteconfigitemupdate) | **POST** /admin/remote-config/update | |
+
+# **remoteConfigAdminServiceRemoteConfigItemCreate**
+> RemoteConfigItemCreateResponse remoteConfigAdminServiceRemoteConfigItemCreate(remoteConfigItemCreateRequest)
+
+RemoteConfigItemCreate 创建新的 远程配置项  请求路径: POST /admin/remote-config/create  权限要求: 需要管理员权限
+
+### Example
+
+```typescript
+import {
+    RemoteConfigAdminServiceApi,
+    Configuration,
+    RemoteConfigItemCreateRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new RemoteConfigAdminServiceApi(configuration);
+
+let remoteConfigItemCreateRequest: RemoteConfigItemCreateRequest; //
+
+const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemCreate(
+    remoteConfigItemCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **remoteConfigItemCreateRequest** | **RemoteConfigItemCreateRequest**|  | |
+
+
+### Return type
+
+**RemoteConfigItemCreateResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **remoteConfigAdminServiceRemoteConfigItemDelete**
+> RemoteConfigItemDeleteResponse remoteConfigAdminServiceRemoteConfigItemDelete(remoteConfigItemDeleteRequest)
+
+RemoteConfigItemDelete 删除已有的 远程配置项  请求路径: POST /admin/remote-config/delete  权限要求: 需要管理员权限
+
+### Example
+
+```typescript
+import {
+    RemoteConfigAdminServiceApi,
+    Configuration,
+    RemoteConfigItemDeleteRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new RemoteConfigAdminServiceApi(configuration);
+
+let remoteConfigItemDeleteRequest: RemoteConfigItemDeleteRequest; //
+
+const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemDelete(
+    remoteConfigItemDeleteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **remoteConfigItemDeleteRequest** | **RemoteConfigItemDeleteRequest**|  | |
+
+
+### Return type
+
+**RemoteConfigItemDeleteResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **remoteConfigAdminServiceRemoteConfigItemGet**
+> RemoteConfigItemGetResponse remoteConfigAdminServiceRemoteConfigItemGet()
+
+RemoteConfigItemGet 获取指定的 远程配置项 及其历史版本  请求路径: GET /admin/remote-config/get  权限要求: 需要管理员权限
+
+### Example
+
+```typescript
+import {
+    RemoteConfigAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new RemoteConfigAdminServiceApi(configuration);
+
+let key: string; //@gotags: form:\"key\" binding:\"required\" (optional) (default to undefined)
+let historyLimit: number; //@gotags: form:\"history_limit\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemGet(
+    key,
+    historyLimit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | @gotags: form:\"key\" binding:\"required\" | (optional) defaults to undefined|
+| **historyLimit** | [**number**] | @gotags: form:\"history_limit\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**RemoteConfigItemGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **remoteConfigAdminServiceRemoteConfigItemList**
+> RemoteConfigItemListResponse remoteConfigAdminServiceRemoteConfigItemList()
+
+RemoteConfigItemList 列出 远程配置项 列表  请求路径: GET /admin/remote-config/list  权限要求: 需要管理员权限
+
+### Example
+
+```typescript
+import {
+    RemoteConfigAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new RemoteConfigAdminServiceApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let pageSize: number; // (optional) (default to undefined)
+let keys: Array<string>; // (optional) (default to undefined)
+let keyword: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemList(
+    page,
+    pageSize,
+    keys,
+    keyword
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **pageSize** | [**number**] |  | (optional) defaults to undefined|
+| **keys** | **Array&lt;string&gt;** |  | (optional) defaults to undefined|
+| **keyword** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**RemoteConfigItemListResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **remoteConfigAdminServiceRemoteConfigItemUpdate**
+> RemoteConfigItemUpdateResponse remoteConfigAdminServiceRemoteConfigItemUpdate(remoteConfigItemUpdateRequest)
+
+RemoteConfigItemUpdate 更新已有的 远程配置项  请求路径: POST /admin/remote-config/update  权限要求: 需要管理员权限
+
+### Example
+
+```typescript
+import {
+    RemoteConfigAdminServiceApi,
+    Configuration,
+    RemoteConfigItemUpdateRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new RemoteConfigAdminServiceApi(configuration);
+
+let remoteConfigItemUpdateRequest: RemoteConfigItemUpdateRequest; //
+
+const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemUpdate(
+    remoteConfigItemUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **remoteConfigItemUpdateRequest** | **RemoteConfigItemUpdateRequest**|  | |
+
+
+### Return type
+
+**RemoteConfigItemUpdateResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+

package/docs/RemoteConfigItemCreateRequest.md

@@ -0,0 +1,20 @@
+# RemoteConfigItemCreateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item** | [**ConfigItem**](ConfigItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemCreateRequest } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemCreateRequest = {
+    item,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemCreateResponse.md

@@ -0,0 +1,24 @@
+# RemoteConfigItemCreateResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**item** | [**ConfigItem**](ConfigItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemCreateResponse } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemCreateResponse = {
+    code,
+    message,
+    item,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemDeleteRequest.md

@@ -0,0 +1,20 @@
+# RemoteConfigItemDeleteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemDeleteRequest } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemDeleteRequest = {
+    key,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemDeleteResponse.md

@@ -0,0 +1,22 @@
+# RemoteConfigItemDeleteResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemDeleteResponse } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemDeleteResponse = {
+    code,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemGetResponse.md

@@ -0,0 +1,24 @@
+# RemoteConfigItemGetResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**data** | [**ConfigItemHistory**](ConfigItemHistory.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemGetResponse } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemGetResponse = {
+    code,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemListResponse.md

@@ -0,0 +1,26 @@
+# RemoteConfigItemListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**list** | [**Array<ConfigItem>**](ConfigItem.md) |  | [optional] [default to undefined]
+**total** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemListResponse } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemListResponse = {
+    code,
+    message,
+    list,
+    total,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemUpdateRequest.md

@@ -0,0 +1,22 @@
+# RemoteConfigItemUpdateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**item** | [**ConfigItem**](ConfigItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemUpdateRequest } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemUpdateRequest = {
+    key,
+    item,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RemoteConfigItemUpdateResponse.md

@@ -0,0 +1,24 @@
+# RemoteConfigItemUpdateResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**item** | [**ConfigItem**](ConfigItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteConfigItemUpdateResponse } from '@cherryin/api-client';
+
+const instance: RemoteConfigItemUpdateResponse = {
+    code,
+    message,
+    item,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SetUserRoleRequest.md

@@ -0,0 +1,22 @@
+# SetUserRoleRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**new_role** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SetUserRoleRequest } from '@cherryin/api-client';
+
+const instance: SetUserRoleRequest = {
+    uid,
+    new_role,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SetUserRoleResponse.md

@@ -0,0 +1,24 @@
+# SetUserRoleResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SetUserRoleResponse } from '@cherryin/api-client';
+
+const instance: SetUserRoleResponse = {
+    code,
+    message,
+    success,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SetUserStatusRequest.md

@@ -0,0 +1,22 @@
+# SetUserStatusRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**new_status** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SetUserStatusRequest } from '@cherryin/api-client';
+
+const instance: SetUserStatusRequest = {
+    uid,
+    new_status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SetUserStatusResponse.md

@@ -0,0 +1,26 @@
+# SetUserStatusResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to undefined]
+**revoked_sessions** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SetUserStatusResponse } from '@cherryin/api-client';
+
+const instance: SetUserStatusResponse = {
+    code,
+    message,
+    success,
+    revoked_sessions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateUserInfoRequest.md

@@ -0,0 +1,26 @@
+# UpdateUserInfoRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateUserInfoRequest } from '@cherryin/api-client';
+
+const instance: UpdateUserInfoRequest = {
+    uid,
+    display_name,
+    email,
+    password,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateUserInfoResponse.md

@@ -0,0 +1,24 @@
+# UpdateUserInfoResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateUserInfoResponse } from '@cherryin/api-client';
+
+const instance: UpdateUserInfoResponse = {
+    code,
+    message,
+    success,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserInfo.md

@@ -5,10 +5,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**user_id** | **string** |  | [optional] [default to undefined]
-**display_name** | **string** |  | [optional] [default to undefined]
-**avatar_url** | **string** |  | [optional] [default to undefined]
-**contact_email** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**email_verified** | **boolean** |  | [optional] [default to undefined]
+**image** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,10 +19,13 @@ Name | Type | Description | Notes
 import { UserInfo } from '@cherryin/api-client';
 
 const instance: UserInfo = {
-    user_id,
-    display_name,
-    avatar_url,
-    contact_email,
+    id,
+    name,
+    email,
+    email_verified,
+    image,
+    created_at,
+    updated_at,
 };
 ```