rezen 1.0.0__tar.gz
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.
- rezen-1.0.0/LICENSE +21 -0
- rezen-1.0.0/MANIFEST.in +16 -0
- rezen-1.0.0/PKG-INFO +224 -0
- rezen-1.0.0/README.md +178 -0
- rezen-1.0.0/docs/README.md +166 -0
- rezen-1.0.0/docs/workflows/authentication.md +459 -0
- rezen-1.0.0/docs/workflows/error-handling.md +609 -0
- rezen-1.0.0/docs/workflows/teams.md +436 -0
- rezen-1.0.0/docs/workflows/testing.md +716 -0
- rezen-1.0.0/docs/workflows/transaction-builder.md +379 -0
- rezen-1.0.0/docs/workflows/transactions.md +645 -0
- rezen-1.0.0/pyproject.toml +159 -0
- rezen-1.0.0/requirements-dev.txt +9 -0
- rezen-1.0.0/requirements.txt +4 -0
- rezen-1.0.0/rezen/__init__.py +34 -0
- rezen-1.0.0/rezen/base_client.py +233 -0
- rezen-1.0.0/rezen/client.py +93 -0
- rezen-1.0.0/rezen/exceptions.py +50 -0
- rezen-1.0.0/rezen/py.typed +1 -0
- rezen-1.0.0/rezen/teams.py +197 -0
- rezen-1.0.0/rezen/transaction_builder.py +765 -0
- rezen-1.0.0/rezen/transactions.py +719 -0
- rezen-1.0.0/rezen.egg-info/PKG-INFO +224 -0
- rezen-1.0.0/rezen.egg-info/SOURCES.txt +26 -0
- rezen-1.0.0/rezen.egg-info/dependency_links.txt +1 -0
- rezen-1.0.0/rezen.egg-info/requires.txt +14 -0
- rezen-1.0.0/rezen.egg-info/top_level.txt +1 -0
- rezen-1.0.0/setup.cfg +4 -0
rezen-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 The Perry Group
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
rezen-1.0.0/MANIFEST.in
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
include README.md
|
|
2
|
+
include LICENSE
|
|
3
|
+
include requirements.txt
|
|
4
|
+
include requirements-dev.txt
|
|
5
|
+
include pyproject.toml
|
|
6
|
+
recursive-include rezen *.py
|
|
7
|
+
recursive-include rezen py.typed
|
|
8
|
+
recursive-include docs *.md
|
|
9
|
+
recursive-exclude tests *
|
|
10
|
+
recursive-exclude venv *
|
|
11
|
+
recursive-exclude .git *
|
|
12
|
+
recursive-exclude __pycache__ *
|
|
13
|
+
recursive-exclude *.pyc *
|
|
14
|
+
recursive-exclude .pytest_cache *
|
|
15
|
+
recursive-exclude .mypy_cache *
|
|
16
|
+
recursive-exclude htmlcov *
|
rezen-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: rezen
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Python wrapper for The Real Brokerage ReZEN API - Transaction Builder, Transactions, and Teams management
|
|
5
|
+
Author-email: The Perry Group <dev@theperrygroup.com>
|
|
6
|
+
Maintainer-email: The Perry Group <dev@theperrygroup.com>
|
|
7
|
+
License: MIT
|
|
8
|
+
Project-URL: Homepage, https://github.com/theperrygroup/rezen
|
|
9
|
+
Project-URL: Documentation, https://github.com/theperrygroup/rezen/blob/main/docs/README.md
|
|
10
|
+
Project-URL: Repository, https://github.com/theperrygroup/rezen
|
|
11
|
+
Project-URL: Bug Tracker, https://github.com/theperrygroup/rezen/issues
|
|
12
|
+
Project-URL: Changelog, https://github.com/theperrygroup/rezen/releases
|
|
13
|
+
Keywords: real-estate,api,transactions,realty,rezen,the-real-brokerage,real-estate-api,transaction-management
|
|
14
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Intended Audience :: Financial and Insurance Industry
|
|
17
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
25
|
+
Classifier: Topic :: Office/Business :: Financial
|
|
26
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
27
|
+
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
|
|
28
|
+
Classifier: Typing :: Typed
|
|
29
|
+
Requires-Python: >=3.8
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
License-File: LICENSE
|
|
32
|
+
Requires-Dist: requests>=2.25.0
|
|
33
|
+
Requires-Dist: python-dotenv>=0.19.0
|
|
34
|
+
Requires-Dist: pydantic>=2.0.0
|
|
35
|
+
Provides-Extra: dev
|
|
36
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
37
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
|
|
38
|
+
Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
|
|
39
|
+
Requires-Dist: responses>=0.23.0; extra == "dev"
|
|
40
|
+
Requires-Dist: black>=23.0.0; extra == "dev"
|
|
41
|
+
Requires-Dist: flake8>=6.0.0; extra == "dev"
|
|
42
|
+
Requires-Dist: mypy>=1.0.0; extra == "dev"
|
|
43
|
+
Requires-Dist: isort>=5.12.0; extra == "dev"
|
|
44
|
+
Requires-Dist: pylint>=2.17.0; extra == "dev"
|
|
45
|
+
Dynamic: license-file
|
|
46
|
+
|
|
47
|
+
# ReZEN API Python Client
|
|
48
|
+
|
|
49
|
+
A comprehensive Python wrapper for the ReZEN (Real Estate) API, providing easy access to transaction builder, transactions, teams, and related real estate services.
|
|
50
|
+
|
|
51
|
+
## ๐ Quick Start
|
|
52
|
+
|
|
53
|
+
```python
|
|
54
|
+
from rezen import RezenClient
|
|
55
|
+
|
|
56
|
+
# Initialize client (uses REZEN_API_KEY environment variable)
|
|
57
|
+
client = RezenClient()
|
|
58
|
+
|
|
59
|
+
# Or provide API key directly
|
|
60
|
+
client = RezenClient(api_key="your_api_key_here")
|
|
61
|
+
|
|
62
|
+
# Create a transaction builder
|
|
63
|
+
response = client.transaction_builder.create_transaction_builder({
|
|
64
|
+
"type": "PURCHASE",
|
|
65
|
+
"property": {
|
|
66
|
+
"address": "123 Main St",
|
|
67
|
+
"city": "Anytown",
|
|
68
|
+
"state": "CA",
|
|
69
|
+
"zipCode": "12345"
|
|
70
|
+
}
|
|
71
|
+
})
|
|
72
|
+
|
|
73
|
+
# Search for teams
|
|
74
|
+
teams = client.teams.search_teams(status="ACTIVE")
|
|
75
|
+
|
|
76
|
+
# Get transaction details
|
|
77
|
+
transaction = client.transactions.get_transaction("transaction-id")
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## ๐ฆ Installation
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
pip install rezen-api # (when published)
|
|
84
|
+
|
|
85
|
+
# Or for development:
|
|
86
|
+
git clone <repository-url>
|
|
87
|
+
cd rezen
|
|
88
|
+
pip install -r requirements-dev.txt
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## ๐ง Setup
|
|
92
|
+
|
|
93
|
+
1. **Get your API key** from the ReZEN platform
|
|
94
|
+
2. **Set environment variable**:
|
|
95
|
+
```bash
|
|
96
|
+
export REZEN_API_KEY="your_api_key_here"
|
|
97
|
+
```
|
|
98
|
+
3. **Or create a `.env` file**:
|
|
99
|
+
```
|
|
100
|
+
REZEN_API_KEY=your_api_key_here
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## ๐ Main Workflows
|
|
104
|
+
|
|
105
|
+
### ๐๏ธ Transaction Builder Workflows
|
|
106
|
+
- **Create transactions** from scratch
|
|
107
|
+
- **Import existing transactions**
|
|
108
|
+
- **Manage participants** (buyers, sellers, agents)
|
|
109
|
+
- **Submit transactions** for processing
|
|
110
|
+
- **Update transaction details** and contracts
|
|
111
|
+
|
|
112
|
+
### ๐ Transaction Management Workflows
|
|
113
|
+
- **Retrieve transaction details** and status
|
|
114
|
+
- **Manage participants** and their information
|
|
115
|
+
- **Handle financial operations** (payments, fees)
|
|
116
|
+
- **Escrow management** (deposits, documentation)
|
|
117
|
+
- **Generate reports** and summaries
|
|
118
|
+
|
|
119
|
+
### ๐ฅ Team Management Workflows
|
|
120
|
+
- **Search teams** by name, status, or type
|
|
121
|
+
- **Get team details** and member information
|
|
122
|
+
- **Filter by team types** (Normal, Platinum, Group, etc.)
|
|
123
|
+
|
|
124
|
+
### ๐งช Testing & Development Workflows
|
|
125
|
+
- **Unit testing** with mocked responses
|
|
126
|
+
- **Live API testing** with real endpoints
|
|
127
|
+
- **Error handling** and validation
|
|
128
|
+
- **Coverage reporting**
|
|
129
|
+
|
|
130
|
+
## ๐ Detailed Documentation
|
|
131
|
+
|
|
132
|
+
For comprehensive workflow documentation, see:
|
|
133
|
+
|
|
134
|
+
- **[Transaction Builder Workflows](docs/workflows/transaction-builder.md)** - Creating and managing transaction builders
|
|
135
|
+
- **[Transaction Management Workflows](docs/workflows/transactions.md)** - Working with existing transactions
|
|
136
|
+
- **[Team Management Workflows](docs/workflows/teams.md)** - Finding and managing teams
|
|
137
|
+
- **[Authentication & Setup](docs/workflows/authentication.md)** - API key setup and configuration
|
|
138
|
+
- **[Testing Workflows](docs/workflows/testing.md)** - Development and testing procedures
|
|
139
|
+
- **[Error Handling](docs/workflows/error-handling.md)** - Common errors and solutions
|
|
140
|
+
|
|
141
|
+
## ๐๏ธ Client Structure
|
|
142
|
+
|
|
143
|
+
The ReZEN client provides access to different API sections:
|
|
144
|
+
|
|
145
|
+
```python
|
|
146
|
+
client = RezenClient()
|
|
147
|
+
|
|
148
|
+
# Transaction Builder API (89 endpoints)
|
|
149
|
+
client.transaction_builder.create_transaction_builder()
|
|
150
|
+
client.transaction_builder.add_buyer()
|
|
151
|
+
client.transaction_builder.submit_transaction()
|
|
152
|
+
|
|
153
|
+
# Transactions API (49 endpoints)
|
|
154
|
+
client.transactions.get_transaction()
|
|
155
|
+
client.transactions.create_participant()
|
|
156
|
+
client.transactions.get_summary_pdf()
|
|
157
|
+
|
|
158
|
+
# Teams API (2 endpoints)
|
|
159
|
+
client.teams.search_teams()
|
|
160
|
+
client.teams.get_team_without_agents()
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## ๐ฏ Key Features
|
|
164
|
+
|
|
165
|
+
- **โ
140+ endpoints** implemented with full coverage
|
|
166
|
+
- **๐ Type-safe** with comprehensive type hints
|
|
167
|
+
- **๐งช 100% test coverage** with pytest
|
|
168
|
+
- **๐ Complete documentation** with examples
|
|
169
|
+
- **๐ง Easy configuration** with environment variables
|
|
170
|
+
- **๐จ Robust error handling** with custom exceptions
|
|
171
|
+
- **๐ Async support** planned for future versions
|
|
172
|
+
|
|
173
|
+
## ๐ ๏ธ Development
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
# Clone and setup
|
|
177
|
+
git clone <repository-url>
|
|
178
|
+
cd rezen
|
|
179
|
+
python -m venv venv
|
|
180
|
+
source venv/bin/activate # or `venv\Scripts\activate` on Windows
|
|
181
|
+
pip install -r requirements-dev.txt
|
|
182
|
+
|
|
183
|
+
# Run tests
|
|
184
|
+
pytest
|
|
185
|
+
|
|
186
|
+
# Run tests with coverage
|
|
187
|
+
pytest --cov=rezen --cov-report=html
|
|
188
|
+
|
|
189
|
+
# Format code
|
|
190
|
+
black rezen tests
|
|
191
|
+
isort rezen tests
|
|
192
|
+
|
|
193
|
+
# Type checking
|
|
194
|
+
mypy rezen
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## ๐ API Coverage
|
|
198
|
+
|
|
199
|
+
| API Section | Endpoints | Status |
|
|
200
|
+
|-------------|-----------|--------|
|
|
201
|
+
| Transaction Builder | 89 | โ
Complete |
|
|
202
|
+
| Transactions | 49 | โ
Complete |
|
|
203
|
+
| Teams | 2 | โ
Complete |
|
|
204
|
+
| **Total** | **140** | **โ
Complete** |
|
|
205
|
+
|
|
206
|
+
## ๐ค Contributing
|
|
207
|
+
|
|
208
|
+
1. Fork the repository
|
|
209
|
+
2. Create a feature branch
|
|
210
|
+
3. Make your changes with tests
|
|
211
|
+
4. Ensure 100% test coverage
|
|
212
|
+
5. Submit a pull request
|
|
213
|
+
|
|
214
|
+
See [STYLE_GUIDE.md](STYLE_GUIDE.md) for coding standards.
|
|
215
|
+
|
|
216
|
+
## ๐ License
|
|
217
|
+
|
|
218
|
+
[Add your license here]
|
|
219
|
+
|
|
220
|
+
## ๐ Support
|
|
221
|
+
|
|
222
|
+
- **Documentation**: [docs/](docs/)
|
|
223
|
+
- **Issues**: [Create an issue](../../issues)
|
|
224
|
+
- **API Reference**: [docs/api-reference/](docs/api-reference/)
|
rezen-1.0.0/README.md
ADDED
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# ReZEN API Python Client
|
|
2
|
+
|
|
3
|
+
A comprehensive Python wrapper for the ReZEN (Real Estate) API, providing easy access to transaction builder, transactions, teams, and related real estate services.
|
|
4
|
+
|
|
5
|
+
## ๐ Quick Start
|
|
6
|
+
|
|
7
|
+
```python
|
|
8
|
+
from rezen import RezenClient
|
|
9
|
+
|
|
10
|
+
# Initialize client (uses REZEN_API_KEY environment variable)
|
|
11
|
+
client = RezenClient()
|
|
12
|
+
|
|
13
|
+
# Or provide API key directly
|
|
14
|
+
client = RezenClient(api_key="your_api_key_here")
|
|
15
|
+
|
|
16
|
+
# Create a transaction builder
|
|
17
|
+
response = client.transaction_builder.create_transaction_builder({
|
|
18
|
+
"type": "PURCHASE",
|
|
19
|
+
"property": {
|
|
20
|
+
"address": "123 Main St",
|
|
21
|
+
"city": "Anytown",
|
|
22
|
+
"state": "CA",
|
|
23
|
+
"zipCode": "12345"
|
|
24
|
+
}
|
|
25
|
+
})
|
|
26
|
+
|
|
27
|
+
# Search for teams
|
|
28
|
+
teams = client.teams.search_teams(status="ACTIVE")
|
|
29
|
+
|
|
30
|
+
# Get transaction details
|
|
31
|
+
transaction = client.transactions.get_transaction("transaction-id")
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## ๐ฆ Installation
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pip install rezen-api # (when published)
|
|
38
|
+
|
|
39
|
+
# Or for development:
|
|
40
|
+
git clone <repository-url>
|
|
41
|
+
cd rezen
|
|
42
|
+
pip install -r requirements-dev.txt
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## ๐ง Setup
|
|
46
|
+
|
|
47
|
+
1. **Get your API key** from the ReZEN platform
|
|
48
|
+
2. **Set environment variable**:
|
|
49
|
+
```bash
|
|
50
|
+
export REZEN_API_KEY="your_api_key_here"
|
|
51
|
+
```
|
|
52
|
+
3. **Or create a `.env` file**:
|
|
53
|
+
```
|
|
54
|
+
REZEN_API_KEY=your_api_key_here
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## ๐ Main Workflows
|
|
58
|
+
|
|
59
|
+
### ๐๏ธ Transaction Builder Workflows
|
|
60
|
+
- **Create transactions** from scratch
|
|
61
|
+
- **Import existing transactions**
|
|
62
|
+
- **Manage participants** (buyers, sellers, agents)
|
|
63
|
+
- **Submit transactions** for processing
|
|
64
|
+
- **Update transaction details** and contracts
|
|
65
|
+
|
|
66
|
+
### ๐ Transaction Management Workflows
|
|
67
|
+
- **Retrieve transaction details** and status
|
|
68
|
+
- **Manage participants** and their information
|
|
69
|
+
- **Handle financial operations** (payments, fees)
|
|
70
|
+
- **Escrow management** (deposits, documentation)
|
|
71
|
+
- **Generate reports** and summaries
|
|
72
|
+
|
|
73
|
+
### ๐ฅ Team Management Workflows
|
|
74
|
+
- **Search teams** by name, status, or type
|
|
75
|
+
- **Get team details** and member information
|
|
76
|
+
- **Filter by team types** (Normal, Platinum, Group, etc.)
|
|
77
|
+
|
|
78
|
+
### ๐งช Testing & Development Workflows
|
|
79
|
+
- **Unit testing** with mocked responses
|
|
80
|
+
- **Live API testing** with real endpoints
|
|
81
|
+
- **Error handling** and validation
|
|
82
|
+
- **Coverage reporting**
|
|
83
|
+
|
|
84
|
+
## ๐ Detailed Documentation
|
|
85
|
+
|
|
86
|
+
For comprehensive workflow documentation, see:
|
|
87
|
+
|
|
88
|
+
- **[Transaction Builder Workflows](docs/workflows/transaction-builder.md)** - Creating and managing transaction builders
|
|
89
|
+
- **[Transaction Management Workflows](docs/workflows/transactions.md)** - Working with existing transactions
|
|
90
|
+
- **[Team Management Workflows](docs/workflows/teams.md)** - Finding and managing teams
|
|
91
|
+
- **[Authentication & Setup](docs/workflows/authentication.md)** - API key setup and configuration
|
|
92
|
+
- **[Testing Workflows](docs/workflows/testing.md)** - Development and testing procedures
|
|
93
|
+
- **[Error Handling](docs/workflows/error-handling.md)** - Common errors and solutions
|
|
94
|
+
|
|
95
|
+
## ๐๏ธ Client Structure
|
|
96
|
+
|
|
97
|
+
The ReZEN client provides access to different API sections:
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
client = RezenClient()
|
|
101
|
+
|
|
102
|
+
# Transaction Builder API (89 endpoints)
|
|
103
|
+
client.transaction_builder.create_transaction_builder()
|
|
104
|
+
client.transaction_builder.add_buyer()
|
|
105
|
+
client.transaction_builder.submit_transaction()
|
|
106
|
+
|
|
107
|
+
# Transactions API (49 endpoints)
|
|
108
|
+
client.transactions.get_transaction()
|
|
109
|
+
client.transactions.create_participant()
|
|
110
|
+
client.transactions.get_summary_pdf()
|
|
111
|
+
|
|
112
|
+
# Teams API (2 endpoints)
|
|
113
|
+
client.teams.search_teams()
|
|
114
|
+
client.teams.get_team_without_agents()
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## ๐ฏ Key Features
|
|
118
|
+
|
|
119
|
+
- **โ
140+ endpoints** implemented with full coverage
|
|
120
|
+
- **๐ Type-safe** with comprehensive type hints
|
|
121
|
+
- **๐งช 100% test coverage** with pytest
|
|
122
|
+
- **๐ Complete documentation** with examples
|
|
123
|
+
- **๐ง Easy configuration** with environment variables
|
|
124
|
+
- **๐จ Robust error handling** with custom exceptions
|
|
125
|
+
- **๐ Async support** planned for future versions
|
|
126
|
+
|
|
127
|
+
## ๐ ๏ธ Development
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
# Clone and setup
|
|
131
|
+
git clone <repository-url>
|
|
132
|
+
cd rezen
|
|
133
|
+
python -m venv venv
|
|
134
|
+
source venv/bin/activate # or `venv\Scripts\activate` on Windows
|
|
135
|
+
pip install -r requirements-dev.txt
|
|
136
|
+
|
|
137
|
+
# Run tests
|
|
138
|
+
pytest
|
|
139
|
+
|
|
140
|
+
# Run tests with coverage
|
|
141
|
+
pytest --cov=rezen --cov-report=html
|
|
142
|
+
|
|
143
|
+
# Format code
|
|
144
|
+
black rezen tests
|
|
145
|
+
isort rezen tests
|
|
146
|
+
|
|
147
|
+
# Type checking
|
|
148
|
+
mypy rezen
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## ๐ API Coverage
|
|
152
|
+
|
|
153
|
+
| API Section | Endpoints | Status |
|
|
154
|
+
|-------------|-----------|--------|
|
|
155
|
+
| Transaction Builder | 89 | โ
Complete |
|
|
156
|
+
| Transactions | 49 | โ
Complete |
|
|
157
|
+
| Teams | 2 | โ
Complete |
|
|
158
|
+
| **Total** | **140** | **โ
Complete** |
|
|
159
|
+
|
|
160
|
+
## ๐ค Contributing
|
|
161
|
+
|
|
162
|
+
1. Fork the repository
|
|
163
|
+
2. Create a feature branch
|
|
164
|
+
3. Make your changes with tests
|
|
165
|
+
4. Ensure 100% test coverage
|
|
166
|
+
5. Submit a pull request
|
|
167
|
+
|
|
168
|
+
See [STYLE_GUIDE.md](STYLE_GUIDE.md) for coding standards.
|
|
169
|
+
|
|
170
|
+
## ๐ License
|
|
171
|
+
|
|
172
|
+
[Add your license here]
|
|
173
|
+
|
|
174
|
+
## ๐ Support
|
|
175
|
+
|
|
176
|
+
- **Documentation**: [docs/](docs/)
|
|
177
|
+
- **Issues**: [Create an issue](../../issues)
|
|
178
|
+
- **API Reference**: [docs/api-reference/](docs/api-reference/)
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# ReZEN API Documentation
|
|
2
|
+
|
|
3
|
+
Welcome to the comprehensive documentation for the ReZEN Python API client.
|
|
4
|
+
|
|
5
|
+
## ๐ Documentation Structure
|
|
6
|
+
|
|
7
|
+
### ๐ Workflow Documentation
|
|
8
|
+
|
|
9
|
+
Complete guides for common patterns and use cases:
|
|
10
|
+
|
|
11
|
+
- **[๐๏ธ Transaction Builder Workflows](workflows/transaction-builder.md)**
|
|
12
|
+
Create and manage transaction builders from scratch, add participants, and submit transactions
|
|
13
|
+
|
|
14
|
+
- **[๐ Transaction Management Workflows](workflows/transactions.md)**
|
|
15
|
+
Work with live transactions, manage participants, handle finances, and generate reports
|
|
16
|
+
|
|
17
|
+
- **[๐ฅ Team Management Workflows](workflows/teams.md)**
|
|
18
|
+
Search for teams, get team details, and integrate teams with transaction workflows
|
|
19
|
+
|
|
20
|
+
- **[๐ Authentication & Setup](workflows/authentication.md)**
|
|
21
|
+
Configure API keys, set up environments, and validate authentication
|
|
22
|
+
|
|
23
|
+
- **[๐จ Error Handling Workflows](workflows/error-handling.md)**
|
|
24
|
+
Handle errors gracefully, implement retry logic, and troubleshoot common issues
|
|
25
|
+
|
|
26
|
+
- **[๐งช Testing Workflows](workflows/testing.md)**
|
|
27
|
+
Test your integration with unit tests, mocked responses, and live API testing
|
|
28
|
+
|
|
29
|
+
### ๐ API Reference
|
|
30
|
+
|
|
31
|
+
Detailed technical reference (future expansion):
|
|
32
|
+
|
|
33
|
+
- **[Transaction Builder API](api-reference/)** - Endpoint specifications and examples
|
|
34
|
+
- **[Transactions API](api-reference/)** - Complete API reference
|
|
35
|
+
- **[Teams API](api-reference/)** - Team endpoints documentation
|
|
36
|
+
|
|
37
|
+
## ๐ Quick Start Paths
|
|
38
|
+
|
|
39
|
+
### New to ReZEN API?
|
|
40
|
+
1. Start with **[Authentication & Setup](workflows/authentication.md)** to configure your environment
|
|
41
|
+
2. Try **[Teams](workflows/teams.md)** to find your team ID
|
|
42
|
+
3. Follow **[Transaction Builder](workflows/transaction-builder.md)** to create your first transaction
|
|
43
|
+
|
|
44
|
+
### Building Production Applications?
|
|
45
|
+
1. Review **[Error Handling](workflows/error-handling.md)** for robust applications
|
|
46
|
+
2. Implement **[Testing](workflows/testing.md)** for reliable code
|
|
47
|
+
3. Use **[Transaction Management](workflows/transactions.md)** for live transaction operations
|
|
48
|
+
|
|
49
|
+
### Integration Developer?
|
|
50
|
+
1. **[Transaction Builder](workflows/transaction-builder.md)** - Core transaction creation
|
|
51
|
+
2. **[Teams](workflows/teams.md)** - Team assignment for agents
|
|
52
|
+
3. **[Error Handling](workflows/error-handling.md)** - Production-ready error handling
|
|
53
|
+
|
|
54
|
+
## ๐ฏ Common Use Cases
|
|
55
|
+
|
|
56
|
+
### ๐ Real Estate Transaction Processing
|
|
57
|
+
- Create purchase/sale transactions
|
|
58
|
+
- Assign agents to teams
|
|
59
|
+
- Add buyers, sellers, and service providers
|
|
60
|
+
- Handle escrow and financial operations
|
|
61
|
+
|
|
62
|
+
### ๐ Agent Management
|
|
63
|
+
- Find agent teams for commission tracking
|
|
64
|
+
- Manage agent participants in transactions
|
|
65
|
+
- Track agent performance across transactions
|
|
66
|
+
|
|
67
|
+
### ๐ฐ Financial Operations
|
|
68
|
+
- Process commission payments
|
|
69
|
+
- Handle escrow deposits and withdrawals
|
|
70
|
+
- Manage banking information
|
|
71
|
+
- Generate financial reports
|
|
72
|
+
|
|
73
|
+
### ๐ Documentation & Reporting
|
|
74
|
+
- Generate transaction summaries
|
|
75
|
+
- Export transaction data
|
|
76
|
+
- Create compliance reports
|
|
77
|
+
|
|
78
|
+
## ๐ง Development Resources
|
|
79
|
+
|
|
80
|
+
### Code Examples
|
|
81
|
+
Each workflow guide includes complete, runnable examples that you can copy and adapt for your use case.
|
|
82
|
+
|
|
83
|
+
### Error Handling
|
|
84
|
+
Comprehensive error handling patterns with specific solutions for common issues.
|
|
85
|
+
|
|
86
|
+
### Testing Support
|
|
87
|
+
Full test suites and mocking strategies for reliable development.
|
|
88
|
+
|
|
89
|
+
### Best Practices
|
|
90
|
+
Industry-standard patterns for real estate API integration.
|
|
91
|
+
|
|
92
|
+
## ๐ API Coverage
|
|
93
|
+
|
|
94
|
+
| API Section | Endpoints | Documentation Status |
|
|
95
|
+
|-------------|-----------|---------------------|
|
|
96
|
+
| Transaction Builder | 89 endpoints | โ
Complete workflows |
|
|
97
|
+
| Transactions | 49 endpoints | โ
Complete workflows |
|
|
98
|
+
| Teams | 2 endpoints | โ
Complete workflows |
|
|
99
|
+
| **Total** | **140 endpoints** | **โ
Complete** |
|
|
100
|
+
|
|
101
|
+
## ๐ Getting Help
|
|
102
|
+
|
|
103
|
+
### Workflow Issues
|
|
104
|
+
- Check the specific workflow guide for your use case
|
|
105
|
+
- Review the **[Error Handling](workflows/error-handling.md)** guide
|
|
106
|
+
- Look at **[Common Issues](workflows/error-handling.md#-common-issues)** sections
|
|
107
|
+
|
|
108
|
+
### API Questions
|
|
109
|
+
- Consult the workflow documentation for your endpoint
|
|
110
|
+
- Review code examples in the relevant workflow guide
|
|
111
|
+
- Check error handling patterns for API-specific issues
|
|
112
|
+
|
|
113
|
+
### Setup Problems
|
|
114
|
+
- Start with **[Authentication & Setup](workflows/authentication.md)**
|
|
115
|
+
- Review **[Testing](workflows/testing.md)** for validation approaches
|
|
116
|
+
- Check environment configuration examples
|
|
117
|
+
|
|
118
|
+
## ๐ Workflow Connections
|
|
119
|
+
|
|
120
|
+
The workflow guides are interconnected:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
Authentication & Setup
|
|
124
|
+
โ
|
|
125
|
+
Teams (find team IDs)
|
|
126
|
+
โ
|
|
127
|
+
Transaction Builder (create transactions)
|
|
128
|
+
โ
|
|
129
|
+
Transaction Management (work with live transactions)
|
|
130
|
+
โ
|
|
131
|
+
Error Handling + Testing (production ready)
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## ๐ง Future Documentation
|
|
135
|
+
|
|
136
|
+
Coming soon:
|
|
137
|
+
- **API Reference** - Detailed endpoint specifications
|
|
138
|
+
- **Webhook Integration** - Real-time transaction updates
|
|
139
|
+
- **Advanced Patterns** - Complex integration scenarios
|
|
140
|
+
- **Performance Optimization** - Scaling best practices
|
|
141
|
+
|
|
142
|
+
## ๐๏ธ Contributing to Documentation
|
|
143
|
+
|
|
144
|
+
Found an issue or want to improve the documentation?
|
|
145
|
+
|
|
146
|
+
1. **Workflow Improvements** - Suggest better patterns or examples
|
|
147
|
+
2. **Error Solutions** - Share solutions to new error scenarios
|
|
148
|
+
3. **Use Case Examples** - Contribute real-world integration examples
|
|
149
|
+
4. **Code Samples** - Submit working code examples
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## ๐ Quick Reference
|
|
154
|
+
|
|
155
|
+
| Task | Workflow Guide |
|
|
156
|
+
|------|----------------|
|
|
157
|
+
| Set up API access | [Authentication](workflows/authentication.md) |
|
|
158
|
+
| Find your team | [Teams](workflows/teams.md) |
|
|
159
|
+
| Create a transaction | [Transaction Builder](workflows/transaction-builder.md) |
|
|
160
|
+
| Work with live transactions | [Transactions](workflows/transactions.md) |
|
|
161
|
+
| Handle errors | [Error Handling](workflows/error-handling.md) |
|
|
162
|
+
| Test your code | [Testing](workflows/testing.md) |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
**๐ Happy coding with the ReZEN API!**
|