@cherryin/api-client 0.0.8 → 0.0.10

package/docs/PassportAuthAdminSignOutResponse.md

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

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

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

@@ -0,0 +1,26 @@
+# PassportAuthAdminUserDisableRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid_list** | **Array<string>** |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+**user_state** | **number** |  | [optional] [default to undefined]
+**disable_until** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminUserDisableRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminUserDisableRequest = {
+    uid_list,
+    reason,
+    user_state,
+    disable_until,
+};
+```
+
+[[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/PassportAuthAdminUserDisableResponse.md

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

@@ -0,0 +1,28 @@
+# PassportAuthAdminUserListRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **number** | page 页码，从 1 开始  默认值: 1 | [optional] [default to undefined]
+**page_size** | **number** | page_size 每页数量  默认值: 20，最大值: 100 | [optional] [default to undefined]
+**status** | **Array<number>** | status 按状态过滤（可选）  0: 返回所有状态  1: 仅返回草稿状态  2: 仅返回已发布状态  3: 仅返回已禁用状态 | [optional] [default to undefined]
+**email** | **string** | email 过滤 | [optional] [default to undefined]
+**phone** | **string** | phone 过滤 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthAdminUserListRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthAdminUserListRequest = {
+    page,
+    page_size,
+    status,
+    email,
+    phone,
+};
+```
+
+[[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/PassportAuthAdminUserListResponse.md

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,28 @@
+# PassportAuthEnterpriseDeleteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**callback_url** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**verify_code** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthEnterpriseDeleteRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthEnterpriseDeleteRequest = {
+    callback_url,
+    email,
+    password,
+    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/PassportAuthEnterpriseDeleteResponse.md

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

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

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

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

@@ -0,0 +1,26 @@
+# PassportAuthEnterpriseMaterialUploadRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company_name** | **string** | 企业名称 | [optional] [default to undefined]
+**unified_social_credit_code** | **string** | 统一社会信用代码 | [optional] [default to undefined]
+**legal_person_name** | **string** | 法定代表人姓名 | [optional] [default to undefined]
+**legal_person_id_number** | **string** | 法定代表人身份证号码 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportAuthEnterpriseMaterialUploadRequest } from '@cherryin/api-client';
+
+const instance: PassportAuthEnterpriseMaterialUploadRequest = {
+    company_name,
+    unified_social_credit_code,
+    legal_person_name,
+    legal_person_id_number,
+};
+```
+
+[[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/PassportAuthEnterpriseMaterialUploadResponse.md

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