@cherryin/aigw-api-client
v0.1.32
Published
OpenAPI client for @cherryin/aigw-api-client
Downloads
2,580
Readme
@cherryin/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @cherryin/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelCheckConnection | GET /admin/ai-model/check/connection | AdminAIModelCheckConnection 检查 AIModel 的连接性 AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelCreate | POST /admin/ai-model/create | AdminAIModelCreate 创建新的 AIModel（草稿状态） 请求路径: POST /admin/ai-model/create AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelDelete | DELETE /admin/ai-model/delete | AdminAIModelDelete 删除 AIModel（软删除） 请求路径: POST /admin/ai-model/delete AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelDisable | POST /admin/ai-model/disable | AdminAIModelDisable 禁用 AIModel，状态变更为已禁用 请求路径: POST /admin/ai-model/disable AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelGet | GET /admin/ai-model/get | AdminAIModelGet 根据 ID 或名称获取单个 AIModel 请求路径: GET /admin/ai-model/get?id={id} 或 GET /admin/ai-model/get?name={name} AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelList | GET /admin/ai-model/list | AdminAIModelList 分页查询 AIModel 列表，支持按状态、名称前缀、端点过滤，支持多字段排序 请求路径: GET /admin/ai-model/list AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelPublish | POST /admin/ai-model/publish | AdminAIModelPublish 发布 AIModel，状态变更为已发布 请求路径: POST /admin/ai-model/publish AIModelAdminServiceApi | aIModelAdminServiceAdminAIModelUpdate | POST /admin/ai-model/update | AdminAIModelUpdate 更新现有的 AIModel 请求路径: POST /admin/ai-model/update AdminAPITokenServiceApi | adminAPITokenServiceAdminAPITokenCreate | POST /admin/api-token/create | AdminAPITokenServiceApi | adminAPITokenServiceAdminAPITokenDelete | DELETE /admin/api-token/delete | AdminAPITokenServiceApi | adminAPITokenServiceAdminAPITokenGet | GET /admin/api-token/get | AdminAPITokenServiceApi | adminAPITokenServiceAdminAPITokenList | GET /admin/api-token/list | AdminAPITokenServiceApi | adminAPITokenServiceAdminAPITokenRefresh | POST /admin/api-token/refresh | AdminAPITokenServiceApi | adminAPITokenServiceAdminAPITokenUpdate | POST /admin/api-token/update | DiscountAdminServiceApi | discountAdminServiceDiscountCreate | POST /admin/discount/create | DiscountCreate 创建折扣接口 DiscountAdminServiceApi | discountAdminServiceDiscountDelete | DELETE /admin/discount/delete | DiscountDelete 删除折扣接口 DiscountAdminServiceApi | discountAdminServiceDiscountGet | GET /admin/discount/get | DiscountGet 获取折扣接口 DiscountAdminServiceApi | discountAdminServiceDiscountList | GET /admin/discount/list | DiscountList 折扣列表接口 DiscountAdminServiceApi | discountAdminServiceDiscountUpdate | POST /admin/discount/update | DiscountUpdate 更新折扣接口 ProviderAdminServiceApi | providerAdminServiceAdminOfficialProviderCreate | POST /admin/official/provider/create | AdminOfficialProviderCreate 创建新的 Provider(官方供应商专用) 请求路径: POST /admin/official/provider/create ProviderAdminServiceApi | providerAdminServiceAdminOfficialProviderDelete | DELETE /admin/official/provider/delete | AdminOfficialProviderDelete 删除 Provider（软删除） 请求路径: DELETE /admin/official/provider/delete ProviderAdminServiceApi | providerAdminServiceAdminOfficialProviderGet | GET /admin/official/provider/get | AdminOfficialProviderGet 根据 ID 获取单个 Provider 请求路径: GET /admin/official/provider/get?id={id} ProviderAdminServiceApi | providerAdminServiceAdminOfficialProviderList | GET /admin/official/provider/list | AdminOfficialProviderList 分页查询 Provider 列表，支持按状态和名称前缀过滤 请求路径: GET /admin/official/provider/list?page={page}&page_size={page_size}&provider_status={status}&name_prefix={prefix} ProviderAdminServiceApi | providerAdminServiceAdminOfficialProviderUpdate | POST /admin/official/provider/update | AdminOfficialProviderUpdate 更新现有的 Provider 请求路径: POST /admin/official/provider/update ProviderAdminServiceApi | providerAdminServiceAdminProviderCreate | POST /admin/provider/create | AdminProviderCreate 创建新的 Provider 请求路径: POST /admin/provider/create ProviderAdminServiceApi | providerAdminServiceAdminProviderDelete | DELETE /admin/provider/delete | AdminProviderDelete 删除 Provider（软删除） 请求路径: DELETE /admin/provider/delete ProviderAdminServiceApi | providerAdminServiceAdminProviderGet | GET /admin/provider/get | AdminProviderGet 根据 ID 获取单个 Provider 请求路径: GET /admin/provider/get?id={id} ProviderAdminServiceApi | providerAdminServiceAdminProviderList | GET /admin/provider/list | AdminProviderList 分页查询 Provider 列表，支持按状态和名称前缀过滤 请求路径: GET /admin/provider/list?page={page}&page_size={page_size}&provider_status={status}&name_prefix={prefix} ProviderAdminServiceApi | providerAdminServiceAdminProviderUpdate | POST /admin/provider/update | AdminProviderUpdate 更新现有的 Provider 请求路径: POST /admin/provider/update ProviderModelAdminServiceApi | providerModelAdminServiceAdminOfficialProviderModelCreate | POST /admin/official/provider-model/create | AdminOfficialProviderModelCreate 创建新的 ProviderModel 请求路径: POST /admin/provider-model/create ProviderModelAdminServiceApi | providerModelAdminServiceAdminOfficialProviderModelDelete | DELETE /admin/official/provider-model/delete | AdminOfficialProviderModelDelete 删除 ProviderModel（软删除） 请求路径: POST /admin/provider-model/delete ProviderModelAdminServiceApi | providerModelAdminServiceAdminOfficialProviderModelGet | GET /admin/official/provider-model/get | AdminOfficialProviderModelGet 根据 ID 获取单个 ProviderModel 请求路径: GET /admin/provider-model/get?id={id} ProviderModelAdminServiceApi | providerModelAdminServiceAdminOfficialProviderModelList | GET /admin/official/provider-model/list | AdminOfficialProviderModelList 分页查询 ProviderModel 列表，支持按 Provider、状态和名称前缀过滤 请求路径: GET /admin/provider-model/list?page={page}&page_size={page_size}&provider_id={provider_id}&status={status}&name_prefix={prefix} ProviderModelAdminServiceApi | providerModelAdminServiceAdminOfficialProviderModelUpdate | POST /admin/official/provider-model/update | AdminOfficialProviderModelUpdate 更新现有的 ProviderModel 请求路径: POST /admin/provider-model/update ProviderModelAdminServiceApi | providerModelAdminServiceAdminProviderModelCreate | POST /admin/provider-model/create | AdminProviderModelCreate 创建新的 ProviderModel 请求路径: POST /admin/provider-model/create ProviderModelAdminServiceApi | providerModelAdminServiceAdminProviderModelDelete | DELETE /admin/provider-model/delete | AdminProviderModelDelete 删除 ProviderModel（软删除） 请求路径: POST /admin/provider-model/delete ProviderModelAdminServiceApi | providerModelAdminServiceAdminProviderModelGet | GET /admin/provider-model/get | AdminProviderModelGet 根据 ID 获取单个 ProviderModel 请求路径: GET /admin/provider-model/get?id={id} ProviderModelAdminServiceApi | providerModelAdminServiceAdminProviderModelList | GET /admin/provider-model/list | AdminProviderModelList 分页查询 ProviderModel 列表，支持按 Provider、状态和名称前缀过滤 请求路径: GET /admin/provider-model/list?page={page}&page_size={page_size}&provider_id={provider_id}&status={status}&name_prefix={prefix} ProviderModelAdminServiceApi | providerModelAdminServiceAdminProviderModelUpdate | POST /admin/provider-model/update | AdminProviderModelUpdate 更新现有的 ProviderModel 请求路径: POST /admin/provider-model/update QRCodeAdminServiceApi | qRCodeAdminServiceQRCodeCreate | POST /admin/qrcode/create | QRCodeCreate 创建新的二维码 请求路径: POST /admin/qrcode/create 权限要求: 需要管理员权限 QRCodeAdminServiceApi | qRCodeAdminServiceQRCodeDelete | DELETE /admin/qrcode/delete | QRCodeDelete 删除已有的二维码 请求路径: DELETE /admin/qrcode/delete 权限要求: 需要管理员权限 QRCodeAdminServiceApi | qRCodeAdminServiceQRCodeGet | GET /admin/qrcode/get | QRCodeGet 获取指定的二维码及其历史版本 请求路径: GET /admin/qrcode/get 权限要求: 需要管理员权限 QRCodeAdminServiceApi | qRCodeAdminServiceQRCodeList | GET /admin/qrcode/list | QRCodeList 列出二维码列表 请求路径: GET /admin/qrcode/list 权限要求: 需要管理员权限 QRCodeAdminServiceApi | qRCodeAdminServiceQRCodeUpdate | POST /admin/qrcode/update | QRCodeUpdate 更新已有的二维码 请求路径: POST /admin/qrcode/update 权限要求: 需要管理员权限 UserAPIKeyServiceApi | userAPIKeyServiceUserAPIKeyCreate | POST /api/v1/user/api-key/create | UserAPIKeyCreate 创建新的 UserAPIKey 请求路径: POST /api/user/api-key/create UserAPIKeyServiceApi | userAPIKeyServiceUserAPIKeyDelete | DELETE /api/v1/user/api-key/delete | UserAPIKeyDelete 删除 UserAPIKey（软删除） 请求路径: POST /api/user/api-key/delete UserAPIKeyServiceApi | 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} UserAPIKeyServiceApi | 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} UserAPIKeyServiceApi | userAPIKeyServiceUserAPIKeyUpdate | POST /api/v1/user/api-key/update | UserAPIKeyUpdate 更新现有的 UserAPIKey 请求路径: POST /api/user/api-key/update UserAdminServiceApi | userAdminServiceUserInfoPageGet | POST /admin/users/search | 用户信息-分页查询接口 UserAdminServiceApi | userAdminServiceUserInfoUpdate | POST /admin/users/update | 用户信息-单个更新接口 UserBalanceServiceApi | userBalanceServiceUserBalanceChange | POST /admin/users/balance/change | 用户余额变更接口 - 增量操作 UserBalanceServiceApi | userBalanceServiceUserBalanceEdit | POST /admin/users/balance/edit | 编辑用户余额信息 - 注意，这是直接编辑最终结果值，不是增量操作 NOTE: 后台尽量别用此接口做增量变更操作，避免并发问题导致数据不一致 UserBalanceServiceApi | userBalanceServiceUserBalanceList | GET /admin/users/balance/list | 用户余额列表接口 UserLabelServiceApi | userLabelServiceLabelCreate | POST /admin/label/create | UserLabelServiceApi | userLabelServiceLabelDelete | DELETE /admin/label/delete | UserLabelServiceApi | userLabelServiceLabelGet | GET /admin/label/get | UserLabelServiceApi | userLabelServiceLabelList | GET /admin/label/list | UserLabelServiceApi | userLabelServiceLabelUpdate | POST /admin/label/update | UserLabelServiceApi | userLabelServiceUserLabelList | GET /admin/users/label/list | UserLabelServiceApi | userLabelServiceUserLabelPairChange | POST /admin/users/label/change | UserModelServiceApi | userModelServiceFrontendModels | GET /api/v1/frontend/models | FrontendModels 获取前端模型列表 NOTE: 登录态鉴权 UserModelServiceApi | userModelServiceFrontendProviders | GET /api/v1/frontend/providers | FrontendProviders 获取前端供应商列表 NOTE: 登录态鉴权 UserModelServiceApi | userModelServiceModelList | GET /v1/models | ModelList OpenAI 通用模型列表 NOTE: 需要 API KEY 鉴权 UserPayAdminServiceApi | userPayAdminServiceUserPayOrderAdminList | POST /admin/users/orders/list | Admin - 用户订单查询列表 UserPayServiceApi | userPayServiceUserPayOrderList | GET /api/v1/user/pay/order/list | UserPayServiceApi | userPayServiceUserPayStripeCheckout | POST /api/v1/user/pay/stripe/checkout | UserPortalServiceApi | userPortalServiceUserMeInfo | GET /api/v1/user/me/info | 个人信息接口 UserPortalServiceApi | userPortalServiceUserPortalDashboard | GET /api/v1/user/portal/dashboard | 用户门户仪表盘信息
Documentation For Models
- AIModelPricingConfig
- AdminAIModel
- AdminAIModelCheckConnectionResponse
- AdminAIModelCheckItem
- AdminAIModelCheckResult
- AdminAIModelCreateRequest
- AdminAIModelCreateResponse
- AdminAIModelDeleteResponse
- AdminAIModelDisableRequest
- AdminAIModelDisableResponse
- AdminAIModelDiscountConfig
- AdminAIModelGetResponse
- AdminAIModelListResponse
- AdminAIModelProviderConfigItem
- AdminAIModelPublishRequest
- AdminAIModelPublishResponse
- AdminAIModelUpdateRequest
- AdminAIModelUpdateResponse
- AdminAPIToken
- AdminAPITokenCreateRequest
- AdminAPITokenCreateResponse
- AdminAPITokenDeleteResponse
- AdminAPITokenGetResponse
- AdminAPITokenListResponse
- AdminAPITokenRefreshRequest
- AdminAPITokenRefreshResponse
- AdminAPITokenScopes
- AdminAPITokenUpdateRequest
- AdminAPITokenUpdateResponse
- AdminProvider
- AdminProviderCreateRequest
- AdminProviderCreateResponse
- AdminProviderDeleteResponse
- AdminProviderGetResponse
- AdminProviderListResponse
- AdminProviderModel
- AdminProviderModelCreateRequest
- AdminProviderModelCreateResponse
- AdminProviderModelDeleteResponse
- AdminProviderModelGetResponse
- AdminProviderModelListResponse
- AdminProviderModelUpdateRequest
- AdminProviderModelUpdateResponse
- AdminProviderUpdateRequest
- AdminProviderUpdateResponse
- AigwpbLabel
- AigwpbUserMeInfo
- AigwpbUserPayStripeCheckout
- AigwpbUserPortalDashboard
- AigwpbUserSettings
- Any
- AudioPricing
- AuthUserMethod
- CodeExecutionPricing
- DailyUsage
- DashboardOverview
- DiscountCreateRequest
- DiscountDeleteResponse
- DiscountGetResponse
- DiscountInfo
- DiscountListResponse
- DiscountUpdateRequest
- DiscountUpdateResponse
- FeatureCostPricing
- FeaturePricing
- FrontAIModel
- FrontendModelExtraInfo
- FrontendModelPricing
- FrontendModelsResponse
- FrontendModelsResponseOption
- FrontendProviderInfo
- FrontendProviderModel
- FrontendProvidersResponse
- FrontendSearchContextCost
- ImagePricing
- LabelCreateRequest
- LabelCreateResponse
- LabelDeleteResponse
- LabelGetResponse
- LabelListResponse
- LabelUpdateRequest
- LabelUpdateResponse
- ModelCapabilities
- ModelLimits
- ModelListResponse
- ModelModalities
- MultimodalPricing
- OrderItem
- PassportpbUserSettings
- PricingConditions
- PricingRules
- ProviderAWSAuth
- ProviderAuth
- ProviderGCPAuth
- QRCodeCreateRequest
- QRCodeCreateResponse
- QRCodeDeleteResponse
- QRCodeGetResponse
- QRCodeHistoryItem
- QRCodeInfo
- QRCodeListResponse
- QRCodeSnapshot
- QRCodeUpdateRequest
- QRCodeUpdateResponse
- QRCodeWithHistory
- ReasoningTokensPricing
- RequestPricing
- Status
- TextTokenInputPricing
- TextTokenOutputPricing
- TextTokenPricing
- TokenBreakdown
- TokenTier
- TokenUsage
- UsageInsights
- UserAPIKey
- UserAPIKeyCreateRequest
- UserAPIKeyCreateResponse
- UserAPIKeyDeleteResponse
- UserAPIKeyGetResponse
- UserAPIKeyListResponse
- UserAPIKeyUpdateRequest
- UserAPIKeyUpdateResponse
- UserBalance
- UserBalanceBrief
- UserBalanceChangeResponse
- UserBalanceEditResponse
- UserBalanceListResponse
- UserBasic
- UserExtendInfo
- UserInfo
- UserInfoItem
- UserInfoPageGetRequest
- UserInfoPageGetResponse
- UserInfoUpdateRequest
- UserInfoUpdateResponse
- UserLabelItem
- UserLabelListResponse
- UserLabelPair
- UserLabelPairChangeAction
- UserLabelPairChangeRequest
- UserLabelPairChangeResponse
- UserMeInfoResponse
- UserPayOrder
- UserPayOrderAdminItem
- UserPayOrderAdminListRequest
- UserPayOrderAdminListResponse
- UserPayOrderListResponse
- UserPayOrderStripe
- UserPayOrderTimeRange
- UserPayStripeCheckoutRequest
- UserPayStripeCheckoutResponse
- UserPaymentInfo
- UserPortalDashboardResponse
- UserPreferences
- VersionedAPISchema
- VideoPricing
- WebSearchPricing
Documentation For Authorization
Endpoints do not require authorization.