@cherryin/api-client 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +265 -103
- package/README.md +391 -156
- package/api.ts +12793 -4366
- package/dist/api.d.ts +7771 -2676
- package/dist/api.js +6883 -1480
- package/dist/esm/api.d.ts +7771 -2676
- package/dist/esm/api.js +6838 -1459
- package/docs/AIModelAdminServiceApi.md +101 -90
- package/docs/AIModelPricingConfig.md +10 -10
- package/docs/AdminAIModel.md +73 -0
- package/docs/{AIModelCheckConnectionResponse.md → AdminAIModelCheckConnectionResponse.md} +4 -4
- package/docs/{AIModelCheckItem.md → AdminAIModelCheckItem.md} +3 -3
- package/docs/{AIModelCheckResult.md → AdminAIModelCheckResult.md} +5 -5
- package/docs/AdminAIModelCreateRequest.md +67 -0
- package/docs/AdminAIModelCreateResponse.md +25 -0
- package/docs/{AIModelDeleteResponse.md → AdminAIModelDeleteResponse.md} +4 -4
- package/docs/AdminAIModelDisableRequest.md +23 -0
- package/docs/AdminAIModelDisableResponse.md +25 -0
- package/docs/{AIModelDiscountConfig.md → AdminAIModelDiscountConfig.md} +4 -4
- package/docs/{AIModelGetResponse.md → AdminAIModelGetResponse.md} +5 -5
- package/docs/{AIModelListResponse.md → AdminAIModelListResponse.md} +5 -5
- package/docs/AdminAIModelProviderConfigItem.md +29 -0
- package/docs/AdminAIModelPublishRequest.md +23 -0
- package/docs/{AIModelDisableResponse.md → AdminAIModelPublishResponse.md} +5 -5
- package/docs/AdminAIModelUpdateRequest.md +25 -0
- package/docs/{AIModelUpdateResponse.md → AdminAIModelUpdateResponse.md} +5 -5
- package/docs/AdminAPIToken.md +41 -0
- package/docs/AdminAPITokenCreateRequest.md +25 -0
- package/docs/{AuthChangePasswordResponse.md → AdminAPITokenCreateResponse.md} +5 -5
- package/docs/AdminAPITokenDeleteResponse.md +22 -0
- package/docs/{AuthAdminRevokeSessionResponse.md → AdminAPITokenGetResponse.md} +5 -5
- package/docs/{AuthUnlinkAccountResponse.md → AdminAPITokenListResponse.md} +7 -5
- package/docs/AdminAPITokenRefreshRequest.md +21 -0
- package/docs/{AuthAdminSignInEmailResponse.md → AdminAPITokenRefreshResponse.md} +5 -5
- package/docs/AdminAPITokenScopes.md +25 -0
- package/docs/AdminAPITokenServiceApi.md +325 -0
- package/docs/AdminAPITokenUpdateRequest.md +29 -0
- package/docs/{AuthAdminUpdateUserResponse.md → AdminAPITokenUpdateResponse.md} +5 -5
- package/docs/AdminEnterpriseMaterials.md +24 -0
- package/docs/AdminEnterpriseUser.md +24 -0
- package/docs/AdminEnterpriseUserMaterials.md +22 -0
- package/docs/AdminPassportItem.md +24 -0
- package/docs/AdminProvider.md +46 -0
- package/docs/AdminProviderCreateRequest.md +41 -0
- package/docs/AdminProviderCreateResponse.md +25 -0
- package/docs/{ProviderModelDeleteResponse.md → AdminProviderDeleteResponse.md} +4 -4
- package/docs/AdminProviderGetResponse.md +25 -0
- package/docs/AdminProviderListResponse.md +27 -0
- package/docs/AdminProviderModel.md +68 -0
- package/docs/AdminProviderModelCreateRequest.md +63 -0
- package/docs/AdminProviderModelCreateResponse.md +25 -0
- package/docs/{ProviderDeleteResponse.md → AdminProviderModelDeleteResponse.md} +4 -4
- package/docs/{ProviderGetResponse.md → AdminProviderModelGetResponse.md} +5 -5
- package/docs/{ProviderModelListResponse.md → AdminProviderModelListResponse.md} +6 -6
- package/docs/AdminProviderModelUpdateRequest.md +27 -0
- package/docs/{AIModelCreateResponse.md → AdminProviderModelUpdateResponse.md} +5 -5
- package/docs/AdminProviderUpdateRequest.md +27 -0
- package/docs/{AIModelPublishResponse.md → AdminProviderUpdateResponse.md} +5 -5
- package/docs/AdminUserItem.md +26 -0
- package/docs/AudioPricing.md +8 -8
- package/docs/AuthAdminSession.md +39 -0
- package/docs/{Auth2Admin.md → AuthAdminUser.md} +7 -7
- package/docs/AuthEnterpriseMaterials.md +33 -0
- package/docs/AuthEnterpriseSession.md +37 -0
- package/docs/AuthEnterpriseUser.md +37 -0
- package/docs/{Auth2IdToken.md → AuthIdToken.md} +3 -3
- package/docs/AuthPassport.md +35 -0
- package/docs/AuthUser.md +39 -0
- package/docs/AuthUserMethod.md +39 -0
- package/docs/AuthUserSession.md +41 -0
- package/docs/CodeExecutionPricing.md +25 -0
- package/docs/ConfigItem.md +10 -6
- package/docs/DiscountDeleteResponse.md +1 -1
- package/docs/DiscountGetResponse.md +1 -1
- package/docs/DiscountListResponse.md +1 -1
- package/docs/DiscountUpdateResponse.md +1 -1
- package/docs/FeatureCostPricing.md +5 -5
- package/docs/FeaturePricing.md +27 -0
- package/docs/FrontAIModel.md +15 -17
- package/docs/FrontendModelExtraInfo.md +21 -0
- package/docs/FrontendModelPricing.md +57 -0
- package/docs/FrontendModelsResponse.md +29 -0
- package/docs/FrontendProviderInfo.md +31 -0
- package/docs/FrontendProviderModel.md +55 -0
- package/docs/FrontendProvidersResponse.md +29 -0
- package/docs/FrontendSearchContextCost.md +25 -0
- package/docs/ImagePricing.md +16 -10
- package/docs/LabelCreateResponse.md +1 -1
- package/docs/LabelDeleteResponse.md +1 -1
- package/docs/LabelListResponse.md +1 -1
- package/docs/LabelUpdateResponse.md +1 -1
- package/docs/ModelCapabilities.md +59 -0
- package/docs/ModelLimits.md +41 -0
- package/docs/{UserModelListResponse.md → ModelListResponse.md} +12 -13
- package/docs/ModelModalities.md +23 -0
- package/docs/MultimodalPricing.md +4 -4
- package/docs/{AuthRequestPasswordResetRequest.md → PassportAdminPasswordForgetRequest.md} +5 -5
- package/docs/{AuthRevokeSessionResponse.md → PassportAdminPasswordForgetResponse.md} +3 -5
- package/docs/PassportAdminPasswordResetRequest.md +28 -0
- package/docs/{AuthLinkSocialResponse.md → PassportAdminPasswordResetResponse.md} +3 -5
- package/docs/PassportAdminPasswordResetTokenVerifyRequest.md +20 -0
- package/docs/PassportAdminPasswordResetTokenVerifyResponse.md +26 -0
- package/docs/PassportAdminSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAdminSendVerificationEmailResponse.md +22 -0
- package/docs/{AuthAdminSignInEmailRequest.md → PassportAdminSignInEmailRequest.md} +7 -5
- package/docs/{AuthGetSessionResponse.md → PassportAdminSignInEmailResponse.md} +6 -6
- package/docs/{AuthAdminRevokeSessionRequest.md → PassportAdminTokenAuthRequest.md} +3 -3
- package/docs/PassportAdminTokenAuthResponse.md +28 -0
- package/docs/{AuthAdminChangePasswordRequest.md → PassportAuthAdminChangePasswordRequest.md} +3 -3
- package/docs/PassportAuthAdminChangePasswordResponse.md +26 -0
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +28 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +22 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewResponse.md +22 -0
- package/docs/{AuthGetAccountInfoResponse.md → PassportAuthAdminGetInfoResponse.md} +4 -4
- package/docs/{AuthAdminGetSessionResponse.md → PassportAuthAdminGetSessionResponse.md} +5 -5
- package/docs/{AuthAdminListSessionsResponse.md → PassportAuthAdminListSessionsResponse.md} +4 -4
- package/docs/PassportAuthAdminPassportDisableRequest.md +22 -0
- package/docs/PassportAuthAdminPassportDisableResponse.md +22 -0
- package/docs/PassportAuthAdminPassportListRequest.md +28 -0
- package/docs/PassportAuthAdminPassportListResponse.md +28 -0
- package/docs/PassportAuthAdminPassportModifyInfoRequest.md +28 -0
- package/docs/PassportAuthAdminPassportModifyInfoResponse.md +24 -0
- package/docs/PassportAuthAdminRPCServiceApi.md +61 -0
- package/docs/{AuthResetPasswordRequest.md → PassportAuthAdminResetPasswordRequest.md} +3 -5
- package/docs/PassportAuthAdminResetPasswordResponse.md +22 -0
- package/docs/{AuthSignOutResponse.md → PassportAuthAdminRevokeOtherSessionsResponse.md} +3 -5
- package/docs/{AuthDeleteUserRequest.md → PassportAuthAdminRevokeSessionRequest.md} +3 -7
- package/docs/PassportAuthAdminRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthAdminRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthAdminServiceApi.md +1286 -0
- package/docs/PassportAuthAdminSignOutResponse.md +22 -0
- package/docs/{AuthAdminUpdateUserRequest.md → PassportAuthAdminUpdateInfoRequest.md} +5 -5
- package/docs/{AuthUpdateUserResponse.md → PassportAuthAdminUpdateInfoResponse.md} +4 -4
- package/docs/PassportAuthAdminUserDisableRequest.md +26 -0
- package/docs/PassportAuthAdminUserDisableResponse.md +22 -0
- package/docs/PassportAuthAdminUserListRequest.md +28 -0
- package/docs/{AuthSendVerificationEmailResponse.md → PassportAuthAdminUserListResponse.md} +9 -5
- package/docs/PassportAuthAdminUserModifyInfoRequest.md +32 -0
- package/docs/{AuthResetPasswordResponse.md → PassportAuthAdminUserModifyInfoResponse.md} +5 -5
- package/docs/PassportAuthAdminUserModifyPermissionRequest.md +22 -0
- package/docs/PassportAuthAdminUserModifyPermissionResponse.md +24 -0
- package/docs/PassportAuthChangePasswordRequest.md +26 -0
- package/docs/PassportAuthChangePasswordResponse.md +26 -0
- package/docs/{AuthSignInEmailRequest.md → PassportAuthDeleteAllRequest.md} +9 -7
- package/docs/PassportAuthDeleteAllResponse.md +22 -0
- package/docs/{AuthChangePasswordRequest.md → PassportAuthEnterpriseChangePasswordRequest.md} +3 -3
- package/docs/{AuthAdminChangePasswordResponse.md → PassportAuthEnterpriseChangePasswordResponse.md} +4 -4
- package/docs/PassportAuthEnterpriseChangePhoneRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePhoneResponse.md +22 -0
- package/docs/{AuthSignUpEmailRequest.md → PassportAuthEnterpriseDeleteRequest.md} +9 -13
- package/docs/PassportAuthEnterpriseDeleteResponse.md +22 -0
- package/docs/PassportAuthEnterpriseGetSessionResponse.md +24 -0
- package/docs/PassportAuthEnterpriseInfoGetResponse.md +24 -0
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +24 -0
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +26 -0
- package/docs/{AuthAdminSignOutResponse.md → PassportAuthEnterpriseMaterialUploadResponse.md} +3 -5
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +24 -0
- package/docs/PassportAuthEnterpriseRPCServiceApi.md +61 -0
- package/docs/PassportAuthEnterpriseRefreshTokenRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRefreshTokenResponse.md +24 -0
- package/docs/PassportAuthEnterpriseResetPasswordRequest.md +22 -0
- package/docs/PassportAuthEnterpriseResetPasswordResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeOtherSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseServiceApi.md +1170 -0
- package/docs/PassportAuthEnterpriseSignOutRequest.md +20 -0
- package/docs/PassportAuthEnterpriseSignOutResponse.md +22 -0
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +22 -0
- package/docs/PassportAuthEnterpriseUpdateInfoResponse.md +24 -0
- package/docs/{AuthSendVerificationEmailRequest.md → PassportAuthEnterpriseVerifyEmailRequest.md} +5 -3
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +22 -0
- package/docs/PassportAuthInfoGetResponse.md +26 -0
- package/docs/{AuthSignInSocialRequest.md → PassportAuthLinkSocialRequest.md} +6 -4
- package/docs/{AuthSignUpEmailResponse.md → PassportAuthLinkSocialResponse.md} +5 -7
- package/docs/PassportAuthListMethodsResponse.md +24 -0
- package/docs/{AuthListSessionsResponse.md → PassportAuthListSessionsResponse.md} +4 -4
- package/docs/PassportAuthListSocialsResponse.md +24 -0
- package/docs/PassportAuthRefreshSessionTokenRequest.md +20 -0
- package/docs/PassportAuthRefreshSessionTokenResponse.md +24 -0
- package/docs/PassportAuthResetPasswordRequest.md +24 -0
- package/docs/PassportAuthResetPasswordResponse.md +22 -0
- package/docs/PassportAuthRevokeOtherSessionsRequest.md +20 -0
- package/docs/{AuthDeleteUserResponse.md → PassportAuthRevokeOtherSessionsResponse.md} +3 -3
- package/docs/PassportAuthRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthRevokeSessionsRequest.md +20 -0
- package/docs/PassportAuthRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAuthSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAuthSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportAuthSendVerificationPhoneResponse.md +22 -0
- package/docs/{AuthRefreshTokenRequest.md → PassportAuthSocialGetAccessTokenRequest.md} +3 -3
- package/docs/{AuthRefreshTokenResponse.md → PassportAuthSocialGetAccessTokenResponse.md} +3 -3
- package/docs/{AuthGetAccessTokenRequest.md → PassportAuthSocialRefreshTokenRequest.md} +3 -3
- package/docs/{AuthGetAccessTokenResponse.md → PassportAuthSocialRefreshTokenResponse.md} +3 -3
- package/docs/{AuthUnlinkAccountRequest.md → PassportAuthUnlinkSocialRequest.md} +5 -3
- package/docs/PassportAuthUnlinkSocialResponse.md +22 -0
- package/docs/{AuthChangeEmailRequest.md → PassportAuthUserChangeEmailRequest.md} +5 -3
- package/docs/PassportAuthUserChangeEmailResponse.md +24 -0
- package/docs/PassportAuthUserChangePhoneRequest.md +26 -0
- package/docs/PassportAuthUserChangePhoneResponse.md +24 -0
- package/docs/PassportAuthUserDeleteRequest.md +30 -0
- package/docs/PassportAuthUserDeleteResponse.md +22 -0
- package/docs/PassportAuthUserGetSessionResponse.md +24 -0
- package/docs/{AuthRevokeOtherSessionsResponse.md → PassportAuthUserInfoGetResponse.md} +5 -5
- package/docs/PassportAuthUserRPCServiceApi.md +223 -0
- package/docs/PassportAuthUserServiceApi.md +2000 -0
- package/docs/PassportAuthUserSignOutRequest.md +22 -0
- package/docs/PassportAuthUserSignOutResponse.md +22 -0
- package/docs/PassportAuthUserUpdateInfoRequest.md +28 -0
- package/docs/PassportAuthUserUpdateInfoResponse.md +24 -0
- package/docs/{AuthUpdateUserRequest.md → PassportAuthUserUpdatePassportRequest.md} +5 -5
- package/docs/PassportAuthUserUpdatePassportResponse.md +24 -0
- package/docs/PassportAuthUserVerifyEmailRequest.md +26 -0
- package/docs/PassportAuthUserVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthUserVerifyPhoneRequest.md +24 -0
- package/docs/PassportAuthUserVerifyPhoneResponse.md +22 -0
- package/docs/PassportEnterprisePasswordResetRequest.md +24 -0
- package/docs/{AuthSignInEmailResponse.md → PassportEnterprisePasswordResetResponse.md} +5 -9
- package/docs/PassportEnterpriseSendVerificationEmailRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationEmailResponse.md +22 -0
- package/docs/PassportEnterpriseSendVerificationPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportEnterpriseSignInEmailRequest.md +30 -0
- package/docs/{AuthOAuth2CallbackResponse.md → PassportEnterpriseSignInEmailResponse.md} +8 -10
- package/docs/PassportEnterpriseSignInPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSignInPhoneResponse.md +26 -0
- package/docs/PassportEnterpriseSignUpEmailRequest.md +34 -0
- package/docs/PassportEnterpriseSignUpEmailResponse.md +30 -0
- package/docs/PassportEnterpriseTokenAuthRequest.md +20 -0
- package/docs/PassportEnterpriseTokenAuthResponse.md +28 -0
- package/docs/PassportSendVerificationEmailRequest.md +26 -0
- package/docs/PassportSendVerificationEmailResponse.md +22 -0
- package/docs/PassportSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportUserInfoBatchGetRequest.md +24 -0
- package/docs/{AuthRequestPasswordResetResponse.md → PassportUserInfoBatchGetResponse.md} +5 -5
- package/docs/PassportUserInfoGetRequest.md +24 -0
- package/docs/{AuthAdminRevokeSessionsResponse.md → PassportUserInfoGetResponse.md} +5 -5
- package/docs/PassportUserOAuthCallbackResponse.md +36 -0
- package/docs/PassportUserPasswordForgetRequest.md +24 -0
- package/docs/PassportUserPasswordForgetResponse.md +22 -0
- package/docs/PassportUserPasswordResetRequest.md +30 -0
- package/docs/{AuthSignInSocialResponse.md → PassportUserPasswordResetResponse.md} +5 -9
- package/docs/PassportUserPasswordResetTokenVerifyRequest.md +22 -0
- package/docs/{AuthListAccountsResponse.md → PassportUserPasswordResetTokenVerifyResponse.md} +7 -5
- package/docs/PassportUserSignInEmailRequest.md +32 -0
- package/docs/PassportUserSignInEmailResponse.md +32 -0
- package/docs/PassportUserSignInPhoneRequest.md +26 -0
- package/docs/PassportUserSignInPhoneResponse.md +28 -0
- package/docs/{AuthLinkSocialRequest.md → PassportUserSignInSocialRequest.md} +8 -6
- package/docs/PassportUserSignInSocialResponse.md +32 -0
- package/docs/PassportUserSignUpEmailRequest.md +36 -0
- package/docs/PassportUserSignUpEmailResponse.md +32 -0
- package/docs/{AuthRevokeSessionRequest.md → PassportUserTokenAuthRequest.md} +3 -3
- package/docs/PassportUserTokenAuthResponse.md +28 -0
- package/docs/PassportUserUpdateInfoRequest.md +30 -0
- package/docs/PassportUserUpdateInfoResponse.md +22 -0
- package/docs/PricingConditions.md +7 -7
- package/docs/PricingRules.md +10 -6
- package/docs/{AWSAuth.md → ProviderAWSAuth.md} +4 -3
- package/docs/ProviderAdminServiceApi.md +305 -53
- package/docs/ProviderAuth.md +6 -6
- package/docs/ProviderGCPAuth.md +27 -0
- package/docs/ProviderModelAdminServiceApi.md +366 -57
- package/docs/QRCodeAdminServiceApi.md +286 -0
- package/docs/QRCodeCreateRequest.md +37 -0
- package/docs/QRCodeCreateResponse.md +25 -0
- package/docs/QRCodeDeleteResponse.md +23 -0
- package/docs/QRCodeGetResponse.md +25 -0
- package/docs/QRCodeHistoryItem.md +29 -0
- package/docs/QRCodeInfo.md +59 -0
- package/docs/QRCodeListResponse.md +27 -0
- package/docs/QRCodeSnapshot.md +37 -0
- package/docs/QRCodeUpdateRequest.md +39 -0
- package/docs/QRCodeUpdateResponse.md +25 -0
- package/docs/QRCodeWithHistory.md +23 -0
- package/docs/ReasoningTokensPricing.md +21 -0
- package/docs/RemoteConfigAdminServiceApi.md +21 -3
- package/docs/RemoteConfigItemGetResponse.md +2 -2
- package/docs/RemoteConfigItemUpdateRequest.md +6 -0
- package/docs/RemoteConfigItemUpdateResponse.md +2 -2
- package/docs/RequestPricing.md +4 -4
- package/docs/TextTokenInputPricing.md +5 -5
- package/docs/TextTokenOutputPricing.md +4 -4
- package/docs/TextTokenPricing.md +3 -3
- package/docs/TokenTier.md +5 -5
- package/docs/UserAPIKey.md +15 -15
- package/docs/UserAPIKeyCreateRequest.md +9 -9
- package/docs/UserAPIKeyCreateResponse.md +4 -4
- package/docs/UserAPIKeyDeleteResponse.md +3 -3
- package/docs/UserAPIKeyGetResponse.md +4 -4
- package/docs/UserAPIKeyListResponse.md +5 -5
- package/docs/UserAPIKeyServiceApi.md +26 -27
- package/docs/UserAPIKeyUpdateResponse.md +3 -3
- package/docs/UserBalanceChangeResponse.md +2 -2
- package/docs/UserBalanceEditResponse.md +2 -2
- package/docs/UserBalanceListResponse.md +2 -2
- package/docs/UserBalanceServiceApi.md +4 -4
- package/docs/UserBasic.md +42 -0
- package/docs/UserExtendInfo.md +20 -0
- package/docs/UserInfoQueryOptions.md +28 -0
- package/docs/UserLabelListResponse.md +1 -1
- package/docs/UserLabelPairChangeResponse.md +1 -1
- package/docs/UserMeInfo.md +3 -3
- package/docs/UserModelActivitySummary.md +31 -0
- package/docs/UserModelHourActivity.md +28 -0
- package/docs/UserModelHourlyUsages.md +20 -0
- package/docs/UserModelServiceApi.md +124 -11
- package/docs/UserPaymentInfo.md +20 -0
- package/docs/UserPortalDashboard.md +25 -0
- package/docs/{AuthAdminRevokeOtherSessionsResponse.md → UserPortalDashboardResponse.md} +5 -5
- package/docs/UserPortalServiceApi.md +109 -0
- package/docs/UserPreferences.md +22 -0
- package/docs/VersionedAPISchema.md +6 -6
- package/docs/VideoPricing.md +8 -8
- package/docs/WebSearchPricing.md +31 -0
- package/package.json +1 -1
- package/docs/AIModel.md +0 -45
- package/docs/AIModelArchitecture.md +0 -25
- package/docs/AIModelCreateRequest.md +0 -35
- package/docs/AIModelDeleteRequest.md +0 -21
- package/docs/AIModelDisableRequest.md +0 -21
- package/docs/AIModelMeta.md +0 -25
- package/docs/AIModelProviderConfigItem.md +0 -29
- package/docs/AIModelPublishRequest.md +0 -21
- package/docs/AIModelUpdateRequest.md +0 -37
- package/docs/Auth2Account.md +0 -33
- package/docs/Auth2AdminServiceApi.md +0 -469
- package/docs/Auth2AdminSession.md +0 -35
- package/docs/Auth2Session.md +0 -35
- package/docs/Auth2User.md +0 -33
- package/docs/Auth2UserServiceApi.md +0 -1261
- package/docs/AuthChangeEmailResponse.md +0 -26
- package/docs/AuthRevokeSessionsResponse.md +0 -24
- package/docs/AuthVerifyEmailResponse.md +0 -24
- package/docs/GCPAuth.md +0 -27
- package/docs/Provider.md +0 -37
- package/docs/ProviderCreateRequest.md +0 -29
- package/docs/ProviderCreateResponse.md +0 -25
- package/docs/ProviderListResponse.md +0 -27
- package/docs/ProviderModel.md +0 -37
- package/docs/ProviderModelCreateRequest.md +0 -29
- package/docs/ProviderModelCreateResponse.md +0 -25
- package/docs/ProviderModelGetResponse.md +0 -25
- package/docs/ProviderModelPayload.md +0 -23
- package/docs/ProviderModelUpdateRequest.md +0 -31
- package/docs/ProviderModelUpdateResponse.md +0 -25
- package/docs/ProviderPayload.md +0 -21
- package/docs/ProviderUpdateRequest.md +0 -31
- package/docs/ProviderUpdateResponse.md +0 -25
- package/docs/UserAPIKeyDeleteRequest.md +0 -21
- package/docs/UserPoralServiceApi.md +0 -52
|
@@ -79,10 +79,16 @@ import {
|
|
|
79
79
|
const configuration = new Configuration();
|
|
80
80
|
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
81
81
|
|
|
82
|
+
let service: string; // (optional) (default to undefined)
|
|
82
83
|
let key: string; // (optional) (default to undefined)
|
|
84
|
+
let envList: Array<string>; //是否强制更新所有环境的配置项,若为 true 则忽略 env_list,仅更新 item 中指定的环境配置 如果为 false,则仅更新 env_list 中指定的环境配置,并且 env_list 不能为空 (optional) (default to undefined)
|
|
85
|
+
let forceUpdateEnvs: boolean; // (optional) (default to undefined)
|
|
83
86
|
|
|
84
87
|
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemDelete(
|
|
85
|
-
|
|
88
|
+
service,
|
|
89
|
+
key,
|
|
90
|
+
envList,
|
|
91
|
+
forceUpdateEnvs
|
|
86
92
|
);
|
|
87
93
|
```
|
|
88
94
|
|
|
@@ -90,7 +96,10 @@ const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigI
|
|
|
90
96
|
|
|
91
97
|
|Name | Type | Description | Notes|
|
|
92
98
|
|------------- | ------------- | ------------- | -------------|
|
|
99
|
+
| **service** | [**string**] | | (optional) defaults to undefined|
|
|
93
100
|
| **key** | [**string**] | | (optional) defaults to undefined|
|
|
101
|
+
| **envList** | **Array<string>** | 是否强制更新所有环境的配置项,若为 true 则忽略 env_list,仅更新 item 中指定的环境配置 如果为 false,则仅更新 env_list 中指定的环境配置,并且 env_list 不能为空 | (optional) defaults to undefined|
|
|
102
|
+
| **forceUpdateEnvs** | [**boolean**] | | (optional) defaults to undefined|
|
|
94
103
|
|
|
95
104
|
|
|
96
105
|
### Return type
|
|
@@ -131,10 +140,12 @@ import {
|
|
|
131
140
|
const configuration = new Configuration();
|
|
132
141
|
const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
133
142
|
|
|
143
|
+
let service: string; //@gotags: form:\"service\" binding:\"required\" (optional) (default to undefined)
|
|
134
144
|
let key: string; //@gotags: form:\"key\" binding:\"required\" (optional) (default to undefined)
|
|
135
145
|
let historyLimit: number; //@gotags: form:\"history_limit\" (optional) (default to undefined)
|
|
136
146
|
|
|
137
147
|
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemGet(
|
|
148
|
+
service,
|
|
138
149
|
key,
|
|
139
150
|
historyLimit
|
|
140
151
|
);
|
|
@@ -144,6 +155,7 @@ const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigI
|
|
|
144
155
|
|
|
145
156
|
|Name | Type | Description | Notes|
|
|
146
157
|
|------------- | ------------- | ------------- | -------------|
|
|
158
|
+
| **service** | [**string**] | @gotags: form:\"service\" binding:\"required\" | (optional) defaults to undefined|
|
|
147
159
|
| **key** | [**string**] | @gotags: form:\"key\" binding:\"required\" | (optional) defaults to undefined|
|
|
148
160
|
| **historyLimit** | [**number**] | @gotags: form:\"history_limit\" | (optional) defaults to undefined|
|
|
149
161
|
|
|
@@ -188,13 +200,17 @@ const apiInstance = new RemoteConfigAdminServiceApi(configuration);
|
|
|
188
200
|
|
|
189
201
|
let page: number; // (optional) (default to undefined)
|
|
190
202
|
let pageSize: number; // (optional) (default to undefined)
|
|
203
|
+
let services: Array<string>; // (optional) (default to undefined)
|
|
191
204
|
let keys: Array<string>; // (optional) (default to undefined)
|
|
192
|
-
let
|
|
205
|
+
let envList: Array<string>; // (optional) (default to undefined)
|
|
206
|
+
let keyword: string; //搜索关键词,模糊匹配 key + payload + values 字段 (optional) (default to undefined)
|
|
193
207
|
|
|
194
208
|
const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigItemList(
|
|
195
209
|
page,
|
|
196
210
|
pageSize,
|
|
211
|
+
services,
|
|
197
212
|
keys,
|
|
213
|
+
envList,
|
|
198
214
|
keyword
|
|
199
215
|
);
|
|
200
216
|
```
|
|
@@ -205,8 +221,10 @@ const { status, data } = await apiInstance.remoteConfigAdminServiceRemoteConfigI
|
|
|
205
221
|
|------------- | ------------- | ------------- | -------------|
|
|
206
222
|
| **page** | [**number**] | | (optional) defaults to undefined|
|
|
207
223
|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
|
224
|
+
| **services** | **Array<string>** | | (optional) defaults to undefined|
|
|
208
225
|
| **keys** | **Array<string>** | | (optional) defaults to undefined|
|
|
209
|
-
| **
|
|
226
|
+
| **envList** | **Array<string>** | | (optional) defaults to undefined|
|
|
227
|
+
| **keyword** | [**string**] | 搜索关键词,模糊匹配 key + payload + values 字段 | (optional) defaults to undefined|
|
|
210
228
|
|
|
211
229
|
|
|
212
230
|
### Return type
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**items** | [**Array<ConfigItemHistory>**](ConfigItemHistory.md) | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ import { RemoteConfigItemGetResponse } from '@cherryin/api-client';
|
|
|
17
17
|
const instance: RemoteConfigItemGetResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
|
-
|
|
20
|
+
items,
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -5,7 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**service** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**key** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**env_list** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
**force_update_envs** | **boolean** | 是否强制更新所有环境的配置项,若为 true 则忽略 env_list,仅更新 item 中指定的环境配置 如果为 false,则仅更新 env_list 中指定的环境配置,并且 env_list 不能为空 | [optional] [default to undefined]
|
|
9
12
|
**item** | [**ConfigItem**](ConfigItem.md) | | [optional] [default to undefined]
|
|
10
13
|
|
|
11
14
|
## Example
|
|
@@ -14,7 +17,10 @@ Name | Type | Description | Notes
|
|
|
14
17
|
import { RemoteConfigItemUpdateRequest } from '@cherryin/api-client';
|
|
15
18
|
|
|
16
19
|
const instance: RemoteConfigItemUpdateRequest = {
|
|
20
|
+
service,
|
|
17
21
|
key,
|
|
22
|
+
env_list,
|
|
23
|
+
force_update_envs,
|
|
18
24
|
item,
|
|
19
25
|
};
|
|
20
26
|
```
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**code** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**items** | [**Array<ConfigItem>**](ConfigItem.md) | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ import { RemoteConfigItemUpdateResponse } from '@cherryin/api-client';
|
|
|
17
17
|
const instance: RemoteConfigItemUpdateResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
|
-
|
|
20
|
+
items,
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
package/docs/RequestPricing.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# RequestPricing
|
|
2
2
|
|
|
3
|
-
RequestPricing 请求级别计费
|
|
3
|
+
RequestPricing 请求级别计费
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**base_fee** | **string** | base_fee 每请求基础费用
|
|
10
|
-
**
|
|
9
|
+
**base_fee** | **string** | base_fee 每请求基础费用 | [optional] [default to undefined]
|
|
10
|
+
**request_fee** | **string** | request_fee 每次请求费用 | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ import { RequestPricing } from '@cherryin/api-client';
|
|
|
16
16
|
|
|
17
17
|
const instance: RequestPricing = {
|
|
18
18
|
base_fee,
|
|
19
|
-
|
|
19
|
+
request_fee,
|
|
20
20
|
};
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# TextTokenInputPricing
|
|
2
2
|
|
|
3
|
-
TextTokenInputPricing 输入Token价格配置
|
|
3
|
+
TextTokenInputPricing 输入Token价格配置
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | id 价格配置ID
|
|
10
|
-
**regular** | [**Array<TokenTier>**](TokenTier.md) | regular 常规价格层级
|
|
11
|
-
**cached** | [**Array<TokenTier>**](TokenTier.md) | cached 缓存Token价格层级
|
|
12
|
-
**cache_write** | [**Array<TokenTier>**](TokenTier.md) | cache_write 缓存写入价格层级
|
|
9
|
+
**id** | **string** | id 价格配置ID | [optional] [default to undefined]
|
|
10
|
+
**regular** | [**Array<TokenTier>**](TokenTier.md) | regular 常规价格层级 | [optional] [default to undefined]
|
|
11
|
+
**cached** | [**Array<TokenTier>**](TokenTier.md) | cached 缓存Token价格层级 | [optional] [default to undefined]
|
|
12
|
+
**cache_write** | [**Array<TokenTier>**](TokenTier.md) | cache_write 缓存写入价格层级 | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# TextTokenOutputPricing
|
|
2
2
|
|
|
3
|
-
TextTokenOutputPricing 输出Token价格配置
|
|
3
|
+
TextTokenOutputPricing 输出Token价格配置
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | id 价格配置ID
|
|
10
|
-
**regular** | [**Array<TokenTier>**](TokenTier.md) | regular 常规价格层级
|
|
11
|
-
**reasoning** | [**Array<TokenTier>**](TokenTier.md) | reasoning 推理Token价格层级(如o1模型)
|
|
9
|
+
**id** | **string** | id 价格配置ID | [optional] [default to undefined]
|
|
10
|
+
**regular** | [**Array<TokenTier>**](TokenTier.md) | regular 常规价格层级 | [optional] [default to undefined]
|
|
11
|
+
**reasoning** | [**Array<TokenTier>**](TokenTier.md) | reasoning 推理Token价格层级(如o1模型) | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/TextTokenPricing.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# TextTokenPricing
|
|
2
2
|
|
|
3
|
-
TextTokenPricing Token计费规则
|
|
3
|
+
TextTokenPricing Token计费规则
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**input** | [**TextTokenInputPricing**](TextTokenInputPricing.md) | input 输入Token价格配置
|
|
10
|
-
**output** | [**TextTokenOutputPricing**](TextTokenOutputPricing.md) | output 输出Token价格配置
|
|
9
|
+
**input** | [**TextTokenInputPricing**](TextTokenInputPricing.md) | input 输入Token价格配置 | [optional] [default to undefined]
|
|
10
|
+
**output** | [**TextTokenOutputPricing**](TextTokenOutputPricing.md) | output 输出Token价格配置 | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TokenTier.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# TokenTier
|
|
2
2
|
|
|
3
|
-
TokenTier Token价格层级
|
|
3
|
+
TokenTier Token价格层级
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**min_tokens** | **string** | min_tokens 最小token数量
|
|
10
|
-
**max_tokens** | **string** | max_tokens 最大token数量(0表示无限)
|
|
11
|
-
**
|
|
9
|
+
**min_tokens** | **string** | min_tokens 最小token数量 | [optional] [default to undefined]
|
|
10
|
+
**max_tokens** | **string** | max_tokens 最大token数量(0表示无限) | [optional] [default to undefined]
|
|
11
|
+
**per_token_price** | **string** | per_token_price 每token价格(使用字符串避免精度损失) | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -18,7 +18,7 @@ import { TokenTier } from '@cherryin/api-client';
|
|
|
18
18
|
const instance: TokenTier = {
|
|
19
19
|
min_tokens,
|
|
20
20
|
max_tokens,
|
|
21
|
-
|
|
21
|
+
per_token_price,
|
|
22
22
|
};
|
|
23
23
|
```
|
|
24
24
|
|
package/docs/UserAPIKey.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
# UserAPIKey
|
|
2
2
|
|
|
3
|
-
UserAPIKey 代表用户的 API 密钥
|
|
3
|
+
UserAPIKey 代表用户的 API 密钥
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | id UserAPIKey 的唯一标识符
|
|
10
|
-
**created_at** | **string** | created_at 创建时间戳(Unix 时间戳)
|
|
11
|
-
**updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳)
|
|
12
|
-
**deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除
|
|
13
|
-
**uid** | **string** | uid 用户 ID
|
|
14
|
-
**name** | **string** | name API Key 的唯一名称标识
|
|
15
|
-
**key_group** | **string** | key_group API Key 分组
|
|
16
|
-
**display_name** | **string** | display_name API Key 的显示名称
|
|
17
|
-
**quota_balance_total** | **string** | quota_balance_total 总配额余额,使用 DECIMAL(24,12) 精度存储
|
|
18
|
-
**quota_balance_used** | **string** | quota_balance_used 已使用配额余额,使用 DECIMAL(24,12) 精度存储
|
|
19
|
-
**balance_code** | **string** | balance_code 余额货币代码
|
|
20
|
-
**quota_mode** | **number** | quota_mode 配额模式
|
|
21
|
-
**key_status** | **string** | key_status API Key 状态
|
|
22
|
-
**expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期
|
|
9
|
+
**id** | **string** | id UserAPIKey 的唯一标识符 | [optional] [default to undefined]
|
|
10
|
+
**created_at** | **string** | created_at 创建时间戳(Unix 时间戳) | [optional] [default to undefined]
|
|
11
|
+
**updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) | [optional] [default to undefined]
|
|
12
|
+
**deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 | [optional] [default to undefined]
|
|
13
|
+
**uid** | **string** | uid 用户 ID | [optional] [default to undefined]
|
|
14
|
+
**name** | **string** | name API Key 的唯一名称标识 | [optional] [default to undefined]
|
|
15
|
+
**key_group** | **string** | key_group API Key 分组 | [optional] [default to undefined]
|
|
16
|
+
**display_name** | **string** | display_name API Key 的显示名称 | [optional] [default to undefined]
|
|
17
|
+
**quota_balance_total** | **string** | quota_balance_total 总配额余额,使用 DECIMAL(24,12) 精度存储 字符串格式,例如:\"100.50\" 表示 $100.50 或 ¥100.50 | [optional] [default to undefined]
|
|
18
|
+
**quota_balance_used** | **string** | quota_balance_used 已使用配额余额,使用 DECIMAL(24,12) 精度存储 字符串格式,例如:\"25.75\" 表示已使用 $25.75 或 ¥25.75 | [optional] [default to undefined]
|
|
19
|
+
**balance_code** | **string** | balance_code 余额货币代码 USD: 美元 (US Dollar) CNY: 人民币 (Chinese Yuan) | [optional] [default to undefined]
|
|
20
|
+
**quota_mode** | **number** | quota_mode 配额模式 1: 有限配额 (Limited) 2: 无限配额 (Unlimited) | [optional] [default to undefined]
|
|
21
|
+
**key_status** | **string** | key_status API Key 状态 1: 启用 (Enabled) 2: 禁用 (Disabled) | [optional] [default to undefined]
|
|
22
|
+
**expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期 | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
# UserAPIKeyCreateRequest
|
|
2
2
|
|
|
3
|
-
UserAPIKeyCreateRequest 创建 UserAPIKey 的请求
|
|
3
|
+
UserAPIKeyCreateRequest 创建 UserAPIKey 的请求
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**uid** | **string** | uid 用户 ID(管理员可以指定,普通用户自动使用当前用户)
|
|
10
|
-
**name** | **string** | name API Key 的唯一名称标识
|
|
11
|
-
**key_group** | **string** | key_group API Key 分组(可选)
|
|
12
|
-
**display_name** | **string** | display_name API Key 的显示名称
|
|
13
|
-
**quota_balance_total** | **string** | quota_balance_total 总配额余额
|
|
14
|
-
**balance_code** | **string** | balance_code 余额货币代码(仅管理员可指定,默认从 user_balances 读取)
|
|
15
|
-
**quota_mode** | **number** | quota_mode 配额模式
|
|
9
|
+
**uid** | **string** | uid 用户 ID(管理员可以指定,普通用户自动使用当前用户) | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | name API Key 的唯一名称标识 | [optional] [default to undefined]
|
|
11
|
+
**key_group** | **string** | key_group API Key 分组(可选) | [optional] [default to undefined]
|
|
12
|
+
**display_name** | **string** | display_name API Key 的显示名称 | [optional] [default to undefined]
|
|
13
|
+
**quota_balance_total** | **string** | quota_balance_total 总配额余额 字符串格式,使用 DECIMAL(24,12) 精度,例如:\"100.50\" | [optional] [default to undefined]
|
|
14
|
+
**balance_code** | **string** | balance_code 余额货币代码(仅管理员可指定,默认从 user_balances 读取) USD: 美元 (US Dollar) CNY: 人民币 (Chinese Yuan) | [optional] [default to undefined]
|
|
15
|
+
**quota_mode** | **number** | quota_mode 配额模式 1: 有限配额 (Limited) 2: 无限配额 (Unlimited) | [optional] [default to undefined]
|
|
16
16
|
**key_status** | **string** | key_status API Key 状态 API Key status 1: 启用 (Enabled) 2: 禁用 (Disabled) | [optional] [default to undefined]
|
|
17
|
-
**expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期
|
|
17
|
+
**expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期 | [optional] [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# UserAPIKeyCreateResponse
|
|
2
2
|
|
|
3
|
-
UserAPIKeyCreateResponse 创建 UserAPIKey 的响应
|
|
3
|
+
UserAPIKeyCreateResponse 创建 UserAPIKey 的响应
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | message 响应消息
|
|
11
|
-
**data** | [**UserAPIKey**](UserAPIKey.md) | data 创建成功后返回的 UserAPIKey 信息
|
|
9
|
+
**code** | **string** | code 响应状态码,20200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
11
|
+
**data** | [**UserAPIKey**](UserAPIKey.md) | data 创建成功后返回的 UserAPIKey 信息 | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# UserAPIKeyDeleteResponse
|
|
2
2
|
|
|
3
|
-
UserAPIKeyDeleteResponse 删除 UserAPIKey 的响应
|
|
3
|
+
UserAPIKeyDeleteResponse 删除 UserAPIKey 的响应
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | message 响应消息
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# UserAPIKeyGetResponse
|
|
2
2
|
|
|
3
|
-
UserAPIKeyGetResponse 获取单个 UserAPIKey 的响应
|
|
3
|
+
UserAPIKeyGetResponse 获取单个 UserAPIKey 的响应
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | message 响应消息
|
|
11
|
-
**data** | [**UserAPIKey**](UserAPIKey.md) | data UserAPIKey 信息
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
11
|
+
**data** | [**UserAPIKey**](UserAPIKey.md) | data UserAPIKey 信息 | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# UserAPIKeyListResponse
|
|
2
2
|
|
|
3
|
-
UserAPIKeyListResponse 分页查询 UserAPIKey 列表的响应
|
|
3
|
+
UserAPIKeyListResponse 分页查询 UserAPIKey 列表的响应
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | message 响应消息
|
|
11
|
-
**list** | [**Array<UserAPIKey>**](UserAPIKey.md) | list UserAPIKey 列表
|
|
12
|
-
**total** | **string** | total 符合条件的 UserAPIKey 总数
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
11
|
+
**list** | [**Array<UserAPIKey>**](UserAPIKey.md) | list UserAPIKey 列表 | [optional] [default to undefined]
|
|
12
|
+
**total** | **string** | total 符合条件的 UserAPIKey 总数 | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -5,7 +5,7 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**userAPIKeyServiceUserAPIKeyCreate**](#userapikeyserviceuserapikeycreate) | **POST** /api/v1/user/api-key/create | |
|
|
8
|
-
|[**userAPIKeyServiceUserAPIKeyDelete**](#userapikeyserviceuserapikeydelete) | **
|
|
8
|
+
|[**userAPIKeyServiceUserAPIKeyDelete**](#userapikeyserviceuserapikeydelete) | **DELETE** /api/v1/user/api-key/delete | |
|
|
9
9
|
|[**userAPIKeyServiceUserAPIKeyGet**](#userapikeyserviceuserapikeyget) | **GET** /api/v1/user/api-key/get | |
|
|
10
10
|
|[**userAPIKeyServiceUserAPIKeyList**](#userapikeyserviceuserapikeylist) | **GET** /api/v1/user/api-key/list | |
|
|
11
11
|
|[**userAPIKeyServiceUserAPIKeyUpdate**](#userapikeyserviceuserapikeyupdate) | **POST** /api/v1/user/api-key/update | |
|
|
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost*
|
|
|
13
13
|
# **userAPIKeyServiceUserAPIKeyCreate**
|
|
14
14
|
> UserAPIKeyCreateResponse userAPIKeyServiceUserAPIKeyCreate(userAPIKeyCreateRequest)
|
|
15
15
|
|
|
16
|
-
UserAPIKeyCreate 创建新的 UserAPIKey
|
|
16
|
+
UserAPIKeyCreate 创建新的 UserAPIKey 请求路径: POST /api/user/api-key/create
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -64,26 +64,25 @@ No authorization required
|
|
|
64
64
|
[[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)
|
|
65
65
|
|
|
66
66
|
# **userAPIKeyServiceUserAPIKeyDelete**
|
|
67
|
-
> UserAPIKeyDeleteResponse userAPIKeyServiceUserAPIKeyDelete(
|
|
67
|
+
> UserAPIKeyDeleteResponse userAPIKeyServiceUserAPIKeyDelete()
|
|
68
68
|
|
|
69
|
-
UserAPIKeyDelete 删除 UserAPIKey(软删除)
|
|
69
|
+
UserAPIKeyDelete 删除 UserAPIKey(软删除) 请求路径: POST /api/user/api-key/delete
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
73
73
|
```typescript
|
|
74
74
|
import {
|
|
75
75
|
UserAPIKeyServiceApi,
|
|
76
|
-
Configuration
|
|
77
|
-
UserAPIKeyDeleteRequest
|
|
76
|
+
Configuration
|
|
78
77
|
} from '@cherryin/api-client';
|
|
79
78
|
|
|
80
79
|
const configuration = new Configuration();
|
|
81
80
|
const apiInstance = new UserAPIKeyServiceApi(configuration);
|
|
82
81
|
|
|
83
|
-
let
|
|
82
|
+
let id: string; //id 要删除的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
|
|
84
83
|
|
|
85
84
|
const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyDelete(
|
|
86
|
-
|
|
85
|
+
id
|
|
87
86
|
);
|
|
88
87
|
```
|
|
89
88
|
|
|
@@ -91,7 +90,7 @@ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyDelete(
|
|
|
91
90
|
|
|
92
91
|
|Name | Type | Description | Notes|
|
|
93
92
|
|------------- | ------------- | ------------- | -------------|
|
|
94
|
-
| **
|
|
93
|
+
| **id** | [**string**] | id 要删除的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
|
|
95
94
|
|
|
96
95
|
|
|
97
96
|
### Return type
|
|
@@ -104,7 +103,7 @@ No authorization required
|
|
|
104
103
|
|
|
105
104
|
### HTTP request headers
|
|
106
105
|
|
|
107
|
-
- **Content-Type**:
|
|
106
|
+
- **Content-Type**: Not defined
|
|
108
107
|
- **Accept**: application/json
|
|
109
108
|
|
|
110
109
|
|
|
@@ -119,7 +118,7 @@ No authorization required
|
|
|
119
118
|
# **userAPIKeyServiceUserAPIKeyGet**
|
|
120
119
|
> UserAPIKeyGetResponse userAPIKeyServiceUserAPIKeyGet()
|
|
121
120
|
|
|
122
|
-
UserAPIKeyGet 根据 ID 或名称获取单个 UserAPIKey
|
|
121
|
+
UserAPIKeyGet 根据 ID 或名称获取单个 UserAPIKey Request path: GET /api/user/api-key/get?id={id} or GET /api/user/api-key/get?name={name}
|
|
123
122
|
|
|
124
123
|
### Example
|
|
125
124
|
|
|
@@ -132,8 +131,8 @@ import {
|
|
|
132
131
|
const configuration = new Configuration();
|
|
133
132
|
const apiInstance = new UserAPIKeyServiceApi(configuration);
|
|
134
133
|
|
|
135
|
-
let id: string; //id 要获取的 UserAPIKey 的唯一标识符
|
|
136
|
-
let name: string; //name 要获取的 UserAPIKey 的名称
|
|
134
|
+
let id: string; //id 要获取的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" (optional) (default to undefined)
|
|
135
|
+
let name: string; //name 要获取的 UserAPIKey 的名称 如果同时提供 id 和 name,以 id 为准 @gotags: form:\"name\" (optional) (default to undefined)
|
|
137
136
|
|
|
138
137
|
const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyGet(
|
|
139
138
|
id,
|
|
@@ -145,8 +144,8 @@ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyGet(
|
|
|
145
144
|
|
|
146
145
|
|Name | Type | Description | Notes|
|
|
147
146
|
|------------- | ------------- | ------------- | -------------|
|
|
148
|
-
| **id** | [**string**] | id 要获取的 UserAPIKey 的唯一标识符
|
|
149
|
-
| **name** | [**string**] | name 要获取的 UserAPIKey 的名称
|
|
147
|
+
| **id** | [**string**] | id 要获取的 UserAPIKey 的唯一标识符 @gotags: form:\"id\" | (optional) defaults to undefined|
|
|
148
|
+
| **name** | [**string**] | name 要获取的 UserAPIKey 的名称 如果同时提供 id 和 name,以 id 为准 @gotags: form:\"name\" | (optional) defaults to undefined|
|
|
150
149
|
|
|
151
150
|
|
|
152
151
|
### Return type
|
|
@@ -174,7 +173,7 @@ No authorization required
|
|
|
174
173
|
# **userAPIKeyServiceUserAPIKeyList**
|
|
175
174
|
> UserAPIKeyListResponse userAPIKeyServiceUserAPIKeyList()
|
|
176
175
|
|
|
177
|
-
UserAPIKeyList 分页查询 UserAPIKey 列表,支持按状态和分组过滤
|
|
176
|
+
UserAPIKeyList 分页查询 UserAPIKey 列表,支持按状态和分组过滤 请求路径: GET /api/user/api-key/list?page={page}&page_size={page_size}&key_status={status}&key_group={group}
|
|
178
177
|
|
|
179
178
|
### Example
|
|
180
179
|
|
|
@@ -187,11 +186,11 @@ import {
|
|
|
187
186
|
const configuration = new Configuration();
|
|
188
187
|
const apiInstance = new UserAPIKeyServiceApi(configuration);
|
|
189
188
|
|
|
190
|
-
let page: number; //page 页码,从 1 开始
|
|
191
|
-
let pageSize: number; //page_size 每页数量
|
|
192
|
-
let uid: string; //uid 按用户 ID 过滤(可选,管理员可用)
|
|
193
|
-
let keyStatus: string; //key_status 按状态过滤(可选)
|
|
194
|
-
let keyGroup: string; //key_group 按分组过滤(可选)
|
|
189
|
+
let page: number; //page 页码,从 1 开始 默认值: 1 @gotags: form:\"page\" (optional) (default to undefined)
|
|
190
|
+
let pageSize: number; //page_size 每页数量 默认值: 20,最大值: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
|
|
191
|
+
let uid: string; //uid 按用户 ID 过滤(可选,管理员可用) 0: return API keys from all users (admin only) > 0: return API keys from specific user only @gotags: form:\"uid\" (optional) (default to undefined)
|
|
192
|
+
let keyStatus: string; //key_status 按状态过滤(可选) 0: 返回所有状态 1: 仅返回启用的 API Key 2: 仅返回禁用的 API Key @gotags: form:\"key_status\" (optional) (default to undefined)
|
|
193
|
+
let keyGroup: string; //key_group 按分组过滤(可选) @gotags: form:\"key_group\" (optional) (default to undefined)
|
|
195
194
|
|
|
196
195
|
const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyList(
|
|
197
196
|
page,
|
|
@@ -206,11 +205,11 @@ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyList(
|
|
|
206
205
|
|
|
207
206
|
|Name | Type | Description | Notes|
|
|
208
207
|
|------------- | ------------- | ------------- | -------------|
|
|
209
|
-
| **page** | [**number**] | page 页码,从 1 开始
|
|
210
|
-
| **pageSize** | [**number**] | page_size 每页数量
|
|
211
|
-
| **uid** | [**string**] | uid 按用户 ID 过滤(可选,管理员可用)
|
|
212
|
-
| **keyStatus** | [**string**] | key_status 按状态过滤(可选)
|
|
213
|
-
| **keyGroup** | [**string**] | key_group 按分组过滤(可选)
|
|
208
|
+
| **page** | [**number**] | page 页码,从 1 开始 默认值: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
|
|
209
|
+
| **pageSize** | [**number**] | page_size 每页数量 默认值: 20,最大值: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
|
|
210
|
+
| **uid** | [**string**] | uid 按用户 ID 过滤(可选,管理员可用) 0: return API keys from all users (admin only) > 0: return API keys from specific user only @gotags: form:\"uid\" | (optional) defaults to undefined|
|
|
211
|
+
| **keyStatus** | [**string**] | key_status 按状态过滤(可选) 0: 返回所有状态 1: 仅返回启用的 API Key 2: 仅返回禁用的 API Key @gotags: form:\"key_status\" | (optional) defaults to undefined|
|
|
212
|
+
| **keyGroup** | [**string**] | key_group 按分组过滤(可选) @gotags: form:\"key_group\" | (optional) defaults to undefined|
|
|
214
213
|
|
|
215
214
|
|
|
216
215
|
### Return type
|
|
@@ -238,7 +237,7 @@ No authorization required
|
|
|
238
237
|
# **userAPIKeyServiceUserAPIKeyUpdate**
|
|
239
238
|
> UserAPIKeyUpdateResponse userAPIKeyServiceUserAPIKeyUpdate(userAPIKeyUpdateRequest)
|
|
240
239
|
|
|
241
|
-
UserAPIKeyUpdate 更新现有的 UserAPIKey
|
|
240
|
+
UserAPIKeyUpdate 更新现有的 UserAPIKey 请求路径: POST /api/user/api-key/update
|
|
242
241
|
|
|
243
242
|
### Example
|
|
244
243
|
|
|
@@ -6,9 +6,9 @@ UserAPIKeyUpdateResponse 更新 UserAPIKey 的响应 Response message for UserA
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | code 响应状态码,
|
|
10
|
-
**message** | **string** | message 响应消息
|
|
11
|
-
**data** | [**UserAPIKey**](UserAPIKey.md) | data 更新后的 UserAPIKey 信息
|
|
9
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
11
|
+
**data** | [**UserAPIKey**](UserAPIKey.md) | data 更新后的 UserAPIKey 信息 | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**code** | **string** | code 响应状态码,
|
|
9
|
-
**message** | **string** | message 响应消息
|
|
8
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
10
10
|
**data** | [**UserBalance**](UserBalance.md) | data 更新后的 UserBalance 信息 | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**code** | **string** | code 响应状态码,
|
|
9
|
-
**message** | **string** | message 响应消息
|
|
8
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
10
10
|
**data** | [**UserBalance**](UserBalance.md) | data 更新后的 UserBalance 信息 | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**code** | **string** | code 响应状态码,
|
|
9
|
-
**message** | **string** | message 响应消息
|
|
8
|
+
**code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | message 响应消息 | [optional] [default to undefined]
|
|
10
10
|
**list** | [**Array<UserBalance>**](UserBalance.md) | list UserBalance 列表 | [optional] [default to undefined]
|
|
11
11
|
**total** | **string** | total 符合条件的 UserBalance 总数 | [optional] [default to undefined]
|
|
12
12
|
|