@cherryin/api-client 0.0.1

package/docs/UserBalanceServiceApi.md

@@ -0,0 +1,226 @@
+# UserBalanceServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userBalanceServiceUserBalanceChange**](#userbalanceserviceuserbalancechange) | **POST** /v1/user_balance/change | |
+|[**userBalanceServiceUserBalanceEdit**](#userbalanceserviceuserbalanceedit) | **POST** /v1/user_balance/edit | |
+|[**userBalanceServiceUserBalanceList**](#userbalanceserviceuserbalancelist) | **GET** /v1/user_balance/list | |
+
+# **userBalanceServiceUserBalanceChange**
+> UserBalanceChangeResponse userBalanceServiceUserBalanceChange()
+
+用户余额变更接口 - 增量操作
+
+### Example
+
+```typescript
+import {
+    UserBalanceServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserBalanceServiceApi(configuration);
+
+let forceCreate: boolean; // (optional) (default to undefined)
+let uid: string; // (optional) (default to undefined)
+let balanceCode: string; //balance_code 余额货币代码. USD/CNY (optional) (default to undefined)
+let action: string; //变更类型，incr/decr (optional) (default to undefined)
+let deltaPrepaidBalanceTotal: string; //delta_prepaid_balance_total 预付费余额增量，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let deltaBonusBalanceTotal: string; //delta_prepaid_balance_total 预付费余额增量，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userBalanceServiceUserBalanceChange(
+    forceCreate,
+    uid,
+    balanceCode,
+    action,
+    deltaPrepaidBalanceTotal,
+    deltaBonusBalanceTotal
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **forceCreate** | [**boolean**] |  | (optional) defaults to undefined|
+| **uid** | [**string**] |  | (optional) defaults to undefined|
+| **balanceCode** | [**string**] | balance_code 余额货币代码. USD/CNY | (optional) defaults to undefined|
+| **action** | [**string**] | 变更类型，incr/decr | (optional) defaults to undefined|
+| **deltaPrepaidBalanceTotal** | [**string**] | delta_prepaid_balance_total 预付费余额增量，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **deltaBonusBalanceTotal** | [**string**] | delta_prepaid_balance_total 预付费余额增量，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserBalanceChangeResponse**
+
+### 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)
+
+# **userBalanceServiceUserBalanceEdit**
+> UserBalanceEditResponse userBalanceServiceUserBalanceEdit()
+
+编辑用户余额信息 - 注意，这是直接编辑最终结果值，不是增量操作  NOTE: 后台尽量别用此接口做增量变更操作，避免并发问题导致数据不一致
+
+### Example
+
+```typescript
+import {
+    UserBalanceServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserBalanceServiceApi(configuration);
+
+let forceCreate: boolean; // (optional) (default to undefined)
+let uid: string; // (optional) (default to undefined)
+let dataId: string; // (optional) (default to undefined)
+let dataCreatedAt: string; // (optional) (default to undefined)
+let dataUpdatedAt: string; // (optional) (default to undefined)
+let dataUid: string; // (optional) (default to undefined)
+let dataBalanceCode: string; //balance_code 余额货币代码. USD/CNY (optional) (default to undefined)
+let dataPrepaidBalanceTotal: string; //prepaid_balance_total 预付费余额总额，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let dataPrepaidBalanceUsed: string; //prepaid_balance_used 已使用预付费余额，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let dataPrepaidBalanceFrozen: string; //prepaid_balance_frozen 冻结预付费余额，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let dataBonusBalanceTotal: string; //bonus_balance_total 赠送余额总额，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let dataBonusBalanceUsed: string; //bonus_balance_used 已使用赠送余额，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let dataBonusBalanceFrozen: string; //bonus_balance_frozen 冻结赠送余额，使用 DECIMAL(24,12) 精度存储 (optional) (default to undefined)
+let dataVersion: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userBalanceServiceUserBalanceEdit(
+    forceCreate,
+    uid,
+    dataId,
+    dataCreatedAt,
+    dataUpdatedAt,
+    dataUid,
+    dataBalanceCode,
+    dataPrepaidBalanceTotal,
+    dataPrepaidBalanceUsed,
+    dataPrepaidBalanceFrozen,
+    dataBonusBalanceTotal,
+    dataBonusBalanceUsed,
+    dataBonusBalanceFrozen,
+    dataVersion
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **forceCreate** | [**boolean**] |  | (optional) defaults to undefined|
+| **uid** | [**string**] |  | (optional) defaults to undefined|
+| **dataId** | [**string**] |  | (optional) defaults to undefined|
+| **dataCreatedAt** | [**string**] |  | (optional) defaults to undefined|
+| **dataUpdatedAt** | [**string**] |  | (optional) defaults to undefined|
+| **dataUid** | [**string**] |  | (optional) defaults to undefined|
+| **dataBalanceCode** | [**string**] | balance_code 余额货币代码. USD/CNY | (optional) defaults to undefined|
+| **dataPrepaidBalanceTotal** | [**string**] | prepaid_balance_total 预付费余额总额，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **dataPrepaidBalanceUsed** | [**string**] | prepaid_balance_used 已使用预付费余额，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **dataPrepaidBalanceFrozen** | [**string**] | prepaid_balance_frozen 冻结预付费余额，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **dataBonusBalanceTotal** | [**string**] | bonus_balance_total 赠送余额总额，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **dataBonusBalanceUsed** | [**string**] | bonus_balance_used 已使用赠送余额，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **dataBonusBalanceFrozen** | [**string**] | bonus_balance_frozen 冻结赠送余额，使用 DECIMAL(24,12) 精度存储 | (optional) defaults to undefined|
+| **dataVersion** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserBalanceEditResponse**
+
+### 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)
+
+# **userBalanceServiceUserBalanceList**
+> UserBalanceListResponse userBalanceServiceUserBalanceList()
+
+用户余额列表接口
+
+### Example
+
+```typescript
+import {
+    UserBalanceServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new UserBalanceServiceApi(configuration);
+
+let page: number; //page 页码，从 1 开始  Page number, starts from 1  默认值: 1  Default: 1  @gotags: form:\"page\" (optional) (default to undefined)
+let pageSize: number; //page_size 每页数量  Number of items per page  默认值: 20，最大值: 100  Default: 20, Maximum: 100  @gotags: form:\"page_size\" (optional) (default to undefined)
+let uidList: Array<string>; //uid_list 用户 ID 列表，空表示不按用户 ID 过滤 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userBalanceServiceUserBalanceList(
+    page,
+    pageSize,
+    uidList
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | page 页码，从 1 开始  Page number, starts from 1  默认值: 1  Default: 1  @gotags: form:\&quot;page\&quot; | (optional) defaults to undefined|
+| **pageSize** | [**number**] | page_size 每页数量  Number of items per page  默认值: 20，最大值: 100  Default: 20, Maximum: 100  @gotags: form:\&quot;page_size\&quot; | (optional) defaults to undefined|
+| **uidList** | **Array&lt;string&gt;** | uid_list 用户 ID 列表，空表示不按用户 ID 过滤 | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserBalanceListResponse**
+
+### 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

@@ -0,0 +1,26 @@
+# UserInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```typescript
+import { UserInfo } from '@cherryin/api-client';
+
+const instance: UserInfo = {
+    user_id,
+    display_name,
+    avatar_url,
+    contact_email,
+};
+```
+
+[[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/UserLabelItem.md

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

@@ -0,0 +1,26 @@
+# UserLabelListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | code 响应状态码，0 表示成功 | [optional] [default to undefined]
+**message** | **string** | message 响应消息 | [optional] [default to undefined]
+**data** | [**Array<UserLabelItem>**](UserLabelItem.md) |  | [optional] [default to undefined]
+**total** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserLabelListResponse } from '@cherryin/api-client';
+
+const instance: UserLabelListResponse = {
+    code,
+    message,
+    data,
+    total,
+};
+```
+
+[[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/UserLabelPair.md

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

@@ -0,0 +1,22 @@
+# UserLabelPairChangeAction
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_label_pairs** | [**Array<UserLabelPair>**](UserLabelPair.md) |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserLabelPairChangeAction } from '@cherryin/api-client';
+
+const instance: UserLabelPairChangeAction = {
+    user_label_pairs,
+    action,
+};
+```
+
+[[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/UserLabelPairChangeRequest.md

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

@@ -0,0 +1,22 @@
+# UserLabelPairChangeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | code 响应状态码，0 表示成功 | [optional] [default to undefined]
+**message** | **string** | message 响应消息 | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserLabelPairChangeResponse } from '@cherryin/api-client';
+
+const instance: UserLabelPairChangeResponse = {
+    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)