npm - @cherryin/api-client - Versions diffs - 0.0.20 → 0.1.1 - Mend

@cherryin/api-client 0.0.20 → 0.1.1

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.

Files changed (323) hide show

package/docs/PassportUserOAuthCallbackResponse.md DELETED Viewed

@@ -1,36 +0,0 @@
-# PassportUserOAuthCallbackResponse
-## 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]
-**is_linked** | **boolean** |  | [optional] [default to undefined]
-**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserOAuthCallbackResponse } from '@cherryin/api-client';
-const instance: PassportUserOAuthCallbackResponse = {
-    code,
-    message,
-    token,
-    url,
-    redirect,
-    is_linked,
-    passport,
-    sessions,
-    users,
-};
-```
-[[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/PassportUserPasswordForgetRequest.md DELETED Viewed

@@ -1,24 +0,0 @@
-# PassportUserPasswordForgetRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**callback_url** | **string** | 注意是前端回调地址，用于用户邮箱点击跳转前端重置密码页 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserPasswordForgetRequest } from '@cherryin/api-client';
-const instance: PassportUserPasswordForgetRequest = {
-    app_ids,
-    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/PassportUserPasswordForgetResponse.md DELETED Viewed

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

@@ -1,30 +0,0 @@
-# PassportUserPasswordResetRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**verify_code** | **string** |  | [optional] [default to undefined]
-**new_password** | **string** |  | [optional] [default to undefined]
-**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
-**callback_url** | **string** |  | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserPasswordResetRequest } from '@cherryin/api-client';
-const instance: PassportUserPasswordResetRequest = {
-    app_ids,
-    email,
-    verify_code,
-    new_password,
-    redirect,
-    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/PassportUserPasswordResetTokenVerifyRequest.md DELETED Viewed

@@ -1,22 +0,0 @@
-# PassportUserPasswordResetTokenVerifyRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [optional] [default to undefined]
-**token** | **string** | 重置密码请求重置的 token | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserPasswordResetTokenVerifyRequest } from '@cherryin/api-client';
-const instance: PassportUserPasswordResetTokenVerifyRequest = {
-    app_ids,
-    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/PassportUserPasswordResetTokenVerifyResponse.md DELETED Viewed

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

@@ -1,32 +0,0 @@
-# PassportUserSignInEmailRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**password** | **string** |  | [optional] [default to undefined]
-**verify_code** | **string** |  | [optional] [default to undefined]
-**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
-**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
-**callback_url** | **string** |  | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignInEmailRequest } from '@cherryin/api-client';
-const instance: PassportUserSignInEmailRequest = {
-    app_ids,
-    email,
-    password,
-    verify_code,
-    remember_me,
-    redirect,
-    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/PassportUserSignInEmailResponse.md DELETED Viewed

@@ -1,32 +0,0 @@
-# PassportUserSignInEmailResponse
-## 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]
-**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignInEmailResponse } from '@cherryin/api-client';
-const instance: PassportUserSignInEmailResponse = {
-    code,
-    message,
-    redirect,
-    url,
-    passport,
-    sessions,
-    users,
-};
-```
-[[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/PassportUserSignInPhoneRequest.md DELETED Viewed

@@ -1,26 +0,0 @@
-# PassportUserSignInPhoneRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [optional] [default to undefined]
-**phone_number** | **string** | 手机号，E164 格式 | [optional] [default to undefined]
-**verify_code** | **string** | 验证码 | [optional] [default to undefined]
-**auto_register** | **boolean** | 登录即注册，开启后默认是通过手机号登录验证通过，没有对应用户时会自动注册新用户 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignInPhoneRequest } from '@cherryin/api-client';
-const instance: PassportUserSignInPhoneRequest = {
-    app_ids,
-    phone_number,
-    verify_code,
-    auto_register,
-};
-```
-[[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/PassportUserSignInPhoneResponse.md DELETED Viewed

@@ -1,28 +0,0 @@
-# PassportUserSignInPhoneResponse
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignInPhoneResponse } from '@cherryin/api-client';
-const instance: PassportUserSignInPhoneResponse = {
-    code,
-    message,
-    passport,
-    sessions,
-    users,
-};
-```
-[[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/PassportUserSignInSocialResponse.md DELETED Viewed

@@ -1,32 +0,0 @@
-# PassportUserSignInSocialResponse
-## 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]
-**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignInSocialResponse } from '@cherryin/api-client';
-const instance: PassportUserSignInSocialResponse = {
-    code,
-    message,
-    redirect,
-    url,
-    passport,
-    sessions,
-    users,
-};
-```
-[[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/PassportUserSignUpEmailRequest.md DELETED Viewed

@@ -1,36 +0,0 @@
-# PassportUserSignUpEmailRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**app_ids** | **string** | User.AppID, 支持多个应用同时注册，如果没有通行证，则创建新通行证  NOTE: app_ids 是 \&#39;:\&#39; 分隔的字符串列表 | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**password** | **string** |  | [optional] [default to undefined]
-**verify_code** | **string** |  | [optional] [default to undefined]
-**avatar_url** | **string** |  | [optional] [default to undefined]
-**redirect** | **boolean** | 是否禁用服务端重定向, 携带 callback_url 时有效 | [optional] [default to undefined]
-**callback_url** | **string** |  | [optional] [default to undefined]
-**remember_me** | **boolean** | 保留参数, 目前暂不设置 cookie | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignUpEmailRequest } from '@cherryin/api-client';
-const instance: PassportUserSignUpEmailRequest = {
-    app_ids,
-    name,
-    email,
-    password,
-    verify_code,
-    avatar_url,
-    redirect,
-    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/PassportUserSignUpEmailResponse.md DELETED Viewed

@@ -1,32 +0,0 @@
-# PassportUserSignUpEmailResponse
-## 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]
-**passport** | [**AuthPassport**](AuthPassport.md) | 用户当前的通行证和会话信息 | [optional] [default to undefined]
-**sessions** | [**Array&lt;AuthUserSession&gt;**](AuthUserSession.md) | 每个应用对应的会话信息 | [optional] [default to undefined]
-**users** | [**Array&lt;AuthUser&gt;**](AuthUser.md) | 每个应用对应的用户信息 | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserSignUpEmailResponse } from '@cherryin/api-client';
-const instance: PassportUserSignUpEmailResponse = {
-    code,
-    message,
-    redirect,
-    url,
-    passport,
-    sessions,
-    users,
-};
-```
-[[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/PassportUserTokenAuthResponse.md DELETED Viewed

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

@@ -1,30 +0,0 @@
-# PassportUserUpdateInfoRequest
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uid** | **string** |  | [optional] [default to undefined]
-**user** | [**UserBasic**](UserBasic.md) |  | [optional] [default to undefined]
-**settings** | [**UserSettings**](UserSettings.md) |  | [optional] [default to undefined]
-**preferences** | [**UserPreferences**](UserPreferences.md) |  | [optional] [default to undefined]
-**payment_info** | [**UserPaymentInfo**](UserPaymentInfo.md) |  | [optional] [default to undefined]
-**extend_info** | [**UserExtendInfo**](UserExtendInfo.md) |  | [optional] [default to undefined]
-## Example
-```typescript
-import { PassportUserUpdateInfoRequest } from '@cherryin/api-client';
-const instance: PassportUserUpdateInfoRequest = {
-    uid,
-    user,
-    settings,
-    preferences,
-    payment_info,
-    extend_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/PassportUserUpdateInfoResponse.md DELETED Viewed

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

@@ -1,27 +0,0 @@
-# ProviderGCPAuth
-ProviderGCPAuth 代表 Google Cloud Platform 的认证详情
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**region** | **string** | region GCP 区域，例如 \&quot;us-central1\&quot;, \&quot;europe-west4\&quot; | [optional] [default to undefined]
-**project_name** | **string** | project_name GCP 项目名称 | [optional] [default to undefined]
-**credentials** | **string** | credentials GCP 凭证的 JSON 格式内容 | [optional] [default to undefined]
-**backend** | **number** | backend Google 后端类型  1: Gemini API  2: Vertex AI | [optional] [default to undefined]
-## Example
-```typescript
-import { ProviderGCPAuth } from '@cherryin/api-client';
-const instance: ProviderGCPAuth = {
-    region,
-    project_name,
-    credentials,
-    backend,
-};
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)