@cherryin/api-client 0.0.20 → 0.1.1
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 +102 -235
- package/README.md +155 -342
- package/api.ts +3375 -9798
- package/dist/api.d.ts +2595 -6538
- package/dist/api.js +1630 -5652
- package/dist/esm/api.d.ts +2595 -6538
- package/dist/esm/api.js +1609 -5611
- package/docs/AIModel.md +45 -0
- package/docs/AIModelAdminServiceApi.md +90 -101
- package/docs/AIModelArchitecture.md +25 -0
- package/docs/{AdminAIModelCheckConnectionResponse.md → AIModelCheckConnectionResponse.md} +4 -4
- package/docs/{AdminAIModelCheckItem.md → AIModelCheckItem.md} +3 -3
- package/docs/{AdminAIModelCheckResult.md → AIModelCheckResult.md} +5 -5
- package/docs/AIModelCreateRequest.md +35 -0
- package/docs/{AdminAIModelCreateResponse.md → AIModelCreateResponse.md} +5 -5
- package/docs/AIModelDeleteRequest.md +21 -0
- package/docs/{AdminProviderModelDeleteResponse.md → AIModelDeleteResponse.md} +4 -4
- package/docs/AIModelDisableRequest.md +21 -0
- package/docs/{AdminAIModelPublishResponse.md → AIModelDisableResponse.md} +5 -5
- package/docs/{AdminAIModelDiscountConfig.md → AIModelDiscountConfig.md} +4 -4
- package/docs/{AdminAIModelGetResponse.md → AIModelGetResponse.md} +5 -5
- package/docs/{AdminAIModelListResponse.md → AIModelListResponse.md} +5 -5
- package/docs/AIModelMeta.md +25 -0
- package/docs/AIModelPricingConfig.md +10 -10
- package/docs/AIModelProviderConfigItem.md +29 -0
- package/docs/AIModelPublishRequest.md +21 -0
- package/docs/{AdminAIModelUpdateResponse.md → AIModelPublishResponse.md} +5 -5
- package/docs/AIModelUpdateRequest.md +37 -0
- package/docs/{AdminProviderGetResponse.md → AIModelUpdateResponse.md} +5 -5
- package/docs/{ProviderAWSAuth.md → AWSAuth.md} +3 -4
- package/docs/AudioPricing.md +8 -8
- package/docs/Auth2Account.md +33 -0
- package/docs/{AuthAdminUser.md → Auth2Admin.md} +7 -7
- package/docs/Auth2AdminServiceApi.md +469 -0
- package/docs/Auth2AdminSession.md +35 -0
- package/docs/{AuthIdToken.md → Auth2IdToken.md} +3 -3
- package/docs/Auth2Session.md +35 -0
- package/docs/Auth2User.md +33 -0
- package/docs/Auth2UserServiceApi.md +1261 -0
- package/docs/{PassportAuthAdminChangePasswordRequest.md → AuthAdminChangePasswordRequest.md} +3 -3
- package/docs/{PassportAuthEnterpriseChangePasswordResponse.md → AuthAdminChangePasswordResponse.md} +4 -4
- package/docs/{PassportAuthEnterpriseRefreshTokenResponse.md → AuthAdminGetSessionResponse.md} +6 -4
- package/docs/{PassportAuthListSessionsResponse.md → AuthAdminListSessionsResponse.md} +4 -4
- package/docs/{PassportAuthAdminUserDisableResponse.md → AuthAdminRevokeOtherSessionsResponse.md} +5 -3
- package/docs/{PassportAdminTokenAuthRequest.md → AuthAdminRevokeSessionRequest.md} +3 -3
- package/docs/{PassportAuthUserDeleteResponse.md → AuthAdminRevokeSessionResponse.md} +5 -3
- package/docs/{PassportAuthUserSignOutResponse.md → AuthAdminRevokeSessionsResponse.md} +5 -3
- package/docs/{PassportAdminSignInEmailRequest.md → AuthAdminSignInEmailRequest.md} +5 -7
- package/docs/{PassportAuthAdminUserModifyPermissionResponse.md → AuthAdminSignInEmailResponse.md} +6 -4
- package/docs/{PassportAuthRevokeOtherSessionsResponse.md → AuthAdminSignOutResponse.md} +3 -3
- package/docs/{PassportAuthAdminUpdateInfoRequest.md → AuthAdminUpdateUserRequest.md} +5 -5
- package/docs/{PassportUserInfoGetResponse.md → AuthAdminUpdateUserResponse.md} +5 -5
- package/docs/{PassportAuthUserChangeEmailRequest.md → AuthChangeEmailRequest.md} +3 -5
- package/docs/{PassportAuthAdminUpdateInfoResponse.md → AuthChangeEmailResponse.md} +6 -4
- package/docs/{PassportAuthEnterpriseChangePasswordRequest.md → AuthChangePasswordRequest.md} +3 -3
- package/docs/{PassportAuthAdminGetInfoResponse.md → AuthChangePasswordResponse.md} +6 -4
- package/docs/{PassportAuthRevokeSessionRequest.md → AuthDeleteUserRequest.md} +7 -3
- package/docs/{PassportAuthAdminRevokeOtherSessionsResponse.md → AuthDeleteUserResponse.md} +5 -3
- package/docs/{PassportAuthSocialRefreshTokenRequest.md → AuthGetAccessTokenRequest.md} +3 -3
- package/docs/{PassportAuthSocialRefreshTokenResponse.md → AuthGetAccessTokenResponse.md} +3 -3
- package/docs/AuthGetAccountInfoResponse.md +24 -0
- package/docs/{PassportAuthEnterpriseGetSessionResponse.md → AuthGetSessionResponse.md} +6 -4
- package/docs/{PassportAuthLinkSocialRequest.md → AuthLinkSocialRequest.md} +4 -6
- package/docs/{PassportAuthLinkSocialResponse.md → AuthLinkSocialResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseRevokeSessionsResponse.md → AuthListAccountsResponse.md} +5 -3
- package/docs/AuthListSessionsResponse.md +24 -0
- package/docs/{PassportEnterpriseSignUpEmailResponse.md → AuthOAuth2CallbackResponse.md} +10 -8
- package/docs/{PassportAuthSocialGetAccessTokenRequest.md → AuthRefreshTokenRequest.md} +3 -3
- package/docs/{PassportAuthSocialGetAccessTokenResponse.md → AuthRefreshTokenResponse.md} +3 -3
- package/docs/AuthRequestPasswordResetRequest.md +22 -0
- package/docs/{PassportAuthAdminSignOutResponse.md → AuthRequestPasswordResetResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseRevokeSessionRequest.md → AuthResetPasswordRequest.md} +5 -3
- package/docs/{PassportAuthAdminUserModifyInfoResponse.md → AuthResetPasswordResponse.md} +5 -5
- package/docs/AuthRevokeOtherSessionsResponse.md +24 -0
- package/docs/{PassportUserTokenAuthRequest.md → AuthRevokeSessionRequest.md} +3 -3
- package/docs/{PassportAdminSendVerificationEmailResponse.md → AuthRevokeSessionResponse.md} +5 -3
- package/docs/{PassportAuthAdminPassportDisableResponse.md → AuthRevokeSessionsResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseVerifyEmailRequest.md → AuthSendVerificationEmailRequest.md} +3 -5
- package/docs/{PassportAuthResetPasswordResponse.md → AuthSendVerificationEmailResponse.md} +5 -3
- package/docs/{PassportAuthDeleteAllRequest.md → AuthSignInEmailRequest.md} +7 -9
- package/docs/{PassportUserPasswordResetResponse.md → AuthSignInEmailResponse.md} +9 -5
- package/docs/{PassportUserSignInSocialRequest.md → AuthSignInSocialRequest.md} +6 -8
- package/docs/{PassportEnterpriseSignInEmailResponse.md → AuthSignInSocialResponse.md} +6 -6
- package/docs/{PassportAuthEnterpriseMaterialUploadResponse.md → AuthSignOutResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseDeleteRequest.md → AuthSignUpEmailRequest.md} +13 -9
- package/docs/{PassportEnterprisePasswordResetResponse.md → AuthSignUpEmailResponse.md} +7 -5
- package/docs/{PassportAuthUnlinkSocialRequest.md → AuthUnlinkAccountRequest.md} +3 -5
- package/docs/{PassportAuthAdminEnterpriseMaterialReviewResponse.md → AuthUnlinkAccountResponse.md} +5 -3
- package/docs/{PassportAuthUserUpdatePassportRequest.md → AuthUpdateUserRequest.md} +5 -5
- package/docs/AuthUpdateUserResponse.md +24 -0
- package/docs/AuthVerifyEmailResponse.md +24 -0
- package/docs/ConfigItem.md +0 -4
- 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/FrontAIModel.md +17 -15
- package/docs/GCPAuth.md +27 -0
- package/docs/ImagePricing.md +7 -7
- 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/MultimodalPricing.md +4 -4
- package/docs/PricingConditions.md +7 -7
- package/docs/PricingRules.md +6 -6
- package/docs/Provider.md +37 -0
- package/docs/ProviderAdminServiceApi.md +53 -74
- package/docs/ProviderAuth.md +6 -6
- package/docs/ProviderCreateRequest.md +29 -0
- package/docs/{AdminAIModelDisableResponse.md → ProviderCreateResponse.md} +5 -5
- package/docs/{AdminAIModelDeleteResponse.md → ProviderDeleteResponse.md} +4 -4
- package/docs/{AdminProviderModelGetResponse.md → ProviderGetResponse.md} +5 -5
- package/docs/{AdminProviderListResponse.md → ProviderListResponse.md} +6 -6
- package/docs/ProviderModel.md +37 -0
- package/docs/ProviderModelAdminServiceApi.md +56 -74
- package/docs/ProviderModelCreateRequest.md +29 -0
- package/docs/{AdminProviderModelUpdateResponse.md → ProviderModelCreateResponse.md} +5 -5
- package/docs/{AdminProviderDeleteResponse.md → ProviderModelDeleteResponse.md} +4 -4
- package/docs/ProviderModelGetResponse.md +25 -0
- package/docs/{AdminProviderModelListResponse.md → ProviderModelListResponse.md} +6 -6
- package/docs/ProviderModelPayload.md +23 -0
- package/docs/ProviderModelUpdateRequest.md +31 -0
- package/docs/{AdminProviderCreateResponse.md → ProviderModelUpdateResponse.md} +5 -5
- package/docs/ProviderPayload.md +21 -0
- package/docs/ProviderUpdateRequest.md +31 -0
- package/docs/ProviderUpdateResponse.md +25 -0
- package/docs/RemoteConfigAdminServiceApi.md +3 -18
- package/docs/RemoteConfigItemGetResponse.md +2 -2
- package/docs/RemoteConfigItemUpdateRequest.md +0 -6
- package/docs/RemoteConfigItemUpdateResponse.md +2 -2
- package/docs/RequestPricing.md +3 -3
- package/docs/TextTokenInputPricing.md +5 -5
- package/docs/TextTokenOutputPricing.md +4 -4
- package/docs/TextTokenPricing.md +3 -3
- package/docs/TokenTier.md +4 -4
- package/docs/UserAPIKey.md +15 -15
- package/docs/UserAPIKeyCreateRequest.md +9 -9
- package/docs/UserAPIKeyCreateResponse.md +4 -4
- package/docs/UserAPIKeyDeleteRequest.md +21 -0
- package/docs/UserAPIKeyDeleteResponse.md +3 -3
- package/docs/UserAPIKeyGetResponse.md +4 -4
- package/docs/UserAPIKeyListResponse.md +5 -5
- package/docs/UserAPIKeyServiceApi.md +27 -26
- 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/UserLabelListResponse.md +1 -1
- package/docs/UserLabelPairChangeResponse.md +1 -1
- package/docs/{ModelListResponse.md → UserModelListResponse.md} +11 -10
- package/docs/UserModelServiceApi.md +11 -124
- package/docs/VersionedAPISchema.md +6 -6
- package/docs/VideoPricing.md +8 -8
- package/package.json +1 -1
- package/docs/AdminAIModel.md +0 -73
- package/docs/AdminAIModelCreateRequest.md +0 -63
- package/docs/AdminAIModelDisableRequest.md +0 -23
- package/docs/AdminAIModelProviderConfigItem.md +0 -29
- package/docs/AdminAIModelPublishRequest.md +0 -23
- package/docs/AdminAIModelUpdateRequest.md +0 -25
- package/docs/AdminEnterpriseMaterials.md +0 -24
- package/docs/AdminEnterpriseUser.md +0 -24
- package/docs/AdminEnterpriseUserMaterials.md +0 -22
- package/docs/AdminPassportItem.md +0 -24
- package/docs/AdminProvider.md +0 -46
- package/docs/AdminProviderCreateRequest.md +0 -39
- package/docs/AdminProviderModel.md +0 -66
- package/docs/AdminProviderModelCreateRequest.md +0 -59
- package/docs/AdminProviderModelCreateResponse.md +0 -25
- package/docs/AdminProviderModelUpdateRequest.md +0 -25
- package/docs/AdminProviderUpdateRequest.md +0 -25
- package/docs/AdminProviderUpdateResponse.md +0 -25
- package/docs/AdminUserItem.md +0 -26
- package/docs/AuthAdminSession.md +0 -39
- package/docs/AuthEnterpriseMaterials.md +0 -33
- package/docs/AuthEnterpriseSession.md +0 -37
- package/docs/AuthEnterpriseUser.md +0 -37
- package/docs/AuthPassport.md +0 -35
- package/docs/AuthUser.md +0 -39
- package/docs/AuthUserMethod.md +0 -39
- package/docs/AuthUserSession.md +0 -41
- package/docs/FrontendModelCost.md +0 -57
- package/docs/FrontendModelExtraInfo.md +0 -21
- package/docs/FrontendModelsResponse.md +0 -29
- package/docs/FrontendProviderInfo.md +0 -31
- package/docs/FrontendProviderModel.md +0 -55
- package/docs/FrontendProvidersResponse.md +0 -29
- package/docs/FrontendSearchContextCost.md +0 -25
- package/docs/ModelCapabilities.md +0 -59
- package/docs/ModelLimits.md +0 -41
- package/docs/ModelModalities.md +0 -23
- package/docs/PassportAdminSendVerificationEmailRequest.md +0 -26
- package/docs/PassportAdminSignInEmailResponse.md +0 -26
- package/docs/PassportAdminTokenAuthResponse.md +0 -28
- package/docs/PassportAuthAdminChangePasswordResponse.md +0 -26
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +0 -28
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +0 -22
- package/docs/PassportAuthAdminGetSessionResponse.md +0 -26
- package/docs/PassportAuthAdminListSessionsResponse.md +0 -24
- package/docs/PassportAuthAdminPassportDisableRequest.md +0 -22
- package/docs/PassportAuthAdminPassportListRequest.md +0 -28
- package/docs/PassportAuthAdminPassportListResponse.md +0 -28
- package/docs/PassportAuthAdminPassportModifyInfoRequest.md +0 -28
- package/docs/PassportAuthAdminPassportModifyInfoResponse.md +0 -24
- package/docs/PassportAuthAdminRPCServiceApi.md +0 -61
- package/docs/PassportAuthAdminRevokeSessionRequest.md +0 -20
- package/docs/PassportAuthAdminRevokeSessionResponse.md +0 -22
- package/docs/PassportAuthAdminRevokeSessionsResponse.md +0 -22
- package/docs/PassportAuthAdminServiceApi.md +0 -1069
- package/docs/PassportAuthAdminUserDisableRequest.md +0 -26
- package/docs/PassportAuthAdminUserListRequest.md +0 -28
- package/docs/PassportAuthAdminUserListResponse.md +0 -28
- package/docs/PassportAuthAdminUserModifyInfoRequest.md +0 -32
- package/docs/PassportAuthAdminUserModifyPermissionRequest.md +0 -22
- package/docs/PassportAuthChangePasswordRequest.md +0 -26
- package/docs/PassportAuthChangePasswordResponse.md +0 -26
- package/docs/PassportAuthDeleteAllResponse.md +0 -22
- package/docs/PassportAuthEnterpriseChangePhoneRequest.md +0 -24
- package/docs/PassportAuthEnterpriseChangePhoneResponse.md +0 -22
- package/docs/PassportAuthEnterpriseDeleteResponse.md +0 -22
- package/docs/PassportAuthEnterpriseInfoGetResponse.md +0 -24
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +0 -24
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +0 -26
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +0 -24
- package/docs/PassportAuthEnterpriseRPCServiceApi.md +0 -61
- package/docs/PassportAuthEnterpriseRefreshTokenRequest.md +0 -20
- package/docs/PassportAuthEnterpriseResetPasswordRequest.md +0 -22
- package/docs/PassportAuthEnterpriseResetPasswordResponse.md +0 -22
- package/docs/PassportAuthEnterpriseRevokeOtherSessionsResponse.md +0 -22
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +0 -22
- package/docs/PassportAuthEnterpriseServiceApi.md +0 -1170
- package/docs/PassportAuthEnterpriseSignOutRequest.md +0 -20
- package/docs/PassportAuthEnterpriseSignOutResponse.md +0 -22
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +0 -22
- package/docs/PassportAuthEnterpriseUpdateInfoResponse.md +0 -24
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +0 -22
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +0 -22
- package/docs/PassportAuthInfoGetResponse.md +0 -26
- package/docs/PassportAuthListMethodsResponse.md +0 -24
- package/docs/PassportAuthListSocialsResponse.md +0 -24
- package/docs/PassportAuthRefreshSessionTokenRequest.md +0 -20
- package/docs/PassportAuthRefreshSessionTokenResponse.md +0 -24
- package/docs/PassportAuthResetPasswordRequest.md +0 -24
- package/docs/PassportAuthRevokeOtherSessionsRequest.md +0 -20
- package/docs/PassportAuthRevokeSessionResponse.md +0 -22
- package/docs/PassportAuthRevokeSessionsRequest.md +0 -20
- package/docs/PassportAuthRevokeSessionsResponse.md +0 -22
- package/docs/PassportAuthSendVerificationEmailRequest.md +0 -26
- package/docs/PassportAuthSendVerificationEmailResponse.md +0 -22
- package/docs/PassportAuthSendVerificationPhoneRequest.md +0 -26
- package/docs/PassportAuthSendVerificationPhoneResponse.md +0 -22
- package/docs/PassportAuthUnlinkSocialResponse.md +0 -22
- package/docs/PassportAuthUserChangeEmailResponse.md +0 -24
- package/docs/PassportAuthUserChangePhoneRequest.md +0 -26
- package/docs/PassportAuthUserChangePhoneResponse.md +0 -24
- package/docs/PassportAuthUserDeleteRequest.md +0 -30
- package/docs/PassportAuthUserGetSessionResponse.md +0 -24
- package/docs/PassportAuthUserInfoGetResponse.md +0 -24
- package/docs/PassportAuthUserRPCServiceApi.md +0 -223
- package/docs/PassportAuthUserServiceApi.md +0 -2000
- package/docs/PassportAuthUserSignOutRequest.md +0 -22
- package/docs/PassportAuthUserUpdateInfoRequest.md +0 -28
- package/docs/PassportAuthUserUpdateInfoResponse.md +0 -24
- package/docs/PassportAuthUserUpdatePassportResponse.md +0 -24
- package/docs/PassportAuthUserVerifyEmailRequest.md +0 -26
- package/docs/PassportAuthUserVerifyEmailResponse.md +0 -22
- package/docs/PassportAuthUserVerifyPhoneRequest.md +0 -24
- package/docs/PassportAuthUserVerifyPhoneResponse.md +0 -22
- package/docs/PassportEnterprisePasswordResetRequest.md +0 -24
- package/docs/PassportEnterpriseSendVerificationEmailRequest.md +0 -24
- package/docs/PassportEnterpriseSendVerificationEmailResponse.md +0 -22
- package/docs/PassportEnterpriseSendVerificationPhoneRequest.md +0 -24
- package/docs/PassportEnterpriseSendVerificationPhoneResponse.md +0 -22
- package/docs/PassportEnterpriseSignInEmailRequest.md +0 -30
- package/docs/PassportEnterpriseSignInPhoneRequest.md +0 -24
- package/docs/PassportEnterpriseSignInPhoneResponse.md +0 -26
- package/docs/PassportEnterpriseSignUpEmailRequest.md +0 -34
- package/docs/PassportEnterpriseTokenAuthRequest.md +0 -20
- package/docs/PassportEnterpriseTokenAuthResponse.md +0 -28
- package/docs/PassportSendVerificationEmailRequest.md +0 -26
- package/docs/PassportSendVerificationEmailResponse.md +0 -22
- package/docs/PassportSendVerificationPhoneRequest.md +0 -26
- package/docs/PassportSendVerificationPhoneResponse.md +0 -22
- package/docs/PassportUserInfoBatchGetRequest.md +0 -24
- package/docs/PassportUserInfoBatchGetResponse.md +0 -24
- package/docs/PassportUserInfoGetRequest.md +0 -24
- package/docs/PassportUserOAuthCallbackResponse.md +0 -36
- package/docs/PassportUserPasswordForgetRequest.md +0 -24
- package/docs/PassportUserPasswordForgetResponse.md +0 -22
- package/docs/PassportUserPasswordResetRequest.md +0 -30
- package/docs/PassportUserPasswordResetTokenVerifyRequest.md +0 -22
- package/docs/PassportUserPasswordResetTokenVerifyResponse.md +0 -26
- package/docs/PassportUserSignInEmailRequest.md +0 -32
- package/docs/PassportUserSignInEmailResponse.md +0 -32
- package/docs/PassportUserSignInPhoneRequest.md +0 -26
- package/docs/PassportUserSignInPhoneResponse.md +0 -28
- package/docs/PassportUserSignInSocialResponse.md +0 -32
- package/docs/PassportUserSignUpEmailRequest.md +0 -36
- package/docs/PassportUserSignUpEmailResponse.md +0 -32
- package/docs/PassportUserTokenAuthResponse.md +0 -28
- package/docs/PassportUserUpdateInfoRequest.md +0 -30
- package/docs/PassportUserUpdateInfoResponse.md +0 -22
- package/docs/ProviderGCPAuth.md +0 -27
- package/docs/QRCodeAdminServiceApi.md +0 -286
- package/docs/QRCodeCreateRequest.md +0 -37
- package/docs/QRCodeCreateResponse.md +0 -25
- package/docs/QRCodeDeleteResponse.md +0 -23
- package/docs/QRCodeGetResponse.md +0 -25
- package/docs/QRCodeHistoryItem.md +0 -29
- package/docs/QRCodeInfo.md +0 -59
- package/docs/QRCodeListResponse.md +0 -27
- package/docs/QRCodeSnapshot.md +0 -37
- package/docs/QRCodeUpdateRequest.md +0 -39
- package/docs/QRCodeUpdateResponse.md +0 -25
- package/docs/QRCodeWithHistory.md +0 -23
- package/docs/UserBasic.md +0 -42
- package/docs/UserExtendInfo.md +0 -20
- package/docs/UserInfoQueryOptions.md +0 -28
- package/docs/UserPaymentInfo.md +0 -20
- package/docs/UserPreferences.md +0 -22
|
@@ -1,2000 +0,0 @@
|
|
|
1
|
-
# PassportAuthUserServiceApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**passportAuthUserServicePassportAuthChangePassword**](#passportauthuserservicepassportauthchangepassword) | **POST** /passport/authed/v1/password/change | |
|
|
8
|
-
|[**passportAuthUserServicePassportAuthDeleteAll**](#passportauthuserservicepassportauthdeleteall) | **POST** /passport/authed/v1/passport/request-delete | |
|
|
9
|
-
|[**passportAuthUserServicePassportAuthInfoGet**](#passportauthuserservicepassportauthinfoget) | **GET** /passport/authed/v1/passport/info | |
|
|
10
|
-
|[**passportAuthUserServicePassportAuthLinkSocial**](#passportauthuserservicepassportauthlinksocial) | **POST** /passport/authed/v1/social/link | |
|
|
11
|
-
|[**passportAuthUserServicePassportAuthListMethods**](#passportauthuserservicepassportauthlistmethods) | **GET** /passport/authed/v1/passport/list-auth-methods | |
|
|
12
|
-
|[**passportAuthUserServicePassportAuthListSessions**](#passportauthuserservicepassportauthlistsessions) | **GET** /passport/authed/v1/sessions/list | |
|
|
13
|
-
|[**passportAuthUserServicePassportAuthListSocials**](#passportauthuserservicepassportauthlistsocials) | **GET** /passport/authed/v1/social/list-accounts | |
|
|
14
|
-
|[**passportAuthUserServicePassportAuthRefreshSessionToken**](#passportauthuserservicepassportauthrefreshsessiontoken) | **POST** /passport/authed/v1/session/refresh-token | |
|
|
15
|
-
|[**passportAuthUserServicePassportAuthResetPassword**](#passportauthuserservicepassportauthresetpassword) | **POST** /passport/authed/v1/password/reset | |
|
|
16
|
-
|[**passportAuthUserServicePassportAuthRevokeOtherSessions**](#passportauthuserservicepassportauthrevokeothersessions) | **POST** /passport/authed/v1/sessions/revoke-other | |
|
|
17
|
-
|[**passportAuthUserServicePassportAuthRevokeSession**](#passportauthuserservicepassportauthrevokesession) | **POST** /passport/authed/v1/session/revoke | |
|
|
18
|
-
|[**passportAuthUserServicePassportAuthRevokeSessions**](#passportauthuserservicepassportauthrevokesessions) | **POST** /passport/authed/v1/sessions/revoke | |
|
|
19
|
-
|[**passportAuthUserServicePassportAuthSendVerificationEmail**](#passportauthuserservicepassportauthsendverificationemail) | **POST** /passport/authed/v1/verification/send-email | |
|
|
20
|
-
|[**passportAuthUserServicePassportAuthSendVerificationPhone**](#passportauthuserservicepassportauthsendverificationphone) | **POST** /passport/authed/v1/verification/send-phone | |
|
|
21
|
-
|[**passportAuthUserServicePassportAuthSocialGetAccessToken**](#passportauthuserservicepassportauthsocialgetaccesstoken) | **POST** /passport/authed/v1/social/get-access-token | |
|
|
22
|
-
|[**passportAuthUserServicePassportAuthSocialRefreshToken**](#passportauthuserservicepassportauthsocialrefreshtoken) | **POST** /passport/authed/v1/social/refresh-token | |
|
|
23
|
-
|[**passportAuthUserServicePassportAuthUnlinkSocial**](#passportauthuserservicepassportauthunlinksocial) | **POST** /passport/authed/v1/social/unlink | |
|
|
24
|
-
|[**passportAuthUserServicePassportAuthUserChangeEmail**](#passportauthuserservicepassportauthuserchangeemail) | **POST** /passport/authed/v1/email/change | |
|
|
25
|
-
|[**passportAuthUserServicePassportAuthUserChangePhone**](#passportauthuserservicepassportauthuserchangephone) | **POST** /passport/authed/v1/phone/change | |
|
|
26
|
-
|[**passportAuthUserServicePassportAuthUserDelete**](#passportauthuserservicepassportauthuserdelete) | **POST** /passport/authed/v1/user/request-delete | |
|
|
27
|
-
|[**passportAuthUserServicePassportAuthUserGetSession**](#passportauthuserservicepassportauthusergetsession) | **GET** /passport/authed/v1/session/get | |
|
|
28
|
-
|[**passportAuthUserServicePassportAuthUserInfoGet**](#passportauthuserservicepassportauthuserinfoget) | **GET** /passport/authed/v1/user/info | |
|
|
29
|
-
|[**passportAuthUserServicePassportAuthUserSignOut**](#passportauthuserservicepassportauthusersignout) | **POST** /passport/authed/v1/sign-out | |
|
|
30
|
-
|[**passportAuthUserServicePassportAuthUserUpdateInfo**](#passportauthuserservicepassportauthuserupdateinfo) | **POST** /passport/authed/v1/user/update-info | |
|
|
31
|
-
|[**passportAuthUserServicePassportAuthUserUpdatePassport**](#passportauthuserservicepassportauthuserupdatepassport) | **POST** /passport/authed/v1/passport/update | |
|
|
32
|
-
|[**passportAuthUserServicePassportAuthUserVerifyEmail**](#passportauthuserservicepassportauthuserverifyemail) | **POST** /passport/authed/v1/email/verify | |
|
|
33
|
-
|[**passportAuthUserServicePassportAuthUserVerifyPhone**](#passportauthuserservicepassportauthuserverifyphone) | **POST** /passport/authed/v1/phone/verify | |
|
|
34
|
-
|[**passportAuthUserServicePassportSendVerificationEmail**](#passportauthuserservicepassportsendverificationemail) | **POST** /passport/auth/v1/verification/send-email | |
|
|
35
|
-
|[**passportAuthUserServicePassportSendVerificationPhone**](#passportauthuserservicepassportsendverificationphone) | **POST** /passport/auth/v1/verification/send-phone | |
|
|
36
|
-
|[**passportAuthUserServicePassportUserOAuthCallback**](#passportauthuserservicepassportuseroauthcallback) | **GET** /passport/oauth2/{platform}/callback | |
|
|
37
|
-
|[**passportAuthUserServicePassportUserPasswordForget**](#passportauthuserservicepassportuserpasswordforget) | **POST** /passport/auth/v1/password/forget | |
|
|
38
|
-
|[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/reset | |
|
|
39
|
-
|[**passportAuthUserServicePassportUserPasswordResetTokenVerify**](#passportauthuserservicepassportuserpasswordresettokenverify) | **POST** /passport/auth/v1/password/reset-token | |
|
|
40
|
-
|[**passportAuthUserServicePassportUserSignInEmail**](#passportauthuserservicepassportusersigninemail) | **POST** /passport/auth/v1/sign-in/email | |
|
|
41
|
-
|[**passportAuthUserServicePassportUserSignInPhone**](#passportauthuserservicepassportusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
|
|
42
|
-
|[**passportAuthUserServicePassportUserSignInSocial**](#passportauthuserservicepassportusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
|
|
43
|
-
|[**passportAuthUserServicePassportUserSignUpEmail**](#passportauthuserservicepassportusersignupemail) | **POST** /passport/auth/v1/sign-up/email | |
|
|
44
|
-
|
|
45
|
-
# **passportAuthUserServicePassportAuthChangePassword**
|
|
46
|
-
> PassportAuthChangePasswordResponse passportAuthUserServicePassportAuthChangePassword(passportAuthChangePasswordRequest)
|
|
47
|
-
|
|
48
|
-
已登录用户修改密码
|
|
49
|
-
|
|
50
|
-
### Example
|
|
51
|
-
|
|
52
|
-
```typescript
|
|
53
|
-
import {
|
|
54
|
-
PassportAuthUserServiceApi,
|
|
55
|
-
Configuration,
|
|
56
|
-
PassportAuthChangePasswordRequest
|
|
57
|
-
} from '@cherryin/api-client';
|
|
58
|
-
|
|
59
|
-
const configuration = new Configuration();
|
|
60
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
61
|
-
|
|
62
|
-
let passportAuthChangePasswordRequest: PassportAuthChangePasswordRequest; //
|
|
63
|
-
|
|
64
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthChangePassword(
|
|
65
|
-
passportAuthChangePasswordRequest
|
|
66
|
-
);
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Parameters
|
|
70
|
-
|
|
71
|
-
|Name | Type | Description | Notes|
|
|
72
|
-
|------------- | ------------- | ------------- | -------------|
|
|
73
|
-
| **passportAuthChangePasswordRequest** | **PassportAuthChangePasswordRequest**| | |
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
### Return type
|
|
77
|
-
|
|
78
|
-
**PassportAuthChangePasswordResponse**
|
|
79
|
-
|
|
80
|
-
### Authorization
|
|
81
|
-
|
|
82
|
-
No authorization required
|
|
83
|
-
|
|
84
|
-
### HTTP request headers
|
|
85
|
-
|
|
86
|
-
- **Content-Type**: application/json
|
|
87
|
-
- **Accept**: application/json
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
### HTTP response details
|
|
91
|
-
| Status code | Description | Response headers |
|
|
92
|
-
|-------------|-------------|------------------|
|
|
93
|
-
|**200** | OK | - |
|
|
94
|
-
|**0** | Default error response | - |
|
|
95
|
-
|
|
96
|
-
[[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)
|
|
97
|
-
|
|
98
|
-
# **passportAuthUserServicePassportAuthDeleteAll**
|
|
99
|
-
> PassportAuthDeleteAllResponse passportAuthUserServicePassportAuthDeleteAll(passportAuthDeleteAllRequest)
|
|
100
|
-
|
|
101
|
-
删除通行证及所有关联用户
|
|
102
|
-
|
|
103
|
-
### Example
|
|
104
|
-
|
|
105
|
-
```typescript
|
|
106
|
-
import {
|
|
107
|
-
PassportAuthUserServiceApi,
|
|
108
|
-
Configuration,
|
|
109
|
-
PassportAuthDeleteAllRequest
|
|
110
|
-
} from '@cherryin/api-client';
|
|
111
|
-
|
|
112
|
-
const configuration = new Configuration();
|
|
113
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
114
|
-
|
|
115
|
-
let passportAuthDeleteAllRequest: PassportAuthDeleteAllRequest; //
|
|
116
|
-
|
|
117
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthDeleteAll(
|
|
118
|
-
passportAuthDeleteAllRequest
|
|
119
|
-
);
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### Parameters
|
|
123
|
-
|
|
124
|
-
|Name | Type | Description | Notes|
|
|
125
|
-
|------------- | ------------- | ------------- | -------------|
|
|
126
|
-
| **passportAuthDeleteAllRequest** | **PassportAuthDeleteAllRequest**| | |
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
### Return type
|
|
130
|
-
|
|
131
|
-
**PassportAuthDeleteAllResponse**
|
|
132
|
-
|
|
133
|
-
### Authorization
|
|
134
|
-
|
|
135
|
-
No authorization required
|
|
136
|
-
|
|
137
|
-
### HTTP request headers
|
|
138
|
-
|
|
139
|
-
- **Content-Type**: application/json
|
|
140
|
-
- **Accept**: application/json
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
### HTTP response details
|
|
144
|
-
| Status code | Description | Response headers |
|
|
145
|
-
|-------------|-------------|------------------|
|
|
146
|
-
|**200** | OK | - |
|
|
147
|
-
|**0** | Default error response | - |
|
|
148
|
-
|
|
149
|
-
[[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)
|
|
150
|
-
|
|
151
|
-
# **passportAuthUserServicePassportAuthInfoGet**
|
|
152
|
-
> PassportAuthInfoGetResponse passportAuthUserServicePassportAuthInfoGet()
|
|
153
|
-
|
|
154
|
-
获取通行证及用户信息
|
|
155
|
-
|
|
156
|
-
### Example
|
|
157
|
-
|
|
158
|
-
```typescript
|
|
159
|
-
import {
|
|
160
|
-
PassportAuthUserServiceApi,
|
|
161
|
-
Configuration
|
|
162
|
-
} from '@cherryin/api-client';
|
|
163
|
-
|
|
164
|
-
const configuration = new Configuration();
|
|
165
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
166
|
-
|
|
167
|
-
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 (optional) (default to undefined)
|
|
168
|
-
|
|
169
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthInfoGet(
|
|
170
|
-
appIds
|
|
171
|
-
);
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
### Parameters
|
|
175
|
-
|
|
176
|
-
|Name | Type | Description | Notes|
|
|
177
|
-
|------------- | ------------- | ------------- | -------------|
|
|
178
|
-
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 | (optional) defaults to undefined|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
### Return type
|
|
182
|
-
|
|
183
|
-
**PassportAuthInfoGetResponse**
|
|
184
|
-
|
|
185
|
-
### Authorization
|
|
186
|
-
|
|
187
|
-
No authorization required
|
|
188
|
-
|
|
189
|
-
### HTTP request headers
|
|
190
|
-
|
|
191
|
-
- **Content-Type**: Not defined
|
|
192
|
-
- **Accept**: application/json
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
### HTTP response details
|
|
196
|
-
| Status code | Description | Response headers |
|
|
197
|
-
|-------------|-------------|------------------|
|
|
198
|
-
|**200** | OK | - |
|
|
199
|
-
|**0** | Default error response | - |
|
|
200
|
-
|
|
201
|
-
[[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)
|
|
202
|
-
|
|
203
|
-
# **passportAuthUserServicePassportAuthLinkSocial**
|
|
204
|
-
> PassportAuthLinkSocialResponse passportAuthUserServicePassportAuthLinkSocial(passportAuthLinkSocialRequest)
|
|
205
|
-
|
|
206
|
-
已登录用户关联社交账号
|
|
207
|
-
|
|
208
|
-
### Example
|
|
209
|
-
|
|
210
|
-
```typescript
|
|
211
|
-
import {
|
|
212
|
-
PassportAuthUserServiceApi,
|
|
213
|
-
Configuration,
|
|
214
|
-
PassportAuthLinkSocialRequest
|
|
215
|
-
} from '@cherryin/api-client';
|
|
216
|
-
|
|
217
|
-
const configuration = new Configuration();
|
|
218
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
219
|
-
|
|
220
|
-
let passportAuthLinkSocialRequest: PassportAuthLinkSocialRequest; //
|
|
221
|
-
|
|
222
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthLinkSocial(
|
|
223
|
-
passportAuthLinkSocialRequest
|
|
224
|
-
);
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
### Parameters
|
|
228
|
-
|
|
229
|
-
|Name | Type | Description | Notes|
|
|
230
|
-
|------------- | ------------- | ------------- | -------------|
|
|
231
|
-
| **passportAuthLinkSocialRequest** | **PassportAuthLinkSocialRequest**| | |
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
### Return type
|
|
235
|
-
|
|
236
|
-
**PassportAuthLinkSocialResponse**
|
|
237
|
-
|
|
238
|
-
### Authorization
|
|
239
|
-
|
|
240
|
-
No authorization required
|
|
241
|
-
|
|
242
|
-
### HTTP request headers
|
|
243
|
-
|
|
244
|
-
- **Content-Type**: application/json
|
|
245
|
-
- **Accept**: application/json
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
### HTTP response details
|
|
249
|
-
| Status code | Description | Response headers |
|
|
250
|
-
|-------------|-------------|------------------|
|
|
251
|
-
|**200** | OK | - |
|
|
252
|
-
|**0** | Default error response | - |
|
|
253
|
-
|
|
254
|
-
[[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)
|
|
255
|
-
|
|
256
|
-
# **passportAuthUserServicePassportAuthListMethods**
|
|
257
|
-
> PassportAuthListMethodsResponse passportAuthUserServicePassportAuthListMethods()
|
|
258
|
-
|
|
259
|
-
列出已关联的认证方法(包含 邮箱/社交账号等)
|
|
260
|
-
|
|
261
|
-
### Example
|
|
262
|
-
|
|
263
|
-
```typescript
|
|
264
|
-
import {
|
|
265
|
-
PassportAuthUserServiceApi,
|
|
266
|
-
Configuration
|
|
267
|
-
} from '@cherryin/api-client';
|
|
268
|
-
|
|
269
|
-
const configuration = new Configuration();
|
|
270
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
271
|
-
|
|
272
|
-
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
273
|
-
|
|
274
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListMethods(
|
|
275
|
-
appIds
|
|
276
|
-
);
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
### Parameters
|
|
280
|
-
|
|
281
|
-
|Name | Type | Description | Notes|
|
|
282
|
-
|------------- | ------------- | ------------- | -------------|
|
|
283
|
-
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
### Return type
|
|
287
|
-
|
|
288
|
-
**PassportAuthListMethodsResponse**
|
|
289
|
-
|
|
290
|
-
### Authorization
|
|
291
|
-
|
|
292
|
-
No authorization required
|
|
293
|
-
|
|
294
|
-
### HTTP request headers
|
|
295
|
-
|
|
296
|
-
- **Content-Type**: Not defined
|
|
297
|
-
- **Accept**: application/json
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
### HTTP response details
|
|
301
|
-
| Status code | Description | Response headers |
|
|
302
|
-
|-------------|-------------|------------------|
|
|
303
|
-
|**200** | OK | - |
|
|
304
|
-
|**0** | Default error response | - |
|
|
305
|
-
|
|
306
|
-
[[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)
|
|
307
|
-
|
|
308
|
-
# **passportAuthUserServicePassportAuthListSessions**
|
|
309
|
-
> PassportAuthListSessionsResponse passportAuthUserServicePassportAuthListSessions()
|
|
310
|
-
|
|
311
|
-
获取当前用户的所有会话列表
|
|
312
|
-
|
|
313
|
-
### Example
|
|
314
|
-
|
|
315
|
-
```typescript
|
|
316
|
-
import {
|
|
317
|
-
PassportAuthUserServiceApi,
|
|
318
|
-
Configuration
|
|
319
|
-
} from '@cherryin/api-client';
|
|
320
|
-
|
|
321
|
-
const configuration = new Configuration();
|
|
322
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
323
|
-
|
|
324
|
-
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
325
|
-
|
|
326
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSessions(
|
|
327
|
-
appIds
|
|
328
|
-
);
|
|
329
|
-
```
|
|
330
|
-
|
|
331
|
-
### Parameters
|
|
332
|
-
|
|
333
|
-
|Name | Type | Description | Notes|
|
|
334
|
-
|------------- | ------------- | ------------- | -------------|
|
|
335
|
-
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
### Return type
|
|
339
|
-
|
|
340
|
-
**PassportAuthListSessionsResponse**
|
|
341
|
-
|
|
342
|
-
### Authorization
|
|
343
|
-
|
|
344
|
-
No authorization required
|
|
345
|
-
|
|
346
|
-
### HTTP request headers
|
|
347
|
-
|
|
348
|
-
- **Content-Type**: Not defined
|
|
349
|
-
- **Accept**: application/json
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
### HTTP response details
|
|
353
|
-
| Status code | Description | Response headers |
|
|
354
|
-
|-------------|-------------|------------------|
|
|
355
|
-
|**200** | OK | - |
|
|
356
|
-
|**0** | Default error response | - |
|
|
357
|
-
|
|
358
|
-
[[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)
|
|
359
|
-
|
|
360
|
-
# **passportAuthUserServicePassportAuthListSocials**
|
|
361
|
-
> PassportAuthListSocialsResponse passportAuthUserServicePassportAuthListSocials()
|
|
362
|
-
|
|
363
|
-
列出已关联的认证方法(列出社交账号)
|
|
364
|
-
|
|
365
|
-
### Example
|
|
366
|
-
|
|
367
|
-
```typescript
|
|
368
|
-
import {
|
|
369
|
-
PassportAuthUserServiceApi,
|
|
370
|
-
Configuration
|
|
371
|
-
} from '@cherryin/api-client';
|
|
372
|
-
|
|
373
|
-
const configuration = new Configuration();
|
|
374
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
375
|
-
|
|
376
|
-
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
377
|
-
|
|
378
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSocials(
|
|
379
|
-
appIds
|
|
380
|
-
);
|
|
381
|
-
```
|
|
382
|
-
|
|
383
|
-
### Parameters
|
|
384
|
-
|
|
385
|
-
|Name | Type | Description | Notes|
|
|
386
|
-
|------------- | ------------- | ------------- | -------------|
|
|
387
|
-
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
### Return type
|
|
391
|
-
|
|
392
|
-
**PassportAuthListSocialsResponse**
|
|
393
|
-
|
|
394
|
-
### Authorization
|
|
395
|
-
|
|
396
|
-
No authorization required
|
|
397
|
-
|
|
398
|
-
### HTTP request headers
|
|
399
|
-
|
|
400
|
-
- **Content-Type**: Not defined
|
|
401
|
-
- **Accept**: application/json
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
### HTTP response details
|
|
405
|
-
| Status code | Description | Response headers |
|
|
406
|
-
|-------------|-------------|------------------|
|
|
407
|
-
|**200** | OK | - |
|
|
408
|
-
|**0** | Default error response | - |
|
|
409
|
-
|
|
410
|
-
[[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)
|
|
411
|
-
|
|
412
|
-
# **passportAuthUserServicePassportAuthRefreshSessionToken**
|
|
413
|
-
> PassportAuthRefreshSessionTokenResponse passportAuthUserServicePassportAuthRefreshSessionToken(passportAuthRefreshSessionTokenRequest)
|
|
414
|
-
|
|
415
|
-
会话 token 刷新
|
|
416
|
-
|
|
417
|
-
### Example
|
|
418
|
-
|
|
419
|
-
```typescript
|
|
420
|
-
import {
|
|
421
|
-
PassportAuthUserServiceApi,
|
|
422
|
-
Configuration,
|
|
423
|
-
PassportAuthRefreshSessionTokenRequest
|
|
424
|
-
} from '@cherryin/api-client';
|
|
425
|
-
|
|
426
|
-
const configuration = new Configuration();
|
|
427
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
428
|
-
|
|
429
|
-
let passportAuthRefreshSessionTokenRequest: PassportAuthRefreshSessionTokenRequest; //
|
|
430
|
-
|
|
431
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRefreshSessionToken(
|
|
432
|
-
passportAuthRefreshSessionTokenRequest
|
|
433
|
-
);
|
|
434
|
-
```
|
|
435
|
-
|
|
436
|
-
### Parameters
|
|
437
|
-
|
|
438
|
-
|Name | Type | Description | Notes|
|
|
439
|
-
|------------- | ------------- | ------------- | -------------|
|
|
440
|
-
| **passportAuthRefreshSessionTokenRequest** | **PassportAuthRefreshSessionTokenRequest**| | |
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
### Return type
|
|
444
|
-
|
|
445
|
-
**PassportAuthRefreshSessionTokenResponse**
|
|
446
|
-
|
|
447
|
-
### Authorization
|
|
448
|
-
|
|
449
|
-
No authorization required
|
|
450
|
-
|
|
451
|
-
### HTTP request headers
|
|
452
|
-
|
|
453
|
-
- **Content-Type**: application/json
|
|
454
|
-
- **Accept**: application/json
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
### HTTP response details
|
|
458
|
-
| Status code | Description | Response headers |
|
|
459
|
-
|-------------|-------------|------------------|
|
|
460
|
-
|**200** | OK | - |
|
|
461
|
-
|**0** | Default error response | - |
|
|
462
|
-
|
|
463
|
-
[[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)
|
|
464
|
-
|
|
465
|
-
# **passportAuthUserServicePassportAuthResetPassword**
|
|
466
|
-
> PassportAuthResetPasswordResponse passportAuthUserServicePassportAuthResetPassword(passportAuthResetPasswordRequest)
|
|
467
|
-
|
|
468
|
-
已登录用户重置密码
|
|
469
|
-
|
|
470
|
-
### Example
|
|
471
|
-
|
|
472
|
-
```typescript
|
|
473
|
-
import {
|
|
474
|
-
PassportAuthUserServiceApi,
|
|
475
|
-
Configuration,
|
|
476
|
-
PassportAuthResetPasswordRequest
|
|
477
|
-
} from '@cherryin/api-client';
|
|
478
|
-
|
|
479
|
-
const configuration = new Configuration();
|
|
480
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
481
|
-
|
|
482
|
-
let passportAuthResetPasswordRequest: PassportAuthResetPasswordRequest; //
|
|
483
|
-
|
|
484
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthResetPassword(
|
|
485
|
-
passportAuthResetPasswordRequest
|
|
486
|
-
);
|
|
487
|
-
```
|
|
488
|
-
|
|
489
|
-
### Parameters
|
|
490
|
-
|
|
491
|
-
|Name | Type | Description | Notes|
|
|
492
|
-
|------------- | ------------- | ------------- | -------------|
|
|
493
|
-
| **passportAuthResetPasswordRequest** | **PassportAuthResetPasswordRequest**| | |
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
### Return type
|
|
497
|
-
|
|
498
|
-
**PassportAuthResetPasswordResponse**
|
|
499
|
-
|
|
500
|
-
### Authorization
|
|
501
|
-
|
|
502
|
-
No authorization required
|
|
503
|
-
|
|
504
|
-
### HTTP request headers
|
|
505
|
-
|
|
506
|
-
- **Content-Type**: application/json
|
|
507
|
-
- **Accept**: application/json
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
### HTTP response details
|
|
511
|
-
| Status code | Description | Response headers |
|
|
512
|
-
|-------------|-------------|------------------|
|
|
513
|
-
|**200** | OK | - |
|
|
514
|
-
|**0** | Default error response | - |
|
|
515
|
-
|
|
516
|
-
[[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)
|
|
517
|
-
|
|
518
|
-
# **passportAuthUserServicePassportAuthRevokeOtherSessions**
|
|
519
|
-
> PassportAuthRevokeOtherSessionsResponse passportAuthUserServicePassportAuthRevokeOtherSessions(passportAuthRevokeOtherSessionsRequest)
|
|
520
|
-
|
|
521
|
-
注销其他会话
|
|
522
|
-
|
|
523
|
-
### Example
|
|
524
|
-
|
|
525
|
-
```typescript
|
|
526
|
-
import {
|
|
527
|
-
PassportAuthUserServiceApi,
|
|
528
|
-
Configuration,
|
|
529
|
-
PassportAuthRevokeOtherSessionsRequest
|
|
530
|
-
} from '@cherryin/api-client';
|
|
531
|
-
|
|
532
|
-
const configuration = new Configuration();
|
|
533
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
534
|
-
|
|
535
|
-
let passportAuthRevokeOtherSessionsRequest: PassportAuthRevokeOtherSessionsRequest; //
|
|
536
|
-
|
|
537
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeOtherSessions(
|
|
538
|
-
passportAuthRevokeOtherSessionsRequest
|
|
539
|
-
);
|
|
540
|
-
```
|
|
541
|
-
|
|
542
|
-
### Parameters
|
|
543
|
-
|
|
544
|
-
|Name | Type | Description | Notes|
|
|
545
|
-
|------------- | ------------- | ------------- | -------------|
|
|
546
|
-
| **passportAuthRevokeOtherSessionsRequest** | **PassportAuthRevokeOtherSessionsRequest**| | |
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
### Return type
|
|
550
|
-
|
|
551
|
-
**PassportAuthRevokeOtherSessionsResponse**
|
|
552
|
-
|
|
553
|
-
### Authorization
|
|
554
|
-
|
|
555
|
-
No authorization required
|
|
556
|
-
|
|
557
|
-
### HTTP request headers
|
|
558
|
-
|
|
559
|
-
- **Content-Type**: application/json
|
|
560
|
-
- **Accept**: application/json
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
### HTTP response details
|
|
564
|
-
| Status code | Description | Response headers |
|
|
565
|
-
|-------------|-------------|------------------|
|
|
566
|
-
|**200** | OK | - |
|
|
567
|
-
|**0** | Default error response | - |
|
|
568
|
-
|
|
569
|
-
[[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)
|
|
570
|
-
|
|
571
|
-
# **passportAuthUserServicePassportAuthRevokeSession**
|
|
572
|
-
> PassportAuthRevokeSessionResponse passportAuthUserServicePassportAuthRevokeSession(passportAuthRevokeSessionRequest)
|
|
573
|
-
|
|
574
|
-
注销指定会话
|
|
575
|
-
|
|
576
|
-
### Example
|
|
577
|
-
|
|
578
|
-
```typescript
|
|
579
|
-
import {
|
|
580
|
-
PassportAuthUserServiceApi,
|
|
581
|
-
Configuration,
|
|
582
|
-
PassportAuthRevokeSessionRequest
|
|
583
|
-
} from '@cherryin/api-client';
|
|
584
|
-
|
|
585
|
-
const configuration = new Configuration();
|
|
586
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
587
|
-
|
|
588
|
-
let passportAuthRevokeSessionRequest: PassportAuthRevokeSessionRequest; //
|
|
589
|
-
|
|
590
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSession(
|
|
591
|
-
passportAuthRevokeSessionRequest
|
|
592
|
-
);
|
|
593
|
-
```
|
|
594
|
-
|
|
595
|
-
### Parameters
|
|
596
|
-
|
|
597
|
-
|Name | Type | Description | Notes|
|
|
598
|
-
|------------- | ------------- | ------------- | -------------|
|
|
599
|
-
| **passportAuthRevokeSessionRequest** | **PassportAuthRevokeSessionRequest**| | |
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
### Return type
|
|
603
|
-
|
|
604
|
-
**PassportAuthRevokeSessionResponse**
|
|
605
|
-
|
|
606
|
-
### Authorization
|
|
607
|
-
|
|
608
|
-
No authorization required
|
|
609
|
-
|
|
610
|
-
### HTTP request headers
|
|
611
|
-
|
|
612
|
-
- **Content-Type**: application/json
|
|
613
|
-
- **Accept**: application/json
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
### HTTP response details
|
|
617
|
-
| Status code | Description | Response headers |
|
|
618
|
-
|-------------|-------------|------------------|
|
|
619
|
-
|**200** | OK | - |
|
|
620
|
-
|**0** | Default error response | - |
|
|
621
|
-
|
|
622
|
-
[[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)
|
|
623
|
-
|
|
624
|
-
# **passportAuthUserServicePassportAuthRevokeSessions**
|
|
625
|
-
> PassportAuthRevokeSessionsResponse passportAuthUserServicePassportAuthRevokeSessions(passportAuthRevokeSessionsRequest)
|
|
626
|
-
|
|
627
|
-
注销所有会话
|
|
628
|
-
|
|
629
|
-
### Example
|
|
630
|
-
|
|
631
|
-
```typescript
|
|
632
|
-
import {
|
|
633
|
-
PassportAuthUserServiceApi,
|
|
634
|
-
Configuration,
|
|
635
|
-
PassportAuthRevokeSessionsRequest
|
|
636
|
-
} from '@cherryin/api-client';
|
|
637
|
-
|
|
638
|
-
const configuration = new Configuration();
|
|
639
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
640
|
-
|
|
641
|
-
let passportAuthRevokeSessionsRequest: PassportAuthRevokeSessionsRequest; //
|
|
642
|
-
|
|
643
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSessions(
|
|
644
|
-
passportAuthRevokeSessionsRequest
|
|
645
|
-
);
|
|
646
|
-
```
|
|
647
|
-
|
|
648
|
-
### Parameters
|
|
649
|
-
|
|
650
|
-
|Name | Type | Description | Notes|
|
|
651
|
-
|------------- | ------------- | ------------- | -------------|
|
|
652
|
-
| **passportAuthRevokeSessionsRequest** | **PassportAuthRevokeSessionsRequest**| | |
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
### Return type
|
|
656
|
-
|
|
657
|
-
**PassportAuthRevokeSessionsResponse**
|
|
658
|
-
|
|
659
|
-
### Authorization
|
|
660
|
-
|
|
661
|
-
No authorization required
|
|
662
|
-
|
|
663
|
-
### HTTP request headers
|
|
664
|
-
|
|
665
|
-
- **Content-Type**: application/json
|
|
666
|
-
- **Accept**: application/json
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
### HTTP response details
|
|
670
|
-
| Status code | Description | Response headers |
|
|
671
|
-
|-------------|-------------|------------------|
|
|
672
|
-
|**200** | OK | - |
|
|
673
|
-
|**0** | Default error response | - |
|
|
674
|
-
|
|
675
|
-
[[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)
|
|
676
|
-
|
|
677
|
-
# **passportAuthUserServicePassportAuthSendVerificationEmail**
|
|
678
|
-
> PassportAuthSendVerificationEmailResponse passportAuthUserServicePassportAuthSendVerificationEmail(passportAuthSendVerificationEmailRequest)
|
|
679
|
-
|
|
680
|
-
用户认证后发送验证码
|
|
681
|
-
|
|
682
|
-
### Example
|
|
683
|
-
|
|
684
|
-
```typescript
|
|
685
|
-
import {
|
|
686
|
-
PassportAuthUserServiceApi,
|
|
687
|
-
Configuration,
|
|
688
|
-
PassportAuthSendVerificationEmailRequest
|
|
689
|
-
} from '@cherryin/api-client';
|
|
690
|
-
|
|
691
|
-
const configuration = new Configuration();
|
|
692
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
693
|
-
|
|
694
|
-
let passportAuthSendVerificationEmailRequest: PassportAuthSendVerificationEmailRequest; //
|
|
695
|
-
|
|
696
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationEmail(
|
|
697
|
-
passportAuthSendVerificationEmailRequest
|
|
698
|
-
);
|
|
699
|
-
```
|
|
700
|
-
|
|
701
|
-
### Parameters
|
|
702
|
-
|
|
703
|
-
|Name | Type | Description | Notes|
|
|
704
|
-
|------------- | ------------- | ------------- | -------------|
|
|
705
|
-
| **passportAuthSendVerificationEmailRequest** | **PassportAuthSendVerificationEmailRequest**| | |
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
### Return type
|
|
709
|
-
|
|
710
|
-
**PassportAuthSendVerificationEmailResponse**
|
|
711
|
-
|
|
712
|
-
### Authorization
|
|
713
|
-
|
|
714
|
-
No authorization required
|
|
715
|
-
|
|
716
|
-
### HTTP request headers
|
|
717
|
-
|
|
718
|
-
- **Content-Type**: application/json
|
|
719
|
-
- **Accept**: application/json
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
### HTTP response details
|
|
723
|
-
| Status code | Description | Response headers |
|
|
724
|
-
|-------------|-------------|------------------|
|
|
725
|
-
|**200** | OK | - |
|
|
726
|
-
|**0** | Default error response | - |
|
|
727
|
-
|
|
728
|
-
[[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)
|
|
729
|
-
|
|
730
|
-
# **passportAuthUserServicePassportAuthSendVerificationPhone**
|
|
731
|
-
> PassportAuthSendVerificationPhoneResponse passportAuthUserServicePassportAuthSendVerificationPhone(passportAuthSendVerificationPhoneRequest)
|
|
732
|
-
|
|
733
|
-
用户认证后发送验证码
|
|
734
|
-
|
|
735
|
-
### Example
|
|
736
|
-
|
|
737
|
-
```typescript
|
|
738
|
-
import {
|
|
739
|
-
PassportAuthUserServiceApi,
|
|
740
|
-
Configuration,
|
|
741
|
-
PassportAuthSendVerificationPhoneRequest
|
|
742
|
-
} from '@cherryin/api-client';
|
|
743
|
-
|
|
744
|
-
const configuration = new Configuration();
|
|
745
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
746
|
-
|
|
747
|
-
let passportAuthSendVerificationPhoneRequest: PassportAuthSendVerificationPhoneRequest; //
|
|
748
|
-
|
|
749
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationPhone(
|
|
750
|
-
passportAuthSendVerificationPhoneRequest
|
|
751
|
-
);
|
|
752
|
-
```
|
|
753
|
-
|
|
754
|
-
### Parameters
|
|
755
|
-
|
|
756
|
-
|Name | Type | Description | Notes|
|
|
757
|
-
|------------- | ------------- | ------------- | -------------|
|
|
758
|
-
| **passportAuthSendVerificationPhoneRequest** | **PassportAuthSendVerificationPhoneRequest**| | |
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
### Return type
|
|
762
|
-
|
|
763
|
-
**PassportAuthSendVerificationPhoneResponse**
|
|
764
|
-
|
|
765
|
-
### Authorization
|
|
766
|
-
|
|
767
|
-
No authorization required
|
|
768
|
-
|
|
769
|
-
### HTTP request headers
|
|
770
|
-
|
|
771
|
-
- **Content-Type**: application/json
|
|
772
|
-
- **Accept**: application/json
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
### HTTP response details
|
|
776
|
-
| Status code | Description | Response headers |
|
|
777
|
-
|-------------|-------------|------------------|
|
|
778
|
-
|**200** | OK | - |
|
|
779
|
-
|**0** | Default error response | - |
|
|
780
|
-
|
|
781
|
-
[[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)
|
|
782
|
-
|
|
783
|
-
# **passportAuthUserServicePassportAuthSocialGetAccessToken**
|
|
784
|
-
> PassportAuthSocialGetAccessTokenResponse passportAuthUserServicePassportAuthSocialGetAccessToken(passportAuthSocialGetAccessTokenRequest)
|
|
785
|
-
|
|
786
|
-
获取社交账号访问令牌
|
|
787
|
-
|
|
788
|
-
### Example
|
|
789
|
-
|
|
790
|
-
```typescript
|
|
791
|
-
import {
|
|
792
|
-
PassportAuthUserServiceApi,
|
|
793
|
-
Configuration,
|
|
794
|
-
PassportAuthSocialGetAccessTokenRequest
|
|
795
|
-
} from '@cherryin/api-client';
|
|
796
|
-
|
|
797
|
-
const configuration = new Configuration();
|
|
798
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
799
|
-
|
|
800
|
-
let passportAuthSocialGetAccessTokenRequest: PassportAuthSocialGetAccessTokenRequest; //
|
|
801
|
-
|
|
802
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialGetAccessToken(
|
|
803
|
-
passportAuthSocialGetAccessTokenRequest
|
|
804
|
-
);
|
|
805
|
-
```
|
|
806
|
-
|
|
807
|
-
### Parameters
|
|
808
|
-
|
|
809
|
-
|Name | Type | Description | Notes|
|
|
810
|
-
|------------- | ------------- | ------------- | -------------|
|
|
811
|
-
| **passportAuthSocialGetAccessTokenRequest** | **PassportAuthSocialGetAccessTokenRequest**| | |
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
### Return type
|
|
815
|
-
|
|
816
|
-
**PassportAuthSocialGetAccessTokenResponse**
|
|
817
|
-
|
|
818
|
-
### Authorization
|
|
819
|
-
|
|
820
|
-
No authorization required
|
|
821
|
-
|
|
822
|
-
### HTTP request headers
|
|
823
|
-
|
|
824
|
-
- **Content-Type**: application/json
|
|
825
|
-
- **Accept**: application/json
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
### HTTP response details
|
|
829
|
-
| Status code | Description | Response headers |
|
|
830
|
-
|-------------|-------------|------------------|
|
|
831
|
-
|**200** | OK | - |
|
|
832
|
-
|**0** | Default error response | - |
|
|
833
|
-
|
|
834
|
-
[[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)
|
|
835
|
-
|
|
836
|
-
# **passportAuthUserServicePassportAuthSocialRefreshToken**
|
|
837
|
-
> PassportAuthSocialRefreshTokenResponse passportAuthUserServicePassportAuthSocialRefreshToken(passportAuthSocialRefreshTokenRequest)
|
|
838
|
-
|
|
839
|
-
社交账号刷新 Token
|
|
840
|
-
|
|
841
|
-
### Example
|
|
842
|
-
|
|
843
|
-
```typescript
|
|
844
|
-
import {
|
|
845
|
-
PassportAuthUserServiceApi,
|
|
846
|
-
Configuration,
|
|
847
|
-
PassportAuthSocialRefreshTokenRequest
|
|
848
|
-
} from '@cherryin/api-client';
|
|
849
|
-
|
|
850
|
-
const configuration = new Configuration();
|
|
851
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
852
|
-
|
|
853
|
-
let passportAuthSocialRefreshTokenRequest: PassportAuthSocialRefreshTokenRequest; //
|
|
854
|
-
|
|
855
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialRefreshToken(
|
|
856
|
-
passportAuthSocialRefreshTokenRequest
|
|
857
|
-
);
|
|
858
|
-
```
|
|
859
|
-
|
|
860
|
-
### Parameters
|
|
861
|
-
|
|
862
|
-
|Name | Type | Description | Notes|
|
|
863
|
-
|------------- | ------------- | ------------- | -------------|
|
|
864
|
-
| **passportAuthSocialRefreshTokenRequest** | **PassportAuthSocialRefreshTokenRequest**| | |
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
### Return type
|
|
868
|
-
|
|
869
|
-
**PassportAuthSocialRefreshTokenResponse**
|
|
870
|
-
|
|
871
|
-
### Authorization
|
|
872
|
-
|
|
873
|
-
No authorization required
|
|
874
|
-
|
|
875
|
-
### HTTP request headers
|
|
876
|
-
|
|
877
|
-
- **Content-Type**: application/json
|
|
878
|
-
- **Accept**: application/json
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
### HTTP response details
|
|
882
|
-
| Status code | Description | Response headers |
|
|
883
|
-
|-------------|-------------|------------------|
|
|
884
|
-
|**200** | OK | - |
|
|
885
|
-
|**0** | Default error response | - |
|
|
886
|
-
|
|
887
|
-
[[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)
|
|
888
|
-
|
|
889
|
-
# **passportAuthUserServicePassportAuthUnlinkSocial**
|
|
890
|
-
> PassportAuthUnlinkSocialResponse passportAuthUserServicePassportAuthUnlinkSocial(passportAuthUnlinkSocialRequest)
|
|
891
|
-
|
|
892
|
-
已登录用户取消关联社交账号
|
|
893
|
-
|
|
894
|
-
### Example
|
|
895
|
-
|
|
896
|
-
```typescript
|
|
897
|
-
import {
|
|
898
|
-
PassportAuthUserServiceApi,
|
|
899
|
-
Configuration,
|
|
900
|
-
PassportAuthUnlinkSocialRequest
|
|
901
|
-
} from '@cherryin/api-client';
|
|
902
|
-
|
|
903
|
-
const configuration = new Configuration();
|
|
904
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
905
|
-
|
|
906
|
-
let passportAuthUnlinkSocialRequest: PassportAuthUnlinkSocialRequest; //
|
|
907
|
-
|
|
908
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUnlinkSocial(
|
|
909
|
-
passportAuthUnlinkSocialRequest
|
|
910
|
-
);
|
|
911
|
-
```
|
|
912
|
-
|
|
913
|
-
### Parameters
|
|
914
|
-
|
|
915
|
-
|Name | Type | Description | Notes|
|
|
916
|
-
|------------- | ------------- | ------------- | -------------|
|
|
917
|
-
| **passportAuthUnlinkSocialRequest** | **PassportAuthUnlinkSocialRequest**| | |
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
### Return type
|
|
921
|
-
|
|
922
|
-
**PassportAuthUnlinkSocialResponse**
|
|
923
|
-
|
|
924
|
-
### Authorization
|
|
925
|
-
|
|
926
|
-
No authorization required
|
|
927
|
-
|
|
928
|
-
### HTTP request headers
|
|
929
|
-
|
|
930
|
-
- **Content-Type**: application/json
|
|
931
|
-
- **Accept**: application/json
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
### HTTP response details
|
|
935
|
-
| Status code | Description | Response headers |
|
|
936
|
-
|-------------|-------------|------------------|
|
|
937
|
-
|**200** | OK | - |
|
|
938
|
-
|**0** | Default error response | - |
|
|
939
|
-
|
|
940
|
-
[[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)
|
|
941
|
-
|
|
942
|
-
# **passportAuthUserServicePassportAuthUserChangeEmail**
|
|
943
|
-
> PassportAuthUserChangeEmailResponse passportAuthUserServicePassportAuthUserChangeEmail(passportAuthUserChangeEmailRequest)
|
|
944
|
-
|
|
945
|
-
已登录用户更换邮箱
|
|
946
|
-
|
|
947
|
-
### Example
|
|
948
|
-
|
|
949
|
-
```typescript
|
|
950
|
-
import {
|
|
951
|
-
PassportAuthUserServiceApi,
|
|
952
|
-
Configuration,
|
|
953
|
-
PassportAuthUserChangeEmailRequest
|
|
954
|
-
} from '@cherryin/api-client';
|
|
955
|
-
|
|
956
|
-
const configuration = new Configuration();
|
|
957
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
958
|
-
|
|
959
|
-
let passportAuthUserChangeEmailRequest: PassportAuthUserChangeEmailRequest; //
|
|
960
|
-
|
|
961
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangeEmail(
|
|
962
|
-
passportAuthUserChangeEmailRequest
|
|
963
|
-
);
|
|
964
|
-
```
|
|
965
|
-
|
|
966
|
-
### Parameters
|
|
967
|
-
|
|
968
|
-
|Name | Type | Description | Notes|
|
|
969
|
-
|------------- | ------------- | ------------- | -------------|
|
|
970
|
-
| **passportAuthUserChangeEmailRequest** | **PassportAuthUserChangeEmailRequest**| | |
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
### Return type
|
|
974
|
-
|
|
975
|
-
**PassportAuthUserChangeEmailResponse**
|
|
976
|
-
|
|
977
|
-
### Authorization
|
|
978
|
-
|
|
979
|
-
No authorization required
|
|
980
|
-
|
|
981
|
-
### HTTP request headers
|
|
982
|
-
|
|
983
|
-
- **Content-Type**: application/json
|
|
984
|
-
- **Accept**: application/json
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
### HTTP response details
|
|
988
|
-
| Status code | Description | Response headers |
|
|
989
|
-
|-------------|-------------|------------------|
|
|
990
|
-
|**200** | OK | - |
|
|
991
|
-
|**0** | Default error response | - |
|
|
992
|
-
|
|
993
|
-
[[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)
|
|
994
|
-
|
|
995
|
-
# **passportAuthUserServicePassportAuthUserChangePhone**
|
|
996
|
-
> PassportAuthUserChangePhoneResponse passportAuthUserServicePassportAuthUserChangePhone(passportAuthUserChangePhoneRequest)
|
|
997
|
-
|
|
998
|
-
已登录用户更换手机号
|
|
999
|
-
|
|
1000
|
-
### Example
|
|
1001
|
-
|
|
1002
|
-
```typescript
|
|
1003
|
-
import {
|
|
1004
|
-
PassportAuthUserServiceApi,
|
|
1005
|
-
Configuration,
|
|
1006
|
-
PassportAuthUserChangePhoneRequest
|
|
1007
|
-
} from '@cherryin/api-client';
|
|
1008
|
-
|
|
1009
|
-
const configuration = new Configuration();
|
|
1010
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1011
|
-
|
|
1012
|
-
let passportAuthUserChangePhoneRequest: PassportAuthUserChangePhoneRequest; //
|
|
1013
|
-
|
|
1014
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangePhone(
|
|
1015
|
-
passportAuthUserChangePhoneRequest
|
|
1016
|
-
);
|
|
1017
|
-
```
|
|
1018
|
-
|
|
1019
|
-
### Parameters
|
|
1020
|
-
|
|
1021
|
-
|Name | Type | Description | Notes|
|
|
1022
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1023
|
-
| **passportAuthUserChangePhoneRequest** | **PassportAuthUserChangePhoneRequest**| | |
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
### Return type
|
|
1027
|
-
|
|
1028
|
-
**PassportAuthUserChangePhoneResponse**
|
|
1029
|
-
|
|
1030
|
-
### Authorization
|
|
1031
|
-
|
|
1032
|
-
No authorization required
|
|
1033
|
-
|
|
1034
|
-
### HTTP request headers
|
|
1035
|
-
|
|
1036
|
-
- **Content-Type**: application/json
|
|
1037
|
-
- **Accept**: application/json
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
### HTTP response details
|
|
1041
|
-
| Status code | Description | Response headers |
|
|
1042
|
-
|-------------|-------------|------------------|
|
|
1043
|
-
|**200** | OK | - |
|
|
1044
|
-
|**0** | Default error response | - |
|
|
1045
|
-
|
|
1046
|
-
[[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)
|
|
1047
|
-
|
|
1048
|
-
# **passportAuthUserServicePassportAuthUserDelete**
|
|
1049
|
-
> PassportAuthUserDeleteResponse passportAuthUserServicePassportAuthUserDelete(passportAuthUserDeleteRequest)
|
|
1050
|
-
|
|
1051
|
-
请求删除用户
|
|
1052
|
-
|
|
1053
|
-
### Example
|
|
1054
|
-
|
|
1055
|
-
```typescript
|
|
1056
|
-
import {
|
|
1057
|
-
PassportAuthUserServiceApi,
|
|
1058
|
-
Configuration,
|
|
1059
|
-
PassportAuthUserDeleteRequest
|
|
1060
|
-
} from '@cherryin/api-client';
|
|
1061
|
-
|
|
1062
|
-
const configuration = new Configuration();
|
|
1063
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1064
|
-
|
|
1065
|
-
let passportAuthUserDeleteRequest: PassportAuthUserDeleteRequest; //
|
|
1066
|
-
|
|
1067
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserDelete(
|
|
1068
|
-
passportAuthUserDeleteRequest
|
|
1069
|
-
);
|
|
1070
|
-
```
|
|
1071
|
-
|
|
1072
|
-
### Parameters
|
|
1073
|
-
|
|
1074
|
-
|Name | Type | Description | Notes|
|
|
1075
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1076
|
-
| **passportAuthUserDeleteRequest** | **PassportAuthUserDeleteRequest**| | |
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
### Return type
|
|
1080
|
-
|
|
1081
|
-
**PassportAuthUserDeleteResponse**
|
|
1082
|
-
|
|
1083
|
-
### Authorization
|
|
1084
|
-
|
|
1085
|
-
No authorization required
|
|
1086
|
-
|
|
1087
|
-
### HTTP request headers
|
|
1088
|
-
|
|
1089
|
-
- **Content-Type**: application/json
|
|
1090
|
-
- **Accept**: application/json
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
### HTTP response details
|
|
1094
|
-
| Status code | Description | Response headers |
|
|
1095
|
-
|-------------|-------------|------------------|
|
|
1096
|
-
|**200** | OK | - |
|
|
1097
|
-
|**0** | Default error response | - |
|
|
1098
|
-
|
|
1099
|
-
[[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)
|
|
1100
|
-
|
|
1101
|
-
# **passportAuthUserServicePassportAuthUserGetSession**
|
|
1102
|
-
> PassportAuthUserGetSessionResponse passportAuthUserServicePassportAuthUserGetSession()
|
|
1103
|
-
|
|
1104
|
-
获取当前会话信息
|
|
1105
|
-
|
|
1106
|
-
### Example
|
|
1107
|
-
|
|
1108
|
-
```typescript
|
|
1109
|
-
import {
|
|
1110
|
-
PassportAuthUserServiceApi,
|
|
1111
|
-
Configuration
|
|
1112
|
-
} from '@cherryin/api-client';
|
|
1113
|
-
|
|
1114
|
-
const configuration = new Configuration();
|
|
1115
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1116
|
-
|
|
1117
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetSession();
|
|
1118
|
-
```
|
|
1119
|
-
|
|
1120
|
-
### Parameters
|
|
1121
|
-
This endpoint does not have any parameters.
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
### Return type
|
|
1125
|
-
|
|
1126
|
-
**PassportAuthUserGetSessionResponse**
|
|
1127
|
-
|
|
1128
|
-
### Authorization
|
|
1129
|
-
|
|
1130
|
-
No authorization required
|
|
1131
|
-
|
|
1132
|
-
### HTTP request headers
|
|
1133
|
-
|
|
1134
|
-
- **Content-Type**: Not defined
|
|
1135
|
-
- **Accept**: application/json
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
### HTTP response details
|
|
1139
|
-
| Status code | Description | Response headers |
|
|
1140
|
-
|-------------|-------------|------------------|
|
|
1141
|
-
|**200** | OK | - |
|
|
1142
|
-
|**0** | Default error response | - |
|
|
1143
|
-
|
|
1144
|
-
[[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)
|
|
1145
|
-
|
|
1146
|
-
# **passportAuthUserServicePassportAuthUserInfoGet**
|
|
1147
|
-
> PassportAuthUserInfoGetResponse passportAuthUserServicePassportAuthUserInfoGet()
|
|
1148
|
-
|
|
1149
|
-
获取用户信息
|
|
1150
|
-
|
|
1151
|
-
### Example
|
|
1152
|
-
|
|
1153
|
-
```typescript
|
|
1154
|
-
import {
|
|
1155
|
-
PassportAuthUserServiceApi,
|
|
1156
|
-
Configuration
|
|
1157
|
-
} from '@cherryin/api-client';
|
|
1158
|
-
|
|
1159
|
-
const configuration = new Configuration();
|
|
1160
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1161
|
-
|
|
1162
|
-
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
1163
|
-
|
|
1164
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserInfoGet(
|
|
1165
|
-
appIds
|
|
1166
|
-
);
|
|
1167
|
-
```
|
|
1168
|
-
|
|
1169
|
-
### Parameters
|
|
1170
|
-
|
|
1171
|
-
|Name | Type | Description | Notes|
|
|
1172
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1173
|
-
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
### Return type
|
|
1177
|
-
|
|
1178
|
-
**PassportAuthUserInfoGetResponse**
|
|
1179
|
-
|
|
1180
|
-
### Authorization
|
|
1181
|
-
|
|
1182
|
-
No authorization required
|
|
1183
|
-
|
|
1184
|
-
### HTTP request headers
|
|
1185
|
-
|
|
1186
|
-
- **Content-Type**: Not defined
|
|
1187
|
-
- **Accept**: application/json
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
### HTTP response details
|
|
1191
|
-
| Status code | Description | Response headers |
|
|
1192
|
-
|-------------|-------------|------------------|
|
|
1193
|
-
|**200** | OK | - |
|
|
1194
|
-
|**0** | Default error response | - |
|
|
1195
|
-
|
|
1196
|
-
[[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)
|
|
1197
|
-
|
|
1198
|
-
# **passportAuthUserServicePassportAuthUserSignOut**
|
|
1199
|
-
> PassportAuthUserSignOutResponse passportAuthUserServicePassportAuthUserSignOut(passportAuthUserSignOutRequest)
|
|
1200
|
-
|
|
1201
|
-
用户登出
|
|
1202
|
-
|
|
1203
|
-
### Example
|
|
1204
|
-
|
|
1205
|
-
```typescript
|
|
1206
|
-
import {
|
|
1207
|
-
PassportAuthUserServiceApi,
|
|
1208
|
-
Configuration,
|
|
1209
|
-
PassportAuthUserSignOutRequest
|
|
1210
|
-
} from '@cherryin/api-client';
|
|
1211
|
-
|
|
1212
|
-
const configuration = new Configuration();
|
|
1213
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1214
|
-
|
|
1215
|
-
let passportAuthUserSignOutRequest: PassportAuthUserSignOutRequest; //
|
|
1216
|
-
|
|
1217
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignOut(
|
|
1218
|
-
passportAuthUserSignOutRequest
|
|
1219
|
-
);
|
|
1220
|
-
```
|
|
1221
|
-
|
|
1222
|
-
### Parameters
|
|
1223
|
-
|
|
1224
|
-
|Name | Type | Description | Notes|
|
|
1225
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1226
|
-
| **passportAuthUserSignOutRequest** | **PassportAuthUserSignOutRequest**| | |
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
### Return type
|
|
1230
|
-
|
|
1231
|
-
**PassportAuthUserSignOutResponse**
|
|
1232
|
-
|
|
1233
|
-
### Authorization
|
|
1234
|
-
|
|
1235
|
-
No authorization required
|
|
1236
|
-
|
|
1237
|
-
### HTTP request headers
|
|
1238
|
-
|
|
1239
|
-
- **Content-Type**: application/json
|
|
1240
|
-
- **Accept**: application/json
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
### HTTP response details
|
|
1244
|
-
| Status code | Description | Response headers |
|
|
1245
|
-
|-------------|-------------|------------------|
|
|
1246
|
-
|**200** | OK | - |
|
|
1247
|
-
|**0** | Default error response | - |
|
|
1248
|
-
|
|
1249
|
-
[[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)
|
|
1250
|
-
|
|
1251
|
-
# **passportAuthUserServicePassportAuthUserUpdateInfo**
|
|
1252
|
-
> PassportAuthUserUpdateInfoResponse passportAuthUserServicePassportAuthUserUpdateInfo(passportAuthUserUpdateInfoRequest)
|
|
1253
|
-
|
|
1254
|
-
更新用户信息
|
|
1255
|
-
|
|
1256
|
-
### Example
|
|
1257
|
-
|
|
1258
|
-
```typescript
|
|
1259
|
-
import {
|
|
1260
|
-
PassportAuthUserServiceApi,
|
|
1261
|
-
Configuration,
|
|
1262
|
-
PassportAuthUserUpdateInfoRequest
|
|
1263
|
-
} from '@cherryin/api-client';
|
|
1264
|
-
|
|
1265
|
-
const configuration = new Configuration();
|
|
1266
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1267
|
-
|
|
1268
|
-
let passportAuthUserUpdateInfoRequest: PassportAuthUserUpdateInfoRequest; //
|
|
1269
|
-
|
|
1270
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdateInfo(
|
|
1271
|
-
passportAuthUserUpdateInfoRequest
|
|
1272
|
-
);
|
|
1273
|
-
```
|
|
1274
|
-
|
|
1275
|
-
### Parameters
|
|
1276
|
-
|
|
1277
|
-
|Name | Type | Description | Notes|
|
|
1278
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1279
|
-
| **passportAuthUserUpdateInfoRequest** | **PassportAuthUserUpdateInfoRequest**| | |
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
### Return type
|
|
1283
|
-
|
|
1284
|
-
**PassportAuthUserUpdateInfoResponse**
|
|
1285
|
-
|
|
1286
|
-
### Authorization
|
|
1287
|
-
|
|
1288
|
-
No authorization required
|
|
1289
|
-
|
|
1290
|
-
### HTTP request headers
|
|
1291
|
-
|
|
1292
|
-
- **Content-Type**: application/json
|
|
1293
|
-
- **Accept**: application/json
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
### HTTP response details
|
|
1297
|
-
| Status code | Description | Response headers |
|
|
1298
|
-
|-------------|-------------|------------------|
|
|
1299
|
-
|**200** | OK | - |
|
|
1300
|
-
|**0** | Default error response | - |
|
|
1301
|
-
|
|
1302
|
-
[[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)
|
|
1303
|
-
|
|
1304
|
-
# **passportAuthUserServicePassportAuthUserUpdatePassport**
|
|
1305
|
-
> PassportAuthUserUpdatePassportResponse passportAuthUserServicePassportAuthUserUpdatePassport(passportAuthUserUpdatePassportRequest)
|
|
1306
|
-
|
|
1307
|
-
更新通行证信息
|
|
1308
|
-
|
|
1309
|
-
### Example
|
|
1310
|
-
|
|
1311
|
-
```typescript
|
|
1312
|
-
import {
|
|
1313
|
-
PassportAuthUserServiceApi,
|
|
1314
|
-
Configuration,
|
|
1315
|
-
PassportAuthUserUpdatePassportRequest
|
|
1316
|
-
} from '@cherryin/api-client';
|
|
1317
|
-
|
|
1318
|
-
const configuration = new Configuration();
|
|
1319
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1320
|
-
|
|
1321
|
-
let passportAuthUserUpdatePassportRequest: PassportAuthUserUpdatePassportRequest; //
|
|
1322
|
-
|
|
1323
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdatePassport(
|
|
1324
|
-
passportAuthUserUpdatePassportRequest
|
|
1325
|
-
);
|
|
1326
|
-
```
|
|
1327
|
-
|
|
1328
|
-
### Parameters
|
|
1329
|
-
|
|
1330
|
-
|Name | Type | Description | Notes|
|
|
1331
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1332
|
-
| **passportAuthUserUpdatePassportRequest** | **PassportAuthUserUpdatePassportRequest**| | |
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
### Return type
|
|
1336
|
-
|
|
1337
|
-
**PassportAuthUserUpdatePassportResponse**
|
|
1338
|
-
|
|
1339
|
-
### Authorization
|
|
1340
|
-
|
|
1341
|
-
No authorization required
|
|
1342
|
-
|
|
1343
|
-
### HTTP request headers
|
|
1344
|
-
|
|
1345
|
-
- **Content-Type**: application/json
|
|
1346
|
-
- **Accept**: application/json
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
### HTTP response details
|
|
1350
|
-
| Status code | Description | Response headers |
|
|
1351
|
-
|-------------|-------------|------------------|
|
|
1352
|
-
|**200** | OK | - |
|
|
1353
|
-
|**0** | Default error response | - |
|
|
1354
|
-
|
|
1355
|
-
[[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)
|
|
1356
|
-
|
|
1357
|
-
# **passportAuthUserServicePassportAuthUserVerifyEmail**
|
|
1358
|
-
> PassportAuthUserVerifyEmailResponse passportAuthUserServicePassportAuthUserVerifyEmail(passportAuthUserVerifyEmailRequest)
|
|
1359
|
-
|
|
1360
|
-
已登录用户验证邮箱
|
|
1361
|
-
|
|
1362
|
-
### Example
|
|
1363
|
-
|
|
1364
|
-
```typescript
|
|
1365
|
-
import {
|
|
1366
|
-
PassportAuthUserServiceApi,
|
|
1367
|
-
Configuration,
|
|
1368
|
-
PassportAuthUserVerifyEmailRequest
|
|
1369
|
-
} from '@cherryin/api-client';
|
|
1370
|
-
|
|
1371
|
-
const configuration = new Configuration();
|
|
1372
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1373
|
-
|
|
1374
|
-
let passportAuthUserVerifyEmailRequest: PassportAuthUserVerifyEmailRequest; //
|
|
1375
|
-
|
|
1376
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyEmail(
|
|
1377
|
-
passportAuthUserVerifyEmailRequest
|
|
1378
|
-
);
|
|
1379
|
-
```
|
|
1380
|
-
|
|
1381
|
-
### Parameters
|
|
1382
|
-
|
|
1383
|
-
|Name | Type | Description | Notes|
|
|
1384
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1385
|
-
| **passportAuthUserVerifyEmailRequest** | **PassportAuthUserVerifyEmailRequest**| | |
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
### Return type
|
|
1389
|
-
|
|
1390
|
-
**PassportAuthUserVerifyEmailResponse**
|
|
1391
|
-
|
|
1392
|
-
### Authorization
|
|
1393
|
-
|
|
1394
|
-
No authorization required
|
|
1395
|
-
|
|
1396
|
-
### HTTP request headers
|
|
1397
|
-
|
|
1398
|
-
- **Content-Type**: application/json
|
|
1399
|
-
- **Accept**: application/json
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
### HTTP response details
|
|
1403
|
-
| Status code | Description | Response headers |
|
|
1404
|
-
|-------------|-------------|------------------|
|
|
1405
|
-
|**200** | OK | - |
|
|
1406
|
-
|**0** | Default error response | - |
|
|
1407
|
-
|
|
1408
|
-
[[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)
|
|
1409
|
-
|
|
1410
|
-
# **passportAuthUserServicePassportAuthUserVerifyPhone**
|
|
1411
|
-
> PassportAuthUserVerifyPhoneResponse passportAuthUserServicePassportAuthUserVerifyPhone(passportAuthUserVerifyPhoneRequest)
|
|
1412
|
-
|
|
1413
|
-
已登录用户验证手机号
|
|
1414
|
-
|
|
1415
|
-
### Example
|
|
1416
|
-
|
|
1417
|
-
```typescript
|
|
1418
|
-
import {
|
|
1419
|
-
PassportAuthUserServiceApi,
|
|
1420
|
-
Configuration,
|
|
1421
|
-
PassportAuthUserVerifyPhoneRequest
|
|
1422
|
-
} from '@cherryin/api-client';
|
|
1423
|
-
|
|
1424
|
-
const configuration = new Configuration();
|
|
1425
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1426
|
-
|
|
1427
|
-
let passportAuthUserVerifyPhoneRequest: PassportAuthUserVerifyPhoneRequest; //
|
|
1428
|
-
|
|
1429
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyPhone(
|
|
1430
|
-
passportAuthUserVerifyPhoneRequest
|
|
1431
|
-
);
|
|
1432
|
-
```
|
|
1433
|
-
|
|
1434
|
-
### Parameters
|
|
1435
|
-
|
|
1436
|
-
|Name | Type | Description | Notes|
|
|
1437
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1438
|
-
| **passportAuthUserVerifyPhoneRequest** | **PassportAuthUserVerifyPhoneRequest**| | |
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
### Return type
|
|
1442
|
-
|
|
1443
|
-
**PassportAuthUserVerifyPhoneResponse**
|
|
1444
|
-
|
|
1445
|
-
### Authorization
|
|
1446
|
-
|
|
1447
|
-
No authorization required
|
|
1448
|
-
|
|
1449
|
-
### HTTP request headers
|
|
1450
|
-
|
|
1451
|
-
- **Content-Type**: application/json
|
|
1452
|
-
- **Accept**: application/json
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
### HTTP response details
|
|
1456
|
-
| Status code | Description | Response headers |
|
|
1457
|
-
|-------------|-------------|------------------|
|
|
1458
|
-
|**200** | OK | - |
|
|
1459
|
-
|**0** | Default error response | - |
|
|
1460
|
-
|
|
1461
|
-
[[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)
|
|
1462
|
-
|
|
1463
|
-
# **passportAuthUserServicePassportSendVerificationEmail**
|
|
1464
|
-
> PassportSendVerificationEmailResponse passportAuthUserServicePassportSendVerificationEmail(passportSendVerificationEmailRequest)
|
|
1465
|
-
|
|
1466
|
-
登录/注册流程中发送验证码
|
|
1467
|
-
|
|
1468
|
-
### Example
|
|
1469
|
-
|
|
1470
|
-
```typescript
|
|
1471
|
-
import {
|
|
1472
|
-
PassportAuthUserServiceApi,
|
|
1473
|
-
Configuration,
|
|
1474
|
-
PassportSendVerificationEmailRequest
|
|
1475
|
-
} from '@cherryin/api-client';
|
|
1476
|
-
|
|
1477
|
-
const configuration = new Configuration();
|
|
1478
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1479
|
-
|
|
1480
|
-
let passportSendVerificationEmailRequest: PassportSendVerificationEmailRequest; //
|
|
1481
|
-
|
|
1482
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationEmail(
|
|
1483
|
-
passportSendVerificationEmailRequest
|
|
1484
|
-
);
|
|
1485
|
-
```
|
|
1486
|
-
|
|
1487
|
-
### Parameters
|
|
1488
|
-
|
|
1489
|
-
|Name | Type | Description | Notes|
|
|
1490
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1491
|
-
| **passportSendVerificationEmailRequest** | **PassportSendVerificationEmailRequest**| | |
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
### Return type
|
|
1495
|
-
|
|
1496
|
-
**PassportSendVerificationEmailResponse**
|
|
1497
|
-
|
|
1498
|
-
### Authorization
|
|
1499
|
-
|
|
1500
|
-
No authorization required
|
|
1501
|
-
|
|
1502
|
-
### HTTP request headers
|
|
1503
|
-
|
|
1504
|
-
- **Content-Type**: application/json
|
|
1505
|
-
- **Accept**: application/json
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
### HTTP response details
|
|
1509
|
-
| Status code | Description | Response headers |
|
|
1510
|
-
|-------------|-------------|------------------|
|
|
1511
|
-
|**200** | OK | - |
|
|
1512
|
-
|**0** | Default error response | - |
|
|
1513
|
-
|
|
1514
|
-
[[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)
|
|
1515
|
-
|
|
1516
|
-
# **passportAuthUserServicePassportSendVerificationPhone**
|
|
1517
|
-
> PassportSendVerificationPhoneResponse passportAuthUserServicePassportSendVerificationPhone(passportSendVerificationPhoneRequest)
|
|
1518
|
-
|
|
1519
|
-
登录/注册流程中发送验证码
|
|
1520
|
-
|
|
1521
|
-
### Example
|
|
1522
|
-
|
|
1523
|
-
```typescript
|
|
1524
|
-
import {
|
|
1525
|
-
PassportAuthUserServiceApi,
|
|
1526
|
-
Configuration,
|
|
1527
|
-
PassportSendVerificationPhoneRequest
|
|
1528
|
-
} from '@cherryin/api-client';
|
|
1529
|
-
|
|
1530
|
-
const configuration = new Configuration();
|
|
1531
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1532
|
-
|
|
1533
|
-
let passportSendVerificationPhoneRequest: PassportSendVerificationPhoneRequest; //
|
|
1534
|
-
|
|
1535
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationPhone(
|
|
1536
|
-
passportSendVerificationPhoneRequest
|
|
1537
|
-
);
|
|
1538
|
-
```
|
|
1539
|
-
|
|
1540
|
-
### Parameters
|
|
1541
|
-
|
|
1542
|
-
|Name | Type | Description | Notes|
|
|
1543
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1544
|
-
| **passportSendVerificationPhoneRequest** | **PassportSendVerificationPhoneRequest**| | |
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
### Return type
|
|
1548
|
-
|
|
1549
|
-
**PassportSendVerificationPhoneResponse**
|
|
1550
|
-
|
|
1551
|
-
### Authorization
|
|
1552
|
-
|
|
1553
|
-
No authorization required
|
|
1554
|
-
|
|
1555
|
-
### HTTP request headers
|
|
1556
|
-
|
|
1557
|
-
- **Content-Type**: application/json
|
|
1558
|
-
- **Accept**: application/json
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
### HTTP response details
|
|
1562
|
-
| Status code | Description | Response headers |
|
|
1563
|
-
|-------------|-------------|------------------|
|
|
1564
|
-
|**200** | OK | - |
|
|
1565
|
-
|**0** | Default error response | - |
|
|
1566
|
-
|
|
1567
|
-
[[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)
|
|
1568
|
-
|
|
1569
|
-
# **passportAuthUserServicePassportUserOAuthCallback**
|
|
1570
|
-
> PassportUserOAuthCallbackResponse passportAuthUserServicePassportUserOAuthCallback()
|
|
1571
|
-
|
|
1572
|
-
OAuth 回调处理
|
|
1573
|
-
|
|
1574
|
-
### Example
|
|
1575
|
-
|
|
1576
|
-
```typescript
|
|
1577
|
-
import {
|
|
1578
|
-
PassportAuthUserServiceApi,
|
|
1579
|
-
Configuration
|
|
1580
|
-
} from '@cherryin/api-client';
|
|
1581
|
-
|
|
1582
|
-
const configuration = new Configuration();
|
|
1583
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1584
|
-
|
|
1585
|
-
let platform: string; //@gotags: form:\"platform\" google/github (default to undefined)
|
|
1586
|
-
let appIds: string; //User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
1587
|
-
let code: string; //@gotags: form:\"code\" OAuth 授权码 (optional) (default to undefined)
|
|
1588
|
-
let state: string; //@gotags: form:\"state\" CSRF state (optional) (default to undefined)
|
|
1589
|
-
|
|
1590
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserOAuthCallback(
|
|
1591
|
-
platform,
|
|
1592
|
-
appIds,
|
|
1593
|
-
code,
|
|
1594
|
-
state
|
|
1595
|
-
);
|
|
1596
|
-
```
|
|
1597
|
-
|
|
1598
|
-
### Parameters
|
|
1599
|
-
|
|
1600
|
-
|Name | Type | Description | Notes|
|
|
1601
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1602
|
-
| **platform** | [**string**] | @gotags: form:\"platform\" google/github | defaults to undefined|
|
|
1603
|
-
| **appIds** | [**string**] | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
1604
|
-
| **code** | [**string**] | @gotags: form:\"code\" OAuth 授权码 | (optional) defaults to undefined|
|
|
1605
|
-
| **state** | [**string**] | @gotags: form:\"state\" CSRF state | (optional) defaults to undefined|
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
### Return type
|
|
1609
|
-
|
|
1610
|
-
**PassportUserOAuthCallbackResponse**
|
|
1611
|
-
|
|
1612
|
-
### Authorization
|
|
1613
|
-
|
|
1614
|
-
No authorization required
|
|
1615
|
-
|
|
1616
|
-
### HTTP request headers
|
|
1617
|
-
|
|
1618
|
-
- **Content-Type**: Not defined
|
|
1619
|
-
- **Accept**: application/json
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
### HTTP response details
|
|
1623
|
-
| Status code | Description | Response headers |
|
|
1624
|
-
|-------------|-------------|------------------|
|
|
1625
|
-
|**200** | OK | - |
|
|
1626
|
-
|**0** | Default error response | - |
|
|
1627
|
-
|
|
1628
|
-
[[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)
|
|
1629
|
-
|
|
1630
|
-
# **passportAuthUserServicePassportUserPasswordForget**
|
|
1631
|
-
> PassportUserPasswordForgetResponse passportAuthUserServicePassportUserPasswordForget(passportUserPasswordForgetRequest)
|
|
1632
|
-
|
|
1633
|
-
未登录 - 用户遗忘密码请求重置
|
|
1634
|
-
|
|
1635
|
-
### Example
|
|
1636
|
-
|
|
1637
|
-
```typescript
|
|
1638
|
-
import {
|
|
1639
|
-
PassportAuthUserServiceApi,
|
|
1640
|
-
Configuration,
|
|
1641
|
-
PassportUserPasswordForgetRequest
|
|
1642
|
-
} from '@cherryin/api-client';
|
|
1643
|
-
|
|
1644
|
-
const configuration = new Configuration();
|
|
1645
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1646
|
-
|
|
1647
|
-
let passportUserPasswordForgetRequest: PassportUserPasswordForgetRequest; //
|
|
1648
|
-
|
|
1649
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordForget(
|
|
1650
|
-
passportUserPasswordForgetRequest
|
|
1651
|
-
);
|
|
1652
|
-
```
|
|
1653
|
-
|
|
1654
|
-
### Parameters
|
|
1655
|
-
|
|
1656
|
-
|Name | Type | Description | Notes|
|
|
1657
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1658
|
-
| **passportUserPasswordForgetRequest** | **PassportUserPasswordForgetRequest**| | |
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
### Return type
|
|
1662
|
-
|
|
1663
|
-
**PassportUserPasswordForgetResponse**
|
|
1664
|
-
|
|
1665
|
-
### Authorization
|
|
1666
|
-
|
|
1667
|
-
No authorization required
|
|
1668
|
-
|
|
1669
|
-
### HTTP request headers
|
|
1670
|
-
|
|
1671
|
-
- **Content-Type**: application/json
|
|
1672
|
-
- **Accept**: application/json
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
### HTTP response details
|
|
1676
|
-
| Status code | Description | Response headers |
|
|
1677
|
-
|-------------|-------------|------------------|
|
|
1678
|
-
|**200** | OK | - |
|
|
1679
|
-
|**0** | Default error response | - |
|
|
1680
|
-
|
|
1681
|
-
[[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)
|
|
1682
|
-
|
|
1683
|
-
# **passportAuthUserServicePassportUserPasswordReset**
|
|
1684
|
-
> PassportUserPasswordResetResponse passportAuthUserServicePassportUserPasswordReset(passportUserPasswordResetRequest)
|
|
1685
|
-
|
|
1686
|
-
未登录 - 用户重置密码
|
|
1687
|
-
|
|
1688
|
-
### Example
|
|
1689
|
-
|
|
1690
|
-
```typescript
|
|
1691
|
-
import {
|
|
1692
|
-
PassportAuthUserServiceApi,
|
|
1693
|
-
Configuration,
|
|
1694
|
-
PassportUserPasswordResetRequest
|
|
1695
|
-
} from '@cherryin/api-client';
|
|
1696
|
-
|
|
1697
|
-
const configuration = new Configuration();
|
|
1698
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1699
|
-
|
|
1700
|
-
let passportUserPasswordResetRequest: PassportUserPasswordResetRequest; //
|
|
1701
|
-
|
|
1702
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordReset(
|
|
1703
|
-
passportUserPasswordResetRequest
|
|
1704
|
-
);
|
|
1705
|
-
```
|
|
1706
|
-
|
|
1707
|
-
### Parameters
|
|
1708
|
-
|
|
1709
|
-
|Name | Type | Description | Notes|
|
|
1710
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1711
|
-
| **passportUserPasswordResetRequest** | **PassportUserPasswordResetRequest**| | |
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
### Return type
|
|
1715
|
-
|
|
1716
|
-
**PassportUserPasswordResetResponse**
|
|
1717
|
-
|
|
1718
|
-
### Authorization
|
|
1719
|
-
|
|
1720
|
-
No authorization required
|
|
1721
|
-
|
|
1722
|
-
### HTTP request headers
|
|
1723
|
-
|
|
1724
|
-
- **Content-Type**: application/json
|
|
1725
|
-
- **Accept**: application/json
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
### HTTP response details
|
|
1729
|
-
| Status code | Description | Response headers |
|
|
1730
|
-
|-------------|-------------|------------------|
|
|
1731
|
-
|**200** | OK | - |
|
|
1732
|
-
|**0** | Default error response | - |
|
|
1733
|
-
|
|
1734
|
-
[[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)
|
|
1735
|
-
|
|
1736
|
-
# **passportAuthUserServicePassportUserPasswordResetTokenVerify**
|
|
1737
|
-
> PassportUserPasswordResetTokenVerifyResponse passportAuthUserServicePassportUserPasswordResetTokenVerify(passportUserPasswordResetTokenVerifyRequest)
|
|
1738
|
-
|
|
1739
|
-
未登录 - 验证重置密码请求 token
|
|
1740
|
-
|
|
1741
|
-
### Example
|
|
1742
|
-
|
|
1743
|
-
```typescript
|
|
1744
|
-
import {
|
|
1745
|
-
PassportAuthUserServiceApi,
|
|
1746
|
-
Configuration,
|
|
1747
|
-
PassportUserPasswordResetTokenVerifyRequest
|
|
1748
|
-
} from '@cherryin/api-client';
|
|
1749
|
-
|
|
1750
|
-
const configuration = new Configuration();
|
|
1751
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1752
|
-
|
|
1753
|
-
let passportUserPasswordResetTokenVerifyRequest: PassportUserPasswordResetTokenVerifyRequest; //
|
|
1754
|
-
|
|
1755
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordResetTokenVerify(
|
|
1756
|
-
passportUserPasswordResetTokenVerifyRequest
|
|
1757
|
-
);
|
|
1758
|
-
```
|
|
1759
|
-
|
|
1760
|
-
### Parameters
|
|
1761
|
-
|
|
1762
|
-
|Name | Type | Description | Notes|
|
|
1763
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1764
|
-
| **passportUserPasswordResetTokenVerifyRequest** | **PassportUserPasswordResetTokenVerifyRequest**| | |
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
### Return type
|
|
1768
|
-
|
|
1769
|
-
**PassportUserPasswordResetTokenVerifyResponse**
|
|
1770
|
-
|
|
1771
|
-
### Authorization
|
|
1772
|
-
|
|
1773
|
-
No authorization required
|
|
1774
|
-
|
|
1775
|
-
### HTTP request headers
|
|
1776
|
-
|
|
1777
|
-
- **Content-Type**: application/json
|
|
1778
|
-
- **Accept**: application/json
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
### HTTP response details
|
|
1782
|
-
| Status code | Description | Response headers |
|
|
1783
|
-
|-------------|-------------|------------------|
|
|
1784
|
-
|**200** | OK | - |
|
|
1785
|
-
|**0** | Default error response | - |
|
|
1786
|
-
|
|
1787
|
-
[[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)
|
|
1788
|
-
|
|
1789
|
-
# **passportAuthUserServicePassportUserSignInEmail**
|
|
1790
|
-
> PassportUserSignInEmailResponse passportAuthUserServicePassportUserSignInEmail(passportUserSignInEmailRequest)
|
|
1791
|
-
|
|
1792
|
-
邮箱登录
|
|
1793
|
-
|
|
1794
|
-
### Example
|
|
1795
|
-
|
|
1796
|
-
```typescript
|
|
1797
|
-
import {
|
|
1798
|
-
PassportAuthUserServiceApi,
|
|
1799
|
-
Configuration,
|
|
1800
|
-
PassportUserSignInEmailRequest
|
|
1801
|
-
} from '@cherryin/api-client';
|
|
1802
|
-
|
|
1803
|
-
const configuration = new Configuration();
|
|
1804
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1805
|
-
|
|
1806
|
-
let passportUserSignInEmailRequest: PassportUserSignInEmailRequest; //
|
|
1807
|
-
|
|
1808
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInEmail(
|
|
1809
|
-
passportUserSignInEmailRequest
|
|
1810
|
-
);
|
|
1811
|
-
```
|
|
1812
|
-
|
|
1813
|
-
### Parameters
|
|
1814
|
-
|
|
1815
|
-
|Name | Type | Description | Notes|
|
|
1816
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1817
|
-
| **passportUserSignInEmailRequest** | **PassportUserSignInEmailRequest**| | |
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
### Return type
|
|
1821
|
-
|
|
1822
|
-
**PassportUserSignInEmailResponse**
|
|
1823
|
-
|
|
1824
|
-
### Authorization
|
|
1825
|
-
|
|
1826
|
-
No authorization required
|
|
1827
|
-
|
|
1828
|
-
### HTTP request headers
|
|
1829
|
-
|
|
1830
|
-
- **Content-Type**: application/json
|
|
1831
|
-
- **Accept**: application/json
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
### HTTP response details
|
|
1835
|
-
| Status code | Description | Response headers |
|
|
1836
|
-
|-------------|-------------|------------------|
|
|
1837
|
-
|**200** | OK | - |
|
|
1838
|
-
|**0** | Default error response | - |
|
|
1839
|
-
|
|
1840
|
-
[[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)
|
|
1841
|
-
|
|
1842
|
-
# **passportAuthUserServicePassportUserSignInPhone**
|
|
1843
|
-
> PassportUserSignInPhoneResponse passportAuthUserServicePassportUserSignInPhone(passportUserSignInPhoneRequest)
|
|
1844
|
-
|
|
1845
|
-
手机登录
|
|
1846
|
-
|
|
1847
|
-
### Example
|
|
1848
|
-
|
|
1849
|
-
```typescript
|
|
1850
|
-
import {
|
|
1851
|
-
PassportAuthUserServiceApi,
|
|
1852
|
-
Configuration,
|
|
1853
|
-
PassportUserSignInPhoneRequest
|
|
1854
|
-
} from '@cherryin/api-client';
|
|
1855
|
-
|
|
1856
|
-
const configuration = new Configuration();
|
|
1857
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1858
|
-
|
|
1859
|
-
let passportUserSignInPhoneRequest: PassportUserSignInPhoneRequest; //
|
|
1860
|
-
|
|
1861
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInPhone(
|
|
1862
|
-
passportUserSignInPhoneRequest
|
|
1863
|
-
);
|
|
1864
|
-
```
|
|
1865
|
-
|
|
1866
|
-
### Parameters
|
|
1867
|
-
|
|
1868
|
-
|Name | Type | Description | Notes|
|
|
1869
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1870
|
-
| **passportUserSignInPhoneRequest** | **PassportUserSignInPhoneRequest**| | |
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
### Return type
|
|
1874
|
-
|
|
1875
|
-
**PassportUserSignInPhoneResponse**
|
|
1876
|
-
|
|
1877
|
-
### Authorization
|
|
1878
|
-
|
|
1879
|
-
No authorization required
|
|
1880
|
-
|
|
1881
|
-
### HTTP request headers
|
|
1882
|
-
|
|
1883
|
-
- **Content-Type**: application/json
|
|
1884
|
-
- **Accept**: application/json
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
### HTTP response details
|
|
1888
|
-
| Status code | Description | Response headers |
|
|
1889
|
-
|-------------|-------------|------------------|
|
|
1890
|
-
|**200** | OK | - |
|
|
1891
|
-
|**0** | Default error response | - |
|
|
1892
|
-
|
|
1893
|
-
[[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)
|
|
1894
|
-
|
|
1895
|
-
# **passportAuthUserServicePassportUserSignInSocial**
|
|
1896
|
-
> PassportUserSignInSocialResponse passportAuthUserServicePassportUserSignInSocial(passportUserSignInSocialRequest)
|
|
1897
|
-
|
|
1898
|
-
社交登录
|
|
1899
|
-
|
|
1900
|
-
### Example
|
|
1901
|
-
|
|
1902
|
-
```typescript
|
|
1903
|
-
import {
|
|
1904
|
-
PassportAuthUserServiceApi,
|
|
1905
|
-
Configuration,
|
|
1906
|
-
PassportUserSignInSocialRequest
|
|
1907
|
-
} from '@cherryin/api-client';
|
|
1908
|
-
|
|
1909
|
-
const configuration = new Configuration();
|
|
1910
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1911
|
-
|
|
1912
|
-
let passportUserSignInSocialRequest: PassportUserSignInSocialRequest; //
|
|
1913
|
-
|
|
1914
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInSocial(
|
|
1915
|
-
passportUserSignInSocialRequest
|
|
1916
|
-
);
|
|
1917
|
-
```
|
|
1918
|
-
|
|
1919
|
-
### Parameters
|
|
1920
|
-
|
|
1921
|
-
|Name | Type | Description | Notes|
|
|
1922
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1923
|
-
| **passportUserSignInSocialRequest** | **PassportUserSignInSocialRequest**| | |
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
### Return type
|
|
1927
|
-
|
|
1928
|
-
**PassportUserSignInSocialResponse**
|
|
1929
|
-
|
|
1930
|
-
### Authorization
|
|
1931
|
-
|
|
1932
|
-
No authorization required
|
|
1933
|
-
|
|
1934
|
-
### HTTP request headers
|
|
1935
|
-
|
|
1936
|
-
- **Content-Type**: application/json
|
|
1937
|
-
- **Accept**: application/json
|
|
1938
|
-
|
|
1939
|
-
|
|
1940
|
-
### HTTP response details
|
|
1941
|
-
| Status code | Description | Response headers |
|
|
1942
|
-
|-------------|-------------|------------------|
|
|
1943
|
-
|**200** | OK | - |
|
|
1944
|
-
|**0** | Default error response | - |
|
|
1945
|
-
|
|
1946
|
-
[[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)
|
|
1947
|
-
|
|
1948
|
-
# **passportAuthUserServicePassportUserSignUpEmail**
|
|
1949
|
-
> PassportUserSignUpEmailResponse passportAuthUserServicePassportUserSignUpEmail(passportUserSignUpEmailRequest)
|
|
1950
|
-
|
|
1951
|
-
邮箱注册
|
|
1952
|
-
|
|
1953
|
-
### Example
|
|
1954
|
-
|
|
1955
|
-
```typescript
|
|
1956
|
-
import {
|
|
1957
|
-
PassportAuthUserServiceApi,
|
|
1958
|
-
Configuration,
|
|
1959
|
-
PassportUserSignUpEmailRequest
|
|
1960
|
-
} from '@cherryin/api-client';
|
|
1961
|
-
|
|
1962
|
-
const configuration = new Configuration();
|
|
1963
|
-
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1964
|
-
|
|
1965
|
-
let passportUserSignUpEmailRequest: PassportUserSignUpEmailRequest; //
|
|
1966
|
-
|
|
1967
|
-
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignUpEmail(
|
|
1968
|
-
passportUserSignUpEmailRequest
|
|
1969
|
-
);
|
|
1970
|
-
```
|
|
1971
|
-
|
|
1972
|
-
### Parameters
|
|
1973
|
-
|
|
1974
|
-
|Name | Type | Description | Notes|
|
|
1975
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1976
|
-
| **passportUserSignUpEmailRequest** | **PassportUserSignUpEmailRequest**| | |
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
### Return type
|
|
1980
|
-
|
|
1981
|
-
**PassportUserSignUpEmailResponse**
|
|
1982
|
-
|
|
1983
|
-
### Authorization
|
|
1984
|
-
|
|
1985
|
-
No authorization required
|
|
1986
|
-
|
|
1987
|
-
### HTTP request headers
|
|
1988
|
-
|
|
1989
|
-
- **Content-Type**: application/json
|
|
1990
|
-
- **Accept**: application/json
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
### HTTP response details
|
|
1994
|
-
| Status code | Description | Response headers |
|
|
1995
|
-
|-------------|-------------|------------------|
|
|
1996
|
-
|**200** | OK | - |
|
|
1997
|
-
|**0** | Default error response | - |
|
|
1998
|
-
|
|
1999
|
-
[[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)
|
|
2000
|
-
|