extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-25 04:02:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

regenerate Python api client

Browse Source
This commit is contained in:
Kenneth Bingham 2025-02-27 13:54:03 -05:00
parent 86a6d4ac17
commit f48a49436e
No known key found for this signature in database
GPG Key ID: 31709281860130B6
281 changed files with 9800 additions and 7770 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sdk/python/examples/pastebin/README.md
View File

@ -4,7 +4,7 @@ This example shows the use of the zrok SDK spinning up a simple pastebin command
## Self-hosting Setup :wrench: ## Self-hosting Setup :wrench:
You don't need this section if you're using hosted zrok from NetFoundry (https://api-v1.zrok.io/). You don't need this section if you're using hosted zrok from NetFoundry (https://api.zrok.io/).
Refer to the [setup guide](../../../docs/guides/self-hosting/self_hosting_guide.md) for details on setting up your zrok Refer to the [setup guide](../../../docs/guides/self-hosting/self_hosting_guide.md) for details on setting up your zrok
environment if you're self-hosting zrok. environment if you're self-hosting zrok.

1
sdk/python/sdk/zrok/.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
zrok/_version.py export-subst

9
sdk/python/sdk/zrok/.swagger-codegen-ignore
View File

@ -21,3 +21,12 @@
#docs/*.md #docs/*.md
# Then explicitly reverse the ignore rule for a single file: # Then explicitly reverse the ignore rule for a single file:
#!docs/README.md #!docs/README.md
.travis.yml
git_push.sh
tox.ini
test-requirements.txt
test/
docs/
README.md
setup.py

2
sdk/python/sdk/zrok/.swagger-codegen/VERSION
View File

@ -1 +1 @@
3.0.51 2.4.43

13
sdk/python/sdk/zrok/.travis.yml
View File

@ -1,13 +0,0 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.2"
- "3.3"
- "3.4"
- "3.5"
#- "3.5-dev" # 3.5 development branch
#- "nightly" # points to the latest development branch e.g. 3.6-dev
# command to install dependencies
install: "pip install -r requirements.txt"
# command to run tests
script: nosetests

274
sdk/python/sdk/zrok/README.md
View File

@ -1,274 +0,0 @@
# zrok_sdk
zrok client access
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import zrok_api
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import zrok_api
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ChangePasswordBody() # ChangePasswordBody | (optional)
try:
api_instance.change_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->change_password: %s\n" % e)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.InviteBody() # InviteBody | (optional)
try:
api_instance.invite(body=body)
except ApiException as e:
print("Exception when calling AccountApi->invite: %s\n" % e)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.LoginBody() # LoginBody | (optional)
try:
api_response = api_instance.login(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->login: %s\n" % e)
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegenerateAccountTokenBody() # RegenerateAccountTokenBody | (optional)
try:
api_response = api_instance.regenerate_account_token(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->regenerate_account_token: %s\n" % e)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegisterBody() # RegisterBody | (optional)
try:
api_response = api_instance.register(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->register: %s\n" % e)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ResetPasswordBody() # ResetPasswordBody | (optional)
try:
api_instance.reset_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->reset_password: %s\n" % e)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ResetPasswordRequestBody() # ResetPasswordRequestBody | (optional)
try:
api_instance.reset_password_request(body=body)
except ApiException as e:
print("Exception when calling AccountApi->reset_password_request: %s\n" % e)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.VerifyBody() # VerifyBody | (optional)
try:
api_response = api_instance.verify(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->verify: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**change_password**](docs/AccountApi.md#change_password) | **POST** /changePassword |
*AccountApi* | [**invite**](docs/AccountApi.md#invite) | **POST** /invite |
*AccountApi* | [**login**](docs/AccountApi.md#login) | **POST** /login |
*AccountApi* | [**regenerate_account_token**](docs/AccountApi.md#regenerate_account_token) | **POST** /regenerateAccountToken |
*AccountApi* | [**register**](docs/AccountApi.md#register) | **POST** /register |
*AccountApi* | [**reset_password**](docs/AccountApi.md#reset_password) | **POST** /resetPassword |
*AccountApi* | [**reset_password_request**](docs/AccountApi.md#reset_password_request) | **POST** /resetPasswordRequest |
*AccountApi* | [**verify**](docs/AccountApi.md#verify) | **POST** /verify |
*AdminApi* | [**add_organization_member**](docs/AdminApi.md#add_organization_member) | **POST** /organization/add |
*AdminApi* | [**create_account**](docs/AdminApi.md#create_account) | **POST** /account |
*AdminApi* | [**create_frontend**](docs/AdminApi.md#create_frontend) | **POST** /frontend |
*AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identity |
*AdminApi* | [**create_organization**](docs/AdminApi.md#create_organization) | **POST** /organization |
*AdminApi* | [**delete_frontend**](docs/AdminApi.md#delete_frontend) | **DELETE** /frontend |
*AdminApi* | [**delete_organization**](docs/AdminApi.md#delete_organization) | **DELETE** /organization |
*AdminApi* | [**grants**](docs/AdminApi.md#grants) | **POST** /grants |
*AdminApi* | [**invite_token_generate**](docs/AdminApi.md#invite_token_generate) | **POST** /invite/token/generate |
*AdminApi* | [**list_frontends**](docs/AdminApi.md#list_frontends) | **GET** /frontends |
*AdminApi* | [**list_organization_members**](docs/AdminApi.md#list_organization_members) | **POST** /organization/list |
*AdminApi* | [**list_organizations**](docs/AdminApi.md#list_organizations) | **GET** /organizations |
*AdminApi* | [**remove_organization_member**](docs/AdminApi.md#remove_organization_member) | **POST** /organization/remove |
*AdminApi* | [**update_frontend**](docs/AdminApi.md#update_frontend) | **PATCH** /frontend |
*EnvironmentApi* | [**disable**](docs/EnvironmentApi.md#disable) | **POST** /disable |
*EnvironmentApi* | [**enable**](docs/EnvironmentApi.md#enable) | **POST** /enable |
*MetadataApi* | [**client_version_check**](docs/MetadataApi.md#client_version_check) | **POST** /clientVersionCheck |
*MetadataApi* | [**configuration**](docs/MetadataApi.md#configuration) | **GET** /configuration |
*MetadataApi* | [**get_account_detail**](docs/MetadataApi.md#get_account_detail) | **GET** /detail/account |
*MetadataApi* | [**get_account_metrics**](docs/MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
*MetadataApi* | [**get_environment_detail**](docs/MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
*MetadataApi* | [**get_environment_metrics**](docs/MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
*MetadataApi* | [**get_frontend_detail**](docs/MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
*MetadataApi* | [**get_share_detail**](docs/MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
*MetadataApi* | [**get_share_metrics**](docs/MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
*MetadataApi* | [**get_sparklines**](docs/MetadataApi.md#get_sparklines) | **POST** /sparklines |
*MetadataApi* | [**list_memberships**](docs/MetadataApi.md#list_memberships) | **GET** /memberships |
*MetadataApi* | [**list_org_members**](docs/MetadataApi.md#list_org_members) | **GET** /members/{organizationToken} |
*MetadataApi* | [**org_account_overview**](docs/MetadataApi.md#org_account_overview) | **GET** /overview/{organizationToken}/{accountEmail} |
*MetadataApi* | [**overview**](docs/MetadataApi.md#overview) | **GET** /overview |
*MetadataApi* | [**version**](docs/MetadataApi.md#version) | **GET** /version |
*MetadataApi* | [**version_inventory**](docs/MetadataApi.md#version_inventory) | **GET** /versions |
*ShareApi* | [**access**](docs/ShareApi.md#access) | **POST** /access |
*ShareApi* | [**share**](docs/ShareApi.md#share) | **POST** /share |
*ShareApi* | [**unaccess**](docs/ShareApi.md#unaccess) | **DELETE** /unaccess |
*ShareApi* | [**unshare**](docs/ShareApi.md#unshare) | **DELETE** /unshare |
*ShareApi* | [**update_access**](docs/ShareApi.md#update_access) | **PATCH** /access |
*ShareApi* | [**update_share**](docs/ShareApi.md#update_share) | **PATCH** /share |
## Documentation For Models
- [AccessBody](docs/AccessBody.md)
- [AccessBody1](docs/AccessBody1.md)
- [AccountBody](docs/AccountBody.md)
- [AuthUser](docs/AuthUser.md)
- [ChangePasswordBody](docs/ChangePasswordBody.md)
- [ClientVersionCheckBody](docs/ClientVersionCheckBody.md)
- [Configuration](docs/Configuration.md)
- [DisableBody](docs/DisableBody.md)
- [EnableBody](docs/EnableBody.md)
- [Environment](docs/Environment.md)
- [EnvironmentAndResources](docs/EnvironmentAndResources.md)
- [Environments](docs/Environments.md)
- [ErrorMessage](docs/ErrorMessage.md)
- [Frontend](docs/Frontend.md)
- [FrontendBody](docs/FrontendBody.md)
- [FrontendBody1](docs/FrontendBody1.md)
- [FrontendBody2](docs/FrontendBody2.md)
- [Frontends](docs/Frontends.md)
- [GrantsBody](docs/GrantsBody.md)
- [IdentityBody](docs/IdentityBody.md)
- [InlineResponse200](docs/InlineResponse200.md)
- [InlineResponse2001](docs/InlineResponse2001.md)
- [InlineResponse2002](docs/InlineResponse2002.md)
- [InlineResponse2003](docs/InlineResponse2003.md)
- [InlineResponse2003Members](docs/InlineResponse2003Members.md)
- [InlineResponse2004](docs/InlineResponse2004.md)
- [InlineResponse2004Organizations](docs/InlineResponse2004Organizations.md)
- [InlineResponse2005](docs/InlineResponse2005.md)
- [InlineResponse2005Memberships](docs/InlineResponse2005Memberships.md)
- [InlineResponse2006](docs/InlineResponse2006.md)
- [InlineResponse2007](docs/InlineResponse2007.md)
- [InlineResponse201](docs/InlineResponse201.md)
- [InlineResponse2011](docs/InlineResponse2011.md)
- [InlineResponse2012](docs/InlineResponse2012.md)
- [InlineResponse2013](docs/InlineResponse2013.md)
- [InviteBody](docs/InviteBody.md)
- [LoginBody](docs/LoginBody.md)
- [Metrics](docs/Metrics.md)
- [MetricsSample](docs/MetricsSample.md)
- [OrganizationAddBody](docs/OrganizationAddBody.md)
- [OrganizationBody](docs/OrganizationBody.md)
- [OrganizationBody1](docs/OrganizationBody1.md)
- [OrganizationListBody](docs/OrganizationListBody.md)
- [OrganizationRemoveBody](docs/OrganizationRemoveBody.md)
- [Overview](docs/Overview.md)
- [Principal](docs/Principal.md)
- [RegenerateAccountTokenBody](docs/RegenerateAccountTokenBody.md)
- [RegisterBody](docs/RegisterBody.md)
- [ResetPasswordBody](docs/ResetPasswordBody.md)
- [ResetPasswordRequestBody](docs/ResetPasswordRequestBody.md)
- [Share](docs/Share.md)
- [ShareBody](docs/ShareBody.md)
- [ShareRequest](docs/ShareRequest.md)
- [ShareResponse](docs/ShareResponse.md)
- [Shares](docs/Shares.md)
- [SparkData](docs/SparkData.md)
- [SparkDataSample](docs/SparkDataSample.md)
- [SparklinesBody](docs/SparklinesBody.md)
- [TokenGenerateBody](docs/TokenGenerateBody.md)
- [UnaccessBody](docs/UnaccessBody.md)
- [UnshareBody](docs/UnshareBody.md)
- [VerifyBody](docs/VerifyBody.md)
- [Version](docs/Version.md)
## Documentation For Authorization
## key
- **Type**: API key
- **API key parameter name**: x-token
- **Location**: HTTP header
## Author

1
sdk/python/sdk/zrok/__init__.py Normal file
View File

@ -0,0 +1 @@
from . import environment # noqa

12
sdk/python/sdk/zrok/docs/AccessBody.md
View File

@ -1,12 +0,0 @@
# AccessBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env_zid** | **str** | | [optional]
**share_token** | **str** | | [optional]
**bind_address** | **str** | | [optional]
**description** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/AccessBody1.md
View File

@ -1,11 +0,0 @@
# AccessBody1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**bind_address** | **str** | | [optional]
**description** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

383
sdk/python/sdk/zrok/docs/AccountApi.md
View File

@ -1,383 +0,0 @@
# zrok_api.AccountApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**change_password**](AccountApi.md#change_password) | **POST** /changePassword |
[**invite**](AccountApi.md#invite) | **POST** /invite |
[**login**](AccountApi.md#login) | **POST** /login |
[**regenerate_account_token**](AccountApi.md#regenerate_account_token) | **POST** /regenerateAccountToken |
[**register**](AccountApi.md#register) | **POST** /register |
[**reset_password**](AccountApi.md#reset_password) | **POST** /resetPassword |
[**reset_password_request**](AccountApi.md#reset_password_request) | **POST** /resetPasswordRequest |
[**verify**](AccountApi.md#verify) | **POST** /verify |
# **change_password**
> change_password(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ChangePasswordBody() # ChangePasswordBody | (optional)
try:
api_instance.change_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->change_password: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ChangePasswordBody**](ChangePasswordBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **invite**
> invite(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.AccountApi()
body = zrok_api.InviteBody() # InviteBody | (optional)
try:
api_instance.invite(body=body)
except ApiException as e:
print("Exception when calling AccountApi->invite: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**InviteBody**](InviteBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **login**
> str login(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.AccountApi()
body = zrok_api.LoginBody() # LoginBody | (optional)
try:
api_response = api_instance.login(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->login: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**LoginBody**](LoginBody.md)| | [optional]
### Return type
**str**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **regenerate_account_token**
> InlineResponse200 regenerate_account_token(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegenerateAccountTokenBody() # RegenerateAccountTokenBody | (optional)
try:
api_response = api_instance.regenerate_account_token(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->regenerate_account_token: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**RegenerateAccountTokenBody**](RegenerateAccountTokenBody.md)| | [optional]
### Return type
[**InlineResponse200**](InlineResponse200.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **register**
> InlineResponse200 register(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.AccountApi()
body = zrok_api.RegisterBody() # RegisterBody | (optional)
try:
api_response = api_instance.register(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->register: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**RegisterBody**](RegisterBody.md)| | [optional]
### Return type
[**InlineResponse200**](InlineResponse200.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **reset_password**
> reset_password(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.AccountApi()
body = zrok_api.ResetPasswordBody() # ResetPasswordBody | (optional)
try:
api_instance.reset_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->reset_password: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ResetPasswordBody**](ResetPasswordBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **reset_password_request**
> reset_password_request(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.AccountApi()
body = zrok_api.ResetPasswordRequestBody() # ResetPasswordRequestBody | (optional)
try:
api_instance.reset_password_request(body=body)
except ApiException as e:
print("Exception when calling AccountApi->reset_password_request: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ResetPasswordRequestBody**](ResetPasswordRequestBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **verify**
> InlineResponse2001 verify(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.AccountApi()
body = zrok_api.VerifyBody() # VerifyBody | (optional)
try:
api_response = api_instance.verify(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->verify: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**VerifyBody**](VerifyBody.md)| | [optional]
### Return type
[**InlineResponse2001**](InlineResponse2001.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/AccountBody.md
View File

@ -1,10 +0,0 @@
# AccountBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**password** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

720
sdk/python/sdk/zrok/docs/AdminApi.md
View File

@ -1,720 +0,0 @@
# zrok_api.AdminApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add_organization_member**](AdminApi.md#add_organization_member) | **POST** /organization/add |
[**create_account**](AdminApi.md#create_account) | **POST** /account |
[**create_frontend**](AdminApi.md#create_frontend) | **POST** /frontend |
[**create_identity**](AdminApi.md#create_identity) | **POST** /identity |
[**create_organization**](AdminApi.md#create_organization) | **POST** /organization |
[**delete_frontend**](AdminApi.md#delete_frontend) | **DELETE** /frontend |
[**delete_organization**](AdminApi.md#delete_organization) | **DELETE** /organization |
[**grants**](AdminApi.md#grants) | **POST** /grants |
[**invite_token_generate**](AdminApi.md#invite_token_generate) | **POST** /invite/token/generate |
[**list_frontends**](AdminApi.md#list_frontends) | **GET** /frontends |
[**list_organization_members**](AdminApi.md#list_organization_members) | **POST** /organization/list |
[**list_organizations**](AdminApi.md#list_organizations) | **GET** /organizations |
[**remove_organization_member**](AdminApi.md#remove_organization_member) | **POST** /organization/remove |
[**update_frontend**](AdminApi.md#update_frontend) | **PATCH** /frontend |
# **add_organization_member**
> add_organization_member(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.OrganizationAddBody() # OrganizationAddBody | (optional)
try:
api_instance.add_organization_member(body=body)
except ApiException as e:
print("Exception when calling AdminApi->add_organization_member: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OrganizationAddBody**](OrganizationAddBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **create_account**
> InlineResponse200 create_account(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.AccountBody() # AccountBody | (optional)
try:
api_response = api_instance.create_account(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->create_account: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AccountBody**](AccountBody.md)| | [optional]
### Return type
[**InlineResponse200**](InlineResponse200.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **create_frontend**
> InlineResponse201 create_frontend(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.FrontendBody() # FrontendBody | (optional)
try:
api_response = api_instance.create_frontend(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->create_frontend: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FrontendBody**](FrontendBody.md)| | [optional]
### Return type
[**InlineResponse201**](InlineResponse201.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **create_identity**
> InlineResponse2011 create_identity(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.IdentityBody() # IdentityBody | (optional)
try:
api_response = api_instance.create_identity(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->create_identity: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**IdentityBody**](IdentityBody.md)| | [optional]
### Return type
[**InlineResponse2011**](InlineResponse2011.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **create_organization**
> InlineResponse2012 create_organization(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.OrganizationBody() # OrganizationBody | (optional)
try:
api_response = api_instance.create_organization(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->create_organization: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OrganizationBody**](OrganizationBody.md)| | [optional]
### Return type
[**InlineResponse2012**](InlineResponse2012.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete_frontend**
> delete_frontend(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.FrontendBody1() # FrontendBody1 | (optional)
try:
api_instance.delete_frontend(body=body)
except ApiException as e:
print("Exception when calling AdminApi->delete_frontend: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FrontendBody1**](FrontendBody1.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete_organization**
> delete_organization(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.OrganizationBody1() # OrganizationBody1 | (optional)
try:
api_instance.delete_organization(body=body)
except ApiException as e:
print("Exception when calling AdminApi->delete_organization: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OrganizationBody1**](OrganizationBody1.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **grants**
> grants(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.GrantsBody() # GrantsBody | (optional)
try:
api_instance.grants(body=body)
except ApiException as e:
print("Exception when calling AdminApi->grants: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**GrantsBody**](GrantsBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **invite_token_generate**
> invite_token_generate(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.TokenGenerateBody() # TokenGenerateBody | (optional)
try:
api_instance.invite_token_generate(body=body)
except ApiException as e:
print("Exception when calling AdminApi->invite_token_generate: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TokenGenerateBody**](TokenGenerateBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_frontends**
> list[InlineResponse2002] list_frontends()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
try:
api_response = api_instance.list_frontends()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->list_frontends: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**list[InlineResponse2002]**](InlineResponse2002.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_organization_members**
> InlineResponse2003 list_organization_members(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.OrganizationListBody() # OrganizationListBody | (optional)
try:
api_response = api_instance.list_organization_members(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->list_organization_members: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OrganizationListBody**](OrganizationListBody.md)| | [optional]
### Return type
[**InlineResponse2003**](InlineResponse2003.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_organizations**
> InlineResponse2004 list_organizations()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
try:
api_response = api_instance.list_organizations()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->list_organizations: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**InlineResponse2004**](InlineResponse2004.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **remove_organization_member**
> remove_organization_member(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.OrganizationRemoveBody() # OrganizationRemoveBody | (optional)
try:
api_instance.remove_organization_member(body=body)
except ApiException as e:
print("Exception when calling AdminApi->remove_organization_member: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OrganizationRemoveBody**](OrganizationRemoveBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_frontend**
> update_frontend(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AdminApi(zrok_api.ApiClient(configuration))
body = zrok_api.FrontendBody2() # FrontendBody2 | (optional)
try:
api_instance.update_frontend(body=body)
except ApiException as e:
print("Exception when calling AdminApi->update_frontend: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FrontendBody2**](FrontendBody2.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/AuthUser.md
View File

@ -1,10 +0,0 @@
# AuthUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **str** | | [optional]
**password** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/ChangePasswordBody.md
View File

@ -1,11 +0,0 @@
# ChangePasswordBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**old_password** | **str** | | [optional]
**new_password** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/ClientVersionCheckBody.md
View File

@ -1,9 +0,0 @@
# ClientVersionCheckBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_version** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
sdk/python/sdk/zrok/docs/Configuration.md
View File

@ -1,13 +0,0 @@
# Configuration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | | [optional]
**tou_link** | **str** | | [optional]
**invites_open** | **bool** | | [optional]
**requires_invite_token** | **bool** | | [optional]
**invite_token_contact** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/DisableBody.md
View File

@ -1,9 +0,0 @@
# DisableBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/EnableBody.md
View File

@ -1,10 +0,0 @@
# EnableBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**host** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
sdk/python/sdk/zrok/docs/Environment.md
View File

@ -1,16 +0,0 @@
# Environment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**host** | **str** | | [optional]
**address** | **str** | | [optional]
**z_id** | **str** | | [optional]
**activity** | [**SparkData**](SparkData.md) | | [optional]
**limited** | **bool** | | [optional]
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/EnvironmentAndResources.md
View File

@ -1,11 +0,0 @@
# EnvironmentAndResources
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**environment** | [**Environment**](Environment.md) | | [optional]
**frontends** | [**Frontends**](Frontends.md) | | [optional]
**shares** | [**Shares**](Shares.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

110
sdk/python/sdk/zrok/docs/EnvironmentApi.md
View File

@ -1,110 +0,0 @@
# zrok_api.EnvironmentApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**disable**](EnvironmentApi.md#disable) | **POST** /disable |
[**enable**](EnvironmentApi.md#enable) | **POST** /enable |
# **disable**
> disable(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.EnvironmentApi(zrok_api.ApiClient(configuration))
body = zrok_api.DisableBody() # DisableBody | (optional)
try:
api_instance.disable(body=body)
except ApiException as e:
print("Exception when calling EnvironmentApi->disable: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DisableBody**](DisableBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **enable**
> InlineResponse2011 enable(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.EnvironmentApi(zrok_api.ApiClient(configuration))
body = zrok_api.EnableBody() # EnableBody | (optional)
try:
api_response = api_instance.enable(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling EnvironmentApi->enable: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**EnableBody**](EnableBody.md)| | [optional]
### Return type
[**InlineResponse2011**](InlineResponse2011.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

8
sdk/python/sdk/zrok/docs/Environments.md
View File

@ -1,8 +0,0 @@
# Environments
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
sdk/python/sdk/zrok/docs/ErrorMessage.md
View File

@ -1,8 +0,0 @@
# ErrorMessage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
sdk/python/sdk/zrok/docs/Frontend.md
View File

@ -1,17 +0,0 @@
# Frontend
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**frontend_token** | **str** | | [optional]
**share_token** | **str** | | [optional]
**backend_mode** | **str** | | [optional]
**bind_address** | **str** | | [optional]
**description** | **str** | | [optional]
**z_id** | **str** | | [optional]
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
sdk/python/sdk/zrok/docs/FrontendBody.md
View File

@ -1,12 +0,0 @@
# FrontendBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**z_id** | **str** | | [optional]
**url_template** | **str** | | [optional]
**public_name** | **str** | | [optional]
**permission_mode** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/FrontendBody1.md
View File

@ -1,9 +0,0 @@
# FrontendBody1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/FrontendBody2.md
View File

@ -1,11 +0,0 @@
# FrontendBody2
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**public_name** | **str** | | [optional]
**url_template** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
sdk/python/sdk/zrok/docs/Frontends.md
View File

@ -1,8 +0,0 @@
# Frontends
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/GrantsBody.md
View File

@ -1,9 +0,0 @@
# GrantsBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/IdentityBody.md
View File

@ -1,9 +0,0 @@
# IdentityBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse200.md
View File

@ -1,9 +0,0 @@
# InlineResponse200
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2001.md
View File

@ -1,9 +0,0 @@
# InlineResponse2001
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
sdk/python/sdk/zrok/docs/InlineResponse2002.md
View File

@ -1,14 +0,0 @@
# InlineResponse2002
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**z_id** | **str** | | [optional]
**url_template** | **str** | | [optional]
**public_name** | **str** | | [optional]
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2003.md
View File

@ -1,9 +0,0 @@
# InlineResponse2003
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**members** | [**list[InlineResponse2003Members]**](InlineResponse2003Members.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InlineResponse2003Members.md
View File

@ -1,10 +0,0 @@
# InlineResponse2003Members
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**admin** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2004.md
View File

@ -1,9 +0,0 @@
# InlineResponse2004
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organizations** | [**list[InlineResponse2004Organizations]**](InlineResponse2004Organizations.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InlineResponse2004Members.md
View File

@ -1,10 +0,0 @@
# InlineResponse2004Members
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**admin** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InlineResponse2004Organizations.md
View File

@ -1,10 +0,0 @@
# InlineResponse2004Organizations
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**description** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2005.md
View File

@ -1,9 +0,0 @@
# InlineResponse2005
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memberships** | [**list[InlineResponse2005Memberships]**](InlineResponse2005Memberships.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/InlineResponse2005Memberships.md
View File

@ -1,11 +0,0 @@
# InlineResponse2005Memberships
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**description** | **str** | | [optional]
**admin** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InlineResponse2005Organizations.md
View File

@ -1,10 +0,0 @@
# InlineResponse2005Organizations
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**token** | **str** | | [optional]
**description** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2006.md
View File

@ -1,9 +0,0 @@
# InlineResponse2006
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sparklines** | [**list[Metrics]**](Metrics.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/InlineResponse2006Memberships.md
View File

@ -1,11 +0,0 @@
# InlineResponse2006Memberships
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**description** | **str** | | [optional]
**admin** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2007.md
View File

@ -1,9 +0,0 @@
# InlineResponse2007
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**controller_version** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse201.md
View File

@ -1,9 +0,0 @@
# InlineResponse201
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InlineResponse2011.md
View File

@ -1,10 +0,0 @@
# InlineResponse2011
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | **str** | | [optional]
**cfg** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse2012.md
View File

@ -1,9 +0,0 @@
# InlineResponse2012
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InlineResponse2013.md
View File

@ -1,10 +0,0 @@
# InlineResponse2013
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**backend_mode** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/InlineResponse400.md
View File

@ -1,9 +0,0 @@
# InlineResponse400
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/InviteBody.md
View File

@ -1,10 +0,0 @@
# InviteBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**invite_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/LoginBody.md
View File

@ -1,10 +0,0 @@
# LoginBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**password** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

796
sdk/python/sdk/zrok/docs/MetadataApi.md
View File

@ -1,796 +0,0 @@
# zrok_api.MetadataApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**client_version_check**](MetadataApi.md#client_version_check) | **POST** /clientVersionCheck |
[**configuration**](MetadataApi.md#configuration) | **GET** /configuration |
[**get_account_detail**](MetadataApi.md#get_account_detail) | **GET** /detail/account |
[**get_account_metrics**](MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
[**get_environment_detail**](MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
[**get_environment_metrics**](MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
[**get_frontend_detail**](MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
[**get_share_detail**](MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
[**get_share_metrics**](MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
[**get_sparklines**](MetadataApi.md#get_sparklines) | **POST** /sparklines |
[**list_memberships**](MetadataApi.md#list_memberships) | **GET** /memberships |
[**list_org_members**](MetadataApi.md#list_org_members) | **GET** /members/{organizationToken} |
[**org_account_overview**](MetadataApi.md#org_account_overview) | **GET** /overview/{organizationToken}/{accountEmail} |
[**overview**](MetadataApi.md#overview) | **GET** /overview |
[**version**](MetadataApi.md#version) | **GET** /version |
[**version_inventory**](MetadataApi.md#version_inventory) | **GET** /versions |
# **client_version_check**
> client_version_check(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.MetadataApi()
body = zrok_api.ClientVersionCheckBody() # ClientVersionCheckBody | (optional)
try:
api_instance.client_version_check(body=body)
except ApiException as e:
print("Exception when calling MetadataApi->client_version_check: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ClientVersionCheckBody**](ClientVersionCheckBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **configuration**
> Configuration configuration()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.MetadataApi()
try:
api_response = api_instance.configuration()
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->configuration: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Configuration**](Configuration.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_account_detail**
> Environments get_account_detail()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
try:
api_response = api_instance.get_account_detail()
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_account_detail: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Environments**](Environments.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_account_metrics**
> Metrics get_account_metrics(duration=duration)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
duration = 'duration_example' # str | (optional)
try:
api_response = api_instance.get_account_metrics(duration=duration)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_account_metrics: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**duration** | **str**| | [optional]
### Return type
[**Metrics**](Metrics.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_environment_detail**
> EnvironmentAndResources get_environment_detail(env_zid)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
env_zid = 'env_zid_example' # str |
try:
api_response = api_instance.get_environment_detail(env_zid)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_environment_detail: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**env_zid** | **str**| |
### Return type
[**EnvironmentAndResources**](EnvironmentAndResources.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_environment_metrics**
> Metrics get_environment_metrics(env_id, duration=duration)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
env_id = 'env_id_example' # str |
duration = 'duration_example' # str | (optional)
try:
api_response = api_instance.get_environment_metrics(env_id, duration=duration)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_environment_metrics: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**env_id** | **str**| |
**duration** | **str**| | [optional]
### Return type
[**Metrics**](Metrics.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_frontend_detail**
> Frontend get_frontend_detail(frontend_id)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
frontend_id = 56 # int |
try:
api_response = api_instance.get_frontend_detail(frontend_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_frontend_detail: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**frontend_id** | **int**| |
### Return type
[**Frontend**](Frontend.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_share_detail**
> Share get_share_detail(share_token)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
share_token = 'share_token_example' # str |
try:
api_response = api_instance.get_share_detail(share_token)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_share_detail: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**share_token** | **str**| |
### Return type
[**Share**](Share.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_share_metrics**
> Metrics get_share_metrics(share_token, duration=duration)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
share_token = 'share_token_example' # str |
duration = 'duration_example' # str | (optional)
try:
api_response = api_instance.get_share_metrics(share_token, duration=duration)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_share_metrics: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**share_token** | **str**| |
**duration** | **str**| | [optional]
### Return type
[**Metrics**](Metrics.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_sparklines**
> InlineResponse2006 get_sparklines(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
body = zrok_api.SparklinesBody() # SparklinesBody | (optional)
try:
api_response = api_instance.get_sparklines(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_sparklines: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**SparklinesBody**](SparklinesBody.md)| | [optional]
### Return type
[**InlineResponse2006**](InlineResponse2006.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_memberships**
> InlineResponse2005 list_memberships()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
try:
api_response = api_instance.list_memberships()
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->list_memberships: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**InlineResponse2005**](InlineResponse2005.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_org_members**
> InlineResponse2003 list_org_members(organization_token)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
organization_token = 'organization_token_example' # str |
try:
api_response = api_instance.list_org_members(organization_token)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->list_org_members: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**organization_token** | **str**| |
### Return type
[**InlineResponse2003**](InlineResponse2003.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **org_account_overview**
> Overview org_account_overview(organization_token, account_email)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
organization_token = 'organization_token_example' # str |
account_email = 'account_email_example' # str |
try:
api_response = api_instance.org_account_overview(organization_token, account_email)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->org_account_overview: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**organization_token** | **str**| |
**account_email** | **str**| |
### Return type
[**Overview**](Overview.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **overview**
> Overview overview()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
try:
api_response = api_instance.overview()
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->overview: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Overview**](Overview.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **version**
> Version version()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.MetadataApi()
try:
api_response = api_instance.version()
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->version: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Version**](Version.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **version_inventory**
> InlineResponse2007 version_inventory()
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zrok_api.MetadataApi()
try:
api_response = api_instance.version_inventory()
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->version_inventory: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**InlineResponse2007**](InlineResponse2007.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

12
sdk/python/sdk/zrok/docs/Metrics.md
View File

@ -1,12 +0,0 @@
# Metrics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scope** | **str** | | [optional]
**id** | **str** | | [optional]
**period** | **float** | | [optional]
**samples** | [**list[MetricsSample]**](MetricsSample.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/MetricsSample.md
View File

@ -1,11 +0,0 @@
# MetricsSample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rx** | **float** | | [optional]
**tx** | **float** | | [optional]
**timestamp** | **float** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/OrganizationAddBody.md
View File

@ -1,11 +0,0 @@
# OrganizationAddBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**email** | **str** | | [optional]
**admin** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/OrganizationBody.md
View File

@ -1,9 +0,0 @@
# OrganizationBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/OrganizationBody1.md
View File

@ -1,9 +0,0 @@
# OrganizationBody1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/OrganizationListBody.md
View File

@ -1,9 +0,0 @@
# OrganizationListBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/OrganizationRemoveBody.md
View File

@ -1,10 +0,0 @@
# OrganizationRemoveBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**email** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/Overview.md
View File

@ -1,10 +0,0 @@
# Overview
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_limited** | **bool** | | [optional]
**environments** | [**list[EnvironmentAndResources]**](EnvironmentAndResources.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
sdk/python/sdk/zrok/docs/Principal.md
View File

@ -1,13 +0,0 @@
# Principal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**email** | **str** | | [optional]
**token** | **str** | | [optional]
**limitless** | **bool** | | [optional]
**admin** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/RegenerateAccountTokenBody.md
View File

@ -1,9 +0,0 @@
# RegenerateAccountTokenBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email_address** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/RegenerateTokenBody.md
View File

@ -1,9 +0,0 @@
# RegenerateTokenBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email_address** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/RegisterBody.md
View File

@ -1,10 +0,0 @@
# RegisterBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**register_token** | **str** | | [optional]
**password** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/ResetPasswordBody.md
View File

@ -1,10 +0,0 @@
# ResetPasswordBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reset_token** | **str** | | [optional]
**password** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/ResetPasswordRequestBody.md
View File

@ -1,9 +0,0 @@
# ResetPasswordRequestBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email_address** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
sdk/python/sdk/zrok/docs/Share.md
View File

@ -1,20 +0,0 @@
# Share
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**share_token** | **str** | | [optional]
**z_id** | **str** | | [optional]
**share_mode** | **str** | | [optional]
**backend_mode** | **str** | | [optional]
**frontend_selection** | **str** | | [optional]
**frontend_endpoint** | **str** | | [optional]
**backend_proxy_endpoint** | **str** | | [optional]
**reserved** | **bool** | | [optional]
**activity** | [**SparkData**](SparkData.md) | | [optional]
**limited** | **bool** | | [optional]
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

315
sdk/python/sdk/zrok/docs/ShareApi.md
View File

@ -1,315 +0,0 @@
# zrok_api.ShareApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**access**](ShareApi.md#access) | **POST** /access |
[**share**](ShareApi.md#share) | **POST** /share |
[**unaccess**](ShareApi.md#unaccess) | **DELETE** /unaccess |
[**unshare**](ShareApi.md#unshare) | **DELETE** /unshare |
[**update_access**](ShareApi.md#update_access) | **PATCH** /access |
[**update_share**](ShareApi.md#update_share) | **PATCH** /share |
# **access**
> InlineResponse2013 access(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.AccessBody() # AccessBody | (optional)
try:
api_response = api_instance.access(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ShareApi->access: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AccessBody**](AccessBody.md)| | [optional]
### Return type
[**InlineResponse2013**](InlineResponse2013.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **share**
> ShareResponse share(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.ShareRequest() # ShareRequest | (optional)
try:
api_response = api_instance.share(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ShareApi->share: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ShareRequest**](ShareRequest.md)| | [optional]
### Return type
[**ShareResponse**](ShareResponse.md)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **unaccess**
> unaccess(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.UnaccessBody() # UnaccessBody | (optional)
try:
api_instance.unaccess(body=body)
except ApiException as e:
print("Exception when calling ShareApi->unaccess: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**UnaccessBody**](UnaccessBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **unshare**
> unshare(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.UnshareBody() # UnshareBody | (optional)
try:
api_instance.unshare(body=body)
except ApiException as e:
print("Exception when calling ShareApi->unshare: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**UnshareBody**](UnshareBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_access**
> update_access(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.AccessBody1() # AccessBody1 | (optional)
try:
api_instance.update_access(body=body)
except ApiException as e:
print("Exception when calling ShareApi->update_access: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AccessBody1**](AccessBody1.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_share**
> update_share(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.ShareBody() # ShareBody | (optional)
try:
api_instance.update_share(body=body)
except ApiException as e:
print("Exception when calling ShareApi->update_share: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ShareBody**](ShareBody.md)| | [optional]
### Return type
void (empty response body)
### Authorization
[key](../README.md#key)
### HTTP request headers
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

12
sdk/python/sdk/zrok/docs/ShareBody.md
View File

@ -1,12 +0,0 @@
# ShareBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**share_token** | **str** | | [optional]
**backend_proxy_endpoint** | **str** | | [optional]
**add_access_grants** | **list[str]** | | [optional]
**remove_access_grants** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
sdk/python/sdk/zrok/docs/ShareRequest.md
View File

@ -1,22 +0,0 @@
# ShareRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env_zid** | **str** | | [optional]
**share_mode** | **str** | | [optional]
**frontend_selection** | **list[str]** | | [optional]
**backend_mode** | **str** | | [optional]
**backend_proxy_endpoint** | **str** | | [optional]
**auth_scheme** | **str** | | [optional]
**auth_users** | [**list[AuthUser]**](AuthUser.md) | | [optional]
**oauth_provider** | **str** | | [optional]
**oauth_email_domains** | **list[str]** | | [optional]
**oauth_authorization_check_interval** | **str** | | [optional]
**reserved** | **bool** | | [optional]
**permission_mode** | **str** | | [optional]
**access_grants** | **list[str]** | | [optional]
**unique_name** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/ShareResponse.md
View File

@ -1,10 +0,0 @@
# ShareResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_proxy_endpoints** | **list[str]** | | [optional]
**share_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
sdk/python/sdk/zrok/docs/Shares.md
View File

@ -1,8 +0,0 @@
# Shares
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
sdk/python/sdk/zrok/docs/SparkData.md
View File

@ -1,8 +0,0 @@
# SparkData
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
sdk/python/sdk/zrok/docs/SparkDataSample.md
View File

@ -1,10 +0,0 @@
# SparkDataSample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rx** | **float** | | [optional]
**tx** | **float** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/SparklinesBody.md
View File

@ -1,11 +0,0 @@
# SparklinesBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account** | **bool** | | [optional]
**environments** | **list[str]** | | [optional]
**shares** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/TokenGenerateBody.md
View File

@ -1,9 +0,0 @@
# TokenGenerateBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**invite_tokens** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/UnaccessBody.md
View File

@ -1,11 +0,0 @@
# UnaccessBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**env_zid** | **str** | | [optional]
**share_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
sdk/python/sdk/zrok/docs/UnshareBody.md
View File

@ -1,11 +0,0 @@
# UnshareBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env_zid** | **str** | | [optional]
**share_token** | **str** | | [optional]
**reserved** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/VerifyBody.md
View File

@ -1,9 +0,0 @@
# VerifyBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**register_token** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
sdk/python/sdk/zrok/docs/Version.md
View File

@ -1,8 +0,0 @@
# Version
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/VersionBody.md
View File

@ -1,9 +0,0 @@
# VersionBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_version** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
sdk/python/sdk/zrok/docs/VersionCheckBody.md
View File

@ -1,9 +0,0 @@
# VersionCheckBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_version** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

33
sdk/python/sdk/zrok/setup.cfg Normal file
View File

@ -0,0 +1,33 @@
[metadata]
name = openziti
author = OpenZiti Developers
author_email = developers@openziti.org
description = Ziti Python SDK
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/openziti/zrok
license = Apache 2.0
project_urls =
Source = https://github.com/openziti/zrok
Tracker = https://github.com/openziti/zrok/issues
Discussion = https://openziti.discourse.group/
[options]
package_dir =
= .
packages = find:
[options.packages.find]
where = .
[flake8]
exclude = zrok_api, build
max-line-length = 120
[versioneer]
VCS = git
style = pep440-pre
versionfile_source = zrok/_version.py
versionfile_build = zrok/_version.py
tag_prefix = v
parentdir_prefix = zrok-

25
sdk/python/sdk/zrok/setup.py
View File

@ -1,18 +1,9 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from setuptools import setup, find_packages # noqa: H301 from setuptools import setup, find_packages # noqa: H301
import os
import versioneer
NAME = "zrok_sdk" # optionally upload to TestPyPi with alternative name in testing repo
NAME = os.getenv('ZROK_PY_NAME', "zrok")
VERSION = "1.0.0" VERSION = "1.0.0"
# To install the library, run the following # To install the library, run the following
# #
@ -21,19 +12,21 @@ VERSION = "1.0.0"
# prerequisite: setuptools # prerequisite: setuptools
# http://pypi.python.org/pypi/setuptools # http://pypi.python.org/pypi/setuptools
REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil"] REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil", "openziti >= 0.8.1"]
setup( setup(
name=NAME, name=NAME,
version=VERSION, cmdclass=versioneer.get_cmdclass(dict()),
version=versioneer.get_version(),
description="zrok", description="zrok",
author_email="", author_email="",
url="", url="",
keywords=["Swagger", "zrok"], keywords=["Swagger", "zrok"],
install_requires=REQUIRES, install_requires=REQUIRES,
python_requires='>3.10.0',
packages=find_packages(), packages=find_packages(),
include_package_data=True, include_package_data=True,
long_description="""\ long_description="""\
zrok client access # noqa: E501 Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
""" """
) )

5
sdk/python/sdk/zrok/test-requirements.txt
View File

@ -1,5 +0,0 @@
coverage>=4.0.3
nose>=1.3.7
pluggy>=0.3.1
py>=1.4.31
randomize>=0.13

1
sdk/python/sdk/zrok/test/__init__.py
View File

@ -1 +0,0 @@
# coding: utf-8

39
sdk/python/sdk/zrok/test/test_access_body.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.access_body import AccessBody # noqa: E501
from zrok_api.rest import ApiException
class TestAccessBody(unittest.TestCase):
"""AccessBody unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testAccessBody(self):
"""Test AccessBody"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.access_body.AccessBody() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_access_body1.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.access_body1 import AccessBody1 # noqa: E501
from zrok_api.rest import ApiException
class TestAccessBody1(unittest.TestCase):
"""AccessBody1 unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testAccessBody1(self):
"""Test AccessBody1"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.access_body1.AccessBody1() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

81
sdk/python/sdk/zrok/test/test_account_api.py
View File

@ -1,81 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.api.account_api import AccountApi # noqa: E501
from zrok_api.rest import ApiException
class TestAccountApi(unittest.TestCase):
"""AccountApi unit test stubs"""
def setUp(self):
self.api = AccountApi() # noqa: E501
def tearDown(self):
pass
def test_change_password(self):
"""Test case for change_password
"""
pass
def test_invite(self):
"""Test case for invite
"""
pass
def test_login(self):
"""Test case for login
"""
pass
def test_regenerate_token(self):
"""Test case for regenerate_token
"""
pass
def test_register(self):
"""Test case for register
"""
pass
def test_reset_password(self):
"""Test case for reset_password
"""
pass
def test_reset_password_request(self):
"""Test case for reset_password_request
"""
pass
def test_verify(self):
"""Test case for verify
"""
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_account_body.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.account_body import AccountBody # noqa: E501
from zrok_api.rest import ApiException
class TestAccountBody(unittest.TestCase):
"""AccountBody unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testAccountBody(self):
"""Test AccountBody"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.account_body.AccountBody() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

117
sdk/python/sdk/zrok/test/test_admin_api.py
View File

@ -1,117 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.api.admin_api import AdminApi # noqa: E501
from zrok_api.rest import ApiException
class TestAdminApi(unittest.TestCase):
"""AdminApi unit test stubs"""
def setUp(self):
self.api = AdminApi() # noqa: E501
def tearDown(self):
pass
def test_add_organization_member(self):
"""Test case for add_organization_member
"""
pass
def test_create_account(self):
"""Test case for create_account
"""
pass
def test_create_frontend(self):
"""Test case for create_frontend
"""
pass
def test_create_identity(self):
"""Test case for create_identity
"""
pass
def test_create_organization(self):
"""Test case for create_organization
"""
pass
def test_delete_frontend(self):
"""Test case for delete_frontend
"""
pass
def test_delete_organization(self):
"""Test case for delete_organization
"""
pass
def test_grants(self):
"""Test case for grants
"""
pass
def test_invite_token_generate(self):
"""Test case for invite_token_generate
"""
pass
def test_list_frontends(self):
"""Test case for list_frontends
"""
pass
def test_list_organization_members(self):
"""Test case for list_organization_members
"""
pass
def test_list_organizations(self):
"""Test case for list_organizations
"""
pass
def test_remove_organization_member(self):
"""Test case for remove_organization_member
"""
pass
def test_update_frontend(self):
"""Test case for update_frontend
"""
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_auth_user.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.auth_user import AuthUser # noqa: E501
from zrok_api.rest import ApiException
class TestAuthUser(unittest.TestCase):
"""AuthUser unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testAuthUser(self):
"""Test AuthUser"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.auth_user.AuthUser() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_change_password_body.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.change_password_body import ChangePasswordBody # noqa: E501
from zrok_api.rest import ApiException
class TestChangePasswordBody(unittest.TestCase):
"""ChangePasswordBody unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testChangePasswordBody(self):
"""Test ChangePasswordBody"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.change_password_body.ChangePasswordBody() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_client_version_check_body.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.client_version_check_body import ClientVersionCheckBody # noqa: E501
from zrok_api.rest import ApiException
class TestClientVersionCheckBody(unittest.TestCase):
"""ClientVersionCheckBody unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testClientVersionCheckBody(self):
"""Test ClientVersionCheckBody"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.client_version_check_body.ClientVersionCheckBody() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_configuration.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.configuration import Configuration # noqa: E501
from zrok_api.rest import ApiException
class TestConfiguration(unittest.TestCase):
"""Configuration unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testConfiguration(self):
"""Test Configuration"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.configuration.Configuration() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_disable_body.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.disable_body import DisableBody # noqa: E501
from zrok_api.rest import ApiException
class TestDisableBody(unittest.TestCase):
"""DisableBody unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testDisableBody(self):
"""Test DisableBody"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.disable_body.DisableBody() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_enable_body.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.enable_body import EnableBody # noqa: E501
from zrok_api.rest import ApiException
class TestEnableBody(unittest.TestCase):
"""EnableBody unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testEnableBody(self):
"""Test EnableBody"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.enable_body.EnableBody() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_environment.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.environment import Environment # noqa: E501
from zrok_api.rest import ApiException
class TestEnvironment(unittest.TestCase):
"""Environment unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testEnvironment(self):
"""Test Environment"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.environment.Environment() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

39
sdk/python/sdk/zrok/test/test_environment_and_resources.py
View File

@ -1,39 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.environment_and_resources import EnvironmentAndResources # noqa: E501
from zrok_api.rest import ApiException
class TestEnvironmentAndResources(unittest.TestCase):
"""EnvironmentAndResources unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testEnvironmentAndResources(self):
"""Test EnvironmentAndResources"""
# FIXME: construct object with mandatory attributes with example values
# model = zrok_api.models.environment_and_resources.EnvironmentAndResources() # noqa: E501
pass
if __name__ == '__main__':
unittest.main()

45
sdk/python/sdk/zrok/test/test_environment_api.py
View File

@ -1,45 +0,0 @@
# coding: utf-8
"""
zrok
zrok client access # noqa: E501
OpenAPI spec version: 1.0.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.api.environment_api import EnvironmentApi # noqa: E501
from zrok_api.rest import ApiException
class TestEnvironmentApi(unittest.TestCase):
"""EnvironmentApi unit test stubs"""
def setUp(self):
self.api = EnvironmentApi() # noqa: E501
def tearDown(self):
pass
def test_disable(self):
"""Test case for disable
"""
pass
def test_enable(self):
"""Test case for enable
"""
pass
if __name__ == '__main__':
unittest.main()

Some files were not shown because too many files have changed in this diff Show More