@cherryin/api-client 0.0.20 → 0.1.1

package/docs/PassportAuthEnterpriseSignOutRequest.md

@@ -1,20 +0,0 @@
-# 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/PassportAuthEnterpriseSignOutResponse.md

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

@@ -1,22 +0,0 @@
-# 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/PassportAuthEnterpriseUpdateInfoResponse.md

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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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/PassportAuthInfoGetResponse.md

@@ -1,26 +0,0 @@
-# PassportAuthInfoGetResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**passport** | [**AuthPassport**](AuthPassport.md) |  | [optional] [default to undefined]
-**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthInfoGetResponse } from '@cherryin/api-client';
-
-const instance: PassportAuthInfoGetResponse = {
-    code,
-    message,
-    passport,
-    users,
-};
-```
-
-[[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/PassportAuthListMethodsResponse.md

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

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

@@ -1,20 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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/PassportAuthResetPasswordRequest.md

@@ -1,24 +0,0 @@
-# PassportAuthResetPasswordRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
-**new_password** | **string** |  | [optional] [default to undefined]
-**verify_code** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthResetPasswordRequest } from '@cherryin/api-client';
-
-const instance: PassportAuthResetPasswordRequest = {
-    app_ids,
-    new_password,
-    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/PassportAuthRevokeOtherSessionsRequest.md

@@ -1,20 +0,0 @@
-# PassportAuthRevokeOtherSessionsRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthRevokeOtherSessionsRequest } from '@cherryin/api-client';
-
-const instance: PassportAuthRevokeOtherSessionsRequest = {
-    app_ids,
-};
-```
-
-[[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/PassportAuthRevokeSessionResponse.md

@@ -1,22 +0,0 @@
-# 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/PassportAuthRevokeSessionsRequest.md

@@ -1,20 +0,0 @@
-# PassportAuthRevokeSessionsRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthRevokeSessionsRequest } from '@cherryin/api-client';
-
-const instance: PassportAuthRevokeSessionsRequest = {
-    app_ids,
-};
-```
-
-[[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/PassportAuthRevokeSessionsResponse.md

@@ -1,22 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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/PassportAuthUnlinkSocialResponse.md

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

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

@@ -1,26 +0,0 @@
-# PassportAuthUserChangePhoneRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
-**new_phone** | **string** |  | [optional] [default to undefined]
-**verify_code** | **string** |  | [optional] [default to undefined]
-**callback_url** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthUserChangePhoneRequest } from '@cherryin/api-client';
-
-const instance: PassportAuthUserChangePhoneRequest = {
-    app_ids,
-    new_phone,
-    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/PassportAuthUserChangePhoneResponse.md

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

@@ -1,30 +0,0 @@
-# PassportAuthUserDeleteRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
-**callback_url** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**password** | **string** |  | [optional] [default to undefined]
-**phone** | **string** |  | [optional] [default to undefined]
-**code** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthUserDeleteRequest } from '@cherryin/api-client';
-
-const instance: PassportAuthUserDeleteRequest = {
-    app_ids,
-    callback_url,
-    email,
-    password,
-    phone,
-    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/PassportAuthUserGetSessionResponse.md

@@ -1,24 +0,0 @@
-# PassportAuthUserGetSessionResponse
-
-
-## 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 { PassportAuthUserGetSessionResponse } from '@cherryin/api-client';
-
-const instance: PassportAuthUserGetSessionResponse = {
-    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/PassportAuthUserInfoGetResponse.md

@@ -1,24 +0,0 @@
-# PassportAuthUserInfoGetResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PassportAuthUserInfoGetResponse } from '@cherryin/api-client';
-
-const instance: PassportAuthUserInfoGetResponse = {
-    code,
-    message,
-    users,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)