@cherryin/aigw-api-client 0.1.0

package/docs/QRCodeAdminServiceApi.md

@@ -0,0 +1,281 @@
+# QRCodeAdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**qRCodeAdminServiceQRCodeCreate**](#qrcodeadminserviceqrcodecreate) | **POST** /admin/qrcode/create | QRCodeCreate 创建新的二维码 请求路径: POST /admin/qrcode/create 权限要求: 需要管理员权限|
+|[**qRCodeAdminServiceQRCodeDelete**](#qrcodeadminserviceqrcodedelete) | **DELETE** /admin/qrcode/delete | QRCodeDelete 删除已有的二维码 请求路径: DELETE /admin/qrcode/delete 权限要求: 需要管理员权限|
+|[**qRCodeAdminServiceQRCodeGet**](#qrcodeadminserviceqrcodeget) | **GET** /admin/qrcode/get | QRCodeGet 获取指定的二维码及其历史版本 请求路径: GET /admin/qrcode/get 权限要求: 需要管理员权限|
+|[**qRCodeAdminServiceQRCodeList**](#qrcodeadminserviceqrcodelist) | **GET** /admin/qrcode/list | QRCodeList 列出二维码列表 请求路径: GET /admin/qrcode/list 权限要求: 需要管理员权限|
+|[**qRCodeAdminServiceQRCodeUpdate**](#qrcodeadminserviceqrcodeupdate) | **POST** /admin/qrcode/update | QRCodeUpdate 更新已有的二维码 请求路径: POST /admin/qrcode/update 权限要求: 需要管理员权限|
+
+# **qRCodeAdminServiceQRCodeCreate**
+> QRCodeCreateResponse qRCodeAdminServiceQRCodeCreate(body)
+
+
+### Example
+
+```typescript
+import {
+    QRCodeAdminServiceApi,
+    Configuration,
+    QRCodeCreateRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new QRCodeAdminServiceApi(configuration);
+
+let body: QRCodeCreateRequest; //
+
+const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeCreate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **QRCodeCreateRequest**|  | |
+
+
+### Return type
+
+**QRCodeCreateResponse**
+
+### 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)
+
+# **qRCodeAdminServiceQRCodeDelete**
+> QRCodeDeleteResponse qRCodeAdminServiceQRCodeDelete()
+
+
+### Example
+
+```typescript
+import {
+    QRCodeAdminServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new QRCodeAdminServiceApi(configuration);
+
+let id: string; //@gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**QRCodeDeleteResponse**
+
+### 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)
+
+# **qRCodeAdminServiceQRCodeGet**
+> QRCodeGetResponse qRCodeAdminServiceQRCodeGet()
+
+
+### Example
+
+```typescript
+import {
+    QRCodeAdminServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new QRCodeAdminServiceApi(configuration);
+
+let id: string; //@gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
+let historyLimit: number; //@gotags: form:\"history_limit\"  返回的历史记录数量限制 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeGet(
+    id,
+    historyLimit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
+| **historyLimit** | [**number**] | @gotags: form:\"history_limit\"  返回的历史记录数量限制 | (optional) defaults to undefined|
+
+
+### Return type
+
+**QRCodeGetResponse**
+
+### 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)
+
+# **qRCodeAdminServiceQRCodeList**
+> QRCodeListResponse qRCodeAdminServiceQRCodeList()
+
+
+### Example
+
+```typescript
+import {
+    QRCodeAdminServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new QRCodeAdminServiceApi(configuration);
+
+let page: number; //@gotags: form:\"page\" (optional) (default to undefined)
+let pageSize: number; //@gotags: form:\"page_size\" (optional) (default to undefined)
+let namePrefix: string; //@gotags: form:\"name_prefix\"  名称前缀过滤 (optional) (default to undefined)
+let status: number; //@gotags: form:\"status\"  状态过滤（1=draft, 2=done, 3=failed） (optional) (default to undefined)
+
+const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeList(
+    page,
+    pageSize,
+    namePrefix,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | @gotags: form:\"page\" | (optional) defaults to undefined|
+| **pageSize** | [**number**] | @gotags: form:\"page_size\" | (optional) defaults to undefined|
+| **namePrefix** | [**string**] | @gotags: form:\"name_prefix\"  名称前缀过滤 | (optional) defaults to undefined|
+| **status** | [**number**] | @gotags: form:\"status\"  状态过滤（1=draft, 2=done, 3=failed） | (optional) defaults to undefined|
+
+
+### Return type
+
+**QRCodeListResponse**
+
+### 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)
+
+# **qRCodeAdminServiceQRCodeUpdate**
+> QRCodeUpdateResponse qRCodeAdminServiceQRCodeUpdate(body)
+
+
+### Example
+
+```typescript
+import {
+    QRCodeAdminServiceApi,
+    Configuration,
+    QRCodeUpdateRequest
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new QRCodeAdminServiceApi(configuration);
+
+let body: QRCodeUpdateRequest; //
+
+const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeUpdate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **QRCodeUpdateRequest**|  | |
+
+
+### Return type
+
+**QRCodeUpdateResponse**
+
+### 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/QRCodeCreateRequest.md

@@ -0,0 +1,36 @@
+# QRCodeCreateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**storage_type** | **string** |  | [optional] [default to undefined]
+**storage_bucket** | **string** |  | [optional] [default to undefined]
+**expire_at** | **string** |  | [optional] [default to undefined]
+**file_data** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [optional] [default to undefined]
+**storage_target_key** | **string** |  | [optional] [default to undefined]
+**target_content_ext** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QRCodeCreateRequest } from '@cherryin/aigw-api-client';
+
+const instance: QRCodeCreateRequest = {
+    name,
+    description,
+    storage_type,
+    storage_bucket,
+    expire_at,
+    file_data,
+    filename,
+    storage_target_key,
+    target_content_ext,
+};
+```
+
+[[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/QRCodeCreateResponse.md

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

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

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

@@ -0,0 +1,28 @@
+# QRCodeHistoryItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**qr_code_id** | **string** |  | [optional] [default to undefined]
+**version** | **string** |  | [optional] [default to undefined]
+**snapshot** | [**QRCodeSnapshot**](QRCodeSnapshot.md) |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QRCodeHistoryItem } from '@cherryin/aigw-api-client';
+
+const instance: QRCodeHistoryItem = {
+    id,
+    qr_code_id,
+    version,
+    snapshot,
+    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/QRCodeInfo.md

@@ -0,0 +1,58 @@
+# QRCodeInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**operator_uid** | **string** |  | [optional] [default to undefined]
+**status** | **number** |  | [optional] [default to undefined]
+**storage_type** | **string** |  | [optional] [default to undefined]
+**storage_bucket** | **string** |  | [optional] [default to undefined]
+**storage_latest_key** | **string** |  | [optional] [default to undefined]
+**storage_target_key** | **string** |  | [optional] [default to undefined]
+**storage_convert_key** | **string** |  | [optional] [default to undefined]
+**content_filename** | **string** |  | [optional] [default to undefined]
+**source_content_type** | **string** |  | [optional] [default to undefined]
+**content_file_size** | **string** |  | [optional] [default to undefined]
+**target_content_ext** | **string** |  | [optional] [default to undefined]
+**latest_cdn_url** | **string** |  | [optional] [default to undefined]
+**target_cdn_url** | **string** |  | [optional] [default to undefined]
+**convert_cdn_url** | **string** |  | [optional] [default to undefined]
+**expire_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QRCodeInfo } from '@cherryin/aigw-api-client';
+
+const instance: QRCodeInfo = {
+    id,
+    name,
+    description,
+    operator_uid,
+    status,
+    storage_type,
+    storage_bucket,
+    storage_latest_key,
+    storage_target_key,
+    storage_convert_key,
+    content_filename,
+    source_content_type,
+    content_file_size,
+    target_content_ext,
+    latest_cdn_url,
+    target_cdn_url,
+    convert_cdn_url,
+    expire_at,
+    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/QRCodeListResponse.md

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

package/docs/QRCodeSnapshot.md

@@ -0,0 +1,36 @@
+# QRCodeSnapshot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**storage_latest_key** | **string** |  | [optional] [default to undefined]
+**storage_target_key** | **string** |  | [optional] [default to undefined]
+**storage_convert_key** | **string** |  | [optional] [default to undefined]
+**content_filename** | **string** |  | [optional] [default to undefined]
+**content_file_size** | **string** |  | [optional] [default to undefined]
+**status** | **number** |  | [optional] [default to undefined]
+**snapshot_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QRCodeSnapshot } from '@cherryin/aigw-api-client';
+
+const instance: QRCodeSnapshot = {
+    name,
+    description,
+    storage_latest_key,
+    storage_target_key,
+    storage_convert_key,
+    content_filename,
+    content_file_size,
+    status,
+    snapshot_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/QRCodeUpdateRequest.md

@@ -0,0 +1,38 @@
+# QRCodeUpdateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**storage_type** | **string** |  | [optional] [default to undefined]
+**storage_bucket** | **string** |  | [optional] [default to undefined]
+**expire_at** | **string** |  | [optional] [default to undefined]
+**file_data** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [optional] [default to undefined]
+**storage_target_key** | **string** |  | [optional] [default to undefined]
+**target_content_ext** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QRCodeUpdateRequest } from '@cherryin/aigw-api-client';
+
+const instance: QRCodeUpdateRequest = {
+    id,
+    name,
+    description,
+    storage_type,
+    storage_bucket,
+    expire_at,
+    file_data,
+    filename,
+    storage_target_key,
+    target_content_ext,
+};
+```
+
+[[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/QRCodeUpdateResponse.md

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

@@ -0,0 +1,22 @@
+# QRCodeWithHistory
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**qr_code** | [**QRCodeInfo**](QRCodeInfo.md) |  | [optional] [default to undefined]
+**history** | [**Array<QRCodeHistoryItem>**](QRCodeHistoryItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QRCodeWithHistory } from '@cherryin/aigw-api-client';
+
+const instance: QRCodeWithHistory = {
+    qr_code,
+    history,
+};
+```
+
+[[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/ReasoningTokensPricing.md

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

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

@@ -0,0 +1,11 @@
+# SessionAction
+
+- SESSION_ACTION_UNSPECIFIED: 未指定  - SESSION_ACTION_REVOKE: 撤销 Session
+
+## Enum
+
+* `SessionActionUnspecified` (value: `'SESSION_ACTION_UNSPECIFIED'`)
+
+* `SessionActionRevoke` (value: `'SESSION_ACTION_REVOKE'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)