@cherryin/aigw-api-client 0.1.0

package/docs/UserLabelServiceApi.md

@@ -0,0 +1,392 @@
+# UserLabelServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userLabelServiceLabelCreate**](#userlabelservicelabelcreate) | **POST** /admin/label/create | |
+|[**userLabelServiceLabelDelete**](#userlabelservicelabeldelete) | **DELETE** /admin/label/delete | |
+|[**userLabelServiceLabelGet**](#userlabelservicelabelget) | **GET** /admin/label/get | |
+|[**userLabelServiceLabelList**](#userlabelservicelabellist) | **GET** /admin/label/list | |
+|[**userLabelServiceLabelUpdate**](#userlabelservicelabelupdate) | **POST** /admin/label/update | |
+|[**userLabelServiceUserLabelList**](#userlabelserviceuserlabellist) | **GET** /admin/users/label/list | |
+|[**userLabelServiceUserLabelPairChange**](#userlabelserviceuserlabelpairchange) | **POST** /admin/users/label/change | |
+
+# **userLabelServiceLabelCreate**
+> LabelCreateResponse userLabelServiceLabelCreate(body)
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration,
+    LabelCreateRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let body: LabelCreateRequest; //
+
+const { status, data } = await apiInstance.userLabelServiceLabelCreate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **LabelCreateRequest**|  | |
+
+
+### Return type
+
+**LabelCreateResponse**
+
+### 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)
+
+# **userLabelServiceLabelDelete**
+> LabelDeleteResponse userLabelServiceLabelDelete()
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let id: string; //@gotags: form:\"id\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userLabelServiceLabelDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | @gotags: form:\"id\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**LabelDeleteResponse**
+
+### 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)
+
+# **userLabelServiceLabelGet**
+> LabelGetResponse userLabelServiceLabelGet()
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let id: string; //@gotags: form:\"id\" (optional) (default to undefined)
+let name: string; //@gotags: form:\"name\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userLabelServiceLabelGet(
+    id,
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | @gotags: form:\"id\" | (optional) defaults to undefined|
+| **name** | [**string**] | @gotags: form:\"name\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**LabelGetResponse**
+
+### 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)
+
+# **userLabelServiceLabelList**
+> LabelListResponse userLabelServiceLabelList()
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let page: number; //page 页码，从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" (optional) (default to undefined)
+let pageSize: number; //page_size 每页数量 Number of items per page 默认值: 20，最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
+let namePrefix: string; //name_prefix 按名称前缀过滤（可选） @gotags: form:\"name_prefix\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userLabelServiceLabelList(
+    page,
+    pageSize,
+    namePrefix
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | page 页码，从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
+| **pageSize** | [**number**] | page_size 每页数量 Number of items per page 默认值: 20，最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
+| **namePrefix** | [**string**] | name_prefix 按名称前缀过滤（可选） @gotags: form:\"name_prefix\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**LabelListResponse**
+
+### 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)
+
+# **userLabelServiceLabelUpdate**
+> LabelUpdateResponse userLabelServiceLabelUpdate(body)
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration,
+    LabelUpdateRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let body: LabelUpdateRequest; //
+
+const { status, data } = await apiInstance.userLabelServiceLabelUpdate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **LabelUpdateRequest**|  | |
+
+
+### Return type
+
+**LabelUpdateResponse**
+
+### 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)
+
+# **userLabelServiceUserLabelList**
+> UserLabelListResponse userLabelServiceUserLabelList()
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let page: number; //page 页码，从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" (optional) (default to undefined)
+let pageSize: number; //page_size 每页数量 Number of items per page 默认值: 20，最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
+let uidList: Array<string>; // (optional) (default to undefined)
+let labelIds: Array<string>; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userLabelServiceUserLabelList(
+    page,
+    pageSize,
+    uidList,
+    labelIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | page 页码，从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\&quot;page\&quot; | (optional) defaults to undefined|
+| **pageSize** | [**number**] | page_size 每页数量 Number of items per page 默认值: 20，最大值: 100 Default: 20, Maximum: 100 @gotags: form:\&quot;page_size\&quot; | (optional) defaults to undefined|
+| **uidList** | **Array&lt;string&gt;** |  | (optional) defaults to undefined|
+| **labelIds** | **Array&lt;string&gt;** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserLabelListResponse**
+
+### 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)
+
+# **userLabelServiceUserLabelPairChange**
+> UserLabelPairChangeResponse userLabelServiceUserLabelPairChange(body)
+
+
+### Example
+
+```typescript
+import {
+    UserLabelServiceApi,
+    Configuration,
+    UserLabelPairChangeRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserLabelServiceApi(configuration);
+
+let body: UserLabelPairChangeRequest; //
+
+const { status, data } = await apiInstance.userLabelServiceUserLabelPairChange(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **UserLabelPairChangeRequest**|  | |
+
+
+### Return type
+
+**UserLabelPairChangeResponse**
+
+### 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/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/aigw-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)