Skip to content

Commit c464832

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.1.0, Speakeasy CLI 1.277.4
1 parent 3a8e080 commit c464832

File tree

152 files changed

+2500
-1317
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+2500
-1317
lines changed

‎.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This allows generated code to be indexed correctly
2+
*.py linguist-generated=false

‎.speakeasy/gen.lock

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
lockVersion: 2.0.0
2+
id: d25f9dc3-777c-4555-805f-3c161ab883d0
3+
management:
4+
docChecksum: a08d8b55b00bfb4ba4828a322fd16614
5+
docVersion: 0.1.0
6+
speakeasyVersion: 1.277.4
7+
generationVersion: 2.318.3
8+
releaseVersion: 0.22.0
9+
configChecksum: 0e9feec9b026dd8294240b0f37ff0118
10+
repoURL: https://github.com/fabra-io/python-sdk.git
11+
repoSubDirectory: .
12+
installationURL: https://github.com/fabra-io/python-sdk.git
13+
published: true
14+
features:
15+
python:
16+
core: 4.6.5
17+
globalSecurity: 2.83.5
18+
globalServerURLs: 2.82.2
19+
responseFormat: 0.1.0
20+
generatedFiles:
21+
- src/fabra/sdkconfiguration.py
22+
- src/fabra/connection.py
23+
- src/fabra/customer_data.py
24+
- src/fabra/destination.py
25+
- src/fabra/link_token.py
26+
- src/fabra/object.py
27+
- src/fabra/source.py
28+
- src/fabra/sync.py
29+
- src/fabra/sdk.py
30+
- py.typed
31+
- pylintrc
32+
- setup.py
33+
- src/fabra/__init__.py
34+
- src/fabra/utils/__init__.py
35+
- src/fabra/utils/retries.py
36+
- src/fabra/utils/utils.py
37+
- src/fabra/models/errors/sdkerror.py
38+
- tests/helpers.py
39+
- src/fabra/models/operations/get_namespaces.py
40+
- src/fabra/models/operations/get_schema.py
41+
- src/fabra/models/operations/get_tables.py
42+
- src/fabra/models/operations/query_object.py
43+
- src/fabra/models/operations/create_destination.py
44+
- src/fabra/models/operations/get_destinations.py
45+
- src/fabra/models/operations/create_link_token.py
46+
- src/fabra/models/operations/create_object.py
47+
- src/fabra/models/operations/get_objects.py
48+
- src/fabra/models/operations/create_source.py
49+
- src/fabra/models/operations/get_sources.py
50+
- src/fabra/models/operations/create_sync.py
51+
- src/fabra/models/operations/get_syncs.py
52+
- src/fabra/models/components/namespaces.py
53+
- src/fabra/models/components/httpmetadata.py
54+
- src/fabra/models/components/field.py
55+
- src/fabra/models/components/fieldtype.py
56+
- src/fabra/models/components/queryfilter.py
57+
- src/fabra/models/components/destination.py
58+
- src/fabra/models/components/connection.py
59+
- src/fabra/models/components/connectiontype.py
60+
- src/fabra/models/components/destinationinput.py
61+
- src/fabra/models/components/snowflakeconfig.py
62+
- src/fabra/models/components/redshiftconfig.py
63+
- src/fabra/models/components/mongodbconfig.py
64+
- src/fabra/models/components/bigqueryconfig.py
65+
- src/fabra/models/components/createlinktokenresponse.py
66+
- src/fabra/models/components/createlinktokenrequest.py
67+
- src/fabra/models/components/object.py
68+
- src/fabra/models/components/objectfield.py
69+
- src/fabra/models/components/objectinput.py
70+
- src/fabra/models/components/frequencyunits.py
71+
- src/fabra/models/components/source.py
72+
- src/fabra/models/components/sourceinput.py
73+
- src/fabra/models/components/sync.py
74+
- src/fabra/models/components/fieldmapping.py
75+
- src/fabra/models/components/syncinput.py
76+
- src/fabra/models/components/security.py
77+
- src/fabra/models/__init__.py
78+
- src/fabra/models/errors/__init__.py
79+
- src/fabra/models/operations/__init__.py
80+
- src/fabra/models/components/__init__.py
81+
- docs/models/operations/getnamespacesrequest.md
82+
- docs/models/operations/getnamespacesresponse.md
83+
- docs/models/operations/getschemarequest.md
84+
- docs/models/operations/getschemaresponsebody.md
85+
- docs/models/operations/getschemaresponse.md
86+
- docs/models/operations/gettablesrequest.md
87+
- docs/models/operations/gettablesresponsebody.md
88+
- docs/models/operations/gettablesresponse.md
89+
- docs/models/operations/queryobjectrequestbody.md
90+
- docs/models/operations/queryobjectrequest.md
91+
- docs/models/operations/examplefield3.md
92+
- docs/models/operations/queryobjectresponsebody.md
93+
- docs/models/operations/queryobjectresponse.md
94+
- docs/models/operations/createdestinationresponsebody.md
95+
- docs/models/operations/createdestinationresponse.md
96+
- docs/models/operations/getdestinationsresponsebody.md
97+
- docs/models/operations/getdestinationsresponse.md
98+
- docs/models/operations/createlinktokenresponse.md
99+
- docs/models/operations/createobjectresponsebody.md
100+
- docs/models/operations/createobjectresponse.md
101+
- docs/models/operations/getobjectsresponsebody.md
102+
- docs/models/operations/getobjectsresponse.md
103+
- docs/models/operations/createsourceresponsebody.md
104+
- docs/models/operations/createsourceresponse.md
105+
- docs/models/operations/getsourcesresponsebody.md
106+
- docs/models/operations/getsourcesresponse.md
107+
- docs/models/operations/createsyncresponsebody.md
108+
- docs/models/operations/createsyncresponse.md
109+
- docs/models/operations/getsyncsresponsebody.md
110+
- docs/models/operations/getsyncsresponse.md
111+
- docs/models/components/namespaces.md
112+
- docs/models/components/httpmetadata.md
113+
- docs/models/components/field.md
114+
- docs/models/components/fieldtype.md
115+
- docs/models/components/queryfilter.md
116+
- docs/models/components/destination.md
117+
- docs/models/components/connection.md
118+
- docs/models/components/connectiontype.md
119+
- docs/models/components/destinationinput.md
120+
- docs/models/components/snowflakeconfig.md
121+
- docs/models/components/redshiftconfig.md
122+
- docs/models/components/mongodbconfig.md
123+
- docs/models/components/bigqueryconfig.md
124+
- docs/models/components/createlinktokenresponse.md
125+
- docs/models/components/createlinktokenrequest.md
126+
- docs/models/components/object.md
127+
- docs/models/components/objectfield.md
128+
- docs/models/components/objectinput.md
129+
- docs/models/components/frequencyunits.md
130+
- docs/models/components/source.md
131+
- docs/models/components/sourceinput.md
132+
- docs/models/components/sync.md
133+
- docs/models/components/fieldmapping.md
134+
- docs/models/components/syncinput.md
135+
- docs/models/components/security.md
136+
- docs/sdks/fabra/README.md
137+
- docs/sdks/connection/README.md
138+
- docs/sdks/customerdata/README.md
139+
- docs/sdks/destination/README.md
140+
- docs/sdks/linktoken/README.md
141+
- docs/sdks/object/README.md
142+
- docs/sdks/source/README.md
143+
- docs/sdks/sync/README.md
144+
- USAGE.md
145+
- .gitattributes
146+
- src/fabra/_hooks/sdkhooks.py
147+
- src/fabra/_hooks/types.py
148+
- src/fabra/_hooks/__init__.py

‎README.md

Lines changed: 163 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,43 @@
66
<a href="https://www.fabra.io/#Email-Hero"><img src="https://img.shields.io/static/v1?label=Docs&message=Sign Up&color=2ca47c&style=for-the-badge" /></a>
77
</div>
88

9-
<!-- Start SDK Installation -->
9+
<!-- Start SDK Installation [installation] -->
1010
## SDK Installation
1111

1212
```bash
1313
pip install fabra
1414
```
15-
<!-- End SDK Installation -->
15+
<!-- End SDK Installation [installation] -->
1616

17+
<!-- Start SDK Example Usage [usage] -->
1718
## SDK Example Usage
18-
<!-- Start SDK Example Usage -->
19+
20+
### Example
21+
1922
```python
2023
import fabra
2124
from fabra.models import operations
2225

2326
s = fabra.Fabra(
24-
security=shared.Security(
25-
api_key_auth="",
26-
),
27+
api_key_auth="<YOUR_API_KEY_HERE>",
2728
)
2829

2930
req = operations.GetNamespacesRequest(
30-
connection_id=548814,
31+
connection_id=995455,
3132
)
3233

3334
res = s.connection.get_namespaces(req)
3435

3536
if res.namespaces is not None:
3637
# handle response
38+
pass
39+
3740
```
38-
<!-- End SDK Example Usage -->
41+
<!-- End SDK Example Usage [usage] -->
3942

40-
<!-- Start SDK Available Operations -->
43+
<!-- Start Available Resources and Operations [operations] -->
4144
## Available Resources and Operations
4245

43-
4446
### [connection](docs/sdks/connection/README.md)
4547

4648
* [get_namespaces](docs/sdks/connection/README.md#get_namespaces) - Get all namespaces
@@ -74,6 +76,156 @@ if res.namespaces is not None:
7476

7577
* [create_sync](docs/sdks/sync/README.md#create_sync) - Create a new sync
7678
* [get_syncs](docs/sdks/sync/README.md#get_syncs) - Get all syncs
77-
<!-- End SDK Available Operations -->
79+
<!-- End Available Resources and Operations [operations] -->
80+
81+
<!-- Start Error Handling [errors] -->
82+
## Error Handling
83+
84+
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
85+
86+
| Error Object | Status Code | Content Type |
87+
| --------------- | --------------- | --------------- |
88+
| errors.SDKError | 4xx-5xx | */* |
89+
90+
### Example
91+
92+
```python
93+
import fabra
94+
from fabra.models import errors, operations
95+
96+
s = fabra.Fabra(
97+
api_key_auth="<YOUR_API_KEY_HERE>",
98+
)
99+
100+
req = operations.GetNamespacesRequest(
101+
connection_id=995455,
102+
)
103+
104+
res = None
105+
try:
106+
res = s.connection.get_namespaces(req)
107+
except errors.SDKError as e:
108+
# handle exception
109+
raise(e)
110+
111+
if res.namespaces is not None:
112+
# handle response
113+
pass
114+
115+
```
116+
<!-- End Error Handling [errors] -->
117+
118+
<!-- Start Server Selection [server] -->
119+
## Server Selection
120+
121+
### Select Server by Index
122+
123+
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
124+
125+
| # | Server | Variables |
126+
| - | ------ | --------- |
127+
| 0 | `https://api.fabra.io` | None |
128+
129+
#### Example
130+
131+
```python
132+
import fabra
133+
from fabra.models import operations
134+
135+
s = fabra.Fabra(
136+
server_idx=0,
137+
api_key_auth="<YOUR_API_KEY_HERE>",
138+
)
139+
140+
req = operations.GetNamespacesRequest(
141+
connection_id=995455,
142+
)
143+
144+
res = s.connection.get_namespaces(req)
145+
146+
if res.namespaces is not None:
147+
# handle response
148+
pass
149+
150+
```
151+
152+
153+
### Override Server URL Per-Client
154+
155+
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
156+
```python
157+
import fabra
158+
from fabra.models import operations
159+
160+
s = fabra.Fabra(
161+
server_url="https://api.fabra.io",
162+
api_key_auth="<YOUR_API_KEY_HERE>",
163+
)
164+
165+
req = operations.GetNamespacesRequest(
166+
connection_id=995455,
167+
)
168+
169+
res = s.connection.get_namespaces(req)
170+
171+
if res.namespaces is not None:
172+
# handle response
173+
pass
174+
175+
```
176+
<!-- End Server Selection [server] -->
177+
178+
<!-- Start Custom HTTP Client [http-client] -->
179+
## Custom HTTP Client
180+
181+
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
182+
183+
For example, you could specify a header for every request that this sdk makes as follows:
184+
```python
185+
import fabra
186+
import requests
187+
188+
http_client = requests.Session()
189+
http_client.headers.update({'x-custom-header': 'someValue'})
190+
s = fabra.Fabra(client=http_client)
191+
```
192+
<!-- End Custom HTTP Client [http-client] -->
193+
194+
<!-- Start Authentication [security] -->
195+
## Authentication
196+
197+
### Per-Client Security Schemes
198+
199+
This SDK supports the following security scheme globally:
200+
201+
| Name | Type | Scheme |
202+
| -------------- | -------------- | -------------- |
203+
| `api_key_auth` | apiKey | API key |
204+
205+
To authenticate with the API the `api_key_auth` parameter must be set when initializing the SDK client instance. For example:
206+
```python
207+
import fabra
208+
from fabra.models import operations
209+
210+
s = fabra.Fabra(
211+
api_key_auth="<YOUR_API_KEY_HERE>",
212+
)
213+
214+
req = operations.GetNamespacesRequest(
215+
connection_id=995455,
216+
)
217+
218+
res = s.connection.get_namespaces(req)
219+
220+
if res.namespaces is not None:
221+
# handle response
222+
pass
223+
224+
```
225+
<!-- End Authentication [security] -->
226+
227+
<!-- Placeholder for Future Speakeasy SDK Sections -->
228+
229+
78230

79231
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,4 +354,14 @@ Based on:
354354
- OpenAPI Doc 0.1.0 https://fabra-io.github.io/docs/openapi.yaml
355355
- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy
356356
### Releases
357-
- [PyPI v0.21.0] https://pypi.org/project/fabra/0.21.0 - .
357+
- [PyPI v0.21.0] https://pypi.org/project/fabra/0.21.0 - .
358+
359+
## 2024-05-01 00:06:28
360+
### Changes
361+
Based on:
362+
- OpenAPI Doc 0.1.0 https://fabra-io.github.io/docs/openapi.yaml
363+
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
364+
### Generated
365+
- [python v0.22.0] .
366+
### Releases
367+
- [PyPI v0.22.0] https://pypi.org/project/fabra/0.22.0 - .

0 commit comments

Comments
 (0)