@cherryin/api-client 0.0.4 → 0.0.5

package/docs/UserManageAPIKey.md

@@ -0,0 +1,38 @@
+# UserManageAPIKey
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**key_group** | **string** |  | [optional] [default to undefined]
+**balance_code** | **string** |  | [optional] [default to undefined]
+**quota_total** | **string** |  | [optional] [default to undefined]
+**quota_used** | **string** |  | [optional] [default to undefined]
+**quota_mode** | **number** |  | [optional] [default to undefined]
+**key_status** | **number** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageAPIKey } from '@cherryin/api-client';
+
+const instance: UserManageAPIKey = {
+    id,
+    name,
+    key_group,
+    balance_code,
+    quota_total,
+    quota_used,
+    quota_mode,
+    key_status,
+    expires_at,
+    created_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/UserManageAdminServiceApi.md

@@ -0,0 +1,330 @@
+# UserManageAdminServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userManageAdminServiceBatchUpdateSessions**](#usermanageadminservicebatchupdatesessions) | **POST** /admin/users/manage/sessions | |
+|[**userManageAdminServiceGetUserDetail**](#usermanageadminservicegetuserdetail) | **GET** /admin/users/detail | |
+|[**userManageAdminServiceListUsers**](#usermanageadminservicelistusers) | **POST** /admin/users/list | |
+|[**userManageAdminServiceSetUserRole**](#usermanageadminservicesetuserrole) | **POST** /admin/users/manage/role | |
+|[**userManageAdminServiceSetUserStatus**](#usermanageadminservicesetuserstatus) | **POST** /admin/users/manage/status | |
+|[**userManageAdminServiceUpdateUserInfo**](#usermanageadminserviceupdateuserinfo) | **POST** /admin/users/manage/info | |
+
+# **userManageAdminServiceBatchUpdateSessions**
+> BatchUpdateSessionsResponse userManageAdminServiceBatchUpdateSessions(batchUpdateSessionsRequest)
+
+批量管理 Session
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    BatchUpdateSessionsRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let batchUpdateSessionsRequest: BatchUpdateSessionsRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceBatchUpdateSessions(
+    batchUpdateSessionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **batchUpdateSessionsRequest** | **BatchUpdateSessionsRequest**|  | |
+
+
+### Return type
+
+**BatchUpdateSessionsResponse**
+
+### 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)
+
+# **userManageAdminServiceGetUserDetail**
+> GetUserDetailResponse userManageAdminServiceGetUserDetail()
+
+用户详情
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let uid: string; //@gotags: form:\"uid\" binding:\"uid\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userManageAdminServiceGetUserDetail(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] | @gotags: form:\"uid\" binding:\"uid\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetUserDetailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **userManageAdminServiceListUsers**
+> ListUsersResponse userManageAdminServiceListUsers(listUsersRequest)
+
+用户列表（分页查询）
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    ListUsersRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let listUsersRequest: ListUsersRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceListUsers(
+    listUsersRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listUsersRequest** | **ListUsersRequest**|  | |
+
+
+### Return type
+
+**ListUsersResponse**
+
+### 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)
+
+# **userManageAdminServiceSetUserRole**
+> SetUserRoleResponse userManageAdminServiceSetUserRole(setUserRoleRequest)
+
+设置用户角色
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    SetUserRoleRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let setUserRoleRequest: SetUserRoleRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceSetUserRole(
+    setUserRoleRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setUserRoleRequest** | **SetUserRoleRequest**|  | |
+
+
+### Return type
+
+**SetUserRoleResponse**
+
+### 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)
+
+# **userManageAdminServiceSetUserStatus**
+> SetUserStatusResponse userManageAdminServiceSetUserStatus(setUserStatusRequest)
+
+设置用户状态（启用/禁用）
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    SetUserStatusRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let setUserStatusRequest: SetUserStatusRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceSetUserStatus(
+    setUserStatusRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setUserStatusRequest** | **SetUserStatusRequest**|  | |
+
+
+### Return type
+
+**SetUserStatusResponse**
+
+### 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)
+
+# **userManageAdminServiceUpdateUserInfo**
+> UpdateUserInfoResponse userManageAdminServiceUpdateUserInfo(updateUserInfoRequest)
+
+更新用户信息
+
+### Example
+
+```typescript
+import {
+    UserManageAdminServiceApi,
+    Configuration,
+    UpdateUserInfoRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserManageAdminServiceApi(configuration);
+
+let updateUserInfoRequest: UpdateUserInfoRequest; //
+
+const { status, data } = await apiInstance.userManageAdminServiceUpdateUserInfo(
+    updateUserInfoRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserInfoRequest** | **UpdateUserInfoRequest**|  | |
+
+
+### Return type
+
+**UpdateUserInfoResponse**
+
+### 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/UserManageAuthMethod.md

@@ -0,0 +1,32 @@
+# UserManageAuthMethod
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**auth_type** | **string** |  | [optional] [default to undefined]
+**auth_id** | **string** |  | [optional] [default to undefined]
+**is_primary** | **boolean** |  | [optional] [default to undefined]
+**auth_status** | **number** |  | [optional] [default to undefined]
+**last_used_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageAuthMethod } from '@cherryin/api-client';
+
+const instance: UserManageAuthMethod = {
+    id,
+    auth_type,
+    auth_id,
+    is_primary,
+    auth_status,
+    last_used_at,
+    created_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/UserManageBalance.md

@@ -0,0 +1,32 @@
+# UserManageBalance
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance_code** | **string** |  | [optional] [default to undefined]
+**prepaid_balance_total** | **string** |  | [optional] [default to undefined]
+**prepaid_balance_used** | **string** |  | [optional] [default to undefined]
+**prepaid_balance_frozen** | **string** |  | [optional] [default to undefined]
+**bonus_balance_total** | **string** |  | [optional] [default to undefined]
+**bonus_balance_used** | **string** |  | [optional] [default to undefined]
+**bonus_balance_frozen** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageBalance } from '@cherryin/api-client';
+
+const instance: UserManageBalance = {
+    balance_code,
+    prepaid_balance_total,
+    prepaid_balance_used,
+    prepaid_balance_frozen,
+    bonus_balance_total,
+    bonus_balance_used,
+    bonus_balance_frozen,
+};
+```
+
+[[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/UserManageDetail.md

@@ -0,0 +1,47 @@
+# UserManageDetail
+
+用户管理详情（完整信息）
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** | 基本信息 | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**user_role** | **number** |  | [optional] [default to undefined]
+**user_status** | **number** |  | [optional] [default to undefined]
+**user_group** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**settings** | [**UserManageSettings**](UserManageSettings.md) | 设置信息 | [optional] [default to undefined]
+**balance** | [**UserManageBalance**](UserManageBalance.md) | 余额信息 | [optional] [default to undefined]
+**api_keys** | [**Array<UserManageAPIKey>**](UserManageAPIKey.md) | API Key 配额信息 | [optional] [default to undefined]
+**auth_methods** | [**Array<UserManageAuthMethod>**](UserManageAuthMethod.md) | 认证方式列表 | [optional] [default to undefined]
+**sessions** | [**Array<UserManageSession>**](UserManageSession.md) | Session 列表 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageDetail } from '@cherryin/api-client';
+
+const instance: UserManageDetail = {
+    uid,
+    display_name,
+    email,
+    avatar_url,
+    user_role,
+    user_status,
+    user_group,
+    created_at,
+    updated_at,
+    settings,
+    balance,
+    api_keys,
+    auth_methods,
+    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/UserManageItem.md

@@ -0,0 +1,39 @@
+# UserManageItem
+
+用户管理列表项（精简信息）
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**user_role** | **number** |  | [optional] [default to undefined]
+**user_status** | **number** |  | [optional] [default to undefined]
+**user_group** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**auth_types** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageItem } from '@cherryin/api-client';
+
+const instance: UserManageItem = {
+    uid,
+    display_name,
+    email,
+    avatar_url,
+    user_role,
+    user_status,
+    user_group,
+    created_at,
+    updated_at,
+    auth_types,
+};
+```
+
+[[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/UserManageSession.md

@@ -0,0 +1,34 @@
+# UserManageSession
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**session_type** | **string** |  | [optional] [default to undefined]
+**ip_address** | **string** |  | [optional] [default to undefined]
+**user_agent** | **string** |  | [optional] [default to undefined]
+**active_at** | **string** |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**is_current** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserManageSession } from '@cherryin/api-client';
+
+const instance: UserManageSession = {
+    id,
+    session_type,
+    ip_address,
+    user_agent,
+    active_at,
+    expires_at,
+    created_at,
+    is_current,
+};
+```
+
+[[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/UserManageSettings.md

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

@@ -22,11 +22,17 @@ const configuration = new Configuration();
 const apiInstance = new UserPayServiceApi(configuration);
 
 let currencyCode: string; // (optional) (default to undefined)
-let chargeAmount: number; // (optional) (default to undefined)
+let chargeAmount: string; // (optional) (default to undefined)
+let redirect: boolean; // (optional) (default to undefined)
+let successUrl: string; // (optional) (default to undefined)
+let cancelUrl: string; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.userPayServiceUserPayStripeCheckout(
     currencyCode,
-    chargeAmount
+    chargeAmount,
+    redirect,
+    successUrl,
+    cancelUrl
 );
 ```
 
@@ -35,7 +41,10 @@ const { status, data } = await apiInstance.userPayServiceUserPayStripeCheckout(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **currencyCode** | [**string**] |  | (optional) defaults to undefined|
-| **chargeAmount** | [**number**] |  | (optional) defaults to undefined|
+| **chargeAmount** | [**string**] |  | (optional) defaults to undefined|
+| **redirect** | [**boolean**] |  | (optional) defaults to undefined|
+| **successUrl** | [**string**] |  | (optional) defaults to undefined|
+| **cancelUrl** | [**string**] |  | (optional) defaults to undefined|
 
 
 ### Return type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cherryin/api-client",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "OpenAPI client for @cherryin/api-client",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/AdminAuthServiceApi.md

@@ -1,81 +0,0 @@
-# AdminAuthServiceApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**adminAuthServiceAdminAuthFlowInit**](#adminauthserviceadminauthflowinit) | **POST** /admin/auth/init | |
-
-# **adminAuthServiceAdminAuthFlowInit**
-> AdminAuthFlowInitResponse adminAuthServiceAdminAuthFlowInit()
-
-管理员登录
-
-### Example
-
-```typescript
-import {
-    AdminAuthServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AdminAuthServiceApi(configuration);
-
-let authType: number; // (optional) (default to undefined)
-let authAction: number; // (optional) (default to undefined)
-let payloadEmailPayloadUserEmail: string; // (optional) (default to undefined)
-let payloadEmailPayloadUserPasswordEncrypt: string; // (optional) (default to undefined)
-let authAt: string; // (optional) (default to undefined)
-let nonce: string; // (optional) (default to undefined)
-let signature: string; //加密方式:  step1: 拼接一个字符串: s = \"cherryin_admin:{auth_type}:{auth_action}:{auth_at}:{nonce}:{payload.k1}:{payload.k2}:...}\"  step2: md5(s)  step3: hex_encode(step2)   Payload 字段参与加密的字段如下:  AuthType=Email:(空字符串也需要拼接)    * UserEmail | UserPasswordEncrypt | DisplayName  AuthType=OAuth2:    * Platform  ) (optional) (default to undefined)
-let sessionType: string; //enum string:  - tenant_admin  - sys_admin (optional) (default to undefined)
-
-const { status, data } = await apiInstance.adminAuthServiceAdminAuthFlowInit(
-    authType,
-    authAction,
-    payloadEmailPayloadUserEmail,
-    payloadEmailPayloadUserPasswordEncrypt,
-    authAt,
-    nonce,
-    signature,
-    sessionType
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authType** | [**number**] |  | (optional) defaults to undefined|
-| **authAction** | [**number**] |  | (optional) defaults to undefined|
-| **payloadEmailPayloadUserEmail** | [**string**] |  | (optional) defaults to undefined|
-| **payloadEmailPayloadUserPasswordEncrypt** | [**string**] |  | (optional) defaults to undefined|
-| **authAt** | [**string**] |  | (optional) defaults to undefined|
-| **nonce** | [**string**] |  | (optional) defaults to undefined|
-| **signature** | [**string**] | 加密方式:  step1: 拼接一个字符串: s = \"cherryin_admin:{auth_type}:{auth_action}:{auth_at}:{nonce}:{payload.k1}:{payload.k2}:...}\"  step2: md5(s)  step3: hex_encode(step2)   Payload 字段参与加密的字段如下:  AuthType=Email:(空字符串也需要拼接)    * UserEmail | UserPasswordEncrypt | DisplayName  AuthType=OAuth2:    * Platform  ) | (optional) defaults to undefined|
-| **sessionType** | [**string**] | enum string:  - tenant_admin  - sys_admin | (optional) defaults to undefined|
-
-
-### Return type
-
-**AdminAuthFlowInitResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **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)
-