Skip to content

Commit 374759a

Browse files
committed
update raw client doc
1 parent 73551e5 commit 374759a

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

src/bubble_data_api_client/client/raw_client.py

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,27 @@ class AdditionalSortField(typing.TypedDict):
3434

3535

3636
class RawClient:
37-
"""Raw Client layer focuses on bubble.io API endpoints.
37+
"""Low-level client providing raw access to all Bubble Data API endpoints.
3838
39-
https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/data-api-requests
40-
https://www.postman.com/bubbleapi/bubble/request/jigyk5v/
39+
This client serves two purposes:
40+
41+
Raw API methods are direct 1:1 mappings to Bubble Data API endpoints. These
42+
return httpx.Response to give full access to status codes, headers, and
43+
response bodies. The caller is responsible for parsing responses.
44+
45+
retrieve, create, bulk_create, delete, update, replace, find
46+
47+
Convenience methods are higher-level operations built on top of raw methods.
48+
These handle response parsing and return typed values. Use these when you
49+
don't need raw HTTP access.
50+
51+
count, exists, create_or_update
52+
53+
For ORM-style access with model classes, use BubbleModel instead.
54+
55+
References:
56+
https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/data-api-requests
57+
https://www.postman.com/bubbleapi/bubble/request/jigyk5v/
4158
"""
4259

4360
_transport: Transport

0 commit comments

Comments
 (0)