@cherryin/api-client 0.0.4 → 0.0.5

package/docs/AuthListAccountsResponse.md

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

@@ -0,0 +1,24 @@
+# AuthListSessionsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**sessions** | [**Array<Auth2Session>**](Auth2Session.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthListSessionsResponse } from '@cherryin/api-client';
+
+const instance: AuthListSessionsResponse = {
+    code,
+    message,
+    sessions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AuthOAuth2CallbackResponse.md

@@ -0,0 +1,32 @@
+# AuthOAuth2CallbackResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
+**user** | [**Auth2User**](Auth2User.md) |  | [optional] [default to undefined]
+**is_linked** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthOAuth2CallbackResponse } from '@cherryin/api-client';
+
+const instance: AuthOAuth2CallbackResponse = {
+    code,
+    message,
+    token,
+    url,
+    redirect,
+    user,
+    is_linked,
+};
+```
+
+[[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/AuthRefreshTokenRequest.md

@@ -0,0 +1,24 @@
+# AuthRefreshTokenRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider_id** | **string** |  | [optional] [default to undefined]
+**account_id** | **string** |  | [optional] [default to undefined]
+**user_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthRefreshTokenRequest } from '@cherryin/api-client';
+
+const instance: AuthRefreshTokenRequest = {
+    provider_id,
+    account_id,
+    user_id,
+};
+```
+
+[[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/AuthRefreshTokenResponse.md

@@ -0,0 +1,34 @@
+# AuthRefreshTokenResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**token_type** | **string** |  | [optional] [default to undefined]
+**id_token** | **string** |  | [optional] [default to undefined]
+**access_token** | **string** |  | [optional] [default to undefined]
+**refresh_token** | **string** |  | [optional] [default to undefined]
+**access_token_expires_at** | **string** |  | [optional] [default to undefined]
+**refresh_token_expires_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthRefreshTokenResponse } from '@cherryin/api-client';
+
+const instance: AuthRefreshTokenResponse = {
+    code,
+    message,
+    token_type,
+    id_token,
+    access_token,
+    refresh_token,
+    access_token_expires_at,
+    refresh_token_expires_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/AuthRequestPasswordResetRequest.md

@@ -0,0 +1,22 @@
+# AuthRequestPasswordResetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**redirect_to** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthRequestPasswordResetRequest } from '@cherryin/api-client';
+
+const instance: AuthRequestPasswordResetRequest = {
+    email,
+    redirect_to,
+};
+```
+
+[[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/{UserAuthFlowOAuthCallbackRequest.md → AuthRequestPasswordResetResponse.md}

@@ -1,4 +1,4 @@
-# UserAuthFlowOAuthCallbackRequest
+# AuthRequestPasswordResetResponse
 
 
 ## Properties
@@ -6,18 +6,18 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
-**state** | **string** |  | [optional] [default to undefined]
-**platform** | **number** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**status** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { UserAuthFlowOAuthCallbackRequest } from '@cherryin/api-client';
+import { AuthRequestPasswordResetResponse } from '@cherryin/api-client';
 
-const instance: UserAuthFlowOAuthCallbackRequest = {
+const instance: AuthRequestPasswordResetResponse = {
     code,
-    state,
-    platform,
+    message,
+    status,
 };
 ```
 

package/docs/AuthResetPasswordRequest.md

@@ -0,0 +1,22 @@
+# AuthResetPasswordRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_password** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthResetPasswordRequest } from '@cherryin/api-client';
+
+const instance: AuthResetPasswordRequest = {
+    new_password,
+    token,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{AdminAuthFlowInitResponse.md → AuthResetPasswordResponse.md}

@@ -1,4 +1,4 @@
-# AdminAuthFlowInitResponse
+# AuthResetPasswordResponse
 
 
 ## Properties
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | 对于部分流程(例如邮箱密码登录)，只需要 init 即可完成授权登录态，则会直接返回 AuthData  否则需要继续走完后续流程和调用相关接口. | [optional] [default to undefined]
+**status** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AdminAuthFlowInitResponse } from '@cherryin/api-client';
+import { AuthResetPasswordResponse } from '@cherryin/api-client';
 
-const instance: AdminAuthFlowInitResponse = {
+const instance: AuthResetPasswordResponse = {
     code,
     message,
-    auth_result,
+    status,
 };
 ```
 

package/docs/AuthRevokeOtherSessionsResponse.md

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

@@ -1,19 +1,19 @@
-# UserAuthInfo
+# AuthRevokeSessionRequest
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**user_info** | [**UserInfo**](UserInfo.md) |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { UserAuthInfo } from '@cherryin/api-client';
+import { AuthRevokeSessionRequest } from '@cherryin/api-client';
 
-const instance: UserAuthInfo = {
-    user_info,
+const instance: AuthRevokeSessionRequest = {
+    token,
 };
 ```
 

package/docs/AuthRevokeSessionResponse.md

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

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

@@ -0,0 +1,22 @@
+# AuthSendVerificationEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSendVerificationEmailRequest } from '@cherryin/api-client';
+
+const instance: AuthSendVerificationEmailRequest = {
+    email,
+    callback_url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{UserAuthFlowOAuthCallbackResponse.md → AuthSendVerificationEmailResponse.md}

@@ -1,4 +1,4 @@
-# UserAuthFlowOAuthCallbackResponse
+# AuthSendVerificationEmailResponse
 
 
 ## Properties
@@ -7,19 +7,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [optional] [default to undefined]
 **message** | **string** |  | [optional] [default to undefined]
-**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) |  | [optional] [default to undefined]
-**user_info** | [**UserAuthInfo**](UserAuthInfo.md) |  | [optional] [default to undefined]
+**status** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { UserAuthFlowOAuthCallbackResponse } from '@cherryin/api-client';
+import { AuthSendVerificationEmailResponse } from '@cherryin/api-client';
 
-const instance: UserAuthFlowOAuthCallbackResponse = {
+const instance: AuthSendVerificationEmailResponse = {
     code,
     message,
-    auth_result,
-    user_info,
+    status,
 };
 ```
 

package/docs/AuthSignInEmailRequest.md

@@ -0,0 +1,26 @@
+# AuthSignInEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSignInEmailRequest } from '@cherryin/api-client';
+
+const instance: AuthSignInEmailRequest = {
+    email,
+    password,
+    callback_url,
+    remember_me,
+};
+```
+
+[[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/AuthSignInEmailResponse.md

@@ -0,0 +1,30 @@
+# AuthSignInEmailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**user** | [**Auth2User**](Auth2User.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSignInEmailResponse } from '@cherryin/api-client';
+
+const instance: AuthSignInEmailResponse = {
+    code,
+    message,
+    redirect,
+    token,
+    url,
+    user,
+};
+```
+
+[[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/AuthSignInSocialRequest.md

@@ -0,0 +1,30 @@
+# AuthSignInSocialRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**error_callback_url** | **string** |  | [optional] [default to undefined]
+**disable_redirect** | **boolean** |  | [optional] [default to undefined]
+**id_token** | [**Auth2IdToken**](Auth2IdToken.md) |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSignInSocialRequest } from '@cherryin/api-client';
+
+const instance: AuthSignInSocialRequest = {
+    provider,
+    callback_url,
+    error_callback_url,
+    disable_redirect,
+    id_token,
+    scopes,
+};
+```
+
+[[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/AuthSignInSocialResponse.md

@@ -0,0 +1,30 @@
+# AuthSignInSocialResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**user** | [**Auth2User**](Auth2User.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSignInSocialResponse } from '@cherryin/api-client';
+
+const instance: AuthSignInSocialResponse = {
+    code,
+    message,
+    redirect,
+    token,
+    url,
+    user,
+};
+```
+
+[[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/AuthSignOutResponse.md

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

@@ -0,0 +1,32 @@
+# AuthSignUpEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**image** | **string** |  | [optional] [default to undefined]
+**callback_url** | **string** |  | [optional] [default to undefined]
+**remember_me** | **boolean** |  | [optional] [default to undefined]
+**disable_redirect** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSignUpEmailRequest } from '@cherryin/api-client';
+
+const instance: AuthSignUpEmailRequest = {
+    name,
+    email,
+    password,
+    image,
+    callback_url,
+    remember_me,
+    disable_redirect,
+};
+```
+
+[[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/AuthSignUpEmailResponse.md

@@ -0,0 +1,28 @@
+# AuthSignUpEmailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**redirect** | **boolean** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**user** | [**Auth2User**](Auth2User.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthSignUpEmailResponse } from '@cherryin/api-client';
+
+const instance: AuthSignUpEmailResponse = {
+    code,
+    message,
+    redirect,
+    url,
+    user,
+};
+```
+
+[[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/AuthUnlinkAccountRequest.md

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

@@ -0,0 +1,24 @@
+# AuthUnlinkAccountResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**status** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthUnlinkAccountResponse } from '@cherryin/api-client';
+
+const instance: AuthUnlinkAccountResponse = {
+    code,
+    message,
+    status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)