@cherryin/aigw-api-client 0.1.26 → 0.1.28

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 (37) hide show
  1. package/.openapi-generator/FILES +13 -22
  2. package/README.md +15 -29
  3. package/api.ts +191 -678
  4. package/dist/api.d.ts +138 -425
  5. package/dist/api.js +100 -436
  6. package/dist/esm/api.d.ts +138 -425
  7. package/dist/esm/api.js +94 -430
  8. package/docs/{UserInfo.md → AigwpbUserInfo.md} +3 -3
  9. package/docs/AigwpbUserMeInfo.md +2 -2
  10. package/docs/{UserSettings.md → AigwpbUserSettings.md} +3 -3
  11. package/docs/AuthUserMethod.md +38 -0
  12. package/docs/PassportpbUserInfo.md +30 -0
  13. package/docs/{UserManageSettings.md → PassportpbUserSettings.md} +3 -3
  14. package/docs/UserAdminServiceApi.md +60 -0
  15. package/docs/UserBasic.md +42 -0
  16. package/docs/{SetUserStatusRequest.md → UserExtendInfo.md} +5 -7
  17. package/docs/UserInfoItem.md +22 -0
  18. package/docs/{UpdateUserInfoRequest.md → UserInfoPageGetRequest.md} +13 -9
  19. package/docs/{ListUsersResponse.md → UserInfoPageGetResponse.md} +5 -9
  20. package/docs/UserPaymentInfo.md +20 -0
  21. package/docs/{SetUserRoleRequest.md → UserPreferences.md} +7 -7
  22. package/package.json +1 -1
  23. package/docs/BatchUpdateSessionsRequest.md +0 -24
  24. package/docs/BatchUpdateSessionsResponse.md +0 -24
  25. package/docs/GetUserDetailResponse.md +0 -24
  26. package/docs/ListUsersRequest.md +0 -36
  27. package/docs/SessionAction.md +0 -11
  28. package/docs/SetUserRoleResponse.md +0 -24
  29. package/docs/SetUserStatusResponse.md +0 -26
  30. package/docs/UpdateUserInfoResponse.md +0 -24
  31. package/docs/UserManageAPIKey.md +0 -38
  32. package/docs/UserManageAdminServiceApi.md +0 -324
  33. package/docs/UserManageAuthMethod.md +0 -32
  34. package/docs/UserManageBalance.md +0 -32
  35. package/docs/UserManageDetail.md +0 -46
  36. package/docs/UserManageItem.md +0 -38
  37. package/docs/UserManageSession.md +0 -34
package/docs/{UserManageSettings.md → PassportpbUserSettings.md} RENAMED
@@ -1,4 +1,4 @@
1
- # UserManageSettings
1
+ # PassportpbUserSettings
2
2
 
3
3
 
4
4
  ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import { UserManageSettings } from '@cherryin/aigw-api-client';
13
+ import { PassportpbUserSettings } from '@cherryin/aigw-api-client';
14
14
 
15
- const instance: UserManageSettings = {
15
+ const instance: PassportpbUserSettings = {
16
16
  email_notifications_enabled,
17
17
  };
18
18
  ```
package/docs/UserAdminServiceApi.md ADDED
@@ -0,0 +1,60 @@
1
+ # UserAdminServiceApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**userAdminServiceUserInfoPageGet**](#useradminserviceuserinfopageget) | **POST** /admin/users/search | 用户信息|
8
+
9
+ # **userAdminServiceUserInfoPageGet**
10
+ > UserInfoPageGetResponse userAdminServiceUserInfoPageGet(body)
11
+
12
+
13
+ ### Example
14
+
15
+ ```typescript
16
+ import {
17
+ UserAdminServiceApi,
18
+ Configuration,
19
+ UserInfoPageGetRequest
20
+ } from '@cherryin/aigw-api-client';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new UserAdminServiceApi(configuration);
24
+
25
+ let body: UserInfoPageGetRequest; //
26
+
27
+ const { status, data } = await apiInstance.userAdminServiceUserInfoPageGet(
28
+ body
29
+ );
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ |Name | Type | Description | Notes|
35
+ |------------- | ------------- | ------------- | -------------|
36
+ | **body** | **UserInfoPageGetRequest**| | |
37
+
38
+
39
+ ### Return type
40
+
41
+ **UserInfoPageGetResponse**
42
+
43
+ ### Authorization
44
+
45
+ No authorization required
46
+
47
+ ### HTTP request headers
48
+
49
+ - **Content-Type**: application/json
50
+ - **Accept**: application/json
51
+
52
+
53
+ ### HTTP response details
54
+ | Status code | Description | Response headers |
55
+ |-------------|-------------|------------------|
56
+ |**200** | A successful response. | - |
57
+ |**0** | An unexpected error response. | - |
58
+
59
+ [[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)
60
+
package/docs/UserBasic.md ADDED
@@ -0,0 +1,42 @@
1
+ # UserBasic
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **uid** | **string** | | [optional] [default to undefined]
9
+ **app_id** | **string** | | [optional] [default to undefined]
10
+ **aid** | **string** | | [optional] [default to undefined]
11
+ **name** | **string** | | [optional] [default to undefined]
12
+ **email** | **string** | | [optional] [default to undefined]
13
+ **phone** | **string** | | [optional] [default to undefined]
14
+ **avatar_url** | **string** | | [optional] [default to undefined]
15
+ **register_at** | **string** | | [optional] [default to undefined]
16
+ **email_verified_at** | **string** | | [optional] [default to undefined]
17
+ **phone_verified_at** | **string** | | [optional] [default to undefined]
18
+ **app_name** | **string** | | [optional] [default to undefined]
19
+ **user_status** | **number** | | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { UserBasic } from '@cherryin/aigw-api-client';
25
+
26
+ const instance: UserBasic = {
27
+ uid,
28
+ app_id,
29
+ aid,
30
+ name,
31
+ email,
32
+ phone,
33
+ avatar_url,
34
+ register_at,
35
+ email_verified_at,
36
+ phone_verified_at,
37
+ app_name,
38
+ user_status,
39
+ };
40
+ ```
41
+
42
+ [[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/{SetUserStatusRequest.md → UserExtendInfo.md} RENAMED
@@ -1,21 +1,19 @@
1
- # SetUserStatusRequest
1
+ # UserExtendInfo
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **uid** | **string** | | [optional] [default to undefined]
9
- **new_status** | **number** | | [optional] [default to undefined]
8
+ **user_groups** | **Array<string>** | | [optional] [default to undefined]
10
9
 
11
10
  ## Example
12
11
 
13
12
  ```typescript
14
- import { SetUserStatusRequest } from '@cherryin/aigw-api-client';
13
+ import { UserExtendInfo } from '@cherryin/aigw-api-client';
15
14
 
16
- const instance: SetUserStatusRequest = {
17
- uid,
18
- new_status,
15
+ const instance: UserExtendInfo = {
16
+ user_groups,
19
17
  };
20
18
  ```
21
19
 
package/docs/UserInfoItem.md ADDED
@@ -0,0 +1,22 @@
1
+ # UserInfoItem
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **user** | [**PassportpbUserInfo**](PassportpbUserInfo.md) | | [optional] [default to undefined]
9
+ **balance** | [**UserBalance**](UserBalance.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UserInfoItem } from '@cherryin/aigw-api-client';
15
+
16
+ const instance: UserInfoItem = {
17
+ user,
18
+ balance,
19
+ };
20
+ ```
21
+
22
+ [[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/{UpdateUserInfoRequest.md → UserInfoPageGetRequest.md} RENAMED
@@ -1,25 +1,29 @@
1
- # UpdateUserInfoRequest
1
+ # UserInfoPageGetRequest
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **uid** | **string** | | [optional] [default to undefined]
9
- **display_name** | **string** | | [optional] [default to undefined]
8
+ **page** | **number** | | [optional] [default to undefined]
9
+ **page_size** | **number** | | [optional] [default to undefined]
10
+ **user_ids** | **Array<string>** | | [optional] [default to undefined]
10
11
  **email** | **string** | | [optional] [default to undefined]
11
- **password** | **string** | | [optional] [default to undefined]
12
+ **phone** | **string** | | [optional] [default to undefined]
13
+ **display_name** | **string** | | [optional] [default to undefined]
12
14
 
13
15
  ## Example
14
16
 
15
17
  ```typescript
16
- import { UpdateUserInfoRequest } from '@cherryin/aigw-api-client';
18
+ import { UserInfoPageGetRequest } from '@cherryin/aigw-api-client';
17
19
 
18
- const instance: UpdateUserInfoRequest = {
19
- uid,
20
- display_name,
20
+ const instance: UserInfoPageGetRequest = {
21
+ page,
22
+ page_size,
23
+ user_ids,
21
24
  email,
22
- password,
25
+ phone,
26
+ display_name,
23
27
  };
24
28
  ```
25
29
 
package/docs/{ListUsersResponse.md → UserInfoPageGetResponse.md} RENAMED
@@ -1,4 +1,4 @@
1
- # ListUsersResponse
1
+ # UserInfoPageGetResponse
2
2
 
3
3
 
4
4
  ## Properties
@@ -7,23 +7,19 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **code** | **string** | | [optional] [default to undefined]
9
9
  **message** | **string** | | [optional] [default to undefined]
10
- **users** | [**Array<UserManageItem>**](UserManageItem.md) | | [optional] [default to undefined]
10
+ **user_info_list** | [**Array<UserInfoItem>**](UserInfoItem.md) | | [optional] [default to undefined]
11
11
  **total** | **string** | | [optional] [default to undefined]
12
- **page** | **number** | | [optional] [default to undefined]
13
- **page_size** | **number** | | [optional] [default to undefined]
14
12
 
15
13
  ## Example
16
14
 
17
15
  ```typescript
18
- import { ListUsersResponse } from '@cherryin/aigw-api-client';
16
+ import { UserInfoPageGetResponse } from '@cherryin/aigw-api-client';
19
17
 
20
- const instance: ListUsersResponse = {
18
+ const instance: UserInfoPageGetResponse = {
21
19
  code,
22
20
  message,
23
- users,
21
+ user_info_list,
24
22
  total,
25
- page,
26
- page_size,
27
23
  };
28
24
  ```
29
25
 
package/docs/UserPaymentInfo.md ADDED
@@ -0,0 +1,20 @@
1
+ # UserPaymentInfo
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **stripe_customer_id** | **string** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { UserPaymentInfo } from '@cherryin/aigw-api-client';
14
+
15
+ const instance: UserPaymentInfo = {
16
+ stripe_customer_id,
17
+ };
18
+ ```
19
+
20
+ [[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/{SetUserRoleRequest.md → UserPreferences.md} RENAMED
@@ -1,21 +1,21 @@
1
- # SetUserRoleRequest
1
+ # UserPreferences
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **uid** | **string** | | [optional] [default to undefined]
9
- **new_role** | **number** | | [optional] [default to undefined]
8
+ **language** | **string** | | [optional] [default to undefined]
9
+ **timezone** | **string** | | [optional] [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import { SetUserRoleRequest } from '@cherryin/aigw-api-client';
14
+ import { UserPreferences } from '@cherryin/aigw-api-client';
15
15
 
16
- const instance: SetUserRoleRequest = {
17
- uid,
18
- new_role,
16
+ const instance: UserPreferences = {
17
+ language,
18
+ timezone,
19
19
  };
20
20
  ```
21
21
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cherryin/aigw-api-client",
3
- "version": "0.1.26",
3
+ "version": "0.1.28",
4
4
  "description": "OpenAPI client for @cherryin/aigw-api-client",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
package/docs/BatchUpdateSessionsRequest.md DELETED
@@ -1,24 +0,0 @@
1
- # BatchUpdateSessionsRequest
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **uid** | **string** | | [optional] [default to undefined]
9
- **session_ids** | **Array<string>** | | [optional] [default to undefined]
10
- **action** | [**SessionAction**](SessionAction.md) | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { BatchUpdateSessionsRequest } from '@cherryin/aigw-api-client';
16
-
17
- const instance: BatchUpdateSessionsRequest = {
18
- uid,
19
- session_ids,
20
- action,
21
- };
22
- ```
23
-
24
- [[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/BatchUpdateSessionsResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # BatchUpdateSessionsResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [optional] [default to undefined]
10
- **affected_count** | **number** | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { BatchUpdateSessionsResponse } from '@cherryin/aigw-api-client';
16
-
17
- const instance: BatchUpdateSessionsResponse = {
18
- code,
19
- message,
20
- affected_count,
21
- };
22
- ```
23
-
24
- [[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/GetUserDetailResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # GetUserDetailResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [optional] [default to undefined]
10
- **user** | [**UserManageDetail**](UserManageDetail.md) | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { GetUserDetailResponse } from '@cherryin/aigw-api-client';
16
-
17
- const instance: GetUserDetailResponse = {
18
- code,
19
- message,
20
- user,
21
- };
22
- ```
23
-
24
- [[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/ListUsersRequest.md DELETED
@@ -1,36 +0,0 @@
1
- # ListUsersRequest
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **page** | **number** | 页码，从1开始 | [optional] [default to undefined]
9
- **page_size** | **number** | | [optional] [default to undefined]
10
- **uids** | **Array<string>** | UID 列表过滤 | [optional] [default to undefined]
11
- **display_name** | **string** | | [optional] [default to undefined]
12
- **email** | **string** | | [optional] [default to undefined]
13
- **user_statuses** | **Array<number>** | | [optional] [default to undefined]
14
- **user_roles** | **Array<number>** | | [optional] [default to undefined]
15
- **order_by** | **string** | 排序字段：created_at, updated_at | [optional] [default to undefined]
16
- **order_dir** | **string** | | [optional] [default to undefined]
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import { ListUsersRequest } from '@cherryin/aigw-api-client';
22
-
23
- const instance: ListUsersRequest = {
24
- page,
25
- page_size,
26
- uids,
27
- display_name,
28
- email,
29
- user_statuses,
30
- user_roles,
31
- order_by,
32
- order_dir,
33
- };
34
- ```
35
-
36
- [[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/SessionAction.md DELETED
@@ -1,11 +0,0 @@
1
- # SessionAction
2
-
3
- - SESSION_ACTION_UNSPECIFIED: 未指定 - SESSION_ACTION_REVOKE: 撤销 Session
4
-
5
- ## Enum
6
-
7
- * `SessionActionUnspecified` (value: `'SESSION_ACTION_UNSPECIFIED'`)
8
-
9
- * `SessionActionRevoke` (value: `'SESSION_ACTION_REVOKE'`)
10
-
11
- [[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/SetUserRoleResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # SetUserRoleResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [optional] [default to undefined]
10
- **success** | **boolean** | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { SetUserRoleResponse } from '@cherryin/aigw-api-client';
16
-
17
- const instance: SetUserRoleResponse = {
18
- code,
19
- message,
20
- success,
21
- };
22
- ```
23
-
24
- [[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/SetUserStatusResponse.md DELETED
@@ -1,26 +0,0 @@
1
- # SetUserStatusResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [optional] [default to undefined]
10
- **success** | **boolean** | | [optional] [default to undefined]
11
- **revoked_sessions** | **number** | | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { SetUserStatusResponse } from '@cherryin/aigw-api-client';
17
-
18
- const instance: SetUserStatusResponse = {
19
- code,
20
- message,
21
- success,
22
- revoked_sessions,
23
- };
24
- ```
25
-
26
- [[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/UpdateUserInfoResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # UpdateUserInfoResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [optional] [default to undefined]
10
- **success** | **boolean** | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { UpdateUserInfoResponse } from '@cherryin/aigw-api-client';
16
-
17
- const instance: UpdateUserInfoResponse = {
18
- code,
19
- message,
20
- success,
21
- };
22
- ```
23
-
24
- [[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/UserManageAPIKey.md DELETED
@@ -1,38 +0,0 @@
1
- # UserManageAPIKey
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | | [optional] [default to undefined]
9
- **name** | **string** | | [optional] [default to undefined]
10
- **key_group** | **string** | | [optional] [default to undefined]
11
- **balance_code** | **string** | | [optional] [default to undefined]
12
- **quota_total** | **string** | | [optional] [default to undefined]
13
- **quota_used** | **string** | | [optional] [default to undefined]
14
- **quota_mode** | **number** | | [optional] [default to undefined]
15
- **key_status** | **number** | | [optional] [default to undefined]
16
- **expires_at** | **string** | | [optional] [default to undefined]
17
- **created_at** | **string** | | [optional] [default to undefined]
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { UserManageAPIKey } from '@cherryin/aigw-api-client';
23
-
24
- const instance: UserManageAPIKey = {
25
- id,
26
- name,
27
- key_group,
28
- balance_code,
29
- quota_total,
30
- quota_used,
31
- quota_mode,
32
- key_status,
33
- expires_at,
34
- created_at,
35
- };
36
- ```
37
-
38
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)