Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: speakeasy sdk regeneration - Generate #10

Open
wants to merge 45 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
f543e32
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
07dfd52
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
de1dcc9
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
57bd7b4
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.51.3
speakeasybot Jun 30, 2023
4903d1d
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
9d9076c
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
2f2a201
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
b768b81
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
3367c5e
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
2c301bf
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.56.3
speakeasybot Jul 12, 2023
827b49b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
70d2d1f
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
098cb2e
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
a5d2d56
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
7d0c94c
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
17665c9
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
857efdd
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
5f6d85a
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
d32b610
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
3908ac6
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
016cd47
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
5d6b998
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
81e27e4
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.73.1
speakeasybot Aug 16, 2023
cfb27f5
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
68ec5e2
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
41e162e
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.15
speakeasybot Aug 26, 2023
aa795d7
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
e50f399
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.75.0
speakeasybot Aug 31, 2023
1229131
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
99bbb7b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
156cf03
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
07ddde0
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
f2f5840
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
21643b0
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
220444d
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
d9a8de9
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
e0f3927
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
2935dcd
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
0ce4175
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
dbf0e54
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
8beb689
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
f09e2e6
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.99.0
speakeasybot Oct 13, 2023
bc56dff
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
f2a172a
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
381f969
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.109.0
speakeasybot Oct 28, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.py linguist-generated=false
126 changes: 124 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pip install fabra
<!-- Start SDK Example Usage -->
```python
import fabra
from fabra.models import operations
from fabra.models import operations, shared

s = fabra.Fabra(
security=shared.Security(
Expand All @@ -27,13 +27,14 @@ s = fabra.Fabra(
)

req = operations.GetNamespacesRequest(
connection_id=548814,
connection_id=995455,
)

res = s.connection.get_namespaces(req)

if res.namespaces is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->

Expand Down Expand Up @@ -76,4 +77,125 @@ if res.namespaces is not None:
* [get_syncs](docs/sdks/sync/README.md#get_syncs) - Get all syncs
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->

<!-- End Dev Containers -->



<!-- Start Pagination -->
# Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.

Here's an example of one such pagination call:
<!-- End Pagination -->



<!-- Start Error Handling -->
# Error Handling

Handling errors in your 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.


<!-- End Error Handling -->



<!-- Start Server Selection -->
# Server Selection

## Select Server by Index

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:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.fabra.io` | None |

For example:


```python
import fabra
from fabra.models import operations, shared

s = fabra.Fabra(
security=shared.Security(
api_key_auth="",
),
server_idx=0
)

req = operations.GetNamespacesRequest(
connection_id=995455,
)

res = s.connection.get_namespaces(req)

if res.namespaces is not None:
# handle response
pass
```


## Override Server URL Per-Client

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:


```python
import fabra
from fabra.models import operations, shared

s = fabra.Fabra(
security=shared.Security(
api_key_auth="",
),
server_url="https://api.fabra.io"
)

req = operations.GetNamespacesRequest(
connection_id=995455,
)

res = s.connection.get_namespaces(req)

if res.namespaces is not None:
# handle response
pass
```
<!-- End Server Selection -->



<!-- Start Custom HTTP Client -->
# Custom HTTP Client

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.


For example, you could specify a header for every request that your sdk makes as follows:

```python
import fabra
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = fabra.Fabra(client: http_client)
```


<!-- End Custom HTTP Client -->

<!-- Placeholder for Future Speakeasy SDK Sections -->



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