@cherryin/api-client 0.0.8 → 0.0.9

package/docs/AuthAdminUser.md

@@ -0,0 +1,33 @@
+# AuthAdminUser
+
+管理员用户信息 (映射 db.User，包含角色信息)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**role** | **number** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthAdminUser } from '@cherryin/api-client';
+
+const instance: AuthAdminUser = {
+    id,
+    name,
+    email,
+    avatar_url,
+    role,
+    created_at,
+    updated_at,
+};
+```
+
+[[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/AuthIdToken.md

@@ -0,0 +1,29 @@
+# AuthIdToken
+
+社交登录 ID Token
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [optional] [default to undefined]
+**nonce** | **string** |  | [optional] [default to undefined]
+**access_token** | **string** |  | [optional] [default to undefined]
+**refresh_token** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthIdToken } from '@cherryin/api-client';
+
+const instance: AuthIdToken = {
+    token,
+    nonce,
+    access_token,
+    refresh_token,
+    expires_at,
+};
+```
+
+[[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/AuthPassport.md

@@ -0,0 +1,35 @@
+# AuthPassport
+
+通行证信息 (映射 db.Passport)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**phone_number_e164** | **string** |  | [optional] [default to undefined]
+**email_verified** | **boolean** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthPassport } from '@cherryin/api-client';
+
+const instance: AuthPassport = {
+    aid,
+    name,
+    email,
+    phone_number_e164,
+    email_verified,
+    avatar_url,
+    created_at,
+    updated_at,
+};
+```
+
+[[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/AuthUser.md

@@ -0,0 +1,39 @@
+# AuthUser
+
+用户信息
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_id** | **string** |  | [optional] [default to undefined]
+**aid** | **string** |  | [optional] [default to undefined]
+**uid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**email_verified** | **boolean** |  | [optional] [default to undefined]
+**phone_number_e164** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthUser } from '@cherryin/api-client';
+
+const instance: AuthUser = {
+    app_id,
+    aid,
+    uid,
+    name,
+    email,
+    email_verified,
+    phone_number_e164,
+    avatar_url,
+    created_at,
+    updated_at,
+};
+```
+
+[[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/AuthUserMethod.md

@@ -0,0 +1,39 @@
+# AuthUserMethod
+
+关联账号信息 (映射 db.UserAuthMethod)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_id** | **string** |  | [optional] [default to undefined]
+**aid** | **string** |  | [optional] [default to undefined]
+**uid** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [optional] [default to undefined]
+**account_id** | **string** |  | [optional] [default to undefined]
+**provider_id** | **string** |  | [optional] [default to undefined]
+**user_id** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthUserMethod } from '@cherryin/api-client';
+
+const instance: AuthUserMethod = {
+    app_id,
+    aid,
+    uid,
+    id,
+    account_id,
+    provider_id,
+    user_id,
+    created_at,
+    updated_at,
+    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/AuthUserSession.md

@@ -0,0 +1,37 @@
+# AuthUserSession
+
+会话信息 (映射 db.UserSession)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_id** | **string** |  | [optional] [default to undefined]
+**aid** | **string** |  | [optional] [default to undefined]
+**uid** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**ip_address** | **string** |  | [optional] [default to undefined]
+**user_agent** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthUserSession } from '@cherryin/api-client';
+
+const instance: AuthUserSession = {
+    app_id,
+    aid,
+    uid,
+    token,
+    expires_at,
+    created_at,
+    updated_at,
+    ip_address,
+    user_agent,
+};
+```
+
+[[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/PassportAuthAdminChangePasswordRequest.md

@@ -0,0 +1,24 @@
+# PassportAuthAdminChangePasswordRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_password** | **string** |  | [optional] [default to undefined]
+**current_password** | **string** |  | [optional] [default to undefined]
+**revoke_other_sessions** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminChangePasswordRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminChangePasswordRequest = {
+    new_password,
+    current_password,
+    revoke_other_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/PassportAuthAdminChangePasswordResponse.md

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

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

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

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

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

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

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