@cherryin/api-client 0.0.8 → 0.0.10

package/docs/PassportAuthUserSignOutRequest.md

@@ -0,0 +1,22 @@
+# PassportAuthUserSignOutRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表  如果想仅登出某些应用的会话，则指定 app_ids | [optional] [default to undefined]
+**sign_out_all** | **boolean** | 如果为 true，则登出所有应用的所有会话 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignOutRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignOutRequest = {
+    app_ids,
+    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/PassportAuthUserSignOutResponse.md

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

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

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

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

@@ -0,0 +1,24 @@
+# PassportAuthUserUpdatePassportResponse
+
+
+## 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]
+
+## Example
+
+```typescript
+import { PassportAuthUserUpdatePassportResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserUpdatePassportResponse = {
+    code,
+    message,
+    passport,
+};
+```
+
+[[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/PassportAuthUserVerifyEmailRequest.md

@@ -0,0 +1,26 @@
+# PassportAuthUserVerifyEmailRequest
+
+
+## Properties
+
+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]
+**callback_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserVerifyEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserVerifyEmailRequest = {
+    app_ids,
+    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/PassportAuthUserVerifyEmailResponse.md

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

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

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

@@ -0,0 +1,24 @@
+# PassportEnterprisePasswordResetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportEnterprisePasswordResetRequest } from '@cherryin/api-client';
+
+const instance: PassportEnterprisePasswordResetRequest = {
+    email,
+    redirect,
+    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/PassportEnterprisePasswordResetResponse.md

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

@@ -0,0 +1,24 @@
+# PassportEnterpriseSendVerificationEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 { PassportEnterpriseSendVerificationEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseSendVerificationEmailRequest = {
+    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/PassportEnterpriseSendVerificationEmailResponse.md

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

@@ -0,0 +1,24 @@
+# PassportEnterpriseSendVerificationPhoneRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 { PassportEnterpriseSendVerificationPhoneRequest } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseSendVerificationPhoneRequest = {
+    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/PassportEnterpriseSendVerificationPhoneResponse.md

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

@@ -0,0 +1,30 @@
+# PassportEnterpriseSignInEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
+**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportEnterpriseSignInEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseSignInEmailRequest = {
+    email,
+    password,
+    verify_code,
+    remember_me,
+    redirect,
+    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/PassportEnterpriseSignInEmailResponse.md

@@ -0,0 +1,30 @@
+# PassportEnterpriseSignInEmailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**session** | [**AuthEnterpriseSession**](AuthEnterpriseSession.md) |  | [optional] [default to undefined]
+**user** | [**AuthEnterpriseUser**](AuthEnterpriseUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportEnterpriseSignInEmailResponse } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseSignInEmailResponse = {
+    code,
+    message,
+    redirect,
+    url,
+    session,
+    user,
+};
+```
+
+[[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/PassportEnterpriseSignInPhoneRequest.md

@@ -0,0 +1,24 @@
+# PassportEnterpriseSignInPhoneRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone** | **string** | 手机号，E164 格式 | [optional] [default to undefined]
+**verify_code** | **string** | 验证码 | [optional] [default to undefined]
+**disable_sign_up** | **boolean** | 登录即注册，开启后默认是通过手机号登录验证通过，没有对应用户时会自动注册新用户 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportEnterpriseSignInPhoneRequest } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseSignInPhoneRequest = {
+    phone,
+    verify_code,
+    disable_sign_up,
+};
+```
+
+[[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/PassportEnterpriseSignInPhoneResponse.md

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

@@ -0,0 +1,34 @@
+# PassportEnterpriseSignUpEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportEnterpriseSignUpEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseSignUpEmailRequest = {
+    email,
+    name,
+    password,
+    verify_code,
+    avatar_url,
+    redirect,
+    callback_url,
+    remember_me,
+};
+```
+
+[[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/PassportEnterpriseSignUpEmailResponse.md

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

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

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

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

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