@cherryin/api-client 0.0.3 → 0.0.4

package/docs/UserAuthServiceApi.md

@@ -0,0 +1,279 @@
+# 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)
+

package/docs/UserInfo.md

@@ -5,13 +5,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**email_verified** | **boolean** |  | [optional] [default to undefined]
-**image** | **string** |  | [optional] [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-**updated_at** | **string** |  | [optional] [default to undefined]
+**user_id** | **string** |  | [optional] [default to undefined]
+**display_name** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**contact_email** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -19,13 +16,10 @@ Name | Type | Description | Notes
 import { UserInfo } from '@cherryin/api-client';
 
 const instance: UserInfo = {
-    id,
-    name,
-    email,
-    email_verified,
-    image,
-    created_at,
-    updated_at,
+    user_id,
+    display_name,
+    avatar_url,
+    contact_email,
 };
 ```
 

package/docs/UserPayServiceApi.md

@@ -22,17 +22,11 @@ const configuration = new Configuration();
 const apiInstance = new UserPayServiceApi(configuration);
 
 let currencyCode: string; // (optional) (default to undefined)
-let chargeAmount: string; // (optional) (default to undefined)
-let redirect: boolean; // (optional) (default to undefined)
-let successUrl: string; // (optional) (default to undefined)
-let cancelUrl: string; // (optional) (default to undefined)
+let chargeAmount: number; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.userPayServiceUserPayStripeCheckout(
     currencyCode,
-    chargeAmount,
-    redirect,
-    successUrl,
-    cancelUrl
+    chargeAmount
 );
 ```
 
@@ -41,10 +35,7 @@ const { status, data } = await apiInstance.userPayServiceUserPayStripeCheckout(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **currencyCode** | [**string**] |  | (optional) defaults to undefined|
-| **chargeAmount** | [**string**] |  | (optional) defaults to undefined|
-| **redirect** | [**boolean**] |  | (optional) defaults to undefined|
-| **successUrl** | [**string**] |  | (optional) defaults to undefined|
-| **cancelUrl** | [**string**] |  | (optional) defaults to undefined|
+| **chargeAmount** | [**number**] |  | (optional) defaults to undefined|
 
 
 ### Return type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cherryin/api-client",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "OpenAPI client for @cherryin/api-client",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/AIModelCheckConnectionResponse.md

@@ -1,25 +0,0 @@
-# AIModelCheckConnectionResponse
-
-AIModelCheckResult AI 模型连接检查结果
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**results** | [**Array<AIModelCheckResult>**](AIModelCheckResult.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AIModelCheckConnectionResponse } from '@cherryin/api-client';
-
-const instance: AIModelCheckConnectionResponse = {
-    code,
-    message,
-    results,
-};
-```
-
-[[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/AIModelCheckItem.md

@@ -1,32 +0,0 @@
-# AIModelCheckItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ai_model_name** | **string** | AI 模型名称 | [optional] [default to undefined]
-**provider_name** | **string** | 供应商名称 | [optional] [default to undefined]
-**provider_model_name** | **string** | 供应商模型名称 | [optional] [default to undefined]
-**ai_model_endpoint** | **string** | AI 模型端点 | [optional] [default to undefined]
-**provider_model_endpoint** | **string** | 供应商模型端点 | [optional] [default to undefined]
-**is_valid** | **boolean** | 是否有效 | [optional] [default to undefined]
-**error** | **string** | 错误信息 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AIModelCheckItem } from '@cherryin/api-client';
-
-const instance: AIModelCheckItem = {
-    ai_model_name,
-    provider_name,
-    provider_model_name,
-    ai_model_endpoint,
-    provider_model_endpoint,
-    is_valid,
-    error,
-};
-```
-
-[[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/AIModelCheckResult.md

@@ -1,23 +0,0 @@
-# AIModelCheckResult
-
-AIModelCheckResult AI 模型验证结果
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ai_model_name** | **string** | AI 模型名称 | [optional] [default to undefined]
-**items** | [**Array<AIModelCheckItem>**](AIModelCheckItem.md) | 供应商名称 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AIModelCheckResult } from '@cherryin/api-client';
-
-const instance: AIModelCheckResult = {
-    ai_model_name,
-    items,
-};
-```
-
-[[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/Auth2Account.md

@@ -1,33 +0,0 @@
-# Auth2Account
-
-关联账号信息 (映射 db.UserAuthMethod)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**account_id** | **string** |  | [optional] [default to undefined]
-**provider_id** | **string** |  | [optional] [default to undefined]
-**user_id** | **string** |  | [optional] [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-**updated_at** | **string** |  | [optional] [default to undefined]
-**scopes** | **Array<string>** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Auth2Account } from '@cherryin/api-client';
-
-const instance: Auth2Account = {
-    id,
-    account_id,
-    provider_id,
-    user_id,
-    created_at,
-    updated_at,
-    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/Auth2Admin.md

@@ -1,33 +0,0 @@
-# Auth2Admin
-
-管理员用户信息 (映射 db.User，包含角色信息)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**image** | **string** |  | [optional] [default to undefined]
-**role** | **number** |  | [optional] [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-**updated_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Auth2Admin } from '@cherryin/api-client';
-
-const instance: Auth2Admin = {
-    id,
-    name,
-    email,
-    image,
-    role,
-    created_at,
-    updated_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)