@cherryin/api-client 0.0.13 → 0.0.15

package/docs/PassportAuthUserRPCServiceApi.md

@@ -0,0 +1,223 @@
+# PassportAuthUserRPCServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**passportAuthUserRPCServicePassportUserInfoBatchGet**](#passportauthuserrpcservicepassportuserinfobatchget) | **POST** /passport/authed/v1/users/batch_get | |
+|[**passportAuthUserRPCServicePassportUserInfoGet**](#passportauthuserrpcservicepassportuserinfoget) | **POST** /passport/authed/v1/user/get | |
+|[**passportAuthUserRPCServicePassportUserTokenAuth**](#passportauthuserrpcservicepassportusertokenauth) | **POST** /passport/authed/v1/passports | |
+|[**passportAuthUserRPCServicePassportUserUpdateInfo**](#passportauthuserrpcservicepassportuserupdateinfo) | **POST** /passport/authed/v1/user/update | |
+
+# **passportAuthUserRPCServicePassportUserInfoBatchGet**
+> PassportUserInfoBatchGetResponse passportAuthUserRPCServicePassportUserInfoBatchGet(passportUserInfoBatchGetRequest)
+
+批量获取用户信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserRPCServiceApi,
+    Configuration,
+    PassportUserInfoBatchGetRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
+
+let passportUserInfoBatchGetRequest: PassportUserInfoBatchGetRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserInfoBatchGet(
+    passportUserInfoBatchGetRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserInfoBatchGetRequest** | **PassportUserInfoBatchGetRequest**|  | |
+
+
+### Return type
+
+**PassportUserInfoBatchGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **passportAuthUserRPCServicePassportUserInfoGet**
+> PassportUserInfoGetResponse passportAuthUserRPCServicePassportUserInfoGet(passportUserInfoGetRequest)
+
+获取用户信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserRPCServiceApi,
+    Configuration,
+    PassportUserInfoGetRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
+
+let passportUserInfoGetRequest: PassportUserInfoGetRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserInfoGet(
+    passportUserInfoGetRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserInfoGetRequest** | **PassportUserInfoGetRequest**|  | |
+
+
+### Return type
+
+**PassportUserInfoGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **passportAuthUserRPCServicePassportUserTokenAuth**
+> PassportUserTokenAuthResponse passportAuthUserRPCServicePassportUserTokenAuth(passportUserTokenAuthRequest)
+
+Token 鉴权 - User
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserRPCServiceApi,
+    Configuration,
+    PassportUserTokenAuthRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
+
+let passportUserTokenAuthRequest: PassportUserTokenAuthRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserTokenAuth(
+    passportUserTokenAuthRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserTokenAuthRequest** | **PassportUserTokenAuthRequest**|  | |
+
+
+### Return type
+
+**PassportUserTokenAuthResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **passportAuthUserRPCServicePassportUserUpdateInfo**
+> PassportUserUpdateInfoResponse passportAuthUserRPCServicePassportUserUpdateInfo(passportUserUpdateInfoRequest)
+
+更新用户信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserRPCServiceApi,
+    Configuration,
+    PassportUserUpdateInfoRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserRPCServiceApi(configuration);
+
+let passportUserUpdateInfoRequest: PassportUserUpdateInfoRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserRPCServicePassportUserUpdateInfo(
+    passportUserUpdateInfoRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserUpdateInfoRequest** | **PassportUserUpdateInfoRequest**|  | |
+
+
+### Return type
+
+**PassportUserUpdateInfoResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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/PassportAuthUserUpdateInfoRequest.md

@@ -5,9 +5,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**app_ids** | **string** | NOTE: app_ids 是 \':\' 分隔的字符串列表 | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**avatar_url** | **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
 
@@ -15,9 +17,11 @@ Name | Type | Description | Notes
 import { PassportAuthUserUpdateInfoRequest } from '@cherryin/api-client';
 
 const instance: PassportAuthUserUpdateInfoRequest = {
-    app_ids,
-    name,
-    avatar_url,
+    user,
+    settings,
+    preferences,
+    payment_info,
+    extend_info,
 };
 ```
 

package/docs/PassportEnterpriseTokenAuthRequest.md

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

@@ -0,0 +1,28 @@
+# PassportEnterpriseTokenAuthResponse
+
+
+## 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** | [**AuthEnterpriseSession**](AuthEnterpriseSession.md) |  | [optional] [default to undefined]
+**user** | [**AuthEnterpriseUser**](AuthEnterpriseUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportEnterpriseTokenAuthResponse } from '@cherryin/api-client';
+
+const instance: PassportEnterpriseTokenAuthResponse = {
+    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/PassportUserInfoBatchGetRequest.md

@@ -0,0 +1,24 @@
+# PassportUserInfoBatchGetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uids** | **Array<string>** |  | [optional] [default to undefined]
+**ignore_cache** | **boolean** |  | [optional] [default to undefined]
+**query_options** | [**UserInfoQueryOptions**](UserInfoQueryOptions.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserInfoBatchGetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserInfoBatchGetRequest = {
+    uids,
+    ignore_cache,
+    query_options,
+};
+```
+
+[[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/PassportUserInfoBatchGetResponse.md

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

@@ -0,0 +1,24 @@
+# PassportUserInfoGetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**ignore_cache** | **boolean** |  | [optional] [default to undefined]
+**query_options** | [**UserInfoQueryOptions**](UserInfoQueryOptions.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportUserInfoGetRequest } from '@cherryin/api-client';
+
+const instance: PassportUserInfoGetRequest = {
+    uid,
+    ignore_cache,
+    query_options,
+};
+```
+
+[[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/PassportUserInfoGetResponse.md

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

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

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

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

@@ -0,0 +1,22 @@
+# 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/UserBasic.md

@@ -0,0 +1,42 @@
+# UserBasic
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** |  | [optional] [default to undefined]
+**app_id** | **string** |  | [optional] [default to undefined]
+**aid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+**register_at** | **string** |  | [optional] [default to undefined]
+**email_verified_at** | **string** |  | [optional] [default to undefined]
+**phone_verified_at** | **string** |  | [optional] [default to undefined]
+**app_name** | **string** |  | [optional] [default to undefined]
+**user_status** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserBasic } from '@cherryin/api-client';
+
+const instance: UserBasic = {
+    uid,
+    app_id,
+    aid,
+    name,
+    email,
+    phone,
+    avatar_url,
+    register_at,
+    email_verified_at,
+    phone_verified_at,
+    app_name,
+    user_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/UserExtendInfo.md

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

@@ -0,0 +1,28 @@
+# UserInfoQueryOptions
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**opt_include_all** | **boolean** |  | [optional] [default to undefined]
+**opt_settings** | **boolean** |  | [optional] [default to undefined]
+**opt_preferences** | **boolean** |  | [optional] [default to undefined]
+**opt_payment_info** | **boolean** |  | [optional] [default to undefined]
+**opt_extend_info** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserInfoQueryOptions } from '@cherryin/api-client';
+
+const instance: UserInfoQueryOptions = {
+    opt_include_all,
+    opt_settings,
+    opt_preferences,
+    opt_payment_info,
+    opt_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/UserPaymentInfo.md

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

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

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