@cherryin/api-client 0.0.13 → 0.0.14
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.
- package/.openapi-generator/FILES +9 -0
- package/README.md +11 -2
- package/api.ts +369 -0
- package/dist/api.d.ts +210 -0
- package/dist/api.js +284 -2
- package/dist/esm/api.d.ts +210 -0
- package/dist/esm/api.js +270 -0
- package/docs/PassportAdminTokenAuthRequest.md +20 -0
- package/docs/PassportAdminTokenAuthResponse.md +28 -0
- package/docs/PassportAuthAdminRPCServiceApi.md +61 -0
- package/docs/PassportAuthEnterpriseRPCServiceApi.md +61 -0
- package/docs/PassportAuthUserRPCServiceApi.md +61 -0
- package/docs/PassportEnterpriseTokenAuthRequest.md +20 -0
- package/docs/PassportEnterpriseTokenAuthResponse.md +28 -0
- package/docs/PassportUserTokenAuthRequest.md +20 -0
- package/docs/PassportUserTokenAuthResponse.md +28 -0
- package/package.json +1 -1
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# PassportAuthEnterpriseRPCServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth**](#passportauthenterpriserpcservicepassportenterprisetokenauth) | **POST** /passport/enterprise/authed/v1/token_auth | |
|
|
8
|
+
|
|
9
|
+
# **passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth**
|
|
10
|
+
> PassportEnterpriseTokenAuthResponse passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth(passportEnterpriseTokenAuthRequest)
|
|
11
|
+
|
|
12
|
+
Token 鉴权 - Enterprise
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
PassportAuthEnterpriseRPCServiceApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
PassportEnterpriseTokenAuthRequest
|
|
21
|
+
} from '@cherryin/api-client';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new PassportAuthEnterpriseRPCServiceApi(configuration);
|
|
25
|
+
|
|
26
|
+
let passportEnterpriseTokenAuthRequest: PassportEnterpriseTokenAuthRequest; //
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseRPCServicePassportEnterpriseTokenAuth(
|
|
29
|
+
passportEnterpriseTokenAuthRequest
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **passportEnterpriseTokenAuthRequest** | **PassportEnterpriseTokenAuthRequest**| | |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**PassportEnterpriseTokenAuthResponse**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
No authorization required
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: application/json
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | OK | - |
|
|
58
|
+
|**0** | Default error response | - |
|
|
59
|
+
|
|
60
|
+
[[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)
|
|
61
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# PassportAuthUserRPCServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**passportAuthUserRPCServicePassportUserTokenAuth**](#passportauthuserrpcservicepassportusertokenauth) | **POST** /passport/authed/v1/token_auth | |
|
|
8
|
+
|
|
9
|
+
# **passportAuthUserRPCServicePassportUserTokenAuth**
|
|
10
|
+
> PassportUserTokenAuthResponse passportAuthUserRPCServicePassportUserTokenAuth(passportUserTokenAuthRequest)
|
|
11
|
+
|
|
12
|
+
Token 鉴权 - User
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
PassportAuthUserRPCServiceApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
PassportUserTokenAuthRequest
|
|
21
|
+
} from '@cherryin/api-client';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
|
|
25
|
+
|
|
26
|
+
let passportUserTokenAuthRequest: PassportUserTokenAuthRequest; //
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserTokenAuth(
|
|
29
|
+
passportUserTokenAuthRequest
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **passportUserTokenAuthRequest** | **PassportUserTokenAuthRequest**| | |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**PassportUserTokenAuthResponse**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
No authorization required
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: application/json
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | OK | - |
|
|
58
|
+
|**0** | Default error response | - |
|
|
59
|
+
|
|
60
|
+
[[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)
|
|
61
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PassportEnterpriseTokenAuthRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**token** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PassportEnterpriseTokenAuthRequest } from '@cherryin/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: PassportEnterpriseTokenAuthRequest = {
|
|
16
|
+
token,
|
|
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)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PassportEnterpriseTokenAuthResponse
|
|
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
|
+
**is_valid** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**session** | [**AuthEnterpriseSession**](AuthEnterpriseSession.md) | | [optional] [default to undefined]
|
|
12
|
+
**user** | [**AuthEnterpriseUser**](AuthEnterpriseUser.md) | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PassportEnterpriseTokenAuthResponse } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: PassportEnterpriseTokenAuthResponse = {
|
|
20
|
+
code,
|
|
21
|
+
message,
|
|
22
|
+
is_valid,
|
|
23
|
+
session,
|
|
24
|
+
user,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PassportUserTokenAuthRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**token** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PassportUserTokenAuthRequest } from '@cherryin/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: PassportUserTokenAuthRequest = {
|
|
16
|
+
token,
|
|
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)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PassportUserTokenAuthResponse
|
|
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
|
+
**is_valid** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**session** | [**AuthUserSession**](AuthUserSession.md) | | [optional] [default to undefined]
|
|
12
|
+
**user** | [**AuthUser**](AuthUser.md) | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PassportUserTokenAuthResponse } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: PassportUserTokenAuthResponse = {
|
|
20
|
+
code,
|
|
21
|
+
message,
|
|
22
|
+
is_valid,
|
|
23
|
+
session,
|
|
24
|
+
user,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|