npm - @cherryin/api-client - Versions diffs - 0.0.20 → 0.1.1 - Mend

@cherryin/api-client 0.0.20 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (323) hide show

package/docs/PassportAuthAdminUserDisableRequest.md DELETED Viewed

@@ -1,26 +0,0 @@
-# PassportAuthAdminUserDisableRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uid_list** | **Array&lt;string&gt;** |  | [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/PassportAuthAdminUserListRequest.md DELETED Viewed

@@ -1,28 +0,0 @@
-# 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&lt;number&gt;** | 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 DELETED Viewed

@@ -1,28 +0,0 @@
-# PassportAuthAdminUserListResponse
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**users** | [**Array&lt;AdminUserItem&gt;**](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 DELETED Viewed

@@ -1,32 +0,0 @@
-# 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/PassportAuthAdminUserModifyPermissionRequest.md DELETED Viewed

@@ -1,22 +0,0 @@
-# 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/PassportAuthChangePasswordRequest.md DELETED Viewed

@@ -1,26 +0,0 @@
-# PassportAuthChangePasswordRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [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 DELETED Viewed

@@ -1,26 +0,0 @@
-# PassportAuthChangePasswordResponse
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](AuthUserSession.md) |  | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](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/PassportAuthDeleteAllResponse.md DELETED Viewed

@@ -1,22 +0,0 @@
-# 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/PassportAuthEnterpriseChangePhoneRequest.md DELETED Viewed

@@ -1,24 +0,0 @@
-# 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 DELETED Viewed

@@ -1,22 +0,0 @@
-# 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/PassportAuthEnterpriseDeleteResponse.md DELETED Viewed

@@ -1,22 +0,0 @@
-# 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/PassportAuthEnterpriseInfoGetResponse.md DELETED Viewed

@@ -1,24 +0,0 @@
-# PassportAuthEnterpriseInfoGetResponse
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](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 DELETED Viewed

@@ -1,24 +0,0 @@
-# PassportAuthEnterpriseListSessionsResponse
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](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 DELETED Viewed

@@ -1,26 +0,0 @@
-# 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/PassportAuthEnterpriseMaterialVerifyStateResponse.md DELETED Viewed

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

@@ -1,61 +0,0 @@
-# PassportAuthEnterpriseRPCServiceApi
-All URIs are relative to *http://localhost*
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth**](#passportauthenterpriserpcservicepassportenterprisetokenauth) | **POST** /passport/enterprise/authed/v1/passports | |
-# **passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth**
-> PassportEnterpriseTokenAuthResponse passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth(passportEnterpriseTokenAuthRequest)
-Token 鉴权 - Enterprise
-### Example
-```typescript
-import {
-    PassportAuthEnterpriseRPCServiceApi,
-    Configuration,
-    PassportEnterpriseTokenAuthRequest
-} from '@cherryin/api-client';
-const configuration = new Configuration();
-const apiInstance = new PassportAuthEnterpriseRPCServiceApi(configuration);
-let passportEnterpriseTokenAuthRequest: PassportEnterpriseTokenAuthRequest; //
-const { status, data } = await apiInstance.passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth(
-    passportEnterpriseTokenAuthRequest
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **passportEnterpriseTokenAuthRequest** | **PassportEnterpriseTokenAuthRequest**|  | |
-### Return type
-**PassportEnterpriseTokenAuthResponse**
-### Authorization
-No authorization required
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Default error response |  -  |
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

package/docs/PassportAuthEnterpriseRefreshTokenRequest.md DELETED Viewed

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

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

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

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

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