@cherryin/api-client 0.0.3 → 0.0.5

package/docs/GetUserDetailResponse.md

@@ -0,0 +1,24 @@
+# GetUserDetailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**user** | [**UserManageDetail**](UserManageDetail.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetUserDetailResponse } from '@cherryin/api-client';
+
+const instance: GetUserDetailResponse = {
+    code,
+    message,
+    user,
+};
+```
+
+[[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/ListUsersRequest.md

@@ -0,0 +1,36 @@
+# ListUsersRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **number** | 分页参数 | [optional] [default to undefined]
+**page_size** | **number** |  | [optional] [default to undefined]
+**uids** | **Array<string>** | 过滤条件 | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**user_statuses** | **Array<number>** |  | [optional] [default to undefined]
+**user_roles** | **Array<number>** |  | [optional] [default to undefined]
+**order_by** | **string** | 排序 | [optional] [default to undefined]
+**order_dir** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListUsersRequest } from '@cherryin/api-client';
+
+const instance: ListUsersRequest = {
+    page,
+    page_size,
+    uids,
+    display_name,
+    email,
+    user_statuses,
+    user_roles,
+    order_by,
+    order_dir,
+};
+```
+
+[[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/ListUsersResponse.md

@@ -0,0 +1,30 @@
+# ListUsersResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**users** | [**Array<UserManageItem>**](UserManageItem.md) |  | [optional] [default to undefined]
+**total** | **string** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**page_size** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListUsersResponse } from '@cherryin/api-client';
+
+const instance: ListUsersResponse = {
+    code,
+    message,
+    users,
+    total,
+    page,
+    page_size,
+};
+```
+
+[[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/ProviderAdminServiceApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *http://localhost*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**providerAdminServiceProviderCreate**](#provideradminserviceprovidercreate) | **POST** /admin/provider/create | |
-|[**providerAdminServiceProviderDelete**](#provideradminserviceproviderdelete) | **POST** /admin/provider/delete | |
+|[**providerAdminServiceProviderDelete**](#provideradminserviceproviderdelete) | **DELETE** /admin/provider/delete | |
 |[**providerAdminServiceProviderGet**](#provideradminserviceproviderget) | **GET** /admin/provider/get | |
 |[**providerAdminServiceProviderList**](#provideradminserviceproviderlist) | **GET** /admin/provider/list | |
 |[**providerAdminServiceProviderUpdate**](#provideradminserviceproviderupdate) | **POST** /admin/provider/update | |

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/UserManageAPIKey.md

@@ -0,0 +1,38 @@
+# UserManageAPIKey
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**key_group** | **string** |  | [optional] [default to undefined]
+**balance_code** | **string** |  | [optional] [default to undefined]
+**quota_total** | **string** |  | [optional] [default to undefined]
+**quota_used** | **string** |  | [optional] [default to undefined]
+**quota_mode** | **number** |  | [optional] [default to undefined]
+**key_status** | **number** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageAPIKey } from '@cherryin/api-client';
+
+const instance: UserManageAPIKey = {
+    id,
+    name,
+    key_group,
+    balance_code,
+    quota_total,
+    quota_used,
+    quota_mode,
+    key_status,
+    expires_at,
+    created_at,
+};
+```
+
+[[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/UserManageAdminServiceApi.md

@@ -0,0 +1,330 @@
+# UserManageAdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userManageAdminServiceBatchUpdateSessions**](#usermanageadminservicebatchupdatesessions) | **POST** /admin/users/manage/sessions | |
+|[**userManageAdminServiceGetUserDetail**](#usermanageadminservicegetuserdetail) | **GET** /admin/users/detail | |
+|[**userManageAdminServiceListUsers**](#usermanageadminservicelistusers) | **POST** /admin/users/list | |
+|[**userManageAdminServiceSetUserRole**](#usermanageadminservicesetuserrole) | **POST** /admin/users/manage/role | |
+|[**userManageAdminServiceSetUserStatus**](#usermanageadminservicesetuserstatus) | **POST** /admin/users/manage/status | |
+|[**userManageAdminServiceUpdateUserInfo**](#usermanageadminserviceupdateuserinfo) | **POST** /admin/users/manage/info | |
+
+# **userManageAdminServiceBatchUpdateSessions**
+> BatchUpdateSessionsResponse userManageAdminServiceBatchUpdateSessions(batchUpdateSessionsRequest)
+
+批量管理 Session
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    BatchUpdateSessionsRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let batchUpdateSessionsRequest: BatchUpdateSessionsRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceBatchUpdateSessions(
+    batchUpdateSessionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **batchUpdateSessionsRequest** | **BatchUpdateSessionsRequest**|  | |
+
+
+### Return type
+
+**BatchUpdateSessionsResponse**
+
+### 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)
+
+# **userManageAdminServiceGetUserDetail**
+> GetUserDetailResponse userManageAdminServiceGetUserDetail()
+
+用户详情
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let uid: string; //@gotags: form:\"uid\" binding:\"uid\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userManageAdminServiceGetUserDetail(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] | @gotags: form:\"uid\" binding:\"uid\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetUserDetailResponse**
+
+### 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)
+
+# **userManageAdminServiceListUsers**
+> ListUsersResponse userManageAdminServiceListUsers(listUsersRequest)
+
+用户列表（分页查询）
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    ListUsersRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let listUsersRequest: ListUsersRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceListUsers(
+    listUsersRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listUsersRequest** | **ListUsersRequest**|  | |
+
+
+### Return type
+
+**ListUsersResponse**
+
+### 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)
+
+# **userManageAdminServiceSetUserRole**
+> SetUserRoleResponse userManageAdminServiceSetUserRole(setUserRoleRequest)
+
+设置用户角色
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    SetUserRoleRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let setUserRoleRequest: SetUserRoleRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceSetUserRole(
+    setUserRoleRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setUserRoleRequest** | **SetUserRoleRequest**|  | |
+
+
+### Return type
+
+**SetUserRoleResponse**
+
+### 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)
+
+# **userManageAdminServiceSetUserStatus**
+> SetUserStatusResponse userManageAdminServiceSetUserStatus(setUserStatusRequest)
+
+设置用户状态（启用/禁用）
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    SetUserStatusRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let setUserStatusRequest: SetUserStatusRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceSetUserStatus(
+    setUserStatusRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setUserStatusRequest** | **SetUserStatusRequest**|  | |
+
+
+### Return type
+
+**SetUserStatusResponse**
+
+### 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)
+
+# **userManageAdminServiceUpdateUserInfo**
+> UpdateUserInfoResponse userManageAdminServiceUpdateUserInfo(updateUserInfoRequest)
+
+更新用户信息
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    UpdateUserInfoRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let updateUserInfoRequest: UpdateUserInfoRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceUpdateUserInfo(
+    updateUserInfoRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserInfoRequest** | **UpdateUserInfoRequest**|  | |
+
+
+### Return type
+
+**UpdateUserInfoResponse**
+
+### 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/UserManageAuthMethod.md

@@ -0,0 +1,32 @@
+# UserManageAuthMethod
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**auth_type** | **string** |  | [optional] [default to undefined]
+**auth_id** | **string** |  | [optional] [default to undefined]
+**is_primary** | **boolean** |  | [optional] [default to undefined]
+**auth_status** | **number** |  | [optional] [default to undefined]
+**last_used_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageAuthMethod } from '@cherryin/api-client';
+
+const instance: UserManageAuthMethod = {
+    id,
+    auth_type,
+    auth_id,
+    is_primary,
+    auth_status,
+    last_used_at,
+    created_at,
+};
+```
+
+[[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/UserManageBalance.md

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