@cherryin/api-client 0.0.17 → 0.0.19

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/PassportUserPasswordForgetResponse.md

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

@@ -0,0 +1,26 @@
+# PassportUserPasswordResetTokenVerifyResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserPasswordResetTokenVerifyResponse } from '@cherryin/api-client';
+
+const instance: PassportUserPasswordResetTokenVerifyResponse = {
+    code,
+    message,
+    email,
+    verify_code,
+};
+```
+
+[[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/UserAPIKeyServiceApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *http://localhost*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**userAPIKeyServiceUserAPIKeyCreate**](#userapikeyserviceuserapikeycreate) | **POST** /api/v1/user/api-key/create | |
-|[**userAPIKeyServiceUserAPIKeyDelete**](#userapikeyserviceuserapikeydelete) | **POST** /api/v1/user/api-key/delete | |
+|[**userAPIKeyServiceUserAPIKeyDelete**](#userapikeyserviceuserapikeydelete) | **DELETE** /api/v1/user/api-key/delete | |
 |[**userAPIKeyServiceUserAPIKeyGet**](#userapikeyserviceuserapikeyget) | **GET** /api/v1/user/api-key/get | |
 |[**userAPIKeyServiceUserAPIKeyList**](#userapikeyserviceuserapikeylist) | **GET** /api/v1/user/api-key/list | |
 |[**userAPIKeyServiceUserAPIKeyUpdate**](#userapikeyserviceuserapikeyupdate) | **POST** /api/v1/user/api-key/update | |
@@ -64,7 +64,7 @@ No authorization required
 [[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)
 
 # **userAPIKeyServiceUserAPIKeyDelete**
-> UserAPIKeyDeleteResponse userAPIKeyServiceUserAPIKeyDelete(userAPIKeyDeleteRequest)
+> UserAPIKeyDeleteResponse userAPIKeyServiceUserAPIKeyDelete()
 
 UserAPIKeyDelete 删除 UserAPIKey（软删除）  Delete a UserAPIKey (soft delete)   请求路径: POST /api/user/api-key/delete  Request path: POST /api/user/api-key/delete   权限要求: 需要用户认证  Permission: Requires user authentication
 
@@ -73,17 +73,16 @@ UserAPIKeyDelete 删除 UserAPIKey（软删除）  Delete a UserAPIKey (soft del
 ```typescript
 import {
     UserAPIKeyServiceApi,
-    Configuration,
-    UserAPIKeyDeleteRequest
+    Configuration
 } from '@cherryin/api-client';
 
 const configuration = new Configuration();
 const apiInstance = new UserAPIKeyServiceApi(configuration);
 
-let userAPIKeyDeleteRequest: UserAPIKeyDeleteRequest; //
+let id: string; //id 要删除的 UserAPIKey 的唯一标识符  Unique identifier of the UserAPIKey to delete  @gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
 
 const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyDelete(
-    userAPIKeyDeleteRequest
+    id
 );
 ```
 
@@ -91,7 +90,7 @@ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyDelete(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **userAPIKeyDeleteRequest** | **UserAPIKeyDeleteRequest**|  | |
+| **id** | [**string**] | id 要删除的 UserAPIKey 的唯一标识符  Unique identifier of the UserAPIKey to delete  @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
 
 
 ### Return type
@@ -104,7 +103,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 

package/package.json

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

package/docs/UserAPIKeyDeleteRequest.md

@@ -1,21 +0,0 @@
-# UserAPIKeyDeleteRequest
-
-UserAPIKeyDeleteRequest 删除 UserAPIKey 的请求  Request message for deleting a UserAPIKey
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id 要删除的 UserAPIKey 的唯一标识符  Unique identifier of the UserAPIKey to delete  @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UserAPIKeyDeleteRequest } from '@cherryin/api-client';
-
-const instance: UserAPIKeyDeleteRequest = {
-    id,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)