Skip to content

Commit cca1e14

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

File tree

151 files changed

+2537
-1305
lines changed

Some content is hidden

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

151 files changed

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

‎README.md

Lines changed: 161 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,42 @@
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

29-
req = operations.GetNamespacesRequest(
30-
connection_id=548814,
31-
)
3230

33-
res = s.connection.get_namespaces(req)
31+
res = s.connection.get_namespaces(request=operations.GetNamespacesRequest(
32+
connection_id=995455,
33+
))
3434

3535
if res.namespaces is not None:
3636
# handle response
37+
pass
38+
3739
```
38-
<!-- End SDK Example Usage -->
40+
<!-- End SDK Example Usage [usage] -->
3941

40-
<!-- Start SDK Available Operations -->
42+
<!-- Start Available Resources and Operations [operations] -->
4143
## Available Resources and Operations
4244

43-
4445
### [connection](docs/sdks/connection/README.md)
4546

4647
* [get_namespaces](docs/sdks/connection/README.md#get_namespaces) - Get all namespaces
@@ -74,6 +75,152 @@ if res.namespaces is not None:
7475

7576
* [create_sync](docs/sdks/sync/README.md#create_sync) - Create a new sync
7677
* [get_syncs](docs/sdks/sync/README.md#get_syncs) - Get all syncs
77-
<!-- End SDK Available Operations -->
78+
<!-- End Available Resources and Operations [operations] -->
79+
80+
<!-- Start Error Handling [errors] -->
81+
## Error Handling
82+
83+
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.
84+
85+
| Error Object | Status Code | Content Type |
86+
| --------------- | --------------- | --------------- |
87+
| errors.SDKError | 4xx-5xx | */* |
88+
89+
### Example
90+
91+
```python
92+
import fabra
93+
from fabra.models import errors, operations
94+
95+
s = fabra.Fabra(
96+
api_key_auth="<YOUR_API_KEY_HERE>",
97+
)
98+
99+
res = None
100+
try:
101+
res = s.connection.get_namespaces(request=operations.GetNamespacesRequest(
102+
connection_id=995455,
103+
))
104+
105+
except errors.SDKError as e:
106+
# handle exception
107+
raise(e)
108+
109+
if res.namespaces is not None:
110+
# handle response
111+
pass
112+
113+
```
114+
<!-- End Error Handling [errors] -->
115+
116+
<!-- Start Server Selection [server] -->
117+
## Server Selection
118+
119+
### Select Server by Index
120+
121+
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:
122+
123+
| # | Server | Variables |
124+
| - | ------ | --------- |
125+
| 0 | `https://api.fabra.io` | None |
126+
127+
#### Example
128+
129+
```python
130+
import fabra
131+
from fabra.models import operations
132+
133+
s = fabra.Fabra(
134+
server_idx=0,
135+
api_key_auth="<YOUR_API_KEY_HERE>",
136+
)
137+
138+
139+
res = s.connection.get_namespaces(request=operations.GetNamespacesRequest(
140+
connection_id=995455,
141+
))
142+
143+
if res.namespaces is not None:
144+
# handle response
145+
pass
146+
147+
```
148+
149+
150+
### Override Server URL Per-Client
151+
152+
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:
153+
```python
154+
import fabra
155+
from fabra.models import operations
156+
157+
s = fabra.Fabra(
158+
server_url="https://api.fabra.io",
159+
api_key_auth="<YOUR_API_KEY_HERE>",
160+
)
161+
162+
163+
res = s.connection.get_namespaces(request=operations.GetNamespacesRequest(
164+
connection_id=995455,
165+
))
166+
167+
if res.namespaces is not None:
168+
# handle response
169+
pass
170+
171+
```
172+
<!-- End Server Selection [server] -->
173+
174+
<!-- Start Custom HTTP Client [http-client] -->
175+
## Custom HTTP Client
176+
177+
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.
178+
179+
For example, you could specify a header for every request that this sdk makes as follows:
180+
```python
181+
import fabra
182+
import requests
183+
184+
http_client = requests.Session()
185+
http_client.headers.update({'x-custom-header': 'someValue'})
186+
s = fabra.Fabra(client=http_client)
187+
```
188+
<!-- End Custom HTTP Client [http-client] -->
189+
190+
<!-- Start Authentication [security] -->
191+
## Authentication
192+
193+
### Per-Client Security Schemes
194+
195+
This SDK supports the following security scheme globally:
196+
197+
| Name | Type | Scheme |
198+
| -------------- | -------------- | -------------- |
199+
| `api_key_auth` | apiKey | API key |
200+
201+
To authenticate with the API the `api_key_auth` parameter must be set when initializing the SDK client instance. For example:
202+
```python
203+
import fabra
204+
from fabra.models import operations
205+
206+
s = fabra.Fabra(
207+
api_key_auth="<YOUR_API_KEY_HERE>",
208+
)
209+
210+
211+
res = s.connection.get_namespaces(request=operations.GetNamespacesRequest(
212+
connection_id=995455,
213+
))
214+
215+
if res.namespaces is not None:
216+
# handle response
217+
pass
218+
219+
```
220+
<!-- End Authentication [security] -->
221+
222+
<!-- Placeholder for Future Speakeasy SDK Sections -->
223+
224+
78225

79226
### 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-29 00:07:04
360+
### Changes
361+
Based on:
362+
- OpenAPI Doc 0.1.0 https://fabra-io.github.io/docs/openapi.yaml
363+
- Speakeasy CLI 1.296.1 (2.338.1) 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)