@cherryin/api-client 0.0.8 → 0.0.10
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 +165 -0
- package/README.md +245 -2
- package/api.ts +10050 -2478
- package/dist/api.d.ts +5919 -1623
- package/dist/api.js +5433 -168
- package/dist/esm/api.d.ts +5919 -1623
- package/dist/esm/api.js +5415 -166
- package/docs/AIModelAdminServiceApi.md +6 -6
- package/docs/AdminEnterpriseMaterials.md +24 -0
- package/docs/AdminEnterpriseUser.md +24 -0
- package/docs/AdminEnterpriseUserMaterials.md +22 -0
- package/docs/AdminPassportItem.md +24 -0
- package/docs/AdminUserItem.md +26 -0
- package/docs/AuthAdminSession.md +39 -0
- package/docs/AuthAdminUser.md +33 -0
- package/docs/AuthEnterpriseMaterials.md +33 -0
- package/docs/AuthEnterpriseSession.md +37 -0
- package/docs/AuthEnterpriseUser.md +37 -0
- package/docs/AuthIdToken.md +29 -0
- package/docs/AuthPassport.md +35 -0
- package/docs/AuthUser.md +39 -0
- package/docs/AuthUserMethod.md +39 -0
- package/docs/AuthUserSession.md +41 -0
- package/docs/ConfigItem.md +4 -0
- package/docs/PassportAdminSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAdminSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAdminSignInEmailRequest.md +28 -0
- package/docs/PassportAdminSignInEmailResponse.md +26 -0
- package/docs/PassportAuthAdminChangePasswordRequest.md +24 -0
- package/docs/PassportAuthAdminChangePasswordResponse.md +26 -0
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +28 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +22 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewResponse.md +22 -0
- package/docs/PassportAuthAdminGetInfoResponse.md +24 -0
- package/docs/PassportAuthAdminGetSessionResponse.md +26 -0
- package/docs/PassportAuthAdminListSessionsResponse.md +24 -0
- package/docs/PassportAuthAdminPassportDisableRequest.md +22 -0
- package/docs/PassportAuthAdminPassportDisableResponse.md +22 -0
- package/docs/PassportAuthAdminPassportListRequest.md +28 -0
- package/docs/PassportAuthAdminPassportListResponse.md +28 -0
- package/docs/PassportAuthAdminPassportModifyInfoRequest.md +28 -0
- package/docs/PassportAuthAdminPassportModifyInfoResponse.md +24 -0
- package/docs/PassportAuthAdminRevokeOtherSessionsResponse.md +22 -0
- package/docs/PassportAuthAdminRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthAdminRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthAdminRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthAdminServiceApi.md +1069 -0
- package/docs/PassportAuthAdminSignOutResponse.md +22 -0
- package/docs/PassportAuthAdminUpdateInfoRequest.md +22 -0
- package/docs/PassportAuthAdminUpdateInfoResponse.md +24 -0
- package/docs/PassportAuthAdminUserDisableRequest.md +26 -0
- package/docs/PassportAuthAdminUserDisableResponse.md +22 -0
- package/docs/PassportAuthAdminUserListRequest.md +28 -0
- package/docs/PassportAuthAdminUserListResponse.md +28 -0
- package/docs/PassportAuthAdminUserModifyInfoRequest.md +32 -0
- package/docs/PassportAuthAdminUserModifyInfoResponse.md +24 -0
- package/docs/PassportAuthAdminUserModifyPermissionRequest.md +22 -0
- package/docs/PassportAuthAdminUserModifyPermissionResponse.md +24 -0
- package/docs/PassportAuthChangePasswordRequest.md +26 -0
- package/docs/PassportAuthChangePasswordResponse.md +26 -0
- package/docs/PassportAuthDeleteAllRequest.md +28 -0
- package/docs/PassportAuthDeleteAllResponse.md +22 -0
- package/docs/PassportAuthEnterpriseChangePasswordRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePasswordResponse.md +26 -0
- package/docs/PassportAuthEnterpriseChangePhoneRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePhoneResponse.md +22 -0
- package/docs/PassportAuthEnterpriseDeleteRequest.md +28 -0
- package/docs/PassportAuthEnterpriseDeleteResponse.md +22 -0
- package/docs/PassportAuthEnterpriseGetSessionResponse.md +24 -0
- package/docs/PassportAuthEnterpriseInfoGetResponse.md +24 -0
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +24 -0
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +26 -0
- package/docs/PassportAuthEnterpriseMaterialUploadResponse.md +22 -0
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +24 -0
- package/docs/PassportAuthEnterpriseRefreshTokenRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRefreshTokenResponse.md +24 -0
- package/docs/PassportAuthEnterpriseResetPasswordRequest.md +22 -0
- package/docs/PassportAuthEnterpriseResetPasswordResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeOtherSessionsResponse.md +24 -0
- package/docs/PassportAuthEnterpriseRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseServiceApi.md +1170 -0
- package/docs/PassportAuthEnterpriseSignOutRequest.md +20 -0
- package/docs/PassportAuthEnterpriseSignOutResponse.md +22 -0
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +22 -0
- package/docs/PassportAuthEnterpriseUpdateInfoResponse.md +24 -0
- package/docs/PassportAuthEnterpriseVerifyEmailRequest.md +24 -0
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +22 -0
- package/docs/PassportAuthInfoGetResponse.md +26 -0
- package/docs/PassportAuthLinkSocialRequest.md +32 -0
- package/docs/PassportAuthLinkSocialResponse.md +26 -0
- package/docs/PassportAuthListMethodsResponse.md +24 -0
- package/docs/PassportAuthListSessionsResponse.md +24 -0
- package/docs/PassportAuthListSocialsResponse.md +24 -0
- package/docs/PassportAuthRefreshSessionTokenRequest.md +20 -0
- package/docs/PassportAuthRefreshSessionTokenResponse.md +24 -0
- package/docs/PassportAuthResetPasswordRequest.md +24 -0
- package/docs/PassportAuthResetPasswordResponse.md +22 -0
- package/docs/PassportAuthRevokeOtherSessionsRequest.md +20 -0
- package/docs/PassportAuthRevokeOtherSessionsResponse.md +24 -0
- package/docs/PassportAuthRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthRevokeSessionsRequest.md +20 -0
- package/docs/PassportAuthRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAuthSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAuthSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportAuthSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportAuthSocialGetAccessTokenRequest.md +24 -0
- package/docs/PassportAuthSocialGetAccessTokenResponse.md +34 -0
- package/docs/PassportAuthSocialRefreshTokenRequest.md +24 -0
- package/docs/PassportAuthSocialRefreshTokenResponse.md +34 -0
- package/docs/PassportAuthUnlinkSocialRequest.md +24 -0
- package/docs/PassportAuthUnlinkSocialResponse.md +22 -0
- package/docs/PassportAuthUserChangeEmailRequest.md +24 -0
- package/docs/PassportAuthUserChangeEmailResponse.md +24 -0
- package/docs/PassportAuthUserChangePhoneRequest.md +26 -0
- package/docs/PassportAuthUserChangePhoneResponse.md +24 -0
- package/docs/PassportAuthUserDeleteRequest.md +30 -0
- package/docs/PassportAuthUserDeleteResponse.md +22 -0
- package/docs/PassportAuthUserGetSessionResponse.md +24 -0
- package/docs/PassportAuthUserInfoGetResponse.md +24 -0
- package/docs/PassportAuthUserServiceApi.md +1892 -0
- package/docs/PassportAuthUserSignOutRequest.md +22 -0
- package/docs/PassportAuthUserSignOutResponse.md +22 -0
- package/docs/PassportAuthUserUpdateInfoRequest.md +24 -0
- package/docs/PassportAuthUserUpdateInfoResponse.md +24 -0
- package/docs/PassportAuthUserUpdatePassportRequest.md +22 -0
- package/docs/PassportAuthUserUpdatePassportResponse.md +24 -0
- package/docs/PassportAuthUserVerifyEmailRequest.md +26 -0
- package/docs/PassportAuthUserVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthUserVerifyPhoneRequest.md +24 -0
- package/docs/PassportAuthUserVerifyPhoneResponse.md +22 -0
- package/docs/PassportEnterprisePasswordResetRequest.md +24 -0
- package/docs/PassportEnterprisePasswordResetResponse.md +26 -0
- package/docs/PassportEnterpriseSendVerificationEmailRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationEmailResponse.md +22 -0
- package/docs/PassportEnterpriseSendVerificationPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportEnterpriseSignInEmailRequest.md +30 -0
- package/docs/PassportEnterpriseSignInEmailResponse.md +30 -0
- package/docs/PassportEnterpriseSignInPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSignInPhoneResponse.md +26 -0
- package/docs/PassportEnterpriseSignUpEmailRequest.md +34 -0
- package/docs/PassportEnterpriseSignUpEmailResponse.md +26 -0
- package/docs/PassportSendVerificationEmailRequest.md +26 -0
- package/docs/PassportSendVerificationEmailResponse.md +22 -0
- package/docs/PassportSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportUserOAuthCallbackResponse.md +36 -0
- package/docs/PassportUserPasswordResetRequest.md +28 -0
- package/docs/PassportUserPasswordResetResponse.md +26 -0
- package/docs/PassportUserSignInEmailRequest.md +32 -0
- package/docs/PassportUserSignInEmailResponse.md +32 -0
- package/docs/PassportUserSignInPhoneRequest.md +26 -0
- package/docs/PassportUserSignInPhoneResponse.md +28 -0
- package/docs/PassportUserSignInSocialRequest.md +32 -0
- package/docs/PassportUserSignInSocialResponse.md +32 -0
- package/docs/PassportUserSignUpEmailRequest.md +36 -0
- package/docs/PassportUserSignUpEmailResponse.md +32 -0
- package/docs/QRCodeAdminServiceApi.md +286 -0
- package/docs/QRCodeCreateRequest.md +37 -0
- package/docs/QRCodeCreateResponse.md +25 -0
- package/docs/QRCodeDeleteResponse.md +23 -0
- package/docs/QRCodeGetResponse.md +25 -0
- package/docs/QRCodeHistoryItem.md +29 -0
- package/docs/QRCodeInfo.md +59 -0
- package/docs/QRCodeListResponse.md +27 -0
- package/docs/QRCodeSnapshot.md +37 -0
- package/docs/QRCodeUpdateRequest.md +39 -0
- package/docs/QRCodeUpdateResponse.md +25 -0
- package/docs/QRCodeWithHistory.md +23 -0
- package/docs/RemoteConfigAdminServiceApi.md +18 -3
- package/docs/RemoteConfigItemGetResponse.md +2 -2
- package/docs/RemoteConfigItemUpdateRequest.md +6 -0
- package/docs/RemoteConfigItemUpdateResponse.md +2 -2
- package/docs/Status.md +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# PassportUserOAuthCallbackResponse
|
|
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
|
+
**token** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
**is_linked** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
|
|
15
|
+
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
|
|
16
|
+
**users** | [**Array<AuthUser>**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { PassportUserOAuthCallbackResponse } from '@cherryin/api-client';
|
|
22
|
+
|
|
23
|
+
const instance: PassportUserOAuthCallbackResponse = {
|
|
24
|
+
code,
|
|
25
|
+
message,
|
|
26
|
+
token,
|
|
27
|
+
url,
|
|
28
|
+
redirect,
|
|
29
|
+
is_linked,
|
|
30
|
+
passport,
|
|
31
|
+
sessions,
|
|
32
|
+
users,
|
|
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)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PassportUserPasswordResetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
12
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PassportUserPasswordResetRequest } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: PassportUserPasswordResetRequest = {
|
|
20
|
+
app_ids,
|
|
21
|
+
email,
|
|
22
|
+
verify_code,
|
|
23
|
+
redirect,
|
|
24
|
+
callback_url,
|
|
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,26 @@
|
|
|
1
|
+
# PassportUserPasswordResetResponse
|
|
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
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportUserPasswordResetResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportUserPasswordResetResponse = {
|
|
19
|
+
code,
|
|
20
|
+
message,
|
|
21
|
+
url,
|
|
22
|
+
redirect,
|
|
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)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PassportUserSignInEmailRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**password** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
|
|
13
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
14
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { PassportUserSignInEmailRequest } from '@cherryin/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: PassportUserSignInEmailRequest = {
|
|
22
|
+
app_ids,
|
|
23
|
+
email,
|
|
24
|
+
password,
|
|
25
|
+
verify_code,
|
|
26
|
+
remember_me,
|
|
27
|
+
redirect,
|
|
28
|
+
callback_url,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# PassportUserSignInEmailResponse
|
|
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
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
|
|
13
|
+
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
|
|
14
|
+
**users** | [**Array<AuthUser>**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { PassportUserSignInEmailResponse } from '@cherryin/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: PassportUserSignInEmailResponse = {
|
|
22
|
+
code,
|
|
23
|
+
message,
|
|
24
|
+
redirect,
|
|
25
|
+
url,
|
|
26
|
+
passport,
|
|
27
|
+
sessions,
|
|
28
|
+
users,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,26 @@
|
|
|
1
|
+
# PassportUserSignInPhoneRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**phone_number** | **string** | 手机号,E164 格式 | [optional] [default to undefined]
|
|
10
|
+
**verify_code** | **string** | 验证码 | [optional] [default to undefined]
|
|
11
|
+
**auto_register** | **boolean** | 登录即注册,开启后默认是通过手机号登录验证通过,没有对应用户时会自动注册新用户 | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassportUserSignInPhoneRequest } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: PassportUserSignInPhoneRequest = {
|
|
19
|
+
app_ids,
|
|
20
|
+
phone_number,
|
|
21
|
+
verify_code,
|
|
22
|
+
auto_register,
|
|
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)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PassportUserSignInPhoneResponse
|
|
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
|
+
**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
|
|
11
|
+
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
|
|
12
|
+
**users** | [**Array<AuthUser>**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PassportUserSignInPhoneResponse } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: PassportUserSignInPhoneResponse = {
|
|
20
|
+
code,
|
|
21
|
+
message,
|
|
22
|
+
passport,
|
|
23
|
+
sessions,
|
|
24
|
+
users,
|
|
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,32 @@
|
|
|
1
|
+
# PassportUserSignInSocialRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**provider** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**error_callback_url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
**id_token** | [**AuthIdToken**](AuthIdToken.md) | | [optional] [default to undefined]
|
|
14
|
+
**scopes** | **Array<string>** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { PassportUserSignInSocialRequest } from '@cherryin/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: PassportUserSignInSocialRequest = {
|
|
22
|
+
app_ids,
|
|
23
|
+
provider,
|
|
24
|
+
callback_url,
|
|
25
|
+
error_callback_url,
|
|
26
|
+
redirect,
|
|
27
|
+
id_token,
|
|
28
|
+
scopes,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# PassportUserSignInSocialResponse
|
|
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
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
|
|
13
|
+
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
|
|
14
|
+
**users** | [**Array<AuthUser>**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { PassportUserSignInSocialResponse } from '@cherryin/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: PassportUserSignInSocialResponse = {
|
|
22
|
+
code,
|
|
23
|
+
message,
|
|
24
|
+
redirect,
|
|
25
|
+
url,
|
|
26
|
+
passport,
|
|
27
|
+
sessions,
|
|
28
|
+
users,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,36 @@
|
|
|
1
|
+
# PassportUserSignUpEmailRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_ids** | **string** | User.AppID, 支持多个应用同时注册,如果没有通行证,则创建新通行证 NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**password** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**verify_code** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**avatar_url** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
|
|
15
|
+
**callback_url** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { PassportUserSignUpEmailRequest } from '@cherryin/api-client';
|
|
22
|
+
|
|
23
|
+
const instance: PassportUserSignUpEmailRequest = {
|
|
24
|
+
app_ids,
|
|
25
|
+
name,
|
|
26
|
+
email,
|
|
27
|
+
password,
|
|
28
|
+
verify_code,
|
|
29
|
+
avatar_url,
|
|
30
|
+
redirect,
|
|
31
|
+
callback_url,
|
|
32
|
+
remember_me,
|
|
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)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PassportUserSignUpEmailResponse
|
|
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
|
+
**redirect** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
|
|
13
|
+
**sessions** | [**Array<AuthUserSession>**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
|
|
14
|
+
**users** | [**Array<AuthUser>**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { PassportUserSignUpEmailResponse } from '@cherryin/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: PassportUserSignUpEmailResponse = {
|
|
22
|
+
code,
|
|
23
|
+
message,
|
|
24
|
+
redirect,
|
|
25
|
+
url,
|
|
26
|
+
passport,
|
|
27
|
+
sessions,
|
|
28
|
+
users,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,286 @@
|
|
|
1
|
+
# QRCodeAdminServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**qRCodeAdminServiceQRCodeCreate**](#qrcodeadminserviceqrcodecreate) | **POST** /admin/qrcode/create | |
|
|
8
|
+
|[**qRCodeAdminServiceQRCodeDelete**](#qrcodeadminserviceqrcodedelete) | **DELETE** /admin/qrcode/delete | |
|
|
9
|
+
|[**qRCodeAdminServiceQRCodeGet**](#qrcodeadminserviceqrcodeget) | **GET** /admin/qrcode/get | |
|
|
10
|
+
|[**qRCodeAdminServiceQRCodeList**](#qrcodeadminserviceqrcodelist) | **GET** /admin/qrcode/list | |
|
|
11
|
+
|[**qRCodeAdminServiceQRCodeUpdate**](#qrcodeadminserviceqrcodeupdate) | **POST** /admin/qrcode/update | |
|
|
12
|
+
|
|
13
|
+
# **qRCodeAdminServiceQRCodeCreate**
|
|
14
|
+
> QRCodeCreateResponse qRCodeAdminServiceQRCodeCreate(qRCodeCreateRequest)
|
|
15
|
+
|
|
16
|
+
QRCodeCreate 创建新的二维码 请求路径: POST /admin/qrcode/create 权限要求: 需要管理员权限
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
QRCodeAdminServiceApi,
|
|
23
|
+
Configuration,
|
|
24
|
+
QRCodeCreateRequest
|
|
25
|
+
} from '@cherryin/api-client';
|
|
26
|
+
|
|
27
|
+
const configuration = new Configuration();
|
|
28
|
+
const apiInstance = new QRCodeAdminServiceApi(configuration);
|
|
29
|
+
|
|
30
|
+
let qRCodeCreateRequest: QRCodeCreateRequest; //
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeCreate(
|
|
33
|
+
qRCodeCreateRequest
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **qRCodeCreateRequest** | **QRCodeCreateRequest**| | |
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**QRCodeCreateResponse**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
No authorization required
|
|
51
|
+
|
|
52
|
+
### HTTP request headers
|
|
53
|
+
|
|
54
|
+
- **Content-Type**: application/json
|
|
55
|
+
- **Accept**: application/json
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### HTTP response details
|
|
59
|
+
| Status code | Description | Response headers |
|
|
60
|
+
|-------------|-------------|------------------|
|
|
61
|
+
|**200** | OK | - |
|
|
62
|
+
|**0** | Default error response | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
66
|
+
# **qRCodeAdminServiceQRCodeDelete**
|
|
67
|
+
> QRCodeDeleteResponse qRCodeAdminServiceQRCodeDelete()
|
|
68
|
+
|
|
69
|
+
QRCodeDelete 删除已有的二维码 请求路径: DELETE /admin/qrcode/delete 权限要求: 需要管理员权限
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
QRCodeAdminServiceApi,
|
|
76
|
+
Configuration
|
|
77
|
+
} from '@cherryin/api-client';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new QRCodeAdminServiceApi(configuration);
|
|
81
|
+
|
|
82
|
+
let id: string; //@gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
|
|
83
|
+
|
|
84
|
+
const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeDelete(
|
|
85
|
+
id
|
|
86
|
+
);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
|Name | Type | Description | Notes|
|
|
92
|
+
|------------- | ------------- | ------------- | -------------|
|
|
93
|
+
| **id** | [**string**] | @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
**QRCodeDeleteResponse**
|
|
99
|
+
|
|
100
|
+
### Authorization
|
|
101
|
+
|
|
102
|
+
No authorization required
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: Not defined
|
|
107
|
+
- **Accept**: application/json
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### HTTP response details
|
|
111
|
+
| Status code | Description | Response headers |
|
|
112
|
+
|-------------|-------------|------------------|
|
|
113
|
+
|**200** | OK | - |
|
|
114
|
+
|**0** | Default error response | - |
|
|
115
|
+
|
|
116
|
+
[[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)
|
|
117
|
+
|
|
118
|
+
# **qRCodeAdminServiceQRCodeGet**
|
|
119
|
+
> QRCodeGetResponse qRCodeAdminServiceQRCodeGet()
|
|
120
|
+
|
|
121
|
+
QRCodeGet 获取指定的二维码及其历史版本 请求路径: GET /admin/qrcode/get 权限要求: 需要管理员权限
|
|
122
|
+
|
|
123
|
+
### Example
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import {
|
|
127
|
+
QRCodeAdminServiceApi,
|
|
128
|
+
Configuration
|
|
129
|
+
} from '@cherryin/api-client';
|
|
130
|
+
|
|
131
|
+
const configuration = new Configuration();
|
|
132
|
+
const apiInstance = new QRCodeAdminServiceApi(configuration);
|
|
133
|
+
|
|
134
|
+
let id: string; //@gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
|
|
135
|
+
let historyLimit: number; //@gotags: form:\"history_limit\" (optional) (default to undefined)
|
|
136
|
+
|
|
137
|
+
const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeGet(
|
|
138
|
+
id,
|
|
139
|
+
historyLimit
|
|
140
|
+
);
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|Name | Type | Description | Notes|
|
|
146
|
+
|------------- | ------------- | ------------- | -------------|
|
|
147
|
+
| **id** | [**string**] | @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
|
|
148
|
+
| **historyLimit** | [**number**] | @gotags: form:\"history_limit\" | (optional) defaults to undefined|
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
**QRCodeGetResponse**
|
|
154
|
+
|
|
155
|
+
### Authorization
|
|
156
|
+
|
|
157
|
+
No authorization required
|
|
158
|
+
|
|
159
|
+
### HTTP request headers
|
|
160
|
+
|
|
161
|
+
- **Content-Type**: Not defined
|
|
162
|
+
- **Accept**: application/json
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### HTTP response details
|
|
166
|
+
| Status code | Description | Response headers |
|
|
167
|
+
|-------------|-------------|------------------|
|
|
168
|
+
|**200** | OK | - |
|
|
169
|
+
|**0** | Default error response | - |
|
|
170
|
+
|
|
171
|
+
[[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)
|
|
172
|
+
|
|
173
|
+
# **qRCodeAdminServiceQRCodeList**
|
|
174
|
+
> QRCodeListResponse qRCodeAdminServiceQRCodeList()
|
|
175
|
+
|
|
176
|
+
QRCodeList 列出二维码列表 请求路径: GET /admin/qrcode/list 权限要求: 需要管理员权限
|
|
177
|
+
|
|
178
|
+
### Example
|
|
179
|
+
|
|
180
|
+
```typescript
|
|
181
|
+
import {
|
|
182
|
+
QRCodeAdminServiceApi,
|
|
183
|
+
Configuration
|
|
184
|
+
} from '@cherryin/api-client';
|
|
185
|
+
|
|
186
|
+
const configuration = new Configuration();
|
|
187
|
+
const apiInstance = new QRCodeAdminServiceApi(configuration);
|
|
188
|
+
|
|
189
|
+
let page: number; //@gotags: form:\"page\" (optional) (default to undefined)
|
|
190
|
+
let pageSize: number; //@gotags: form:\"page_size\" (optional) (default to undefined)
|
|
191
|
+
let namePrefix: string; //@gotags: form:\"name_prefix\" (optional) (default to undefined)
|
|
192
|
+
let status: number; //@gotags: form:\"status\" (optional) (default to undefined)
|
|
193
|
+
|
|
194
|
+
const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeList(
|
|
195
|
+
page,
|
|
196
|
+
pageSize,
|
|
197
|
+
namePrefix,
|
|
198
|
+
status
|
|
199
|
+
);
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Parameters
|
|
203
|
+
|
|
204
|
+
|Name | Type | Description | Notes|
|
|
205
|
+
|------------- | ------------- | ------------- | -------------|
|
|
206
|
+
| **page** | [**number**] | @gotags: form:\"page\" | (optional) defaults to undefined|
|
|
207
|
+
| **pageSize** | [**number**] | @gotags: form:\"page_size\" | (optional) defaults to undefined|
|
|
208
|
+
| **namePrefix** | [**string**] | @gotags: form:\"name_prefix\" | (optional) defaults to undefined|
|
|
209
|
+
| **status** | [**number**] | @gotags: form:\"status\" | (optional) defaults to undefined|
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
### Return type
|
|
213
|
+
|
|
214
|
+
**QRCodeListResponse**
|
|
215
|
+
|
|
216
|
+
### Authorization
|
|
217
|
+
|
|
218
|
+
No authorization required
|
|
219
|
+
|
|
220
|
+
### HTTP request headers
|
|
221
|
+
|
|
222
|
+
- **Content-Type**: Not defined
|
|
223
|
+
- **Accept**: application/json
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
### HTTP response details
|
|
227
|
+
| Status code | Description | Response headers |
|
|
228
|
+
|-------------|-------------|------------------|
|
|
229
|
+
|**200** | OK | - |
|
|
230
|
+
|**0** | Default error response | - |
|
|
231
|
+
|
|
232
|
+
[[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)
|
|
233
|
+
|
|
234
|
+
# **qRCodeAdminServiceQRCodeUpdate**
|
|
235
|
+
> QRCodeUpdateResponse qRCodeAdminServiceQRCodeUpdate(qRCodeUpdateRequest)
|
|
236
|
+
|
|
237
|
+
QRCodeUpdate 更新已有的二维码 请求路径: POST /admin/qrcode/update 权限要求: 需要管理员权限
|
|
238
|
+
|
|
239
|
+
### Example
|
|
240
|
+
|
|
241
|
+
```typescript
|
|
242
|
+
import {
|
|
243
|
+
QRCodeAdminServiceApi,
|
|
244
|
+
Configuration,
|
|
245
|
+
QRCodeUpdateRequest
|
|
246
|
+
} from '@cherryin/api-client';
|
|
247
|
+
|
|
248
|
+
const configuration = new Configuration();
|
|
249
|
+
const apiInstance = new QRCodeAdminServiceApi(configuration);
|
|
250
|
+
|
|
251
|
+
let qRCodeUpdateRequest: QRCodeUpdateRequest; //
|
|
252
|
+
|
|
253
|
+
const { status, data } = await apiInstance.qRCodeAdminServiceQRCodeUpdate(
|
|
254
|
+
qRCodeUpdateRequest
|
|
255
|
+
);
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Parameters
|
|
259
|
+
|
|
260
|
+
|Name | Type | Description | Notes|
|
|
261
|
+
|------------- | ------------- | ------------- | -------------|
|
|
262
|
+
| **qRCodeUpdateRequest** | **QRCodeUpdateRequest**| | |
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
**QRCodeUpdateResponse**
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
No authorization required
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: application/json
|
|
276
|
+
- **Accept**: application/json
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
### HTTP response details
|
|
280
|
+
| Status code | Description | Response headers |
|
|
281
|
+
|-------------|-------------|------------------|
|
|
282
|
+
|**200** | OK | - |
|
|
283
|
+
|**0** | Default error response | - |
|
|
284
|
+
|
|
285
|
+
[[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)
|
|
286
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# QRCodeCreateRequest
|
|
2
|
+
|
|
3
|
+
QRCodeCreateRequest 创建二维码请求
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**storage_type** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**storage_bucket** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**expire_at** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**file_data** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**filename** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**storage_target_key** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**target_content_ext** | **string** | | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { QRCodeCreateRequest } from '@cherryin/api-client';
|
|
23
|
+
|
|
24
|
+
const instance: QRCodeCreateRequest = {
|
|
25
|
+
name,
|
|
26
|
+
description,
|
|
27
|
+
storage_type,
|
|
28
|
+
storage_bucket,
|
|
29
|
+
expire_at,
|
|
30
|
+
file_data,
|
|
31
|
+
filename,
|
|
32
|
+
storage_target_key,
|
|
33
|
+
target_content_ext,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|