@cherryin/api-client 0.0.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 (155) hide show
  1. package/.openapi-generator/FILES +135 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +219 -0
  5. package/api.ts +6364 -0
  6. package/base.ts +62 -0
  7. package/common.ts +113 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +4175 -0
  10. package/dist/api.js +3694 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +46 -0
  13. package/dist/common.d.ts +28 -0
  14. package/dist/common.js +124 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +4175 -0
  18. package/dist/esm/api.js +3643 -0
  19. package/dist/esm/base.d.ts +42 -0
  20. package/dist/esm/base.js +41 -0
  21. package/dist/esm/common.d.ts +28 -0
  22. package/dist/esm/common.js +112 -0
  23. package/dist/esm/configuration.d.ts +98 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/AIModel.md +45 -0
  30. package/docs/AIModelAdminServiceApi.md +398 -0
  31. package/docs/AIModelArchitecture.md +25 -0
  32. package/docs/AIModelCreateRequest.md +35 -0
  33. package/docs/AIModelCreateResponse.md +25 -0
  34. package/docs/AIModelDeleteRequest.md +21 -0
  35. package/docs/AIModelDeleteResponse.md +23 -0
  36. package/docs/AIModelDisableRequest.md +21 -0
  37. package/docs/AIModelDisableResponse.md +25 -0
  38. package/docs/AIModelDiscountConfig.md +21 -0
  39. package/docs/AIModelGetResponse.md +25 -0
  40. package/docs/AIModelListResponse.md +27 -0
  41. package/docs/AIModelMeta.md +25 -0
  42. package/docs/AIModelPricingConfig.md +37 -0
  43. package/docs/AIModelProviderConfigItem.md +29 -0
  44. package/docs/AIModelPublishRequest.md +21 -0
  45. package/docs/AIModelPublishResponse.md +25 -0
  46. package/docs/AIModelUpdateRequest.md +37 -0
  47. package/docs/AIModelUpdateResponse.md +25 -0
  48. package/docs/AWSAuth.md +24 -0
  49. package/docs/AdminAuthFlowInitResponse.md +24 -0
  50. package/docs/AdminAuthServiceApi.md +81 -0
  51. package/docs/AudioPricing.md +33 -0
  52. package/docs/AuthFlowResult.md +23 -0
  53. package/docs/AuthTokenPair.md +27 -0
  54. package/docs/DiscountAdminServiceApi.md +281 -0
  55. package/docs/DiscountCreateRequest.md +36 -0
  56. package/docs/DiscountDeleteRequest.md +20 -0
  57. package/docs/DiscountDeleteResponse.md +22 -0
  58. package/docs/DiscountGetResponse.md +24 -0
  59. package/docs/DiscountInfo.md +42 -0
  60. package/docs/DiscountListResponse.md +26 -0
  61. package/docs/DiscountUpdateRequest.md +38 -0
  62. package/docs/DiscountUpdateResponse.md +24 -0
  63. package/docs/FeatureCostPricing.md +27 -0
  64. package/docs/FrontAIModel.md +45 -0
  65. package/docs/GCPAuth.md +27 -0
  66. package/docs/GoogleProtobufAny.md +21 -0
  67. package/docs/ImagePricing.md +31 -0
  68. package/docs/Label.md +28 -0
  69. package/docs/LabelCreateRequest.md +22 -0
  70. package/docs/LabelCreateResponse.md +24 -0
  71. package/docs/LabelDeleteRequest.md +20 -0
  72. package/docs/LabelDeleteResponse.md +22 -0
  73. package/docs/LabelListRequest.md +24 -0
  74. package/docs/LabelListResponse.md +26 -0
  75. package/docs/LabelUpdateRequest.md +24 -0
  76. package/docs/LabelUpdateResponse.md +24 -0
  77. package/docs/MultimodalPricing.md +25 -0
  78. package/docs/PricingConditions.md +31 -0
  79. package/docs/PricingRules.md +29 -0
  80. package/docs/Provider.md +37 -0
  81. package/docs/ProviderAdminServiceApi.md +284 -0
  82. package/docs/ProviderAuth.md +29 -0
  83. package/docs/ProviderCreateRequest.md +29 -0
  84. package/docs/ProviderCreateResponse.md +25 -0
  85. package/docs/ProviderDeleteRequest.md +21 -0
  86. package/docs/ProviderDeleteResponse.md +23 -0
  87. package/docs/ProviderGetResponse.md +25 -0
  88. package/docs/ProviderListResponse.md +27 -0
  89. package/docs/ProviderModel.md +37 -0
  90. package/docs/ProviderModelAdminServiceApi.md +287 -0
  91. package/docs/ProviderModelCreateRequest.md +29 -0
  92. package/docs/ProviderModelCreateResponse.md +25 -0
  93. package/docs/ProviderModelDeleteRequest.md +21 -0
  94. package/docs/ProviderModelDeleteResponse.md +23 -0
  95. package/docs/ProviderModelGetResponse.md +25 -0
  96. package/docs/ProviderModelListResponse.md +27 -0
  97. package/docs/ProviderModelPayload.md +23 -0
  98. package/docs/ProviderModelUpdateRequest.md +31 -0
  99. package/docs/ProviderModelUpdateResponse.md +25 -0
  100. package/docs/ProviderPayload.md +21 -0
  101. package/docs/ProviderUpdateRequest.md +31 -0
  102. package/docs/ProviderUpdateResponse.md +25 -0
  103. package/docs/RequestPricing.md +23 -0
  104. package/docs/Status.md +25 -0
  105. package/docs/TextTokenInputPricing.md +27 -0
  106. package/docs/TextTokenOutputPricing.md +25 -0
  107. package/docs/TextTokenPricing.md +23 -0
  108. package/docs/TokenTier.md +25 -0
  109. package/docs/UserAPIKey.md +47 -0
  110. package/docs/UserAPIKeyCreateRequest.md +37 -0
  111. package/docs/UserAPIKeyCreateResponse.md +25 -0
  112. package/docs/UserAPIKeyDeleteRequest.md +21 -0
  113. package/docs/UserAPIKeyDeleteResponse.md +23 -0
  114. package/docs/UserAPIKeyGetResponse.md +25 -0
  115. package/docs/UserAPIKeyListResponse.md +27 -0
  116. package/docs/UserAPIKeyServiceApi.md +290 -0
  117. package/docs/UserAPIKeyUpdateRequest.md +33 -0
  118. package/docs/UserAPIKeyUpdateResponse.md +25 -0
  119. package/docs/UserAuthFlowCodeResponse.md +26 -0
  120. package/docs/UserAuthFlowInitResponse.md +28 -0
  121. package/docs/UserAuthFlowInitResponseOAuthResult.md +20 -0
  122. package/docs/UserAuthFlowOAuthCallbackRequest.md +24 -0
  123. package/docs/UserAuthFlowOAuthCallbackResponse.md +26 -0
  124. package/docs/UserAuthInfo.md +20 -0
  125. package/docs/UserAuthServiceApi.md +279 -0
  126. package/docs/UserBalance.md +42 -0
  127. package/docs/UserBalanceBrief.md +32 -0
  128. package/docs/UserBalanceChangeResponse.md +24 -0
  129. package/docs/UserBalanceEditResponse.md +24 -0
  130. package/docs/UserBalanceListResponse.md +26 -0
  131. package/docs/UserBalanceServiceApi.md +226 -0
  132. package/docs/UserInfo.md +26 -0
  133. package/docs/UserLabelItem.md +22 -0
  134. package/docs/UserLabelListResponse.md +26 -0
  135. package/docs/UserLabelPair.md +22 -0
  136. package/docs/UserLabelPairChangeAction.md +22 -0
  137. package/docs/UserLabelPairChangeRequest.md +20 -0
  138. package/docs/UserLabelPairChangeResponse.md +22 -0
  139. package/docs/UserLabelServiceApi.md +386 -0
  140. package/docs/UserMeInfo.md +24 -0
  141. package/docs/UserMeInfoResponse.md +24 -0
  142. package/docs/UserModelListResponse.md +33 -0
  143. package/docs/UserModelServiceApi.md +71 -0
  144. package/docs/UserPayServiceApi.md +62 -0
  145. package/docs/UserPayStripeCheckout.md +20 -0
  146. package/docs/UserPayStripeCheckoutResponse.md +24 -0
  147. package/docs/UserPoralServiceApi.md +52 -0
  148. package/docs/UserSettings.md +20 -0
  149. package/docs/VersionedAPISchema.md +31 -0
  150. package/docs/VideoPricing.md +33 -0
  151. package/git_push.sh +57 -0
  152. package/index.ts +18 -0
  153. package/package.json +36 -0
  154. package/tsconfig.esm.json +7 -0
  155. package/tsconfig.json +18 -0
@@ -0,0 +1,27 @@
1
+ # TextTokenInputPricing
2
+
3
+ TextTokenInputPricing 输入Token价格配置 Input token price configuration
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 价格配置ID Price configuration ID | [optional] [default to undefined]
10
+ **regular** | [**Array<TokenTier>**](TokenTier.md) | regular 常规价格层级 Regular price tiers | [optional] [default to undefined]
11
+ **cached** | [**Array<TokenTier>**](TokenTier.md) | cached 缓存Token价格层级 Cached token price tiers | [optional] [default to undefined]
12
+ **cache_write** | [**Array<TokenTier>**](TokenTier.md) | cache_write 缓存写入价格层级 Cache write price tiers | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { TextTokenInputPricing } from '@cherryin/api-client';
18
+
19
+ const instance: TextTokenInputPricing = {
20
+ id,
21
+ regular,
22
+ cached,
23
+ cache_write,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # TextTokenOutputPricing
2
+
3
+ TextTokenOutputPricing 输出Token价格配置 Output token price configuration
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 价格配置ID Price configuration ID | [optional] [default to undefined]
10
+ **regular** | [**Array<TokenTier>**](TokenTier.md) | regular 常规价格层级 Regular price tiers | [optional] [default to undefined]
11
+ **reasoning** | [**Array<TokenTier>**](TokenTier.md) | reasoning 推理Token价格层级(如o1模型) Reasoning token price tiers (e.g., o1 models) | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { TextTokenOutputPricing } from '@cherryin/api-client';
17
+
18
+ const instance: TextTokenOutputPricing = {
19
+ id,
20
+ regular,
21
+ reasoning,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # TextTokenPricing
2
+
3
+ TextTokenPricing Token计费规则 Text token pricing rules
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **input** | [**TextTokenInputPricing**](TextTokenInputPricing.md) | input 输入Token价格配置 Input token price configuration | [optional] [default to undefined]
10
+ **output** | [**TextTokenOutputPricing**](TextTokenOutputPricing.md) | output 输出Token价格配置 Output token price configuration | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { TextTokenPricing } from '@cherryin/api-client';
16
+
17
+ const instance: TextTokenPricing = {
18
+ input,
19
+ output,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # TokenTier
2
+
3
+ TokenTier Token价格层级 Token price tier
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **min_tokens** | **string** | min_tokens 最小token数量 Minimum token count | [optional] [default to undefined]
10
+ **max_tokens** | **string** | max_tokens 最大token数量(0表示无限) Maximum token count (0 means unlimited) | [optional] [default to undefined]
11
+ **price_per_million** | **string** | price_per_million 每百万token价格(使用字符串避免精度损失) Price per million tokens (string to avoid precision loss) | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { TokenTier } from '@cherryin/api-client';
17
+
18
+ const instance: TokenTier = {
19
+ min_tokens,
20
+ max_tokens,
21
+ price_per_million,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,47 @@
1
+ # UserAPIKey
2
+
3
+ UserAPIKey 代表用户的 API 密钥 UserAPIKey represents a user\'s API key
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id UserAPIKey 的唯一标识符 Unique identifier for the UserAPIKey | [optional] [default to undefined]
10
+ **created_at** | **string** | created_at 创建时间戳(Unix 时间戳) Creation timestamp (Unix timestamp) | [optional] [default to undefined]
11
+ **updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) Last update timestamp (Unix timestamp) | [optional] [default to undefined]
12
+ **deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 Soft deletion timestamp, 0 means not deleted | [optional] [default to undefined]
13
+ **uid** | **string** | uid 用户 ID User ID | [optional] [default to undefined]
14
+ **name** | **string** | name API Key 的唯一名称标识 Unique name identifier for the API key | [optional] [default to undefined]
15
+ **key_group** | **string** | key_group API Key 分组 API Key group | [optional] [default to undefined]
16
+ **display_name** | **string** | display_name API Key 的显示名称 Display name for the API key | [optional] [default to undefined]
17
+ **quota_balance_total** | **string** | quota_balance_total 总配额余额,使用 DECIMAL(24,12) 精度存储 Total quota balance, stored with DECIMAL(24,12) precision 字符串格式,例如:\"100.50\" 表示 $100.50 或 ¥100.50 String format, e.g., \"100.50\" represents $100.50 or ¥100.50 | [optional] [default to undefined]
18
+ **quota_balance_used** | **string** | quota_balance_used 已使用配额余额,使用 DECIMAL(24,12) 精度存储 Used quota balance, stored with DECIMAL(24,12) precision 字符串格式,例如:\"25.75\" 表示已使用 $25.75 或 ¥25.75 String format, e.g., \"25.75\" represents $25.75 or ¥25.75 used | [optional] [default to undefined]
19
+ **balance_code** | **string** | balance_code 余额货币代码 Balance currency code USD: 美元 (US Dollar) CNY: 人民币 (Chinese Yuan) | [optional] [default to undefined]
20
+ **quota_mode** | **number** | quota_mode 配额模式 Quota mode 1: 有限配额 (Limited) 2: 无限配额 (Unlimited) | [optional] [default to undefined]
21
+ **key_status** | **string** | key_status API Key 状态 API Key status 1: 启用 (Enabled) 2: 禁用 (Disabled) | [optional] [default to undefined]
22
+ **expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期 Expiration timestamp, 0 means never expires | [optional] [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { UserAPIKey } from '@cherryin/api-client';
28
+
29
+ const instance: UserAPIKey = {
30
+ id,
31
+ created_at,
32
+ updated_at,
33
+ deleted_at,
34
+ uid,
35
+ name,
36
+ key_group,
37
+ display_name,
38
+ quota_balance_total,
39
+ quota_balance_used,
40
+ balance_code,
41
+ quota_mode,
42
+ key_status,
43
+ expires_at,
44
+ };
45
+ ```
46
+
47
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,37 @@
1
+ # UserAPIKeyCreateRequest
2
+
3
+ UserAPIKeyCreateRequest 创建 UserAPIKey 的请求 Request message for creating a new UserAPIKey
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **uid** | **string** | uid 用户 ID(管理员可以指定,普通用户自动使用当前用户) User ID (admin can specify, normal user uses current user automatically) | [optional] [default to undefined]
10
+ **name** | **string** | name API Key 的唯一名称标识 Unique name identifier for the API key | [optional] [default to undefined]
11
+ **key_group** | **string** | key_group API Key 分组(可选) API Key group (optional) | [optional] [default to undefined]
12
+ **display_name** | **string** | display_name API Key 的显示名称 Display name for the API key | [optional] [default to undefined]
13
+ **quota_balance_total** | **string** | quota_balance_total 总配额余额 Total quota balance 字符串格式,使用 DECIMAL(24,12) 精度,例如:\"100.50\" String format with DECIMAL(24,12) precision, e.g., \"100.50\" | [optional] [default to undefined]
14
+ **balance_code** | **string** | balance_code 余额货币代码(仅管理员可指定,默认从 user_balances 读取) Balance currency code (admin only, defaults to reading from user_balances) USD: 美元 (US Dollar) CNY: 人民币 (Chinese Yuan) | [optional] [default to undefined]
15
+ **quota_mode** | **number** | quota_mode 配额模式 Quota mode 1: 有限配额 (Limited) 2: 无限配额 (Unlimited) | [optional] [default to undefined]
16
+ **key_status** | **string** | key_status API Key 状态 API Key status 1: 启用 (Enabled) 2: 禁用 (Disabled) | [optional] [default to undefined]
17
+ **expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期 Expiration timestamp, 0 means never expires | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { UserAPIKeyCreateRequest } from '@cherryin/api-client';
23
+
24
+ const instance: UserAPIKeyCreateRequest = {
25
+ uid,
26
+ name,
27
+ key_group,
28
+ display_name,
29
+ quota_balance_total,
30
+ balance_code,
31
+ quota_mode,
32
+ key_status,
33
+ expires_at,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # UserAPIKeyCreateResponse
2
+
3
+ UserAPIKeyCreateResponse 创建 UserAPIKey 的响应 Response message for UserAPIKey creation
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**UserAPIKey**](UserAPIKey.md) | data 创建成功后返回的 UserAPIKey 信息 UserAPIKey information returned after successful creation | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { UserAPIKeyCreateResponse } from '@cherryin/api-client';
17
+
18
+ const instance: UserAPIKeyCreateResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # UserAPIKeyDeleteRequest
2
+
3
+ UserAPIKeyDeleteRequest 删除 UserAPIKey 的请求 Request message for deleting a UserAPIKey
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 要删除的 UserAPIKey 的唯一标识符 Unique identifier of the UserAPIKey to delete @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UserAPIKeyDeleteRequest } from '@cherryin/api-client';
15
+
16
+ const instance: UserAPIKeyDeleteRequest = {
17
+ id,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # UserAPIKeyDeleteResponse
2
+
3
+ UserAPIKeyDeleteResponse 删除 UserAPIKey 的响应 Response message for UserAPIKey deletion
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UserAPIKeyDeleteResponse } from '@cherryin/api-client';
16
+
17
+ const instance: UserAPIKeyDeleteResponse = {
18
+ code,
19
+ message,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # UserAPIKeyGetResponse
2
+
3
+ UserAPIKeyGetResponse 获取单个 UserAPIKey 的响应 Response message for UserAPIKey retrieval
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**UserAPIKey**](UserAPIKey.md) | data UserAPIKey 信息 UserAPIKey information | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { UserAPIKeyGetResponse } from '@cherryin/api-client';
17
+
18
+ const instance: UserAPIKeyGetResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # UserAPIKeyListResponse
2
+
3
+ UserAPIKeyListResponse 分页查询 UserAPIKey 列表的响应 Response message for UserAPIKey listing
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **list** | [**Array<UserAPIKey>**](UserAPIKey.md) | list UserAPIKey 列表 List of UserAPIKeys | [optional] [default to undefined]
12
+ **total** | **string** | total 符合条件的 UserAPIKey 总数 Total number of UserAPIKeys matching the filter criteria | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { UserAPIKeyListResponse } from '@cherryin/api-client';
18
+
19
+ const instance: UserAPIKeyListResponse = {
20
+ code,
21
+ message,
22
+ list,
23
+ total,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,290 @@
1
+ # UserAPIKeyServiceApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**userAPIKeyServiceUserAPIKeyCreate**](#userapikeyserviceuserapikeycreate) | **POST** /api/v1/user/api-key/create | |
8
+ |[**userAPIKeyServiceUserAPIKeyDelete**](#userapikeyserviceuserapikeydelete) | **POST** /api/v1/user/api-key/delete | |
9
+ |[**userAPIKeyServiceUserAPIKeyGet**](#userapikeyserviceuserapikeyget) | **GET** /api/v1/user/api-key/get | |
10
+ |[**userAPIKeyServiceUserAPIKeyList**](#userapikeyserviceuserapikeylist) | **GET** /api/v1/user/api-key/list | |
11
+ |[**userAPIKeyServiceUserAPIKeyUpdate**](#userapikeyserviceuserapikeyupdate) | **POST** /api/v1/user/api-key/update | |
12
+
13
+ # **userAPIKeyServiceUserAPIKeyCreate**
14
+ > UserAPIKeyCreateResponse userAPIKeyServiceUserAPIKeyCreate(userAPIKeyCreateRequest)
15
+
16
+ UserAPIKeyCreate 创建新的 UserAPIKey Create a new UserAPIKey 请求路径: POST /api/user/api-key/create Request path: POST /api/user/api-key/create 权限要求: 需要用户认证 Permission: Requires user authentication
17
+
18
+ ### Example
19
+
20
+ ```typescript
21
+ import {
22
+ UserAPIKeyServiceApi,
23
+ Configuration,
24
+ UserAPIKeyCreateRequest
25
+ } from '@cherryin/api-client';
26
+
27
+ const configuration = new Configuration();
28
+ const apiInstance = new UserAPIKeyServiceApi(configuration);
29
+
30
+ let userAPIKeyCreateRequest: UserAPIKeyCreateRequest; //
31
+
32
+ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyCreate(
33
+ userAPIKeyCreateRequest
34
+ );
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ |Name | Type | Description | Notes|
40
+ |------------- | ------------- | ------------- | -------------|
41
+ | **userAPIKeyCreateRequest** | **UserAPIKeyCreateRequest**| | |
42
+
43
+
44
+ ### Return type
45
+
46
+ **UserAPIKeyCreateResponse**
47
+
48
+ ### Authorization
49
+
50
+ No authorization required
51
+
52
+ ### HTTP request headers
53
+
54
+ - **Content-Type**: application/json
55
+ - **Accept**: application/json
56
+
57
+
58
+ ### HTTP response details
59
+ | Status code | Description | Response headers |
60
+ |-------------|-------------|------------------|
61
+ |**200** | OK | - |
62
+ |**0** | Default error response | - |
63
+
64
+ [[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)
65
+
66
+ # **userAPIKeyServiceUserAPIKeyDelete**
67
+ > UserAPIKeyDeleteResponse userAPIKeyServiceUserAPIKeyDelete(userAPIKeyDeleteRequest)
68
+
69
+ UserAPIKeyDelete 删除 UserAPIKey(软删除) Delete a UserAPIKey (soft delete) 请求路径: POST /api/user/api-key/delete Request path: POST /api/user/api-key/delete 权限要求: 需要用户认证 Permission: Requires user authentication
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ UserAPIKeyServiceApi,
76
+ Configuration,
77
+ UserAPIKeyDeleteRequest
78
+ } from '@cherryin/api-client';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new UserAPIKeyServiceApi(configuration);
82
+
83
+ let userAPIKeyDeleteRequest: UserAPIKeyDeleteRequest; //
84
+
85
+ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyDelete(
86
+ userAPIKeyDeleteRequest
87
+ );
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ |Name | Type | Description | Notes|
93
+ |------------- | ------------- | ------------- | -------------|
94
+ | **userAPIKeyDeleteRequest** | **UserAPIKeyDeleteRequest**| | |
95
+
96
+
97
+ ### Return type
98
+
99
+ **UserAPIKeyDeleteResponse**
100
+
101
+ ### Authorization
102
+
103
+ No authorization required
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: application/json
108
+ - **Accept**: application/json
109
+
110
+
111
+ ### HTTP response details
112
+ | Status code | Description | Response headers |
113
+ |-------------|-------------|------------------|
114
+ |**200** | OK | - |
115
+ |**0** | Default error response | - |
116
+
117
+ [[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)
118
+
119
+ # **userAPIKeyServiceUserAPIKeyGet**
120
+ > UserAPIKeyGetResponse userAPIKeyServiceUserAPIKeyGet()
121
+
122
+ UserAPIKeyGet 根据 ID 或名称获取单个 UserAPIKey Retrieve a single UserAPIKey by ID or name 请求路径: GET /api/user/api-key/get?id={id} 或 GET /api/user/api-key/get?name={name} Request path: GET /api/user/api-key/get?id={id} or GET /api/user/api-key/get?name={name} 权限要求: 需要用户认证 Permission: Requires user authentication
123
+
124
+ ### Example
125
+
126
+ ```typescript
127
+ import {
128
+ UserAPIKeyServiceApi,
129
+ Configuration
130
+ } from '@cherryin/api-client';
131
+
132
+ const configuration = new Configuration();
133
+ const apiInstance = new UserAPIKeyServiceApi(configuration);
134
+
135
+ let id: string; //id 要获取的 UserAPIKey 的唯一标识符 Unique identifier of the UserAPIKey to retrieve @gotags: form:\"id\" (optional) (default to undefined)
136
+ let name: string; //name 要获取的 UserAPIKey 的名称 Name of the UserAPIKey to retrieve 如果同时提供 id 和 name,以 id 为准 If both id and name are provided, id takes precedence @gotags: form:\"name\" (optional) (default to undefined)
137
+
138
+ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyGet(
139
+ id,
140
+ name
141
+ );
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ |Name | Type | Description | Notes|
147
+ |------------- | ------------- | ------------- | -------------|
148
+ | **id** | [**string**] | id 要获取的 UserAPIKey 的唯一标识符 Unique identifier of the UserAPIKey to retrieve @gotags: form:\"id\" | (optional) defaults to undefined|
149
+ | **name** | [**string**] | name 要获取的 UserAPIKey 的名称 Name of the UserAPIKey to retrieve 如果同时提供 id 和 name,以 id 为准 If both id and name are provided, id takes precedence @gotags: form:\"name\" | (optional) defaults to undefined|
150
+
151
+
152
+ ### Return type
153
+
154
+ **UserAPIKeyGetResponse**
155
+
156
+ ### Authorization
157
+
158
+ No authorization required
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: Not defined
163
+ - **Accept**: application/json
164
+
165
+
166
+ ### HTTP response details
167
+ | Status code | Description | Response headers |
168
+ |-------------|-------------|------------------|
169
+ |**200** | OK | - |
170
+ |**0** | Default error response | - |
171
+
172
+ [[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)
173
+
174
+ # **userAPIKeyServiceUserAPIKeyList**
175
+ > UserAPIKeyListResponse userAPIKeyServiceUserAPIKeyList()
176
+
177
+ UserAPIKeyList 分页查询 UserAPIKey 列表,支持按状态和分组过滤 List UserAPIKeys with pagination, supports filtering by status and key group 请求路径: GET /api/user/api-key/list?page={page}&page_size={page_size}&key_status={status}&key_group={group} Request path: GET /api/user/api-key/list?page={page}&page_size={page_size}&key_status={status}&key_group={group} 权限要求: 需要用户认证 Permission: Requires user authentication
178
+
179
+ ### Example
180
+
181
+ ```typescript
182
+ import {
183
+ UserAPIKeyServiceApi,
184
+ Configuration
185
+ } from '@cherryin/api-client';
186
+
187
+ const configuration = new Configuration();
188
+ const apiInstance = new UserAPIKeyServiceApi(configuration);
189
+
190
+ let page: number; //page 页码,从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" (optional) (default to undefined)
191
+ let pageSize: number; //page_size 每页数量 Number of items per page 默认值: 20,最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
192
+ let uid: string; //uid 按用户 ID 过滤(可选,管理员可用) Filter by user ID (optional, admin only) 0: 返回所有用户的 API Key(仅管理员) > 0: 仅返回指定用户的 API Key 0: return API keys from all users (admin only) > 0: return API keys from specific user only @gotags: form:\"uid\" (optional) (default to undefined)
193
+ let keyStatus: string; //key_status 按状态过滤(可选) Filter by status (optional) 0: 返回所有状态 1: 仅返回启用的 API Key 2: 仅返回禁用的 API Key 0: return all statuses 1: return enabled API keys only 2: return disabled API keys only @gotags: form:\"key_status\" (optional) (default to undefined)
194
+ let keyGroup: string; //key_group 按分组过滤(可选) Filter by key group (optional) @gotags: form:\"key_group\" (optional) (default to undefined)
195
+
196
+ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyList(
197
+ page,
198
+ pageSize,
199
+ uid,
200
+ keyStatus,
201
+ keyGroup
202
+ );
203
+ ```
204
+
205
+ ### Parameters
206
+
207
+ |Name | Type | Description | Notes|
208
+ |------------- | ------------- | ------------- | -------------|
209
+ | **page** | [**number**] | page 页码,从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
210
+ | **pageSize** | [**number**] | page_size 每页数量 Number of items per page 默认值: 20,最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
211
+ | **uid** | [**string**] | uid 按用户 ID 过滤(可选,管理员可用) Filter by user ID (optional, admin only) 0: 返回所有用户的 API Key(仅管理员) > 0: 仅返回指定用户的 API Key 0: return API keys from all users (admin only) > 0: return API keys from specific user only @gotags: form:\"uid\" | (optional) defaults to undefined|
212
+ | **keyStatus** | [**string**] | key_status 按状态过滤(可选) Filter by status (optional) 0: 返回所有状态 1: 仅返回启用的 API Key 2: 仅返回禁用的 API Key 0: return all statuses 1: return enabled API keys only 2: return disabled API keys only @gotags: form:\"key_status\" | (optional) defaults to undefined|
213
+ | **keyGroup** | [**string**] | key_group 按分组过滤(可选) Filter by key group (optional) @gotags: form:\"key_group\" | (optional) defaults to undefined|
214
+
215
+
216
+ ### Return type
217
+
218
+ **UserAPIKeyListResponse**
219
+
220
+ ### Authorization
221
+
222
+ No authorization required
223
+
224
+ ### HTTP request headers
225
+
226
+ - **Content-Type**: Not defined
227
+ - **Accept**: application/json
228
+
229
+
230
+ ### HTTP response details
231
+ | Status code | Description | Response headers |
232
+ |-------------|-------------|------------------|
233
+ |**200** | OK | - |
234
+ |**0** | Default error response | - |
235
+
236
+ [[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)
237
+
238
+ # **userAPIKeyServiceUserAPIKeyUpdate**
239
+ > UserAPIKeyUpdateResponse userAPIKeyServiceUserAPIKeyUpdate(userAPIKeyUpdateRequest)
240
+
241
+ UserAPIKeyUpdate 更新现有的 UserAPIKey Update an existing UserAPIKey 请求路径: POST /api/user/api-key/update Request path: POST /api/user/api-key/update 权限要求: 需要用户认证 Permission: Requires user authentication
242
+
243
+ ### Example
244
+
245
+ ```typescript
246
+ import {
247
+ UserAPIKeyServiceApi,
248
+ Configuration,
249
+ UserAPIKeyUpdateRequest
250
+ } from '@cherryin/api-client';
251
+
252
+ const configuration = new Configuration();
253
+ const apiInstance = new UserAPIKeyServiceApi(configuration);
254
+
255
+ let userAPIKeyUpdateRequest: UserAPIKeyUpdateRequest; //
256
+
257
+ const { status, data } = await apiInstance.userAPIKeyServiceUserAPIKeyUpdate(
258
+ userAPIKeyUpdateRequest
259
+ );
260
+ ```
261
+
262
+ ### Parameters
263
+
264
+ |Name | Type | Description | Notes|
265
+ |------------- | ------------- | ------------- | -------------|
266
+ | **userAPIKeyUpdateRequest** | **UserAPIKeyUpdateRequest**| | |
267
+
268
+
269
+ ### Return type
270
+
271
+ **UserAPIKeyUpdateResponse**
272
+
273
+ ### Authorization
274
+
275
+ No authorization required
276
+
277
+ ### HTTP request headers
278
+
279
+ - **Content-Type**: application/json
280
+ - **Accept**: application/json
281
+
282
+
283
+ ### HTTP response details
284
+ | Status code | Description | Response headers |
285
+ |-------------|-------------|------------------|
286
+ |**200** | OK | - |
287
+ |**0** | Default error response | - |
288
+
289
+ [[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)
290
+
@@ -0,0 +1,33 @@
1
+ # UserAPIKeyUpdateRequest
2
+
3
+ UserAPIKeyUpdateRequest 更新 UserAPIKey 的请求 Request message for updating an existing UserAPIKey
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id UserAPIKey 的唯一标识符 Unique identifier of the UserAPIKey to update | [optional] [default to undefined]
10
+ **display_name** | **string** | display_name API Key 的显示名称 Display name for the API key | [optional] [default to undefined]
11
+ **quota_balance_total** | **string** | quota_balance_total 总配额余额 Total quota balance 字符串格式,使用 DECIMAL(24,12) 精度,例如:\"100.50\" String format with DECIMAL(24,12) precision, e.g., \"100.50\" | [optional] [default to undefined]
12
+ **balance_code** | **string** | balance_code 余额货币代码(仅管理员可修改) Balance currency code (admin only) USD: 美元 (US Dollar) CNY: 人民币 (Chinese Yuan) | [optional] [default to undefined]
13
+ **quota_mode** | **number** | quota_mode 配额模式 Quota mode 1: 有限配额 (Limited) 2: 无限配额 (Unlimited) | [optional] [default to undefined]
14
+ **key_status** | **string** | key_status API Key 状态 API Key status 1: 启用 (Enabled) 2: 禁用 (Disabled) | [optional] [default to undefined]
15
+ **expires_at** | **string** | expires_at 过期时间戳,0 表示永不过期 Expiration timestamp, 0 means never expires | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { UserAPIKeyUpdateRequest } from '@cherryin/api-client';
21
+
22
+ const instance: UserAPIKeyUpdateRequest = {
23
+ id,
24
+ display_name,
25
+ quota_balance_total,
26
+ balance_code,
27
+ quota_mode,
28
+ key_status,
29
+ expires_at,
30
+ };
31
+ ```
32
+
33
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # UserAPIKeyUpdateResponse
2
+
3
+ UserAPIKeyUpdateResponse 更新 UserAPIKey 的响应 Response message for UserAPIKey update
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**UserAPIKey**](UserAPIKey.md) | data 更新后的 UserAPIKey 信息 Updated UserAPIKey information | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { UserAPIKeyUpdateResponse } from '@cherryin/api-client';
17
+
18
+ const instance: UserAPIKeyUpdateResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)