Skip to content

Commit e1077c5

Browse files
committed
feat: update docs
1 parent d37ef89 commit e1077c5

File tree

2 files changed

+4
-110
lines changed

2 files changed

+4
-110
lines changed

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -396,15 +396,13 @@ order = await client.get_customer_order(order_id=123)
396396

397397
**📖 [Full Wallet Service Documentation](docs/en/services/wallet.md)**
398398

399-
Manage user balances, expenses, and refunds with the Wallet Service. This service provides comprehensive functionality
399+
Manage user balances and expenses with the Wallet Service. This service provides comprehensive functionality
400400
for handling user financial operations.
401401

402402
**Key Features:**
403403

404404
- Get user balance and transaction history
405405
- Create and manage expenses
406-
- Process refunds
407-
- Handle credit-specific operations
408406

409407
**Methods:**
410408

@@ -413,14 +411,10 @@ for handling user financial operations.
413411
| `get_balance()` | Get user's balance | `user_id`, `filters`, `x_operator_id` |
414412
| `get_transactions()` | Get transaction history | `user_id`, `page`, `per_page`, `x_operator_id` |
415413
| `create_expense()` | Create an expense | `user_id`, `request`, `x_operator_id` |
416-
| `create_expense_from_credit()` | Create expense from specific credit | `user_id`, `credit_id`, `request`, `x_operator_id` |
417414
| `get_expense()` | Get expense details | `user_id`, `expense_id`, `x_operator_id` |
418415
| `delete_expense()` | Delete/rollback expense | `user_id`, `expense_id`, `rollback_reason_id`, `x_operator_id` |
419416
| `get_expense_by_ref()` | Get expense by reference | `user_id`, `reason_id`, `reference_id`, `x_operator_id` |
420417
| `delete_expense_by_ref()` | Delete expense by reference | `user_id`, `reason_id`, `reference_id`, `rollback_reason_id`, `x_operator_id` |
421-
| `create_refund()` | Process a refund | `request`, `x_operator_id` |
422-
| `can_rollback_refund()` | Check if refund can be rolled back | `refund_reason`, `refund_reference_id`, `x_operator_id` |
423-
| `rollback_refund()` | Rollback a refund | `request`, `x_operator_id` |
424418

425419
**Example:**
426420

docs/en/services/wallet.md

Lines changed: 3 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Wallet Service
22

3-
Manage user balances, expenses, and refunds with the Wallet Service. This service provides comprehensive functionality
4-
for handling user financial operations: get user balance and transaction history, create and manage expenses, process
5-
refunds, and handle credit-specific operations.
3+
Manage user balances and expenses with the Wallet Service. This service provides comprehensive functionality
4+
for handling user financial operations: get user balance and transaction history, and create and manage expenses.
65

76
## Table of Contents
87

@@ -18,14 +17,10 @@ refunds, and handle credit-specific operations.
1817
| [`get_balance()`](#get-balance-example) | Get user's balance | `user_id`, `filters`, `x_operator_id` |
1918
| [`get_transactions()`](#get-transactions-example) | Get transaction history | `user_id`, `page`, `per_page`, `x_operator_id` |
2019
| [`create_expense()`](#create-expense-example) | Create an expense | `user_id`, `request`, `x_operator_id` |
21-
| [`create_expense_from_credit()`](#create-expense-from-credit-example) | Create expense from specific credit | `user_id`, `credit_id`, `request`, `x_operator_id` |
2220
| [`get_expense()`](#get-expense-example) | Get expense details | `user_id`, `expense_id`, `x_operator_id` |
2321
| [`delete_expense()`](#delete-expense-example) | Delete/rollback expense | `user_id`, `expense_id`, `rollback_reason_id`, `x_operator_id` |
2422
| [`get_expense_by_ref()`](#get-expense-by-ref-example) | Get expense by reference | `user_id`, `reason_id`, `reference_id`, `x_operator_id` |
2523
| [`delete_expense_by_ref()`](#delete-expense-by-ref-example) | Delete expense by reference | `user_id`, `reason_id`, `reference_id`, `rollback_reason_id`, `x_operator_id` |
26-
| [`create_refund()`](#create-refund-example) | Process a refund | `request`, `x_operator_id` |
27-
| [`can_rollback_refund()`](#can-rollback-refund-example) | Check if refund can be rolled back | `refund_id`, `refund_reason`, `refund_reference_id`, `x_operator_id`| |
28-
| [`rollback_refund()`](#rollback-refund-example) | Rollback a refund | `refund_id`, `request`, `x_operator_id` |
2924

3025
## Examples
3126

@@ -34,8 +29,7 @@ refunds, and handle credit-specific operations.
3429
```python
3530
from basalam_sdk import BasalamClient, PersonalToken
3631
from basalam_sdk.wallet.models import (
37-
SpendCreditRequest, SpendSpecificCreditRequest, RefundRequest,
38-
RollbackRefundRequest, BalanceFilter
32+
SpendCreditRequest, BalanceFilter
3933
)
4034

4135
auth = PersonalToken(
@@ -108,31 +102,6 @@ async def create_expense_example():
108102
return expense
109103
```
110104

111-
### Create Expense From Credit Example
112-
113-
```python
114-
async def create_expense_from_credit_example():
115-
expense = await client.wallet.create_expense_from_credit(
116-
user_id=123,
117-
credit_id=789,
118-
request=SpendSpecificCreditRequest(
119-
reason_id=1,
120-
reference_id=456,
121-
amount=5000,
122-
description="Payment from specific credit",
123-
settleable=True,
124-
references={
125-
"order_id": 456,
126-
"credit_type": 1
127-
}
128-
),
129-
x_operator_id=456
130-
)
131-
132-
print(f"Specific credit expense created: {expense.id}")
133-
return expense
134-
```
135-
136105
### Get Expense Example
137106

138107
```python
@@ -196,75 +165,6 @@ async def delete_expense_by_ref_example():
196165
return result
197166
```
198167

199-
### Create Refund Example
200-
201-
```python
202-
async def create_refund_example():
203-
refund = await client.wallet.create_refund(
204-
request=RefundRequest(
205-
original_reason=1,
206-
original_reference_id=456,
207-
reason=2,
208-
reference_id=789,
209-
amount=5000,
210-
description="Refund for cancelled order",
211-
references=[
212-
{
213-
"reference_type_id": 1,
214-
"reference_id": 456
215-
}
216-
]
217-
),
218-
x_operator_id=456
219-
)
220-
221-
print(f"Refund processed: {refund.id}")
222-
return refund
223-
```
224-
225-
### Can Rollback Refund Example
226-
227-
```python
228-
async def can_rollback_refund_example():
229-
# Assuming refund_id is 999
230-
can_rollback = await client.wallet.can_rollback_refund(
231-
refund_id=999,
232-
x_operator_id=456
233-
)
234-
235-
print(f"Can rollback refund: {can_rollback.status}")
236-
print(f"Message: {can_rollback.message}")
237-
238-
return can_rollback
239-
```
240-
241-
### Rollback Refund Example
242-
243-
```python
244-
async def rollback_refund_example():
245-
# Assuming refund_id is 999
246-
result = await client.wallet.rollback_refund(
247-
refund_id=999,
248-
request=RollbackRefundRequest(
249-
refund_reason=2,
250-
rollback_refund_reason=3,
251-
refund_reference_id=789,
252-
reference_id=456,
253-
description="Rollback refund due to error",
254-
references=[
255-
{
256-
"reference_type_id": 1,
257-
"reference_id": 456
258-
}
259-
]
260-
),
261-
x_operator_id=456
262-
)
263-
264-
print(f"Refund rolled back: {result.id}")
265-
return result
266-
```
267-
268168
## Next Steps
269169

270170
- [Webhook Service](./webhook.md) - Handle webhook subscriptions

0 commit comments

Comments
 (0)