@cherryin/api-client 0.0.4 → 0.0.5

package/docs/AuthFlowResult.md

@@ -1,23 +0,0 @@
-# AuthFlowResult
-
-AuthFlowResult 授权登录态获取成功后的数据
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**is_authed** | **boolean** |  | [optional] [default to undefined]
-**auth_tokens** | [**AuthTokenPair**](AuthTokenPair.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AuthFlowResult } from '@cherryin/api-client';
-
-const instance: AuthFlowResult = {
-    is_authed,
-    auth_tokens,
-};
-```
-
-[[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/UserAuthFlowCodeResponse.md

@@ -1,26 +0,0 @@
-# UserAuthFlowCodeResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | 如果验证通过立刻下发登录态，则会通过这个返回鉴权的 AuthToken  如果注册成功，还需要登录，则不会下发 | [optional] [default to undefined]
-**user_info** | [**UserAuthInfo**](UserAuthInfo.md) | 注册成功后返回的用户信息 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UserAuthFlowCodeResponse } from '@cherryin/api-client';
-
-const instance: UserAuthFlowCodeResponse = {
-    code,
-    message,
-    auth_result,
-    user_info,
-};
-```
-
-[[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/UserAuthFlowInitResponse.md

@@ -1,28 +0,0 @@
-# UserAuthFlowInitResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**oauth_result** | [**UserAuthFlowInitResponseOAuthResult**](UserAuthFlowInitResponseOAuthResult.md) | for AuthType=OAuth2 才会返回 | [optional] [default to undefined]
-**auth_result** | [**AuthFlowResult**](AuthFlowResult.md) | 对于部分流程，只需要 init 即可完成授权登录态，则会直接返回 AuthData  否则需要继续走完后续流程和调用相关接口 | [optional] [default to undefined]
-**user_info** | [**UserAuthInfo**](UserAuthInfo.md) | 注册成功后返回的用户信息 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UserAuthFlowInitResponse } from '@cherryin/api-client';
-
-const instance: UserAuthFlowInitResponse = {
-    code,
-    message,
-    oauth_result,
-    auth_result,
-    user_info,
-};
-```
-
-[[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/UserAuthServiceApi.md

@@ -1,279 +0,0 @@
-# UserAuthServiceApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**userAuthServiceUserAuthFlowCode**](#userauthserviceuserauthflowcode) | **POST** /auth/v1/flow/code | |
-|[**userAuthServiceUserAuthFlowInit**](#userauthserviceuserauthflowinit) | **POST** /auth/v1/flow/init | |
-|[**userAuthServiceUserAuthFlowOAuthCallback**](#userauthserviceuserauthflowoauthcallback) | **GET** /auth/v1/flow/oauth/cb | |
-|[**userAuthServiceUserAuthFlowTokenRefresh**](#userauthserviceuserauthflowtokenrefresh) | **POST** /auth/v1/flow/refresh_token | |
-
-# **userAuthServiceUserAuthFlowCode**
-> UserAuthFlowCodeResponse userAuthServiceUserAuthFlowCode()
-
-提交验证码流程
-
-### Example
-
-```typescript
-import {
-    UserAuthServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new UserAuthServiceApi(configuration);
-
-let authType: number; // (optional) (default to undefined)
-let authAction: number; // (optional) (default to undefined)
-let payloadEmailPayloadUserEmail: string; // (optional) (default to undefined)
-let payloadEmailPayloadAuthCode: 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_v1:{auth_type}:{auth_action}:{auth_at}:{nonce}:{payload.k1}:{payload.k2}:...}\"  step2: md5(s)  step3: hex_encode(step2)   Payload 字段参与加密的字段如下:  AuthType=Email:(空字符串也需要拼接)    * UserEmail | AuthCode | UserPasswordEncrypt  ) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.userAuthServiceUserAuthFlowCode(
-    authType,
-    authAction,
-    payloadEmailPayloadUserEmail,
-    payloadEmailPayloadAuthCode,
-    payloadEmailPayloadUserPasswordEncrypt,
-    authAt,
-    nonce,
-    signature
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authType** | [**number**] |  | (optional) defaults to undefined|
-| **authAction** | [**number**] |  | (optional) defaults to undefined|
-| **payloadEmailPayloadUserEmail** | [**string**] |  | (optional) defaults to undefined|
-| **payloadEmailPayloadAuthCode** | [**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_v1:{auth_type}:{auth_action}:{auth_at}:{nonce}:{payload.k1}:{payload.k2}:...}\"  step2: md5(s)  step3: hex_encode(step2)   Payload 字段参与加密的字段如下:  AuthType=Email:(空字符串也需要拼接)    * UserEmail | AuthCode | UserPasswordEncrypt  ) | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserAuthFlowCodeResponse**
-
-### 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)
-
-# **userAuthServiceUserAuthFlowInit**
-> UserAuthFlowInitResponse userAuthServiceUserAuthFlowInit()
-
-鉴权流程启动
-
-### Example
-
-```typescript
-import {
-    UserAuthServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new UserAuthServiceApi(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 payloadEmailPayloadDisplayName: string; // (optional) (default to undefined)
-let payloadOauth2PayloadPlatform: number; // (optional) (default to undefined)
-let authAt: string; // (optional) (default to undefined)
-let nonce: string; // (optional) (default to undefined)
-let signature: string; //加密方式:  step1: 拼接一个字符串: s = \"cherryin_v1:{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)
-
-const { status, data } = await apiInstance.userAuthServiceUserAuthFlowInit(
-    authType,
-    authAction,
-    payloadEmailPayloadUserEmail,
-    payloadEmailPayloadUserPasswordEncrypt,
-    payloadEmailPayloadDisplayName,
-    payloadOauth2PayloadPlatform,
-    authAt,
-    nonce,
-    signature
-);
-```
-
-### 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|
-| **payloadEmailPayloadDisplayName** | [**string**] |  | (optional) defaults to undefined|
-| **payloadOauth2PayloadPlatform** | [**number**] |  | (optional) defaults to undefined|
-| **authAt** | [**string**] |  | (optional) defaults to undefined|
-| **nonce** | [**string**] |  | (optional) defaults to undefined|
-| **signature** | [**string**] | 加密方式:  step1: 拼接一个字符串: s = \"cherryin_v1:{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|
-
-
-### Return type
-
-**UserAuthFlowInitResponse**
-
-### 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)
-
-# **userAuthServiceUserAuthFlowOAuthCallback**
-> UserAuthFlowOAuthCallbackResponse userAuthServiceUserAuthFlowOAuthCallback()
-
-OAUTH 流程验证回调
-
-### Example
-
-```typescript
-import {
-    UserAuthServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new UserAuthServiceApi(configuration);
-
-let code: string; // (optional) (default to undefined)
-let state: string; // (optional) (default to undefined)
-let platform: number; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.userAuthServiceUserAuthFlowOAuthCallback(
-    code,
-    state,
-    platform
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **code** | [**string**] |  | (optional) defaults to undefined|
-| **state** | [**string**] |  | (optional) defaults to undefined|
-| **platform** | [**number**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserAuthFlowOAuthCallbackResponse**
-
-### 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)
-
-# **userAuthServiceUserAuthFlowTokenRefresh**
-> UserAuthFlowOAuthCallbackRequest userAuthServiceUserAuthFlowTokenRefresh()
-
-Auth Token 刷新接口
-
-### Example
-
-```typescript
-import {
-    UserAuthServiceApi,
-    Configuration
-} from '@cherryin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new UserAuthServiceApi(configuration);
-
-let refreshToken: string; // (optional) (default to undefined)
-let authAt: string; // (optional) (default to undefined)
-let nonce: string; // (optional) (default to undefined)
-let signature: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.userAuthServiceUserAuthFlowTokenRefresh(
-    refreshToken,
-    authAt,
-    nonce,
-    signature
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **refreshToken** | [**string**] |  | (optional) defaults to undefined|
-| **authAt** | [**string**] |  | (optional) defaults to undefined|
-| **nonce** | [**string**] |  | (optional) defaults to undefined|
-| **signature** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserAuthFlowOAuthCallbackRequest**
-
-### 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)
-