@cherryin/api-client 0.0.16 → 0.0.18

package/docs/PassportAuthUserServiceApi.md

@@ -34,7 +34,9 @@ All URIs are relative to *http://localhost*
 |[**passportAuthUserServicePassportSendVerificationEmail**](#passportauthuserservicepassportsendverificationemail) | **POST** /passport/auth/v1/verification/send-email | |
 |[**passportAuthUserServicePassportSendVerificationPhone**](#passportauthuserservicepassportsendverificationphone) | **POST** /passport/auth/v1/verification/send-phone | |
 |[**passportAuthUserServicePassportUserOAuthCallback**](#passportauthuserservicepassportuseroauthcallback) | **GET** /passport/oauth2/{platform}/callback | |
+|[**passportAuthUserServicePassportUserPasswordForget**](#passportauthuserservicepassportuserpasswordforget) | **POST** /passport/auth/v1/password/forget | |
 |[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/reset | |
+|[**passportAuthUserServicePassportUserPasswordResetTokenVerify**](#passportauthuserservicepassportuserpasswordresettokenverify) | **POST** /passport/auth/v1/password/reset-token | |
 |[**passportAuthUserServicePassportUserSignInEmail**](#passportauthuserservicepassportusersigninemail) | **POST** /passport/auth/v1/sign-in/email | |
 |[**passportAuthUserServicePassportUserSignInPhone**](#passportauthuserservicepassportusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
 |[**passportAuthUserServicePassportUserSignInSocial**](#passportauthuserservicepassportusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
@@ -1617,6 +1619,59 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **passportAuthUserServicePassportUserPasswordForget**
+> PassportUserPasswordForgetResponse passportAuthUserServicePassportUserPasswordForget(passportUserPasswordForgetRequest)
+
+未登录 - 用户遗忘密码请求重置
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserPasswordForgetRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserPasswordForgetRequest: PassportUserPasswordForgetRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordForget(
+    passportUserPasswordForgetRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserPasswordForgetRequest** | **PassportUserPasswordForgetRequest**|  | |
+
+
+### Return type
+
+**PassportUserPasswordForgetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -1628,7 +1683,7 @@ No authorization required
 # **passportAuthUserServicePassportUserPasswordReset**
 > PassportUserPasswordResetResponse passportAuthUserServicePassportUserPasswordReset(passportUserPasswordResetRequest)
 
-请求重置密码
+未登录 - 用户重置密码
 
 ### Example
 
@@ -1670,6 +1725,59 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **passportAuthUserServicePassportUserPasswordResetTokenVerify**
+> PassportUserPasswordResetTokenVerifyResponse passportAuthUserServicePassportUserPasswordResetTokenVerify(passportUserPasswordResetTokenVerifyRequest)
+
+未登录 - 验证重置密码请求 token
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserPasswordResetTokenVerifyRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserPasswordResetTokenVerifyRequest: PassportUserPasswordResetTokenVerifyRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordResetTokenVerify(
+    passportUserPasswordResetTokenVerifyRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserPasswordResetTokenVerifyRequest** | **PassportUserPasswordResetTokenVerifyRequest**|  | |
+
+
+### Return type
+
+**PassportUserPasswordResetTokenVerifyResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/PassportUserPasswordForgetRequest.md

@@ -0,0 +1,24 @@
+# PassportUserPasswordForgetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** | 注意是前端回调地址，用于用户邮箱点击跳转前端重置密码页 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserPasswordForgetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserPasswordForgetRequest = {
+    app_ids,
+    email,
+    callback_url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{AuthSignOutResponse.md → PassportUserPasswordForgetResponse.md}

@@ -1,4 +1,4 @@
-# AuthSignOutResponse
+# PassportUserPasswordForgetResponse
 
 
 ## Properties
@@ -7,17 +7,15 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**success** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthSignOutResponse } from '@cherryin/api-client';
+import { PassportUserPasswordForgetResponse } from '@cherryin/api-client';
 
-const instance: AuthSignOutResponse = {
+const instance: PassportUserPasswordForgetResponse = {
     code,
     message,
-    success,
 };
 ```
 

package/docs/PassportUserPasswordResetRequest.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
 **email** | **string** |  | [optional] [default to undefined]
 **verify_code** | **string** |  | [optional] [default to undefined]
+**new_password** | **string** |  | [optional] [default to undefined]
 **redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
 **callback_url** | **string** |  | [optional] [default to undefined]
 
@@ -20,6 +21,7 @@ const instance: PassportUserPasswordResetRequest = {
     app_ids,
     email,
     verify_code,
+    new_password,
     redirect,
     callback_url,
 };

package/docs/PassportUserPasswordResetTokenVerifyRequest.md

@@ -0,0 +1,22 @@
+# PassportUserPasswordResetTokenVerifyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**token** | **string** | 重置密码请求重置的 token | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserPasswordResetTokenVerifyRequest } from '@cherryin/api-client';
+
+const instance: PassportUserPasswordResetTokenVerifyRequest = {
+    app_ids,
+    token,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{AuthAdminSignOutResponse.md → PassportUserPasswordResetTokenVerifyResponse.md}

@@ -1,4 +1,4 @@
-# AuthAdminSignOutResponse
+# PassportUserPasswordResetTokenVerifyResponse
 
 
 ## Properties
@@ -7,17 +7,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**success** | **boolean** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthAdminSignOutResponse } from '@cherryin/api-client';
+import { PassportUserPasswordResetTokenVerifyResponse } from '@cherryin/api-client';
 
-const instance: AuthAdminSignOutResponse = {
+const instance: PassportUserPasswordResetTokenVerifyResponse = {
     code,
     message,
-    success,
+    email,
+    verify_code,
 };
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cherryin/api-client",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "OpenAPI client for @cherryin/api-client",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/Auth2Account.md

@@ -1,33 +0,0 @@
-# Auth2Account
-
-关联账号信息 (映射 db.UserAuthMethod)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**account_id** | **string** |  | [optional] [default to undefined]
-**provider_id** | **string** |  | [optional] [default to undefined]
-**user_id** | **string** |  | [optional] [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-**updated_at** | **string** |  | [optional] [default to undefined]
-**scopes** | **Array<string>** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Auth2Account } from '@cherryin/api-client';
-
-const instance: Auth2Account = {
-    id,
-    account_id,
-    provider_id,
-    user_id,
-    created_at,
-    updated_at,
-    scopes,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Auth2Admin.md

@@ -1,33 +0,0 @@
-# Auth2Admin
-
-管理员用户信息 (映射 db.User，包含角色信息)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**image** | **string** |  | [optional] [default to undefined]
-**role** | **number** |  | [optional] [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-**updated_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Auth2Admin } from '@cherryin/api-client';
-
-const instance: Auth2Admin = {
-    id,
-    name,
-    email,
-    image,
-    role,
-    created_at,
-    updated_at,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)