@crestal/nation-sdk 0.7.39 → 0.7.41
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.
- package/.openapi-generator/FILES +50 -7
- package/.openapi-generator/VERSION +1 -1
- package/README.md +52 -9
- package/api.ts +481 -2349
- package/base.ts +1 -25
- package/common.ts +1 -38
- package/configuration.ts +1 -18
- package/dist/api.d.ts +476 -2352
- package/dist/api.js +1 -146
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -38
- package/dist/common.js +1 -38
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AgentAssetsResponse.md +1 -1
- package/docs/Amount.md +19 -0
- package/docs/AssetInput.md +23 -0
- package/docs/{Asset.md → AssetOutput.md} +3 -3
- package/docs/Balance.md +19 -0
- package/docs/BalanceAfter.md +19 -0
- package/docs/BaseAmount.md +19 -0
- package/docs/BaseDiscountAmount.md +19 -0
- package/docs/BaseFreeAmount.md +19 -0
- package/docs/BaseLlmAmount.md +19 -0
- package/docs/BaseOriginalAmount.md +19 -0
- package/docs/BasePermanentAmount.md +19 -0
- package/docs/BaseRewardAmount.md +19 -0
- package/docs/BaseSkillAmount.md +19 -0
- package/docs/ChangeAmount.md +19 -0
- package/docs/CreditAmount.md +19 -0
- package/docs/CreditApi.md +2 -2
- package/docs/CreditEventInput.md +109 -0
- package/docs/{CreditEvent.md → CreditEventOutput.md} +3 -3
- package/docs/CreditEventWithAgentInput.md +111 -0
- package/docs/{CreditEventWithAgent.md → CreditEventWithAgentOutput.md} +3 -3
- package/docs/CreditEventsResponse.md +1 -1
- package/docs/CreditTransactionRespInput.md +43 -0
- package/docs/{CreditTransactionResp.md → CreditTransactionRespOutput.md} +4 -4
- package/docs/CreditTransactionsResponse.md +1 -1
- package/docs/FeeAgentAmount.md +19 -0
- package/docs/FeeAgentFreeAmount.md +19 -0
- package/docs/FeeAgentPermanentAmount.md +19 -0
- package/docs/FeeAgentRewardAmount.md +19 -0
- package/docs/FeeDevAmount.md +19 -0
- package/docs/FeeDevFreeAmount.md +19 -0
- package/docs/FeeDevPermanentAmount.md +19 -0
- package/docs/FeeDevRewardAmount.md +19 -0
- package/docs/FeePlatformAmount.md +19 -0
- package/docs/FeePlatformFreeAmount.md +19 -0
- package/docs/FeePlatformPermanentAmount.md +19 -0
- package/docs/FeePlatformRewardAmount.md +19 -0
- package/docs/FreeAmount.md +19 -0
- package/docs/FreeAmount1.md +19 -0
- package/docs/InputPrice.md +18 -0
- package/docs/LLMModelInfoWithProviderNameInput.md +67 -0
- package/docs/{LLMModelInfoWithProviderName.md → LLMModelInfoWithProviderNameOutput.md} +5 -5
- package/docs/MetadataApi.md +4 -4
- package/docs/OutputPrice.md +18 -0
- package/docs/PermanentAmount.md +19 -0
- package/docs/PermanentAmount1.md +19 -0
- package/docs/Price.md +19 -0
- package/docs/PriceSelfKey.md +19 -0
- package/docs/RewardAmount.md +19 -0
- package/docs/RewardAmount1.md +19 -0
- package/docs/SkillInput.md +43 -0
- package/docs/{Skill.md → SkillOutput.md} +3 -3
- package/docs/TopupRecordInput.md +47 -0
- package/docs/{TopupRecord.md → TopupRecordOutput.md} +3 -3
- package/docs/TopupRecordsResponse.md +1 -1
- package/docs/TotalAmount.md +19 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CreditAmount
|
|
2
|
+
|
|
3
|
+
Credits applied after conversion
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CreditAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: CreditAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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/CreditApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost*
|
|
|
12
12
|
|[**listUserTransactions**](#listusertransactions) | **GET** /credit/user/transactions | List User Transactions|
|
|
13
13
|
|
|
14
14
|
# **fetchCreditEvent**
|
|
15
|
-
>
|
|
15
|
+
> CreditEventOutput fetchCreditEvent()
|
|
16
16
|
|
|
17
17
|
Fetch a credit event by its ID, with authorization check. Returns the credit event if it exists and belongs to the user, otherwise raises an HTTP error.
|
|
18
18
|
|
|
@@ -43,7 +43,7 @@ const { status, data } = await apiInstance.fetchCreditEvent(
|
|
|
43
43
|
|
|
44
44
|
### Return type
|
|
45
45
|
|
|
46
|
-
**
|
|
46
|
+
**CreditEventOutput**
|
|
47
47
|
|
|
48
48
|
### Authorization
|
|
49
49
|
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# CreditEventInput
|
|
2
|
+
|
|
3
|
+
Credit event model with all fields.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the credit event | [optional] [default to undefined]
|
|
10
|
+
**account_id** | **string** | Account ID from which credits flow | [optional] [default to undefined]
|
|
11
|
+
**event_type** | [**EventType**](EventType.md) | Type of the event | [default to undefined]
|
|
12
|
+
**user_id** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**upstream_type** | [**UpstreamType**](UpstreamType.md) | Type of upstream transaction | [default to undefined]
|
|
14
|
+
**upstream_tx_id** | **string** | Upstream transaction ID if any | [default to undefined]
|
|
15
|
+
**agent_id** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**agent_wallet_address** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**start_message_id** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**message_id** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**model** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**skill_call_id** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**skill_name** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**direction** | [**Direction**](Direction.md) | Direction of the credit flow | [default to undefined]
|
|
23
|
+
**total_amount** | [**TotalAmount**](TotalAmount.md) | | [optional] [default to undefined]
|
|
24
|
+
**credit_type** | [**CreditType**](CreditType.md) | Type of credits involved | [default to undefined]
|
|
25
|
+
**credit_types** | [**Array<CreditType>**](CreditType.md) | | [optional] [default to undefined]
|
|
26
|
+
**balance_after** | [**BalanceAfter**](BalanceAfter.md) | | [optional] [default to undefined]
|
|
27
|
+
**base_amount** | [**BaseAmount**](BaseAmount.md) | | [optional] [default to undefined]
|
|
28
|
+
**base_discount_amount** | [**BaseDiscountAmount**](BaseDiscountAmount.md) | | [optional] [default to undefined]
|
|
29
|
+
**base_original_amount** | [**BaseOriginalAmount**](BaseOriginalAmount.md) | | [optional] [default to undefined]
|
|
30
|
+
**base_llm_amount** | [**BaseLlmAmount**](BaseLlmAmount.md) | | [optional] [default to undefined]
|
|
31
|
+
**base_skill_amount** | [**BaseSkillAmount**](BaseSkillAmount.md) | | [optional] [default to undefined]
|
|
32
|
+
**base_free_amount** | [**BaseFreeAmount**](BaseFreeAmount.md) | | [optional] [default to undefined]
|
|
33
|
+
**base_reward_amount** | [**BaseRewardAmount**](BaseRewardAmount.md) | | [optional] [default to undefined]
|
|
34
|
+
**base_permanent_amount** | [**BasePermanentAmount**](BasePermanentAmount.md) | | [optional] [default to undefined]
|
|
35
|
+
**fee_platform_amount** | [**FeePlatformAmount**](FeePlatformAmount.md) | | [optional] [default to undefined]
|
|
36
|
+
**fee_platform_free_amount** | [**FeePlatformFreeAmount**](FeePlatformFreeAmount.md) | | [optional] [default to undefined]
|
|
37
|
+
**fee_platform_reward_amount** | [**FeePlatformRewardAmount**](FeePlatformRewardAmount.md) | | [optional] [default to undefined]
|
|
38
|
+
**fee_platform_permanent_amount** | [**FeePlatformPermanentAmount**](FeePlatformPermanentAmount.md) | | [optional] [default to undefined]
|
|
39
|
+
**fee_dev_account** | **string** | | [optional] [default to undefined]
|
|
40
|
+
**fee_dev_amount** | [**FeeDevAmount**](FeeDevAmount.md) | | [optional] [default to undefined]
|
|
41
|
+
**fee_dev_free_amount** | [**FeeDevFreeAmount**](FeeDevFreeAmount.md) | | [optional] [default to undefined]
|
|
42
|
+
**fee_dev_reward_amount** | [**FeeDevRewardAmount**](FeeDevRewardAmount.md) | | [optional] [default to undefined]
|
|
43
|
+
**fee_dev_permanent_amount** | [**FeeDevPermanentAmount**](FeeDevPermanentAmount.md) | | [optional] [default to undefined]
|
|
44
|
+
**fee_agent_account** | **string** | | [optional] [default to undefined]
|
|
45
|
+
**fee_agent_amount** | [**FeeAgentAmount**](FeeAgentAmount.md) | | [optional] [default to undefined]
|
|
46
|
+
**fee_agent_free_amount** | [**FeeAgentFreeAmount**](FeeAgentFreeAmount.md) | | [optional] [default to undefined]
|
|
47
|
+
**fee_agent_reward_amount** | [**FeeAgentRewardAmount**](FeeAgentRewardAmount.md) | | [optional] [default to undefined]
|
|
48
|
+
**fee_agent_permanent_amount** | [**FeeAgentPermanentAmount**](FeeAgentPermanentAmount.md) | | [optional] [default to undefined]
|
|
49
|
+
**free_amount** | [**FreeAmount**](FreeAmount.md) | | [optional] [default to undefined]
|
|
50
|
+
**reward_amount** | [**RewardAmount**](RewardAmount.md) | | [optional] [default to undefined]
|
|
51
|
+
**permanent_amount** | [**PermanentAmount**](PermanentAmount.md) | | [optional] [default to undefined]
|
|
52
|
+
**note** | **string** | | [optional] [default to undefined]
|
|
53
|
+
**created_at** | **string** | Timestamp when this event was created | [default to undefined]
|
|
54
|
+
|
|
55
|
+
## Example
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
import { CreditEventInput } from '@crestal/nation-sdk';
|
|
59
|
+
|
|
60
|
+
const instance: CreditEventInput = {
|
|
61
|
+
id,
|
|
62
|
+
account_id,
|
|
63
|
+
event_type,
|
|
64
|
+
user_id,
|
|
65
|
+
upstream_type,
|
|
66
|
+
upstream_tx_id,
|
|
67
|
+
agent_id,
|
|
68
|
+
agent_wallet_address,
|
|
69
|
+
start_message_id,
|
|
70
|
+
message_id,
|
|
71
|
+
model,
|
|
72
|
+
skill_call_id,
|
|
73
|
+
skill_name,
|
|
74
|
+
direction,
|
|
75
|
+
total_amount,
|
|
76
|
+
credit_type,
|
|
77
|
+
credit_types,
|
|
78
|
+
balance_after,
|
|
79
|
+
base_amount,
|
|
80
|
+
base_discount_amount,
|
|
81
|
+
base_original_amount,
|
|
82
|
+
base_llm_amount,
|
|
83
|
+
base_skill_amount,
|
|
84
|
+
base_free_amount,
|
|
85
|
+
base_reward_amount,
|
|
86
|
+
base_permanent_amount,
|
|
87
|
+
fee_platform_amount,
|
|
88
|
+
fee_platform_free_amount,
|
|
89
|
+
fee_platform_reward_amount,
|
|
90
|
+
fee_platform_permanent_amount,
|
|
91
|
+
fee_dev_account,
|
|
92
|
+
fee_dev_amount,
|
|
93
|
+
fee_dev_free_amount,
|
|
94
|
+
fee_dev_reward_amount,
|
|
95
|
+
fee_dev_permanent_amount,
|
|
96
|
+
fee_agent_account,
|
|
97
|
+
fee_agent_amount,
|
|
98
|
+
fee_agent_free_amount,
|
|
99
|
+
fee_agent_reward_amount,
|
|
100
|
+
fee_agent_permanent_amount,
|
|
101
|
+
free_amount,
|
|
102
|
+
reward_amount,
|
|
103
|
+
permanent_amount,
|
|
104
|
+
note,
|
|
105
|
+
created_at,
|
|
106
|
+
};
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreditEventOutput
|
|
2
2
|
|
|
3
3
|
Credit event model with all fields.
|
|
4
4
|
|
|
@@ -55,9 +55,9 @@ Name | Type | Description | Notes
|
|
|
55
55
|
## Example
|
|
56
56
|
|
|
57
57
|
```typescript
|
|
58
|
-
import {
|
|
58
|
+
import { CreditEventOutput } from '@crestal/nation-sdk';
|
|
59
59
|
|
|
60
|
-
const instance:
|
|
60
|
+
const instance: CreditEventOutput = {
|
|
61
61
|
id,
|
|
62
62
|
account_id,
|
|
63
63
|
event_type,
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# CreditEventWithAgentInput
|
|
2
|
+
|
|
3
|
+
Credit event response model with agent name. Extends CreditEvent to include the agent name for better user experience.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the credit event | [optional] [default to undefined]
|
|
10
|
+
**account_id** | **string** | Account ID from which credits flow | [optional] [default to undefined]
|
|
11
|
+
**event_type** | [**EventType**](EventType.md) | Type of the event | [default to undefined]
|
|
12
|
+
**user_id** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**upstream_type** | [**UpstreamType**](UpstreamType.md) | Type of upstream transaction | [default to undefined]
|
|
14
|
+
**upstream_tx_id** | **string** | Upstream transaction ID if any | [default to undefined]
|
|
15
|
+
**agent_id** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**agent_wallet_address** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**start_message_id** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**message_id** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**model** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**skill_call_id** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**skill_name** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**direction** | [**Direction**](Direction.md) | Direction of the credit flow | [default to undefined]
|
|
23
|
+
**total_amount** | [**TotalAmount**](TotalAmount.md) | | [optional] [default to undefined]
|
|
24
|
+
**credit_type** | [**CreditType**](CreditType.md) | Type of credits involved | [default to undefined]
|
|
25
|
+
**credit_types** | [**Array<CreditType>**](CreditType.md) | | [optional] [default to undefined]
|
|
26
|
+
**balance_after** | [**BalanceAfter**](BalanceAfter.md) | | [optional] [default to undefined]
|
|
27
|
+
**base_amount** | [**BaseAmount**](BaseAmount.md) | | [optional] [default to undefined]
|
|
28
|
+
**base_discount_amount** | [**BaseDiscountAmount**](BaseDiscountAmount.md) | | [optional] [default to undefined]
|
|
29
|
+
**base_original_amount** | [**BaseOriginalAmount**](BaseOriginalAmount.md) | | [optional] [default to undefined]
|
|
30
|
+
**base_llm_amount** | [**BaseLlmAmount**](BaseLlmAmount.md) | | [optional] [default to undefined]
|
|
31
|
+
**base_skill_amount** | [**BaseSkillAmount**](BaseSkillAmount.md) | | [optional] [default to undefined]
|
|
32
|
+
**base_free_amount** | [**BaseFreeAmount**](BaseFreeAmount.md) | | [optional] [default to undefined]
|
|
33
|
+
**base_reward_amount** | [**BaseRewardAmount**](BaseRewardAmount.md) | | [optional] [default to undefined]
|
|
34
|
+
**base_permanent_amount** | [**BasePermanentAmount**](BasePermanentAmount.md) | | [optional] [default to undefined]
|
|
35
|
+
**fee_platform_amount** | [**FeePlatformAmount**](FeePlatformAmount.md) | | [optional] [default to undefined]
|
|
36
|
+
**fee_platform_free_amount** | [**FeePlatformFreeAmount**](FeePlatformFreeAmount.md) | | [optional] [default to undefined]
|
|
37
|
+
**fee_platform_reward_amount** | [**FeePlatformRewardAmount**](FeePlatformRewardAmount.md) | | [optional] [default to undefined]
|
|
38
|
+
**fee_platform_permanent_amount** | [**FeePlatformPermanentAmount**](FeePlatformPermanentAmount.md) | | [optional] [default to undefined]
|
|
39
|
+
**fee_dev_account** | **string** | | [optional] [default to undefined]
|
|
40
|
+
**fee_dev_amount** | [**FeeDevAmount**](FeeDevAmount.md) | | [optional] [default to undefined]
|
|
41
|
+
**fee_dev_free_amount** | [**FeeDevFreeAmount**](FeeDevFreeAmount.md) | | [optional] [default to undefined]
|
|
42
|
+
**fee_dev_reward_amount** | [**FeeDevRewardAmount**](FeeDevRewardAmount.md) | | [optional] [default to undefined]
|
|
43
|
+
**fee_dev_permanent_amount** | [**FeeDevPermanentAmount**](FeeDevPermanentAmount.md) | | [optional] [default to undefined]
|
|
44
|
+
**fee_agent_account** | **string** | | [optional] [default to undefined]
|
|
45
|
+
**fee_agent_amount** | [**FeeAgentAmount**](FeeAgentAmount.md) | | [optional] [default to undefined]
|
|
46
|
+
**fee_agent_free_amount** | [**FeeAgentFreeAmount**](FeeAgentFreeAmount.md) | | [optional] [default to undefined]
|
|
47
|
+
**fee_agent_reward_amount** | [**FeeAgentRewardAmount**](FeeAgentRewardAmount.md) | | [optional] [default to undefined]
|
|
48
|
+
**fee_agent_permanent_amount** | [**FeeAgentPermanentAmount**](FeeAgentPermanentAmount.md) | | [optional] [default to undefined]
|
|
49
|
+
**free_amount** | [**FreeAmount**](FreeAmount.md) | | [optional] [default to undefined]
|
|
50
|
+
**reward_amount** | [**RewardAmount**](RewardAmount.md) | | [optional] [default to undefined]
|
|
51
|
+
**permanent_amount** | [**PermanentAmount**](PermanentAmount.md) | | [optional] [default to undefined]
|
|
52
|
+
**note** | **string** | | [optional] [default to undefined]
|
|
53
|
+
**created_at** | **string** | Timestamp when this event was created | [default to undefined]
|
|
54
|
+
**agent_name** | **string** | | [optional] [default to undefined]
|
|
55
|
+
|
|
56
|
+
## Example
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { CreditEventWithAgentInput } from '@crestal/nation-sdk';
|
|
60
|
+
|
|
61
|
+
const instance: CreditEventWithAgentInput = {
|
|
62
|
+
id,
|
|
63
|
+
account_id,
|
|
64
|
+
event_type,
|
|
65
|
+
user_id,
|
|
66
|
+
upstream_type,
|
|
67
|
+
upstream_tx_id,
|
|
68
|
+
agent_id,
|
|
69
|
+
agent_wallet_address,
|
|
70
|
+
start_message_id,
|
|
71
|
+
message_id,
|
|
72
|
+
model,
|
|
73
|
+
skill_call_id,
|
|
74
|
+
skill_name,
|
|
75
|
+
direction,
|
|
76
|
+
total_amount,
|
|
77
|
+
credit_type,
|
|
78
|
+
credit_types,
|
|
79
|
+
balance_after,
|
|
80
|
+
base_amount,
|
|
81
|
+
base_discount_amount,
|
|
82
|
+
base_original_amount,
|
|
83
|
+
base_llm_amount,
|
|
84
|
+
base_skill_amount,
|
|
85
|
+
base_free_amount,
|
|
86
|
+
base_reward_amount,
|
|
87
|
+
base_permanent_amount,
|
|
88
|
+
fee_platform_amount,
|
|
89
|
+
fee_platform_free_amount,
|
|
90
|
+
fee_platform_reward_amount,
|
|
91
|
+
fee_platform_permanent_amount,
|
|
92
|
+
fee_dev_account,
|
|
93
|
+
fee_dev_amount,
|
|
94
|
+
fee_dev_free_amount,
|
|
95
|
+
fee_dev_reward_amount,
|
|
96
|
+
fee_dev_permanent_amount,
|
|
97
|
+
fee_agent_account,
|
|
98
|
+
fee_agent_amount,
|
|
99
|
+
fee_agent_free_amount,
|
|
100
|
+
fee_agent_reward_amount,
|
|
101
|
+
fee_agent_permanent_amount,
|
|
102
|
+
free_amount,
|
|
103
|
+
reward_amount,
|
|
104
|
+
permanent_amount,
|
|
105
|
+
note,
|
|
106
|
+
created_at,
|
|
107
|
+
agent_name,
|
|
108
|
+
};
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreditEventWithAgentOutput
|
|
2
2
|
|
|
3
3
|
Credit event response model with agent name. Extends CreditEvent to include the agent name for better user experience.
|
|
4
4
|
|
|
@@ -56,9 +56,9 @@ Name | Type | Description | Notes
|
|
|
56
56
|
## Example
|
|
57
57
|
|
|
58
58
|
```typescript
|
|
59
|
-
import {
|
|
59
|
+
import { CreditEventWithAgentOutput } from '@crestal/nation-sdk';
|
|
60
60
|
|
|
61
|
-
const instance:
|
|
61
|
+
const instance: CreditEventWithAgentOutput = {
|
|
62
62
|
id,
|
|
63
63
|
account_id,
|
|
64
64
|
event_type,
|
|
@@ -6,7 +6,7 @@ Paginated response model for credit events. Contains a list of credit events, a
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<
|
|
9
|
+
**data** | [**Array<CreditEventWithAgentOutput>**](CreditEventWithAgentOutput.md) | List of credit events with agent names | [default to undefined]
|
|
10
10
|
**has_more** | **boolean** | Indicates if there are more items | [default to undefined]
|
|
11
11
|
**next_cursor** | **string** | | [optional] [default to undefined]
|
|
12
12
|
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# CreditTransactionRespInput
|
|
2
|
+
|
|
3
|
+
Credit transaction response model with associated event data. Extends CreditTransaction to include the related CreditEvent if available.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the credit transaction | [optional] [default to undefined]
|
|
10
|
+
**account_id** | **string** | ID of the account this transaction belongs to | [default to undefined]
|
|
11
|
+
**event_id** | **string** | ID of the event that triggered this transaction | [default to undefined]
|
|
12
|
+
**tx_type** | [**TransactionType**](TransactionType.md) | Type of the transaction | [default to undefined]
|
|
13
|
+
**credit_debit** | [**CreditDebit**](CreditDebit.md) | Whether this is a credit or debit transaction | [default to undefined]
|
|
14
|
+
**change_amount** | [**ChangeAmount**](ChangeAmount.md) | | [optional] [default to undefined]
|
|
15
|
+
**free_amount** | [**FreeAmount1**](FreeAmount1.md) | | [optional] [default to undefined]
|
|
16
|
+
**reward_amount** | [**RewardAmount1**](RewardAmount1.md) | | [optional] [default to undefined]
|
|
17
|
+
**permanent_amount** | [**PermanentAmount1**](PermanentAmount1.md) | | [optional] [default to undefined]
|
|
18
|
+
**credit_type** | [**CreditType**](CreditType.md) | Type of credits involved | [default to undefined]
|
|
19
|
+
**created_at** | **string** | Timestamp when this transaction was created | [default to undefined]
|
|
20
|
+
**event** | [**CreditEventInput**](CreditEventInput.md) | | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { CreditTransactionRespInput } from '@crestal/nation-sdk';
|
|
26
|
+
|
|
27
|
+
const instance: CreditTransactionRespInput = {
|
|
28
|
+
id,
|
|
29
|
+
account_id,
|
|
30
|
+
event_id,
|
|
31
|
+
tx_type,
|
|
32
|
+
credit_debit,
|
|
33
|
+
change_amount,
|
|
34
|
+
free_amount,
|
|
35
|
+
reward_amount,
|
|
36
|
+
permanent_amount,
|
|
37
|
+
credit_type,
|
|
38
|
+
created_at,
|
|
39
|
+
event,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreditTransactionRespOutput
|
|
2
2
|
|
|
3
3
|
Credit transaction response model with associated event data. Extends CreditTransaction to include the related CreditEvent if available.
|
|
4
4
|
|
|
@@ -17,14 +17,14 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**permanent_amount** | **string** | Amount of permanent credits changed | [optional] [default to '0']
|
|
18
18
|
**credit_type** | [**CreditType**](CreditType.md) | Type of credits involved | [default to undefined]
|
|
19
19
|
**created_at** | **string** | Timestamp when this transaction was created | [default to undefined]
|
|
20
|
-
**event** | [**
|
|
20
|
+
**event** | [**CreditEventOutput**](CreditEventOutput.md) | | [optional] [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
24
24
|
```typescript
|
|
25
|
-
import {
|
|
25
|
+
import { CreditTransactionRespOutput } from '@crestal/nation-sdk';
|
|
26
26
|
|
|
27
|
-
const instance:
|
|
27
|
+
const instance: CreditTransactionRespOutput = {
|
|
28
28
|
id,
|
|
29
29
|
account_id,
|
|
30
30
|
event_id,
|
|
@@ -6,7 +6,7 @@ Paginated response model for credit transactions. Contains a list of credit tra
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<
|
|
9
|
+
**data** | [**Array<CreditTransactionRespOutput>**](CreditTransactionRespOutput.md) | List of credit transactions | [default to undefined]
|
|
10
10
|
**has_more** | **boolean** | Indicates if there are more items | [default to undefined]
|
|
11
11
|
**next_cursor** | **string** | | [optional] [default to undefined]
|
|
12
12
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# FeeAgentAmount
|
|
2
|
+
|
|
3
|
+
Agent fee amount
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeAgentAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeAgentAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeAgentFreeAmount
|
|
2
|
+
|
|
3
|
+
Agent fee amount from free credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeAgentFreeAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeAgentFreeAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeAgentPermanentAmount
|
|
2
|
+
|
|
3
|
+
Agent fee amount from permanent credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeAgentPermanentAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeAgentPermanentAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeAgentRewardAmount
|
|
2
|
+
|
|
3
|
+
Agent fee amount from reward credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeAgentRewardAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeAgentRewardAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeDevAmount
|
|
2
|
+
|
|
3
|
+
Developer fee amount
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeDevAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeDevAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeDevFreeAmount
|
|
2
|
+
|
|
3
|
+
Developer fee amount from free credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeDevFreeAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeDevFreeAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeDevPermanentAmount
|
|
2
|
+
|
|
3
|
+
Developer fee amount from permanent credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeDevPermanentAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeDevPermanentAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeeDevRewardAmount
|
|
2
|
+
|
|
3
|
+
Developer fee amount from reward credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeeDevRewardAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeeDevRewardAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeePlatformAmount
|
|
2
|
+
|
|
3
|
+
Platform fee amount
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeePlatformAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeePlatformAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeePlatformFreeAmount
|
|
2
|
+
|
|
3
|
+
Platform fee amount from free credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeePlatformFreeAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeePlatformFreeAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeePlatformPermanentAmount
|
|
2
|
+
|
|
3
|
+
Platform fee amount from permanent credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeePlatformPermanentAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeePlatformPermanentAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FeePlatformRewardAmount
|
|
2
|
+
|
|
3
|
+
Platform fee amount from reward credits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FeePlatformRewardAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FeePlatformRewardAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FreeAmount
|
|
2
|
+
|
|
3
|
+
Free credit amount involved
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FreeAmount } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FreeAmount = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[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,19 @@
|
|
|
1
|
+
# FreeAmount1
|
|
2
|
+
|
|
3
|
+
Amount of free credits changed
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { FreeAmount1 } from '@crestal/nation-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: FreeAmount1 = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|