@cherryin/aigw-api-client 0.1.0

package/docs/UserModelServiceApi.md

@@ -0,0 +1,181 @@
+# UserModelServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userModelServiceFrontendModels**](#usermodelservicefrontendmodels) | **GET** /api/v1/frontend/models | FrontendModels 获取前端模型列表 NOTE: 登录态鉴权|
+|[**userModelServiceFrontendProviders**](#usermodelservicefrontendproviders) | **GET** /api/v1/frontend/providers | FrontendProviders 获取前端供应商列表 NOTE: 登录态鉴权|
+|[**userModelServiceModelList**](#usermodelservicemodellist) | **GET** /v1/models | ModelList OpenAI 通用模型列表 NOTE: 需要 API KEY 鉴权|
+
+# **userModelServiceFrontendModels**
+> FrontendModelsResponse userModelServiceFrontendModels()
+
+
+### Example
+
+```typescript
+import {
+    UserModelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserModelServiceApi(configuration);
+
+let providerId: string; //provider_id 可选的供应商 ID 过滤 @gotags: form:\"provider_id\" (optional) (default to undefined)
+let limit: number; //limit 每页数量，0 或不传表示返回全部（默认不分页） Page size, 0 or not set means return all (no pagination by default) @gotags: form:\"limit\" (optional) (default to undefined)
+let offset: number; //offset 偏移量，配合 limit 使用 Offset, used with limit @gotags: form:\"offset\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userModelServiceFrontendModels(
+    providerId,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **providerId** | [**string**] | provider_id 可选的供应商 ID 过滤 @gotags: form:\"provider_id\" | (optional) defaults to undefined|
+| **limit** | [**number**] | limit 每页数量，0 或不传表示返回全部（默认不分页） Page size, 0 or not set means return all (no pagination by default) @gotags: form:\"limit\" | (optional) defaults to undefined|
+| **offset** | [**number**] | offset 偏移量，配合 limit 使用 Offset, used with limit @gotags: form:\"offset\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**FrontendModelsResponse**
+
+### 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)
+
+# **userModelServiceFrontendProviders**
+> FrontendProvidersResponse userModelServiceFrontendProviders()
+
+
+### Example
+
+```typescript
+import {
+    UserModelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserModelServiceApi(configuration);
+
+let limit: number; //limit 每页数量，0 或不传表示返回全部（默认不分页） Page size, 0 or not set means return all (no pagination by default) @gotags: form:\"limit\" (optional) (default to undefined)
+let offset: number; //offset 偏移量，配合 limit 使用 Offset, used with limit @gotags: form:\"offset\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userModelServiceFrontendProviders(
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | limit 每页数量，0 或不传表示返回全部（默认不分页） Page size, 0 or not set means return all (no pagination by default) @gotags: form:\"limit\" | (optional) defaults to undefined|
+| **offset** | [**number**] | offset 偏移量，配合 limit 使用 Offset, used with limit @gotags: form:\"offset\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**FrontendProvidersResponse**
+
+### 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)
+
+# **userModelServiceModelList**
+> ModelListResponse userModelServiceModelList()
+
+
+### Example
+
+```typescript
+import {
+    UserModelServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserModelServiceApi(configuration);
+
+let beforeId: string; //ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. @gotags: form:\"before_id\" (optional) (default to undefined)
+let afterId: string; //ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. @gotags: form:\"after_id\" (optional) (default to undefined)
+let limit: string; //Number of items to return per page. Defaults to 0. Ranges from 1 to 1000. if limit is 0, server will return all models. @gotags: form:\"limit\" (optional) (default to undefined)
+let pricingCode: string; //model pricing currency code. eg. USD/CNY @gotags: form:\"pricing_code\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userModelServiceModelList(
+    beforeId,
+    afterId,
+    limit,
+    pricingCode
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **beforeId** | [**string**] | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. @gotags: form:\"before_id\" | (optional) defaults to undefined|
+| **afterId** | [**string**] | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. @gotags: form:\"after_id\" | (optional) defaults to undefined|
+| **limit** | [**string**] | Number of items to return per page. Defaults to 0. Ranges from 1 to 1000. if limit is 0, server will return all models. @gotags: form:\"limit\" | (optional) defaults to undefined|
+| **pricingCode** | [**string**] | model pricing currency code. eg. USD/CNY @gotags: form:\"pricing_code\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**ModelListResponse**
+
+### 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)
+

package/docs/UserPayServiceApi.md

@@ -0,0 +1,71 @@
+# UserPayServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userPayServiceUserPayStripeCheckout**](#userpayserviceuserpaystripecheckout) | **POST** /api/v1/user/pay/stripe/checkout | |
+
+# **userPayServiceUserPayStripeCheckout**
+> UserPayStripeCheckoutResponse userPayServiceUserPayStripeCheckout()
+
+
+### Example
+
+```typescript
+import {
+    UserPayServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserPayServiceApi(configuration);
+
+let currencyCode: string; //Currency code, e.g., \"USD\" (optional) (default to undefined)
+let chargeAmount: string; //充值金额（必须整数，10） (optional) (default to undefined)
+let redirect: boolean; //是否跳转到支付页面，true-跳转，false-不跳转 (optional) (default to undefined)
+let successUrl: string; //支付成功跳转地址 (optional) (default to undefined)
+let cancelUrl: string; //支付取消跳转地址 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userPayServiceUserPayStripeCheckout(
+    currencyCode,
+    chargeAmount,
+    redirect,
+    successUrl,
+    cancelUrl
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **currencyCode** | [**string**] | Currency code, e.g., \"USD\" | (optional) defaults to undefined|
+| **chargeAmount** | [**string**] | 充值金额（必须整数，10） | (optional) defaults to undefined|
+| **redirect** | [**boolean**] | 是否跳转到支付页面，true-跳转，false-不跳转 | (optional) defaults to undefined|
+| **successUrl** | [**string**] | 支付成功跳转地址 | (optional) defaults to undefined|
+| **cancelUrl** | [**string**] | 支付取消跳转地址 | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserPayStripeCheckoutResponse**
+
+### 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)
+

package/docs/UserPayStripeCheckoutResponse.md

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

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

@@ -0,0 +1,107 @@
+# UserPortalServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userPortalServiceUserMeInfo**](#userportalserviceusermeinfo) | **POST** /api/v1/user/me/info | 个人信息接口|
+|[**userPortalServiceUserPortalDashboard**](#userportalserviceuserportaldashboard) | **GET** /api/v1/user/portal/dashboard | 用户门户仪表盘信息|
+
+# **userPortalServiceUserMeInfo**
+> UserMeInfoResponse userPortalServiceUserMeInfo()
+
+
+### Example
+
+```typescript
+import {
+    UserPortalServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserPortalServiceApi(configuration);
+
+const { status, data } = await apiInstance.userPortalServiceUserMeInfo();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserMeInfoResponse**
+
+### 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)
+
+# **userPortalServiceUserPortalDashboard**
+> UserPortalDashboardResponse userPortalServiceUserPortalDashboard()
+
+
+### Example
+
+```typescript
+import {
+    UserPortalServiceApi,
+    Configuration
+} from '@cherryin/aigw-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserPortalServiceApi(configuration);
+
+let startAt: string; //开始时间戳，单位秒 (不能超过 7 天前，默认是请求时间往前推 24 小时) @gotags: form:\"start_at\" (optional) (default to undefined)
+let endAt: string; //结束时间戳，单位秒 (不能超过 1 天后，默认是请求时间） @gotags: form:\"end_at\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userPortalServiceUserPortalDashboard(
+    startAt,
+    endAt
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **startAt** | [**string**] | 开始时间戳，单位秒 (不能超过 7 天前，默认是请求时间往前推 24 小时) @gotags: form:\"start_at\" | (optional) defaults to undefined|
+| **endAt** | [**string**] | 结束时间戳，单位秒 (不能超过 1 天后，默认是请求时间） @gotags: form:\"end_at\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserPortalDashboardResponse**
+
+### 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)
+

package/docs/UserSettings.md

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

@@ -0,0 +1,30 @@
+# VersionedAPISchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**schema** | **string** |  | [optional] [default to undefined]
+**version** | **string** |  | [optional] [default to undefined]
+**path** | **string** |  | [optional] [default to undefined]
+**method** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VersionedAPISchema } from '@cherryin/aigw-api-client';
+
+const instance: VersionedAPISchema = {
+    id,
+    name,
+    schema,
+    version,
+    path,
+    method,
+};
+```
+
+[[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/VideoPricing.md

@@ -0,0 +1,32 @@
+# VideoPricing
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**mode** | **string** |  | [optional] [default to undefined]
+**input_per_token** | **string** |  | [optional] [default to undefined]
+**output_per_token** | **string** |  | [optional] [default to undefined]
+**input_per_second** | **string** |  | [optional] [default to undefined]
+**output_per_second** | **string** |  | [optional] [default to undefined]
+**extra** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VideoPricing } from '@cherryin/aigw-api-client';
+
+const instance: VideoPricing = {
+    id,
+    mode,
+    input_per_token,
+    output_per_token,
+    input_per_second,
+    output_per_second,
+    extra,
+};
+```
+
+[[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/WebSearchPricing.md

@@ -0,0 +1,30 @@
+# WebSearchPricing
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**per_thousand** | **string** |  | [optional] [default to undefined]
+**free_daily** | **string** |  | [optional] [default to undefined]
+**context_size_high** | **string** |  | [optional] [default to undefined]
+**context_size_medium** | **string** |  | [optional] [default to undefined]
+**context_size_low** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebSearchPricing } from '@cherryin/aigw-api-client';
+
+const instance: WebSearchPricing = {
+    id,
+    per_thousand,
+    free_daily,
+    context_size_high,
+    context_size_medium,
+    context_size_low,
+};
+```
+
+[[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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="CherryIntelligence"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="aigw-api-client"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * aigwpb/api_token_admin_api.proto
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: version not set
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cherryin/aigw-api-client",
+  "version": "0.1.0",
+  "description": "OpenAPI client for @cherryin/aigw-api-client",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CherryIntelligence/aigw-api-client.git"
+  },
+  "keywords": [
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "@cherryin/aigw-api-client"
+  ],
+  "license": "Unlicense",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "axios": "^1.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "12.11.5 - 12.20.42",
+    "typescript": "^4.0 || ^5.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "dist/esm"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "ES6",
+    "module": "commonjs",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "moduleResolution": "node",
+    "typeRoots": [
+      "node_modules/@types"
+    ]
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}