Skip to content

Commit a4bb78d

Browse files
committed
Refactor terminology from "company" to "entity" across multiple API endpoints and models for consistency. Updated documentation and request/response structures to reflect this change, enhancing clarity in financial and connection-related functionalities.
1 parent d67fd3e commit a4bb78d

23 files changed

+142
-225
lines changed

robosystems_client/api/agent/query_financial_agent.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ def sync_detailed(
9898
AI-powered financial analysis with direct access to graph data.
9999
100100
This endpoint provides intelligent financial analysis using an AI agent that can:
101-
- Analyze company financial statements and SEC filings
101+
- Analyze entity financial statements and SEC filings
102102
- Review QuickBooks transactions and accounting data
103103
- Perform multi-period trend analysis
104104
- Generate insights from balance sheets and income statements
@@ -185,7 +185,7 @@ def sync(
185185
AI-powered financial analysis with direct access to graph data.
186186
187187
This endpoint provides intelligent financial analysis using an AI agent that can:
188-
- Analyze company financial statements and SEC filings
188+
- Analyze entity financial statements and SEC filings
189189
- Review QuickBooks transactions and accounting data
190190
- Perform multi-period trend analysis
191191
- Generate insights from balance sheets and income statements
@@ -267,7 +267,7 @@ async def asyncio_detailed(
267267
AI-powered financial analysis with direct access to graph data.
268268
269269
This endpoint provides intelligent financial analysis using an AI agent that can:
270-
- Analyze company financial statements and SEC filings
270+
- Analyze entity financial statements and SEC filings
271271
- Review QuickBooks transactions and accounting data
272272
- Perform multi-period trend analysis
273273
- Generate insights from balance sheets and income statements
@@ -352,7 +352,7 @@ async def asyncio(
352352
AI-powered financial analysis with direct access to graph data.
353353
354354
This endpoint provides intelligent financial analysis using an AI agent that can:
355-
- Analyze company financial statements and SEC filings
355+
- Analyze entity financial statements and SEC filings
356356
- Review QuickBooks transactions and accounting data
357357
- Perform multi-period trend analysis
358358
- Generate insights from balance sheets and income statements

robosystems_client/api/connections/create_connection.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def sync_detailed(
104104
This endpoint initiates connections to external data sources:
105105
106106
**SEC Connections**:
107-
- Provide company CIK for automatic filing retrieval
107+
- Provide entity CIK for automatic filing retrieval
108108
- No authentication needed
109109
- Begins immediate data sync
110110
@@ -166,7 +166,7 @@ def sync(
166166
This endpoint initiates connections to external data sources:
167167
168168
**SEC Connections**:
169-
- Provide company CIK for automatic filing retrieval
169+
- Provide entity CIK for automatic filing retrieval
170170
- No authentication needed
171171
- Begins immediate data sync
172172
@@ -223,7 +223,7 @@ async def asyncio_detailed(
223223
This endpoint initiates connections to external data sources:
224224
225225
**SEC Connections**:
226-
- Provide company CIK for automatic filing retrieval
226+
- Provide entity CIK for automatic filing retrieval
227227
- No authentication needed
228228
- Begins immediate data sync
229229
@@ -283,7 +283,7 @@ async def asyncio(
283283
This endpoint initiates connections to external data sources:
284284
285285
**SEC Connections**:
286-
- Provide company CIK for automatic filing retrieval
286+
- Provide entity CIK for automatic filing retrieval
287287
- No authentication needed
288288
- Begins immediate data sync
289289

robosystems_client/api/connections/create_link_token.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ def sync_detailed(
100100
- Expires after 4 hours
101101
- Is single-use only
102102
- Must be used with the matching frontend SDK
103-
- Includes user and company context
103+
- Includes user and entity context
104104
105105
No credits are consumed for creating link tokens.
106106
@@ -153,7 +153,7 @@ def sync(
153153
- Expires after 4 hours
154154
- Is single-use only
155155
- Must be used with the matching frontend SDK
156-
- Includes user and company context
156+
- Includes user and entity context
157157
158158
No credits are consumed for creating link tokens.
159159
@@ -201,7 +201,7 @@ async def asyncio_detailed(
201201
- Expires after 4 hours
202202
- Is single-use only
203203
- Must be used with the matching frontend SDK
204-
- Includes user and company context
204+
- Includes user and entity context
205205
206206
No credits are consumed for creating link tokens.
207207
@@ -252,7 +252,7 @@ async def asyncio(
252252
- Expires after 4 hours
253253
- Is single-use only
254254
- Must be used with the matching frontend SDK
255-
- Includes user and company context
255+
- Includes user and entity context
256256
257257
No credits are consumed for creating link tokens.
258258

robosystems_client/api/connections/get_connection_options.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def sync_detailed(
8484
8585
This endpoint returns comprehensive information about each supported provider:
8686
87-
**SEC EDGAR**: Public company financial filings
87+
**SEC EDGAR**: Public entity financial filings
8888
- No authentication required (public data)
8989
- 10-K, 10-Q, 8-K reports with XBRL data
9090
- Historical and real-time filing access
@@ -140,7 +140,7 @@ def sync(
140140
141141
This endpoint returns comprehensive information about each supported provider:
142142
143-
**SEC EDGAR**: Public company financial filings
143+
**SEC EDGAR**: Public entity financial filings
144144
- No authentication required (public data)
145145
- 10-K, 10-Q, 8-K reports with XBRL data
146146
- Historical and real-time filing access
@@ -191,7 +191,7 @@ async def asyncio_detailed(
191191
192192
This endpoint returns comprehensive information about each supported provider:
193193
194-
**SEC EDGAR**: Public company financial filings
194+
**SEC EDGAR**: Public entity financial filings
195195
- No authentication required (public data)
196196
- 10-K, 10-Q, 8-K reports with XBRL data
197197
- Historical and real-time filing access
@@ -245,7 +245,7 @@ async def asyncio(
245245
246246
This endpoint returns comprehensive information about each supported provider:
247247
248-
**SEC EDGAR**: Public company financial filings
248+
**SEC EDGAR**: Public entity financial filings
249249
- No authentication required (public data)
250250
- 10-K, 10-Q, 8-K reports with XBRL data
251251
- Historical and real-time filing access

robosystems_client/api/connections/list_connections.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
def _get_kwargs(
1616
graph_id: str,
1717
*,
18-
company_id: Union[None, Unset, str] = UNSET,
18+
entity_id: Union[None, Unset, str] = UNSET,
1919
provider: Union[ListConnectionsProviderType0, None, Unset] = UNSET,
2020
authorization: Union[None, Unset, str] = UNSET,
2121
auth_token: Union[None, Unset, str] = UNSET,
@@ -30,12 +30,12 @@ def _get_kwargs(
3030

3131
params: dict[str, Any] = {}
3232

33-
json_company_id: Union[None, Unset, str]
34-
if isinstance(company_id, Unset):
35-
json_company_id = UNSET
33+
json_entity_id: Union[None, Unset, str]
34+
if isinstance(entity_id, Unset):
35+
json_entity_id = UNSET
3636
else:
37-
json_company_id = company_id
38-
params["company_id"] = json_company_id
37+
json_entity_id = entity_id
38+
params["entity_id"] = json_entity_id
3939

4040
json_provider: Union[None, Unset, str]
4141
if isinstance(provider, Unset):
@@ -104,7 +104,7 @@ def sync_detailed(
104104
graph_id: str,
105105
*,
106106
client: AuthenticatedClient,
107-
company_id: Union[None, Unset, str] = UNSET,
107+
entity_id: Union[None, Unset, str] = UNSET,
108108
provider: Union[ListConnectionsProviderType0, None, Unset] = UNSET,
109109
authorization: Union[None, Unset, str] = UNSET,
110110
auth_token: Union[None, Unset, str] = UNSET,
@@ -115,7 +115,7 @@ def sync_detailed(
115115
116116
Returns active and inactive connections with their current status.
117117
Connections can be filtered by:
118-
- **Company**: Show connections for a specific company
118+
- **Entity**: Show connections for a specific entity
119119
- **Provider**: Filter by connection type (sec, quickbooks, plaid)
120120
121121
Each connection shows:
@@ -128,7 +128,7 @@ def sync_detailed(
128128
129129
Args:
130130
graph_id (str): Graph database identifier
131-
company_id (Union[None, Unset, str]): Filter by company ID
131+
entity_id (Union[None, Unset, str]): Filter by entity ID
132132
provider (Union[ListConnectionsProviderType0, None, Unset]): Filter by provider type
133133
authorization (Union[None, Unset, str]):
134134
auth_token (Union[None, Unset, str]):
@@ -143,7 +143,7 @@ def sync_detailed(
143143

144144
kwargs = _get_kwargs(
145145
graph_id=graph_id,
146-
company_id=company_id,
146+
entity_id=entity_id,
147147
provider=provider,
148148
authorization=authorization,
149149
auth_token=auth_token,
@@ -160,7 +160,7 @@ def sync(
160160
graph_id: str,
161161
*,
162162
client: AuthenticatedClient,
163-
company_id: Union[None, Unset, str] = UNSET,
163+
entity_id: Union[None, Unset, str] = UNSET,
164164
provider: Union[ListConnectionsProviderType0, None, Unset] = UNSET,
165165
authorization: Union[None, Unset, str] = UNSET,
166166
auth_token: Union[None, Unset, str] = UNSET,
@@ -171,7 +171,7 @@ def sync(
171171
172172
Returns active and inactive connections with their current status.
173173
Connections can be filtered by:
174-
- **Company**: Show connections for a specific company
174+
- **Entity**: Show connections for a specific entity
175175
- **Provider**: Filter by connection type (sec, quickbooks, plaid)
176176
177177
Each connection shows:
@@ -184,7 +184,7 @@ def sync(
184184
185185
Args:
186186
graph_id (str): Graph database identifier
187-
company_id (Union[None, Unset, str]): Filter by company ID
187+
entity_id (Union[None, Unset, str]): Filter by entity ID
188188
provider (Union[ListConnectionsProviderType0, None, Unset]): Filter by provider type
189189
authorization (Union[None, Unset, str]):
190190
auth_token (Union[None, Unset, str]):
@@ -200,7 +200,7 @@ def sync(
200200
return sync_detailed(
201201
graph_id=graph_id,
202202
client=client,
203-
company_id=company_id,
203+
entity_id=entity_id,
204204
provider=provider,
205205
authorization=authorization,
206206
auth_token=auth_token,
@@ -211,7 +211,7 @@ async def asyncio_detailed(
211211
graph_id: str,
212212
*,
213213
client: AuthenticatedClient,
214-
company_id: Union[None, Unset, str] = UNSET,
214+
entity_id: Union[None, Unset, str] = UNSET,
215215
provider: Union[ListConnectionsProviderType0, None, Unset] = UNSET,
216216
authorization: Union[None, Unset, str] = UNSET,
217217
auth_token: Union[None, Unset, str] = UNSET,
@@ -222,7 +222,7 @@ async def asyncio_detailed(
222222
223223
Returns active and inactive connections with their current status.
224224
Connections can be filtered by:
225-
- **Company**: Show connections for a specific company
225+
- **Entity**: Show connections for a specific entity
226226
- **Provider**: Filter by connection type (sec, quickbooks, plaid)
227227
228228
Each connection shows:
@@ -235,7 +235,7 @@ async def asyncio_detailed(
235235
236236
Args:
237237
graph_id (str): Graph database identifier
238-
company_id (Union[None, Unset, str]): Filter by company ID
238+
entity_id (Union[None, Unset, str]): Filter by entity ID
239239
provider (Union[ListConnectionsProviderType0, None, Unset]): Filter by provider type
240240
authorization (Union[None, Unset, str]):
241241
auth_token (Union[None, Unset, str]):
@@ -250,7 +250,7 @@ async def asyncio_detailed(
250250

251251
kwargs = _get_kwargs(
252252
graph_id=graph_id,
253-
company_id=company_id,
253+
entity_id=entity_id,
254254
provider=provider,
255255
authorization=authorization,
256256
auth_token=auth_token,
@@ -265,7 +265,7 @@ async def asyncio(
265265
graph_id: str,
266266
*,
267267
client: AuthenticatedClient,
268-
company_id: Union[None, Unset, str] = UNSET,
268+
entity_id: Union[None, Unset, str] = UNSET,
269269
provider: Union[ListConnectionsProviderType0, None, Unset] = UNSET,
270270
authorization: Union[None, Unset, str] = UNSET,
271271
auth_token: Union[None, Unset, str] = UNSET,
@@ -276,7 +276,7 @@ async def asyncio(
276276
277277
Returns active and inactive connections with their current status.
278278
Connections can be filtered by:
279-
- **Company**: Show connections for a specific company
279+
- **Entity**: Show connections for a specific entity
280280
- **Provider**: Filter by connection type (sec, quickbooks, plaid)
281281
282282
Each connection shows:
@@ -289,7 +289,7 @@ async def asyncio(
289289
290290
Args:
291291
graph_id (str): Graph database identifier
292-
company_id (Union[None, Unset, str]): Filter by company ID
292+
entity_id (Union[None, Unset, str]): Filter by entity ID
293293
provider (Union[ListConnectionsProviderType0, None, Unset]): Filter by provider type
294294
authorization (Union[None, Unset, str]):
295295
auth_token (Union[None, Unset, str]):
@@ -306,7 +306,7 @@ async def asyncio(
306306
await asyncio_detailed(
307307
graph_id=graph_id,
308308
client=client,
309-
company_id=company_id,
309+
entity_id=entity_id,
310310
provider=provider,
311311
authorization=authorization,
312312
auth_token=auth_token,

0 commit comments

Comments
 (0)