@cherryin/aigw-api-client 0.1.0

package/docs/UserManageAdminServiceApi.md

@@ -0,0 +1,324 @@
+# UserManageAdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userManageAdminServiceBatchUpdateSessions**](#usermanageadminservicebatchupdatesessions) | **POST** /admin/users/manage/sessions | 批量管理 Session|
+|[**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(body)
+
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    BatchUpdateSessionsRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let body: BatchUpdateSessionsRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceBatchUpdateSessions(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **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** | A successful response. |  -  |
+|**0** | An unexpected 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/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let uid: string; //@gotags: form:\"uid\" binding:\"uid\"  用户 UID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userManageAdminServiceGetUserDetail(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] | @gotags: form:\"uid\" binding:\"uid\"  用户 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** | A successful response. |  -  |
+|**0** | An unexpected 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(body)
+
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    ListUsersRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let body: ListUsersRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceListUsers(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **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** | A successful response. |  -  |
+|**0** | An unexpected 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(body)
+
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    SetUserRoleRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let body: SetUserRoleRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceSetUserRole(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **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** | A successful response. |  -  |
+|**0** | An unexpected 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(body)
+
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    SetUserStatusRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let body: SetUserStatusRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceSetUserStatus(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **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** | A successful response. |  -  |
+|**0** | An unexpected 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(body)
+
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    UpdateUserInfoRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let body: UpdateUserInfoRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceUpdateUserInfo(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **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** | A successful response. |  -  |
+|**0** | An unexpected 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/aigw-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/aigw-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)

package/docs/UserManageDetail.md

@@ -0,0 +1,46 @@
+# UserManageDetail
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**user_role** | **number** |  | [optional] [default to undefined]
+**user_status** | **number** |  | [optional] [default to undefined]
+**user_group** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**settings** | [**UserManageSettings**](UserManageSettings.md) |  | [optional] [default to undefined]
+**balance** | [**UserManageBalance**](UserManageBalance.md) |  | [optional] [default to undefined]
+**api_keys** | [**Array<UserManageAPIKey>**](UserManageAPIKey.md) |  | [optional] [default to undefined]
+**auth_methods** | [**Array<UserManageAuthMethod>**](UserManageAuthMethod.md) |  | [optional] [default to undefined]
+**sessions** | [**Array<UserManageSession>**](UserManageSession.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageDetail } from '@cherryin/aigw-api-client';
+
+const instance: UserManageDetail = {
+    uid,
+    display_name,
+    email,
+    avatar_url,
+    user_role,
+    user_status,
+    user_group,
+    created_at,
+    updated_at,
+    settings,
+    balance,
+    api_keys,
+    auth_methods,
+    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/UserManageItem.md

@@ -0,0 +1,38 @@
+# UserManageItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**user_role** | **number** |  | [optional] [default to undefined]
+**user_status** | **number** |  | [optional] [default to undefined]
+**user_group** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**auth_types** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageItem } from '@cherryin/aigw-api-client';
+
+const instance: UserManageItem = {
+    uid,
+    display_name,
+    email,
+    avatar_url,
+    user_role,
+    user_status,
+    user_group,
+    created_at,
+    updated_at,
+    auth_types,
+};
+```
+
+[[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/UserManageSession.md

@@ -0,0 +1,34 @@
+# UserManageSession
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**session_type** | **string** |  | [optional] [default to undefined]
+**ip_address** | **string** |  | [optional] [default to undefined]
+**user_agent** | **string** |  | [optional] [default to undefined]
+**active_at** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**is_current** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageSession } from '@cherryin/aigw-api-client';
+
+const instance: UserManageSession = {
+    id,
+    session_type,
+    ip_address,
+    user_agent,
+    active_at,
+    expires_at,
+    created_at,
+    is_current,
+};
+```
+
+[[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/UserManageSettings.md

@@ -0,0 +1,20 @@
+# UserManageSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_notifications_enabled** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageSettings } from '@cherryin/aigw-api-client';
+
+const instance: UserManageSettings = {
+    email_notifications_enabled,
+};
+```
+
+[[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/UserMeInfoResponse.md

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

@@ -0,0 +1,30 @@
+# UserModelActivitySummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_model_request_count** | **string** |  | [optional] [default to undefined]
+**total_model_request_tokens** | **string** |  | [optional] [default to undefined]
+**stat_model_request_count** | **string** |  | [optional] [default to undefined]
+**stat_model_request_tokens** | **string** |  | [optional] [default to undefined]
+**stat_model_rpm_avg** | **string** |  | [optional] [default to undefined]
+**stat_model_tpm_avg** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserModelActivitySummary } from '@cherryin/aigw-api-client';
+
+const instance: UserModelActivitySummary = {
+    total_model_request_count,
+    total_model_request_tokens,
+    stat_model_request_count,
+    stat_model_request_tokens,
+    stat_model_rpm_avg,
+    stat_model_tpm_avg,
+};
+```
+
+[[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/UserModelHourActivity.md

@@ -0,0 +1,28 @@
+# UserModelHourActivity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hour_at** | **string** |  | [optional] [default to undefined]
+**model_id** | **string** |  | [optional] [default to undefined]
+**total_request_count** | **string** |  | [optional] [default to undefined]
+**total_request_tokens** | **string** |  | [optional] [default to undefined]
+**total_cost** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserModelHourActivity } from '@cherryin/aigw-api-client';
+
+const instance: UserModelHourActivity = {
+    hour_at,
+    model_id,
+    total_request_count,
+    total_request_tokens,
+    total_cost,
+};
+```
+
+[[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/UserModelHourlyUsages.md

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