@cherryin/api-client 0.0.9 → 0.0.10

package/docs/PassportAuthEnterpriseSignOutRequest.md

@@ -0,0 +1,20 @@
+# PassportAuthEnterpriseSignOutRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sign_out_all** | **boolean** | 如果为 true，则登出所有应用的所有会话 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthEnterpriseSignOutRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthEnterpriseSignOutRequest = {
+    sign_out_all,
+};
+```
+
+[[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/{PassportAuthUserUnlinkAccountResponse.md → PassportAuthEnterpriseSignOutResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserUnlinkAccountResponse
+# PassportAuthEnterpriseSignOutResponse
 
 
 ## Properties
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserUnlinkAccountResponse } from '@cherryin/api-client';
+import { PassportAuthEnterpriseSignOutResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserUnlinkAccountResponse = {
+const instance: PassportAuthEnterpriseSignOutResponse = {
     code,
     message,
 };

package/docs/PassportAuthEnterpriseUpdateInfoRequest.md

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

@@ -1,4 +1,4 @@
-# PassportAuthUserChangePasswordResponse
+# PassportAuthEnterpriseUpdateInfoResponse
 
 
 ## Properties
@@ -7,18 +7,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**token** | **string** |  | [optional] [default to undefined]
 **users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { PassportAuthUserChangePasswordResponse } from '@cherryin/api-client';
+import { PassportAuthEnterpriseUpdateInfoResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserChangePasswordResponse = {
+const instance: PassportAuthEnterpriseUpdateInfoResponse = {
     code,
     message,
-    token,
     users,
 };
 ```

package/docs/PassportAuthEnterpriseVerifyEmailRequest.md

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

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

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

@@ -1,4 +1,4 @@
-# PassportAuthUserGetPassportInfoResponse
+# PassportAuthInfoGetResponse
 
 
 ## Properties
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserGetPassportInfoResponse } from '@cherryin/api-client';
+import { PassportAuthInfoGetResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserGetPassportInfoResponse = {
+const instance: PassportAuthInfoGetResponse = {
     code,
     message,
     passport,

package/docs/{PassportAuthUserLinkSocialRequest.md → PassportAuthLinkSocialRequest.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserLinkSocialRequest
+# PassportAuthLinkSocialRequest
 
 
 ## Properties
@@ -16,9 +16,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserLinkSocialRequest } from '@cherryin/api-client';
+import { PassportAuthLinkSocialRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserLinkSocialRequest = {
+const instance: PassportAuthLinkSocialRequest = {
     app_ids,
     provider,
     callback_url,

package/docs/{PassportAuthUserLinkSocialResponse.md → PassportAuthLinkSocialResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserLinkSocialResponse
+# PassportAuthLinkSocialResponse
 
 
 ## Properties
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserLinkSocialResponse } from '@cherryin/api-client';
+import { PassportAuthLinkSocialResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserLinkSocialResponse = {
+const instance: PassportAuthLinkSocialResponse = {
     code,
     message,
     url,

package/docs/{PassportAuthUserListMethodsResponse.md → PassportAuthListMethodsResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserListMethodsResponse
+# PassportAuthListMethodsResponse
 
 
 ## Properties
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserListMethodsResponse } from '@cherryin/api-client';
+import { PassportAuthListMethodsResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserListMethodsResponse = {
+const instance: PassportAuthListMethodsResponse = {
     code,
     message,
     auth_methods,

package/docs/{PassportAuthUserListSessionsResponse.md → PassportAuthListSessionsResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserListSessionsResponse
+# PassportAuthListSessionsResponse
 
 
 ## Properties
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserListSessionsResponse } from '@cherryin/api-client';
+import { PassportAuthListSessionsResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserListSessionsResponse = {
+const instance: PassportAuthListSessionsResponse = {
     code,
     message,
     sessions,

package/docs/{PassportAuthUserListAccountsResponse.md → PassportAuthListSocialsResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserListAccountsResponse
+# PassportAuthListSocialsResponse
 
 
 ## Properties
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserListAccountsResponse } from '@cherryin/api-client';
+import { PassportAuthListSocialsResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserListAccountsResponse = {
+const instance: PassportAuthListSocialsResponse = {
     code,
     message,
     auth_methods,

package/docs/PassportAuthRefreshSessionTokenRequest.md

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

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

@@ -1,4 +1,4 @@
-# PassportAuthUserResetPasswordRequest
+# PassportAuthResetPasswordRequest
 
 
 ## Properties
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
 **new_password** | **string** |  | [optional] [default to undefined]
-**token** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { PassportAuthUserResetPasswordRequest } from '@cherryin/api-client';
+import { PassportAuthResetPasswordRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserResetPasswordRequest = {
+const instance: PassportAuthResetPasswordRequest = {
     app_ids,
     new_password,
-    token,
+    verify_code,
 };
 ```
 

package/docs/PassportAuthResetPasswordResponse.md

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

@@ -1,4 +1,4 @@
-# PassportAuthUserRevokeOtherSessionsRequest
+# PassportAuthRevokeOtherSessionsRequest
 
 
 ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserRevokeOtherSessionsRequest } from '@cherryin/api-client';
+import { PassportAuthRevokeOtherSessionsRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserRevokeOtherSessionsRequest = {
+const instance: PassportAuthRevokeOtherSessionsRequest = {
     app_ids,
 };
 ```

package/docs/{PassportAuthUserDeleteUserResponse.md → PassportAuthRevokeOtherSessionsResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserDeleteUserResponse
+# PassportAuthRevokeOtherSessionsResponse
 
 
 ## Properties
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserDeleteUserResponse } from '@cherryin/api-client';
+import { PassportAuthRevokeOtherSessionsResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserDeleteUserResponse = {
+const instance: PassportAuthRevokeOtherSessionsResponse = {
     code,
     message,
     success,

package/docs/{PassportAuthUserRevokeSessionRequest.md → PassportAuthRevokeSessionRequest.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserRevokeSessionRequest
+# PassportAuthRevokeSessionRequest
 
 
 ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserRevokeSessionRequest } from '@cherryin/api-client';
+import { PassportAuthRevokeSessionRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserRevokeSessionRequest = {
+const instance: PassportAuthRevokeSessionRequest = {
     token,
 };
 ```

package/docs/PassportAuthRevokeSessionResponse.md

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

@@ -1,4 +1,4 @@
-# PassportAuthUserRevokeSessionsRequest
+# PassportAuthRevokeSessionsRequest
 
 
 ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserRevokeSessionsRequest } from '@cherryin/api-client';
+import { PassportAuthRevokeSessionsRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserRevokeSessionsRequest = {
+const instance: PassportAuthRevokeSessionsRequest = {
     app_ids,
 };
 ```

package/docs/PassportAuthRevokeSessionsResponse.md

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

@@ -0,0 +1,26 @@
+# PassportAuthSendVerificationEmailRequest
+
+
+## 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]
+**purpose** | **string** | 验证目的，可选值：verify_email（验证邮箱），change_email（更换邮箱） | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthSendVerificationEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthSendVerificationEmailRequest = {
+    app_ids,
+    email,
+    callback_url,
+    purpose,
+};
+```
+
+[[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/PassportAuthSendVerificationEmailResponse.md

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

@@ -0,0 +1,26 @@
+# PassportAuthSendVerificationPhoneRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**purpose** | **string** | 验证目的，可选值：verify_phone（验证手机号），change_phone（更换手机号） | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthSendVerificationPhoneRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthSendVerificationPhoneRequest = {
+    app_ids,
+    phone,
+    callback_url,
+    purpose,
+};
+```
+
+[[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/PassportAuthSendVerificationPhoneResponse.md

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

@@ -1,4 +1,4 @@
-# PassportAuthUserRefreshTokenRequest
+# PassportAuthSocialGetAccessTokenRequest
 
 
 ## Properties
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserRefreshTokenRequest } from '@cherryin/api-client';
+import { PassportAuthSocialGetAccessTokenRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserRefreshTokenRequest = {
+const instance: PassportAuthSocialGetAccessTokenRequest = {
     provider_id,
     account_id,
     user_id,

package/docs/{PassportAuthUserRefreshTokenResponse.md → PassportAuthSocialGetAccessTokenResponse.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserRefreshTokenResponse
+# PassportAuthSocialGetAccessTokenResponse
 
 
 ## Properties
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserRefreshTokenResponse } from '@cherryin/api-client';
+import { PassportAuthSocialGetAccessTokenResponse } from '@cherryin/api-client';
 
-const instance: PassportAuthUserRefreshTokenResponse = {
+const instance: PassportAuthSocialGetAccessTokenResponse = {
     code,
     message,
     token_type,

package/docs/{PassportAuthUserGetAccessTokenRequest.md → PassportAuthSocialRefreshTokenRequest.md}

@@ -1,4 +1,4 @@
-# PassportAuthUserGetAccessTokenRequest
+# PassportAuthSocialRefreshTokenRequest
 
 
 ## Properties
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PassportAuthUserGetAccessTokenRequest } from '@cherryin/api-client';
+import { PassportAuthSocialRefreshTokenRequest } from '@cherryin/api-client';
 
-const instance: PassportAuthUserGetAccessTokenRequest = {
+const instance: PassportAuthSocialRefreshTokenRequest = {
     provider_id,
     account_id,
     user_id,