@cherryin/aigw-api-client 0.1.0

package/docs/UserAPIKeyServiceApi.md

@@ -0,0 +1,284 @@
+# UserAPIKeyServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userAPIKeyServiceUserAPIKeyCreate**](#userapikeyserviceuserapikeycreate) | **POST** /api/v1/user/api-key/create | UserAPIKeyCreate 创建新的 UserAPIKey 请求路径: POST /api/user/api-key/create|
+|[**userAPIKeyServiceUserAPIKeyDelete**](#userapikeyserviceuserapikeydelete) | **DELETE** /api/v1/user/api-key/delete | UserAPIKeyDelete 删除 UserAPIKey（软删除） 请求路径: POST /api/user/api-key/delete|
+|[**userAPIKeyServiceUserAPIKeyGet**](#userapikeyserviceuserapikeyget) | **GET** /api/v1/user/api-key/get | UserAPIKeyGet 根据 ID 或名称获取单个 UserAPIKey Request path: GET /api/user/api-key/get?id={id} or GET /api/user/api-key/get?name={name}|
+|[**userAPIKeyServiceUserAPIKeyList**](#userapikeyserviceuserapikeylist) | **GET** /api/v1/user/api-key/list | UserAPIKeyList 分页查询 UserAPIKey 列表，支持按状态和分组过滤 请求路径: GET /api/user/api-key/list?page={page}&page_size={page_size}&key_status={status}&key_group={group}|
+|[**userAPIKeyServiceUserAPIKeyUpdate**](#userapikeyserviceuserapikeyupdate) | **POST** /api/v1/user/api-key/update | UserAPIKeyUpdate 更新现有的 UserAPIKey 请求路径: POST /api/user/api-key/update|
+
+# **userAPIKeyServiceUserAPIKeyCreate**
+> UserAPIKeyCreateResponse userAPIKeyServiceUserAPIKeyCreate(body)
+
+
+### Example
+
+```typescript
+import {
+    UserAPIKeyServiceApi,
+    Configuration,
+    UserAPIKeyCreateRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserAPIKeyServiceApi(configuration);
+
+let body: UserAPIKeyCreateRequest; //
+
+const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyCreate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **UserAPIKeyCreateRequest**|  | |
+
+
+### Return type
+
+**UserAPIKeyCreateResponse**
+
+### 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)
+
+# **userAPIKeyServiceUserAPIKeyDelete**
+> UserAPIKeyDeleteResponse userAPIKeyServiceUserAPIKeyDelete()
+
+
+### Example
+
+```typescript
+import {
+    UserAPIKeyServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserAPIKeyServiceApi(configuration);
+
+let id: string; //id 要删除的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | id 要删除的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserAPIKeyDeleteResponse**
+
+### 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)
+
+# **userAPIKeyServiceUserAPIKeyGet**
+> UserAPIKeyGetResponse userAPIKeyServiceUserAPIKeyGet()
+
+
+### Example
+
+```typescript
+import {
+    UserAPIKeyServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserAPIKeyServiceApi(configuration);
+
+let id: string; //id 要获取的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" (optional) (default to undefined)
+let name: string; //name 要获取的 UserAPIKey 的名称 如果同时提供 id 和 name，以 id 为准 @gotags: form:\"name\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyGet(
+    id,
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | id 要获取的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" | (optional) defaults to undefined|
+| **name** | [**string**] | name 要获取的 UserAPIKey 的名称 如果同时提供 id 和 name，以 id 为准 @gotags: form:\"name\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserAPIKeyGetResponse**
+
+### 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)
+
+# **userAPIKeyServiceUserAPIKeyList**
+> UserAPIKeyListResponse userAPIKeyServiceUserAPIKeyList()
+
+
+### Example
+
+```typescript
+import {
+    UserAPIKeyServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserAPIKeyServiceApi(configuration);
+
+let page: number; //page 页码，从 1 开始 默认值: 1 @gotags: form:\"page\" (optional) (default to undefined)
+let pageSize: number; //page_size 每页数量 默认值: 20，最大值: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
+let uid: string; //uid 按用户 ID 过滤（可选，管理员可用） 0: return API keys from all users (admin only) > 0: return API keys from specific user only @gotags: form:\"uid\" (optional) (default to undefined)
+let keyStatus: string; //key_status 按状态过滤（可选） 0: 返回所有状态 1: 仅返回启用的 API Key 2: 仅返回禁用的 API Key @gotags: form:\"key_status\" (optional) (default to undefined)
+let keyGroup: string; //key_group 按分组过滤（可选） @gotags: form:\"key_group\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyList(
+    page,
+    pageSize,
+    uid,
+    keyStatus,
+    keyGroup
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | page 页码，从 1 开始 默认值: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
+| **pageSize** | [**number**] | page_size 每页数量 默认值: 20，最大值: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
+| **uid** | [**string**] | uid 按用户 ID 过滤（可选，管理员可用） 0: return API keys from all users (admin only) > 0: return API keys from specific user only @gotags: form:\"uid\" | (optional) defaults to undefined|
+| **keyStatus** | [**string**] | key_status 按状态过滤（可选） 0: 返回所有状态 1: 仅返回启用的 API Key 2: 仅返回禁用的 API Key @gotags: form:\"key_status\" | (optional) defaults to undefined|
+| **keyGroup** | [**string**] | key_group 按分组过滤（可选） @gotags: form:\"key_group\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserAPIKeyListResponse**
+
+### 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)
+
+# **userAPIKeyServiceUserAPIKeyUpdate**
+> UserAPIKeyUpdateResponse userAPIKeyServiceUserAPIKeyUpdate(body)
+
+
+### Example
+
+```typescript
+import {
+    UserAPIKeyServiceApi,
+    Configuration,
+    UserAPIKeyUpdateRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserAPIKeyServiceApi(configuration);
+
+let body: UserAPIKeyUpdateRequest; //
+
+const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyUpdate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **UserAPIKeyUpdateRequest**|  | |
+
+
+### Return type
+
+**UserAPIKeyUpdateResponse**
+
+### 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/UserAPIKeyUpdateRequest.md

@@ -0,0 +1,32 @@
+# UserAPIKeyUpdateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**quota_balance_total** | **string** |  | [optional] [default to undefined]
+**balance_code** | **string** |  | [optional] [default to undefined]
+**quota_mode** | **number** |  | [optional] [default to undefined]
+**key_status** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserAPIKeyUpdateRequest } from '@cherryin/aigw-api-client';
+
+const instance: UserAPIKeyUpdateRequest = {
+    id,
+    display_name,
+    quota_balance_total,
+    balance_code,
+    quota_mode,
+    key_status,
+    expires_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/UserAPIKeyUpdateResponse.md

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

@@ -0,0 +1,42 @@
+# UserBalance
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**uid** | **string** |  | [optional] [default to undefined]
+**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]
+**version** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserBalance } from '@cherryin/aigw-api-client';
+
+const instance: UserBalance = {
+    id,
+    created_at,
+    updated_at,
+    uid,
+    balance_code,
+    prepaid_balance_total,
+    prepaid_balance_used,
+    prepaid_balance_frozen,
+    bonus_balance_total,
+    bonus_balance_used,
+    bonus_balance_frozen,
+    version,
+};
+```
+
+[[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/UserBalanceBrief.md

@@ -0,0 +1,32 @@
+# UserBalanceBrief
+
+
+## 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 { UserBalanceBrief } from '@cherryin/aigw-api-client';
+
+const instance: UserBalanceBrief = {
+    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/UserBalanceChangeResponse.md

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

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

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