@cherryin/api-client 0.1.1 → 0.1.2

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（更换邮箱）  - reset_password (重置密码) | [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)

package/docs/PassportUserInfoBatchGetRequest.md

@@ -0,0 +1,24 @@
+# PassportUserInfoBatchGetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uids** | **Array<string>** |  | [optional] [default to undefined]
+**ignore_cache** | **boolean** |  | [optional] [default to undefined]
+**query_options** | [**UserInfoQueryOptions**](UserInfoQueryOptions.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserInfoBatchGetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserInfoBatchGetRequest = {
+    uids,
+    ignore_cache,
+    query_options,
+};
+```
+
+[[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/{AuthRequestPasswordResetResponse.md → PassportUserInfoBatchGetResponse.md}

@@ -1,4 +1,4 @@
-# AuthRequestPasswordResetResponse
+# PassportUserInfoBatchGetResponse
 
 
 ## Properties
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**status** | **boolean** |  | [optional] [default to undefined]
+**user_info_list** | [**Array<UserInfo>**](UserInfo.md) |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthRequestPasswordResetResponse } from '@cherryin/api-client';
+import { PassportUserInfoBatchGetResponse } from '@cherryin/api-client';
 
-const instance: AuthRequestPasswordResetResponse = {
+const instance: PassportUserInfoBatchGetResponse = {
     code,
     message,
-    status,
+    user_info_list,
 };
 ```
 

package/docs/PassportUserInfoGetRequest.md

@@ -0,0 +1,24 @@
+# PassportUserInfoGetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**ignore_cache** | **boolean** |  | [optional] [default to undefined]
+**query_options** | [**UserInfoQueryOptions**](UserInfoQueryOptions.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserInfoGetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserInfoGetRequest = {
+    uid,
+    ignore_cache,
+    query_options,
+};
+```
+
+[[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/{AuthAdminRevokeSessionsResponse.md → PassportUserInfoGetResponse.md}

@@ -1,4 +1,4 @@
-# AuthAdminRevokeSessionsResponse
+# PassportUserInfoGetResponse
 
 
 ## Properties
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**status** | **boolean** |  | [optional] [default to undefined]
+**user_info** | [**UserInfo**](UserInfo.md) |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthAdminRevokeSessionsResponse } from '@cherryin/api-client';
+import { PassportUserInfoGetResponse } from '@cherryin/api-client';
 
-const instance: AuthAdminRevokeSessionsResponse = {
+const instance: PassportUserInfoGetResponse = {
     code,
     message,
-    status,
+    user_info,
 };
 ```
 

package/docs/PassportUserOAuthCallbackResponse.md

@@ -0,0 +1,36 @@
+# PassportUserOAuthCallbackResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
+**is_linked** | **boolean** |  | [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 { PassportUserOAuthCallbackResponse } from '@cherryin/api-client';
+
+const instance: PassportUserOAuthCallbackResponse = {
+    code,
+    message,
+    token,
+    url,
+    redirect,
+    is_linked,
+    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/PassportUserPasswordForgetRequest.md

@@ -0,0 +1,24 @@
+# PassportUserPasswordForgetRequest
+
+
+## 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]
+
+## Example
+
+```typescript
+import { PassportUserPasswordForgetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserPasswordForgetRequest = {
+    app_ids,
+    email,
+    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/PassportUserPasswordForgetResponse.md

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

@@ -0,0 +1,30 @@
+# PassportUserPasswordResetRequest
+
+
+## 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]
+**new_password** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserPasswordResetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserPasswordResetRequest = {
+    app_ids,
+    email,
+    verify_code,
+    new_password,
+    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/{AuthSignInSocialResponse.md → PassportUserPasswordResetResponse.md}

@@ -1,4 +1,4 @@
-# AuthSignInSocialResponse
+# PassportUserPasswordResetResponse
 
 
 ## Properties
@@ -7,23 +7,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**redirect** | **boolean** |  | [optional] [default to undefined]
-**token** | **string** |  | [optional] [default to undefined]
 **url** | **string** |  | [optional] [default to undefined]
-**user** | [**Auth2User**](Auth2User.md) |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthSignInSocialResponse } from '@cherryin/api-client';
+import { PassportUserPasswordResetResponse } from '@cherryin/api-client';
 
-const instance: AuthSignInSocialResponse = {
+const instance: PassportUserPasswordResetResponse = {
     code,
     message,
-    redirect,
-    token,
     url,
-    user,
+    redirect,
 };
 ```
 

package/docs/PassportUserPasswordResetTokenVerifyRequest.md

@@ -0,0 +1,22 @@
+# PassportUserPasswordResetTokenVerifyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**token** | **string** | 重置密码请求重置的 token | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserPasswordResetTokenVerifyRequest } from '@cherryin/api-client';
+
+const instance: PassportUserPasswordResetTokenVerifyRequest = {
+    app_ids,
+    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/{AuthListAccountsResponse.md → PassportUserPasswordResetTokenVerifyResponse.md}

@@ -1,4 +1,4 @@
-# AuthListAccountsResponse
+# PassportUserPasswordResetTokenVerifyResponse
 
 
 ## Properties
@@ -7,17 +7,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**accounts** | [**Array<Auth2Account>**](Auth2Account.md) |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuthListAccountsResponse } from '@cherryin/api-client';
+import { PassportUserPasswordResetTokenVerifyResponse } from '@cherryin/api-client';
 
-const instance: AuthListAccountsResponse = {
+const instance: PassportUserPasswordResetTokenVerifyResponse = {
     code,
     message,
-    accounts,
+    email,
+    verify_code,
 };
 ```
 

package/docs/PassportUserSignInEmailRequest.md

@@ -0,0 +1,32 @@
+# PassportUserSignInEmailRequest
+
+
+## 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]
+**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 { PassportUserSignInEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportUserSignInEmailRequest = {
+    app_ids,
+    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/PassportUserSignInEmailResponse.md

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

@@ -0,0 +1,26 @@
+# PassportUserSignInPhoneRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_ids** | **string** | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
+**phone_number** | **string** | 手机号，E164 格式 | [optional] [default to undefined]
+**verify_code** | **string** | 验证码 | [optional] [default to undefined]
+**auto_register** | **boolean** | 登录即注册，开启后默认是通过手机号登录验证通过，没有对应用户时会自动注册新用户 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserSignInPhoneRequest } from '@cherryin/api-client';
+
+const instance: PassportUserSignInPhoneRequest = {
+    app_ids,
+    phone_number,
+    verify_code,
+    auto_register,
+};
+```
+
+[[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/PassportUserSignInPhoneResponse.md

@@ -0,0 +1,28 @@
+# PassportUserSignInPhoneResponse
+
+
+## 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 { PassportUserSignInPhoneResponse } from '@cherryin/api-client';
+
+const instance: PassportUserSignInPhoneResponse = {
+    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/{AuthLinkSocialRequest.md → PassportUserSignInSocialRequest.md}

@@ -1,27 +1,29 @@
-# AuthLinkSocialRequest
+# PassportUserSignInSocialRequest
 
 
 ## 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** | [**Auth2IdToken**](Auth2IdToken.md) |  | [optional] [default to undefined]
+**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 { AuthLinkSocialRequest } from '@cherryin/api-client';
+import { PassportUserSignInSocialRequest } from '@cherryin/api-client';
 
-const instance: AuthLinkSocialRequest = {
+const instance: PassportUserSignInSocialRequest = {
+    app_ids,
     provider,
     callback_url,
     error_callback_url,
-    disable_redirect,
+    redirect,
     id_token,
     scopes,
 };

package/docs/PassportUserSignInSocialResponse.md

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

@@ -0,0 +1,36 @@
+# PassportUserSignUpEmailRequest
+
+
+## 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]
+**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 { PassportUserSignUpEmailRequest } from '@cherryin/api-client';
+
+const instance: PassportUserSignUpEmailRequest = {
+    app_ids,
+    name,
+    email,
+    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)