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 Permissions SDK #59

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
213c920
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
51300bf
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
5a287c1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
bb3fa66
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
1c9db45
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
42dbe66
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
2160ba8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
e5b069d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
fc28e6e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
de646a4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
5307937
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
6f4be30
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
ca7b43d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
80aea78
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
0d19db4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
d5c09be
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
9386020
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
4ad5fc5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
4a824ff
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
cf6cca3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
dc78422
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
f9c7777
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
c6c6690
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
19d7b30
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
e7f8224
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
581f539
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
aa7e3fe
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
5af6eed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.3
speakeasybot Jun 2, 2023
852c696
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
2149f7f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
ad61633
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
710d888
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
ad2d7a6
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
d430c9e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
24d11cf
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
4d40dc3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
42f3282
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
f965f97
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
42fe529
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
1c283b1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
56c7a16
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
ddb8f40
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
6f64223
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
e0fd539
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
a83547c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
feb3900
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
8d9f4c3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.4
speakeasybot Jul 12, 2023
dcd6a3d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
1c5cd11
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
0b4cd42
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.60.0
speakeasybot Jul 17, 2023
0a5d56d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
eb42be0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
6c1c4a1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
83d31f6
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
43e4c40
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
b878011
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
28dd697
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
150dab9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
8558d62
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
003874a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
ba06d54
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
984abd6
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
1a3b4b2
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
08ec40d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.16
speakeasybot Aug 26, 2023
30203dc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
f30b9dd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.76.1
speakeasybot Aug 31, 2023
5c52d20
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
f67f930
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
e886c42
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
1eee8f3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
ce85ca1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
e59e35e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
38bb8b4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
ee4cc8e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
0a3df19
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
a969063
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
e003f0b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
afc8687
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
f27c7fb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
c10af50
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.1
speakeasybot Oct 13, 2023
f10a27d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
8167290
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
24da0f3
ci: regenerated with OpenAPI Doc 1.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 permissions/.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 permissions/.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`
163 changes: 143 additions & 20 deletions permissions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,44 +16,167 @@ from epilot.models import operations, shared

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


req = operations.AddAssignmentRequest(
role_id="123:owner",
user_id="1",
role_id='123:owner',
user_id='1',
)

res = s.assignments.add_assignment(req)

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

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


### assignments
### [assignments](docs/sdks/assignments/README.md)

* `add_assignment` - addAssignment
* `assign_roles` - assignRoles
* `get_assigned_roles_for_user` - getAssignedRolesForUser
* `list_all_assignments` - listAllAssignments
* `remove_assignment` - removeAssignment
* [add_assignment](docs/sdks/assignments/README.md#add_assignment) - addAssignment
* [assign_roles](docs/sdks/assignments/README.md#assign_roles) - assignRoles
* [get_assigned_roles_for_user](docs/sdks/assignments/README.md#get_assigned_roles_for_user) - getAssignedRolesForUser
* [list_all_assignments](docs/sdks/assignments/README.md#list_all_assignments) - listAllAssignments
* [remove_assignment](docs/sdks/assignments/README.md#remove_assignment) - removeAssignment

### roles
### [roles](docs/sdks/roles/README.md)

* `delete_role` - deleteRole
* `get_role` - getRole
* `list_all_roles` - listAllRoles
* `list_current_roles` - listCurrentRoles
* `put_role` - putRole
* `refresh_permissions` - refreshPermissions
* `search_roles` - searchRoles
* [delete_role](docs/sdks/roles/README.md#delete_role) - deleteRole
* [get_role](docs/sdks/roles/README.md#get_role) - getRole
* [list_all_roles](docs/sdks/roles/README.md#list_all_roles) - listAllRoles
* [list_current_roles](docs/sdks/roles/README.md#list_current_roles) - listCurrentRoles
* [put_role](docs/sdks/roles/README.md#put_role) - putRole
* [refresh_permissions](docs/sdks/roles/README.md#refresh_permissions) - refreshPermissions
* [search_roles](docs/sdks/roles/README.md#search_roles) - searchRoles
<!-- 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://permissions.sls.epilot.io` | None |

For example:


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

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

req = operations.AddAssignmentRequest(
role_id='123:owner',
user_id='1',
)

res = s.assignments.add_assignment(req)

if res.assignment 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 operations, shared

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

req = operations.AddAssignmentRequest(
role_id='123:owner',
user_id='1',
)

res = s.assignments.add_assignment(req)

if res.assignment 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