@cherryin/api-client 0.1.0 → 0.1.2

package/docs/AdminAPITokenServiceApi.md

@@ -0,0 +1,325 @@
+# AdminAPITokenServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminAPITokenServiceAdminAPITokenCreate**](#adminapitokenserviceadminapitokencreate) | **POST** /admin/api-token/create | |
+|[**adminAPITokenServiceAdminAPITokenDelete**](#adminapitokenserviceadminapitokendelete) | **DELETE** /admin/api-token/delete | |
+|[**adminAPITokenServiceAdminAPITokenGet**](#adminapitokenserviceadminapitokenget) | **GET** /admin/api-token/get | |
+|[**adminAPITokenServiceAdminAPITokenList**](#adminapitokenserviceadminapitokenlist) | **GET** /admin/api-token/list | |
+|[**adminAPITokenServiceAdminAPITokenRefresh**](#adminapitokenserviceadminapitokenrefresh) | **POST** /admin/api-token/refresh | |
+|[**adminAPITokenServiceAdminAPITokenUpdate**](#adminapitokenserviceadminapitokenupdate) | **POST** /admin/api-token/update | |
+
+# **adminAPITokenServiceAdminAPITokenCreate**
+> AdminAPITokenCreateResponse adminAPITokenServiceAdminAPITokenCreate(adminAPITokenCreateRequest)
+
+
+### Example
+
+```typescript
+import {
+    AdminAPITokenServiceApi,
+    Configuration,
+    AdminAPITokenCreateRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAPITokenServiceApi(configuration);
+
+let adminAPITokenCreateRequest: AdminAPITokenCreateRequest; //
+
+const { status, data } = await apiInstance.adminAPITokenServiceAdminAPITokenCreate(
+    adminAPITokenCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminAPITokenCreateRequest** | **AdminAPITokenCreateRequest**|  | |
+
+
+### Return type
+
+**AdminAPITokenCreateResponse**
+
+### 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)
+
+# **adminAPITokenServiceAdminAPITokenDelete**
+> AdminAPITokenDeleteResponse adminAPITokenServiceAdminAPITokenDelete()
+
+
+### Example
+
+```typescript
+import {
+    AdminAPITokenServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAPITokenServiceApi(configuration);
+
+let id: string; //@gotags: form:\"id\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminAPITokenServiceAdminAPITokenDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | @gotags: form:\"id\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**AdminAPITokenDeleteResponse**
+
+### 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)
+
+# **adminAPITokenServiceAdminAPITokenGet**
+> AdminAPITokenGetResponse adminAPITokenServiceAdminAPITokenGet()
+
+
+### Example
+
+```typescript
+import {
+    AdminAPITokenServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAPITokenServiceApi(configuration);
+
+let id: string; //@gotags: form:\"id\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminAPITokenServiceAdminAPITokenGet(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | @gotags: form:\"id\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**AdminAPITokenGetResponse**
+
+### 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)
+
+# **adminAPITokenServiceAdminAPITokenList**
+> AdminAPITokenListResponse adminAPITokenServiceAdminAPITokenList()
+
+
+### Example
+
+```typescript
+import {
+    AdminAPITokenServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAPITokenServiceApi(configuration);
+
+let page: number; //@gotags: form:\"page\" (optional) (default to undefined)
+let pageSize: number; //@gotags: form:\"page_size\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminAPITokenServiceAdminAPITokenList(
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | @gotags: form:\"page\" | (optional) defaults to undefined|
+| **pageSize** | [**number**] | @gotags: form:\"page_size\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**AdminAPITokenListResponse**
+
+### 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)
+
+# **adminAPITokenServiceAdminAPITokenRefresh**
+> AdminAPITokenRefreshResponse adminAPITokenServiceAdminAPITokenRefresh(adminAPITokenRefreshRequest)
+
+
+### Example
+
+```typescript
+import {
+    AdminAPITokenServiceApi,
+    Configuration,
+    AdminAPITokenRefreshRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAPITokenServiceApi(configuration);
+
+let adminAPITokenRefreshRequest: AdminAPITokenRefreshRequest; //
+
+const { status, data } = await apiInstance.adminAPITokenServiceAdminAPITokenRefresh(
+    adminAPITokenRefreshRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminAPITokenRefreshRequest** | **AdminAPITokenRefreshRequest**|  | |
+
+
+### Return type
+
+**AdminAPITokenRefreshResponse**
+
+### 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)
+
+# **adminAPITokenServiceAdminAPITokenUpdate**
+> AdminAPITokenUpdateResponse adminAPITokenServiceAdminAPITokenUpdate(adminAPITokenUpdateRequest)
+
+
+### Example
+
+```typescript
+import {
+    AdminAPITokenServiceApi,
+    Configuration,
+    AdminAPITokenUpdateRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAPITokenServiceApi(configuration);
+
+let adminAPITokenUpdateRequest: AdminAPITokenUpdateRequest; //
+
+const { status, data } = await apiInstance.adminAPITokenServiceAdminAPITokenUpdate(
+    adminAPITokenUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminAPITokenUpdateRequest** | **AdminAPITokenUpdateRequest**|  | |
+
+
+### Return type
+
+**AdminAPITokenUpdateResponse**
+
+### 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/AdminAPITokenUpdateRequest.md

@@ -0,0 +1,29 @@
+# AdminAPITokenUpdateRequest
+
+Update
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**token_status** | **number** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**scopes** | [**AdminAPITokenScopes**](AdminAPITokenScopes.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminAPITokenUpdateRequest } from '@cherryin/api-client';
+
+const instance: AdminAPITokenUpdateRequest = {
+    id,
+    display_name,
+    token_status,
+    expires_at,
+    scopes,
+};
+```
+
+[[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/{AuthAdminUpdateUserResponse.md → AdminAPITokenUpdateResponse.md}

@@ -1,4 +1,4 @@
-# AuthAdminUpdateUserResponse
+# AdminAPITokenUpdateResponse
 
 
 ## Properties
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**user** | [**Auth2Admin**](Auth2Admin.md) |  | [optional] [default to undefined]
+**data** | [**AdminAPIToken**](AdminAPIToken.md) |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthAdminUpdateUserResponse } from '@cherryin/api-client';
+import { AdminAPITokenUpdateResponse } from '@cherryin/api-client';
 
-const instance: AuthAdminUpdateUserResponse = {
+const instance: AdminAPITokenUpdateResponse = {
     code,
     message,
-    user,
+    data,
 };
 ```
 

package/docs/AdminEnterpriseMaterials.md

@@ -0,0 +1,24 @@
+# AdminEnterpriseMaterials
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**materials** | [**AuthEnterpriseMaterials**](AuthEnterpriseMaterials.md) |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminEnterpriseMaterials } from '@cherryin/api-client';
+
+const instance: AdminEnterpriseMaterials = {
+    materials,
+    created_at,
+    updated_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/AdminEnterpriseUser.md

@@ -0,0 +1,24 @@
+# AdminEnterpriseUser
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**AuthEnterpriseUser**](AuthEnterpriseUser.md) | 企业用户信息 | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminEnterpriseUser } from '@cherryin/api-client';
+
+const instance: AdminEnterpriseUser = {
+    user,
+    created_at,
+    updated_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/AdminEnterpriseUserMaterials.md

@@ -0,0 +1,22 @@
+# AdminEnterpriseUserMaterials
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**AdminEnterpriseUser**](AdminEnterpriseUser.md) |  | [optional] [default to undefined]
+**materials** | [**AdminEnterpriseMaterials**](AdminEnterpriseMaterials.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminEnterpriseUserMaterials } from '@cherryin/api-client';
+
+const instance: AdminEnterpriseUserMaterials = {
+    user,
+    materials,
+};
+```
+
+[[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/AdminPassportItem.md

@@ -0,0 +1,24 @@
+# AdminPassportItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**passport** | [**AuthPassport**](AuthPassport.md) |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminPassportItem } from '@cherryin/api-client';
+
+const instance: AdminPassportItem = {
+    passport,
+    created_at,
+    updated_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/AdminProvider.md

@@ -0,0 +1,46 @@
+# AdminProvider
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | id 供应商 ID | [optional] [default to undefined]
+**name** | **string** | name 供应商名称 | [optional] [default to undefined]
+**env** | **Array<string>** | env 供应商使用的环境变量 | [optional] [default to undefined]
+**npm** | **string** | npm 供应商提供的 NPM 包 | [optional] [default to undefined]
+**api** | **string** | api 供应商的 API BaseURL | [optional] [default to undefined]
+**doc** | **string** | doc 供应商官方文档地址 | [optional] [default to undefined]
+**provider_status** | **number** | provider_status Provider 状态  1: 启用 (Active)  2: 禁用 (Disabled) | [optional] [default to undefined]
+**provider_auth** | [**ProviderAuth**](ProviderAuth.md) | provider_auth 供应商的认证授权配置 | [optional] [default to undefined]
+**is_official** | **boolean** | 是否为官方供应商，官方供应商会额外写官方供应商表. | [optional] [default to undefined]
+**record_id** | **string** | 数据库自增 id，方便区别 | [optional] [default to undefined]
+**created_at** | **string** | created_at 创建时间戳（Unix 时间戳） | [optional] [default to undefined]
+**updated_at** | **string** | updated_at 更新时间戳（Unix 时间戳） | [optional] [default to undefined]
+**deleted_at** | **string** | deleted_at 软删除时间戳，0 表示未删除 | [optional] [default to undefined]
+**provider_type** | **string** | provider_type 供应商类型, 对齐创建供应商时的类型 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminProvider } from '@cherryin/api-client';
+
+const instance: AdminProvider = {
+    id,
+    name,
+    env,
+    npm,
+    api,
+    doc,
+    provider_status,
+    provider_auth,
+    is_official,
+    record_id,
+    created_at,
+    updated_at,
+    deleted_at,
+    provider_type,
+};
+```
+
+[[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/AdminProviderCreateRequest.md

@@ -0,0 +1,41 @@
+# AdminProviderCreateRequest
+
+AdminProviderCreateRequest 创建 Provider 的请求
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | id 供应商 ID | [optional] [default to undefined]
+**name** | **string** | name 供应商名称 | [optional] [default to undefined]
+**env** | **Array<string>** | env 供应商使用的环境变量 | [optional] [default to undefined]
+**npm** | **string** | npm 供应商提供的 NPM 包 | [optional] [default to undefined]
+**api** | **string** | api 供应商的 API BaseURL | [optional] [default to undefined]
+**doc** | **string** | doc 供应商官方文档地址 | [optional] [default to undefined]
+**provider_status** | **number** | provider_status Provider 状态  1: 启用 (Active)  2: 禁用 (Disabled) | [optional] [default to undefined]
+**provider_auth** | [**ProviderAuth**](ProviderAuth.md) | provider_auth 供应商的认证授权配置 | [optional] [default to undefined]
+**is_official** | **boolean** | 是否为官方供应商，官方供应商会额外写官方供应商表. | [optional] [default to undefined]
+**provider_type** | **string** | provider_type 供应商类型  目前支持:  - openai  - anthropic  - vertex  - gemini  - azure | [optional] [default to undefined]
+**is_sync** | **boolean** | 是否同步到官方供应商表，默认 true  Whether to sync to official_provider table, default true | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminProviderCreateRequest } from '@cherryin/api-client';
+
+const instance: AdminProviderCreateRequest = {
+    id,
+    name,
+    env,
+    npm,
+    api,
+    doc,
+    provider_status,
+    provider_auth,
+    is_official,
+    provider_type,
+    is_sync,
+};
+```
+
+[[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/AdminProviderCreateResponse.md

@@ -0,0 +1,25 @@
+# AdminProviderCreateResponse
+
+AdminProviderCreateResponse 创建 Provider 的响应  Response message for provider creation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**data** | [**AdminProvider**](AdminProvider.md) | data 创建成功后返回的 Provider 信息 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminProviderCreateResponse } from '@cherryin/api-client';
+
+const instance: AdminProviderCreateResponse = {
+    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/{ProviderModelDeleteResponse.md → AdminProviderDeleteResponse.md}

@@ -1,6 +1,6 @@
-# ProviderModelDeleteResponse
+# AdminProviderDeleteResponse
 
-ProviderModelDeleteResponse 删除 ProviderModel 的响应  Response message for provider model deletion
+AdminProviderDeleteResponse 删除 Provider 的响应  Response message for provider deletion
 
 ## Properties
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { ProviderModelDeleteResponse } from '@cherryin/api-client';
+import { AdminProviderDeleteResponse } from '@cherryin/api-client';
 
-const instance: ProviderModelDeleteResponse = {
+const instance: AdminProviderDeleteResponse = {
     code,
     message,
 };

package/docs/AdminProviderGetResponse.md

@@ -0,0 +1,25 @@
+# AdminProviderGetResponse
+
+AdminProviderGetResponse 获取单个 Provider 的响应  Response message for provider retrieval
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**data** | [**AdminProvider**](AdminProvider.md) | data Provider 信息 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminProviderGetResponse } from '@cherryin/api-client';
+
+const instance: AdminProviderGetResponse = {
+    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/AdminProviderListResponse.md

@@ -0,0 +1,27 @@
+# AdminProviderListResponse
+
+AdminProviderListResponse 分页查询 Provider 列表的响应  Response message for provider listing
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**list** | [**Array<AdminProvider>**](AdminProvider.md) | list Provider 列表 | [optional] [default to undefined]
+**total** | **string** | total 符合条件的 Provider 总数 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminProviderListResponse } from '@cherryin/api-client';
+
+const instance: AdminProviderListResponse = {
+    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)