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 User SDK #51

Open
wants to merge 83 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
f19f771
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
3c1c122
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
67e5770
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
f21b7e3
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
f8e8490
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
b25a95b
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
47e298e
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
2405b1c
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
7148f06
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
816ec63
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
27c628e
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
9397cd1
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
4da8e3a
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
181bc41
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
5bc15bf
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
74230b9
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
7f890d9
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
9c682bb
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
279c932
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
9fd7d7f
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
70c563f
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
1405e8d
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
20f0d63
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
ffef13e
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
9172974
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
bc43804
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
95d53d7
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
b740380
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.40.3
speakeasybot Jun 2, 2023
18193ad
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
2e3f749
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
1cf2962
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
bb40b37
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
f0bc826
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
e074d72
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
5876b73
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
3260be3
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
eeadfd2
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
b9e3bc8
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
17639c0
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
cc2068e
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
62e058c
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
570724a
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
e47a877
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
cecc39e
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
a76f721
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
3fa35d7
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
e06ab66
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.56.3
speakeasybot Jul 12, 2023
e47fb1f
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
e67f8ca
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
e32d586
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
2f70e61
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
cbc3e08
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
82dee8d
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
925bd8b
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
978ce96
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
d908b01
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
40f6b40
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
ccd229d
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
b796cdc
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
08d040e
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
c65fb27
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
7c686f3
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
beedc04
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.74.16
speakeasybot Aug 26, 2023
3624934
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
def433b
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.76.0
speakeasybot Aug 31, 2023
05cdf80
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
91f8664
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
2d878a9
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
85f80ca
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
fc876e3
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
6275281
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.87.0
speakeasybot Sep 19, 2023
1678d54
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
722262c
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
092dc81
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
3b55682
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
936226a
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
ff1d7a1
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
c6b3520
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
429f415
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
5f809cb
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.99.0
speakeasybot Oct 13, 2023
3c9702a
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
4a055da
ci: regenerated with OpenAPI Doc 2.0.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
93a896a
ci: regenerated with OpenAPI Doc 2.0.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 user/.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
7 changes: 7 additions & 0 deletions user/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.python-version
.DS_Store
venv/
src/*.egg-info/
__pycache__/
.pytest_cache/
.python-version`
158 changes: 137 additions & 21 deletions user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,46 +12,162 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=user
<!-- Start SDK Example Usage -->
```python
import epilot
from epilot.models import operations, shared
from epilot.models import shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE",
epilot_auth="",
),
)


res = s.user_v1.get_me()

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

<!-- Start SDK Available Operations -->
## SDK Available Operations
## Available Resources and Operations


### user_v1
### [user_v1](docs/sdks/userv1/README.md)

* `get_me` - getMe
* `get_user` - getUser
* `get_user_login_parameters` - getUserLoginParameters
* `list_users` - listUsers
* [get_me](docs/sdks/userv1/README.md#get_me) - getMe
* [get_user](docs/sdks/userv1/README.md#get_user) - getUser
* [get_user_login_parameters](docs/sdks/userv1/README.md#get_user_login_parameters) - getUserLoginParameters
* [list_users](docs/sdks/userv1/README.md#list_users) - listUsers

### user_v2
### [user_v2](docs/sdks/userv2/README.md)

* `activate_user` - activateUser
* `delete_user_v2` - deleteUserV2
* `get_me_v2` - getMeV2
* `get_user_login_parameters_v2` - getUserLoginParametersV2
* `get_user_v2` - getUserV2
* `invite_user` - inviteUser
* `list_users_v2` - listUsersV2
* `resend_user_invitation` - resendUserInvitation
* `sign_up_user` - signUpUser
* `update_user_v2` - updateUserV2
* `verify_email_with_token` - verifyEmailWithToken
* [activate_user](docs/sdks/userv2/README.md#activate_user) - activateUser
* [delete_user_v2](docs/sdks/userv2/README.md#delete_user_v2) - deleteUserV2
* [get_me_v2](docs/sdks/userv2/README.md#get_me_v2) - getMeV2
* [get_user_login_parameters_v2](docs/sdks/userv2/README.md#get_user_login_parameters_v2) - getUserLoginParametersV2
* [get_user_v2](docs/sdks/userv2/README.md#get_user_v2) - getUserV2
* [invite_user](docs/sdks/userv2/README.md#invite_user) - inviteUser
* [list_users_v2](docs/sdks/userv2/README.md#list_users_v2) - listUsersV2
* [resend_user_invitation](docs/sdks/userv2/README.md#resend_user_invitation) - resendUserInvitation
* [sign_up_user](docs/sdks/userv2/README.md#sign_up_user) - signUpUser
* [update_user_v2](docs/sdks/userv2/README.md#update_user_v2) - updateUserV2
* [verify_email_with_token](docs/sdks/userv2/README.md#verify_email_with_token) - verifyEmailWithToken
<!-- 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://user.sls.epilot.io` | None |

For example:


```python
import epilot
from epilot.models import shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
server_idx=0
)


res = s.user_v1.get_me()

if res.user 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 epilot
from epilot.models import shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
server_url="https://user.sls.epilot.io"
)


res = s.user_v1.get_me()

if res.user 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 epilot
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = epilot.Epilot(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