@cherryin/api-client 0.0.8 → 0.0.9

package/docs/PassportAuthUserSignInEmailRequest.md

@@ -0,0 +1,28 @@
+# PassportAuthUserSignInEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignInEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignInEmailRequest = {
+    app_ids,
+    email,
+    password,
+    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/PassportAuthUserSignInEmailResponse.md

@@ -0,0 +1,32 @@
+# PassportAuthUserSignInEmailResponse
+
+
+## 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]
+**passport** | [**AuthPassport**](AuthPassport.md) |  | [optional] [default to undefined]
+**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) |  | [optional] [default to undefined]
+**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignInEmailResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignInEmailResponse = {
+    code,
+    message,
+    redirect,
+    url,
+    passport,
+    sessions,
+    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/PassportAuthUserSignInPhoneRequest.md

@@ -0,0 +1,24 @@
+# PassportAuthUserSignInPhoneRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**phone_number** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignInPhoneRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignInPhoneRequest = {
+    app_ids,
+    phone_number,
+    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/PassportAuthUserSignInPhoneResponse.md

@@ -0,0 +1,28 @@
+# PassportAuthUserSignInPhoneResponse
+
+
+## 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]
+**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) |  | [optional] [default to undefined]
+**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignInPhoneResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignInPhoneResponse = {
+    code,
+    message,
+    passport,
+    sessions,
+    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/PassportAuthUserSignInSocialRequest.md

@@ -0,0 +1,32 @@
+# PassportAuthUserSignInSocialRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  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 { PassportAuthUserSignInSocialRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignInSocialRequest = {
+    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/PassportAuthUserSignInSocialResponse.md

@@ -0,0 +1,32 @@
+# PassportAuthUserSignInSocialResponse
+
+
+## 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]
+**passport** | [**AuthPassport**](AuthPassport.md) |  | [optional] [default to undefined]
+**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) |  | [optional] [default to undefined]
+**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignInSocialResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignInSocialResponse = {
+    code,
+    message,
+    redirect,
+    url,
+    passport,
+    sessions,
+    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/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,24 @@
+# PassportAuthUserSignOutResponse
+
+
+## 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 { PassportAuthUserSignOutResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignOutResponse = {
+    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/PassportAuthUserSignUpEmailRequest.md

@@ -0,0 +1,34 @@
+# PassportAuthUserSignUpEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | User.AppID, 支持多个应用同时注册，如果没有通行证，则创建新通行证  NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** |  | [optional] [default to undefined]
+**disable_redirect** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignUpEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignUpEmailRequest = {
+    app_ids,
+    name,
+    email,
+    password,
+    avatar_url,
+    callback_url,
+    remember_me,
+    disable_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/PassportAuthUserSignUpEmailResponse.md

@@ -0,0 +1,30 @@
+# PassportAuthUserSignUpEmailResponse
+
+
+## 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]
+**passport** | [**AuthPassport**](AuthPassport.md) |  | [optional] [default to undefined]
+**users** | [**Array<AuthUser>**](AuthUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthUserSignUpEmailResponse } from '@cherryin/api-client';
+
+const instance: PassportAuthUserSignUpEmailResponse = {
+    code,
+    message,
+    redirect,
+    url,
+    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/PassportAuthUserUnlinkAccountRequest.md

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

package/docs/PassportAuthUserUnlinkAccountResponse.md

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

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

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

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

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