@cherryin/api-client 0.0.8 → 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/PassportAuthEnterpriseSignOutResponse.md

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

@@ -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/PassportAuthEnterpriseUpdateInfoResponse.md

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

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

@@ -0,0 +1,32 @@
+# PassportAuthLinkSocialRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**provider** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**error_callback_url** | **string** |  | [optional] [default to undefined]
+**disable_redirect** | **boolean** |  | [optional] [default to undefined]
+**id_token** | [**AuthIdToken**](AuthIdToken.md) |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthLinkSocialRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthLinkSocialRequest = {
+    app_ids,
+    provider,
+    callback_url,
+    error_callback_url,
+    disable_redirect,
+    id_token,
+    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/PassportAuthLinkSocialResponse.md

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

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

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

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

@@ -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/PassportAuthResetPasswordRequest.md

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

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

@@ -0,0 +1,24 @@
+# PassportAuthRevokeOtherSessionsResponse
+
+
+## Properties
+
+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 { PassportAuthRevokeOtherSessionsResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthRevokeOtherSessionsResponse = {
+    code,
+    message,
+    success,
+};
+```
+
+[[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/PassportAuthRevokeSessionRequest.md

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

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

@@ -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)