run openapi-generator for python

This commit is contained in:
Kenneth Bingham 2025-03-03 17:07:03 -05:00
parent c13eddc06a
commit 26ce4eb270
No known key found for this signature in database
GPG Key ID: 31709281860130B6
220 changed files with 23469 additions and 14598 deletions

View File

@ -45,7 +45,9 @@ coverage.xml
*,cover
.hypothesis/
venv/
.venv/
.python-version
.pytest_cache
# Translations
*.mo

View File

@ -0,0 +1,125 @@
.gitignore
README.md
docs/Access201Response.md
docs/AccessRequest.md
docs/AccountApi.md
docs/AddOrganizationMemberRequest.md
docs/AdminApi.md
docs/AuthUser.md
docs/ChangePasswordRequest.md
docs/ClientVersionCheckRequest.md
docs/Configuration.md
docs/CreateFrontend201Response.md
docs/CreateFrontendRequest.md
docs/CreateIdentity201Response.md
docs/CreateIdentityRequest.md
docs/CreateOrganization201Response.md
docs/CreateOrganizationRequest.md
docs/DisableRequest.md
docs/EnableRequest.md
docs/Environment.md
docs/EnvironmentAndResources.md
docs/EnvironmentApi.md
docs/Frontend.md
docs/GetSparklines200Response.md
docs/GetSparklinesRequest.md
docs/InviteRequest.md
docs/InviteTokenGenerateRequest.md
docs/ListFrontends200ResponseInner.md
docs/ListMemberships200Response.md
docs/ListMemberships200ResponseMembershipsInner.md
docs/ListOrganizationMembers200Response.md
docs/ListOrganizationMembers200ResponseMembersInner.md
docs/ListOrganizations200Response.md
docs/ListOrganizations200ResponseOrganizationsInner.md
docs/LoginRequest.md
docs/MetadataApi.md
docs/Metrics.md
docs/MetricsSample.md
docs/Overview.md
docs/Principal.md
docs/RegenerateAccountToken200Response.md
docs/RegenerateAccountTokenRequest.md
docs/RegisterRequest.md
docs/RemoveOrganizationMemberRequest.md
docs/ResetPasswordRequest.md
docs/Share.md
docs/ShareApi.md
docs/ShareRequest.md
docs/ShareResponse.md
docs/SparkDataSample.md
docs/UnaccessRequest.md
docs/UnshareRequest.md
docs/UpdateAccessRequest.md
docs/UpdateFrontendRequest.md
docs/UpdateShareRequest.md
docs/Verify200Response.md
docs/VerifyRequest.md
docs/VersionInventory200Response.md
requirements.txt
test/__init__.py
zrok_api/__init__.py
zrok_api/api/__init__.py
zrok_api/api/account_api.py
zrok_api/api/admin_api.py
zrok_api/api/environment_api.py
zrok_api/api/metadata_api.py
zrok_api/api/share_api.py
zrok_api/api_client.py
zrok_api/api_response.py
zrok_api/configuration.py
zrok_api/exceptions.py
zrok_api/models/__init__.py
zrok_api/models/access201_response.py
zrok_api/models/access_request.py
zrok_api/models/add_organization_member_request.py
zrok_api/models/auth_user.py
zrok_api/models/change_password_request.py
zrok_api/models/client_version_check_request.py
zrok_api/models/configuration.py
zrok_api/models/create_frontend201_response.py
zrok_api/models/create_frontend_request.py
zrok_api/models/create_identity201_response.py
zrok_api/models/create_identity_request.py
zrok_api/models/create_organization201_response.py
zrok_api/models/create_organization_request.py
zrok_api/models/disable_request.py
zrok_api/models/enable_request.py
zrok_api/models/environment.py
zrok_api/models/environment_and_resources.py
zrok_api/models/frontend.py
zrok_api/models/get_sparklines200_response.py
zrok_api/models/get_sparklines_request.py
zrok_api/models/invite_request.py
zrok_api/models/invite_token_generate_request.py
zrok_api/models/list_frontends200_response_inner.py
zrok_api/models/list_memberships200_response.py
zrok_api/models/list_memberships200_response_memberships_inner.py
zrok_api/models/list_organization_members200_response.py
zrok_api/models/list_organization_members200_response_members_inner.py
zrok_api/models/list_organizations200_response.py
zrok_api/models/list_organizations200_response_organizations_inner.py
zrok_api/models/login_request.py
zrok_api/models/metrics.py
zrok_api/models/metrics_sample.py
zrok_api/models/overview.py
zrok_api/models/principal.py
zrok_api/models/regenerate_account_token200_response.py
zrok_api/models/regenerate_account_token_request.py
zrok_api/models/register_request.py
zrok_api/models/remove_organization_member_request.py
zrok_api/models/reset_password_request.py
zrok_api/models/share.py
zrok_api/models/share_request.py
zrok_api/models/share_response.py
zrok_api/models/spark_data_sample.py
zrok_api/models/unaccess_request.py
zrok_api/models/unshare_request.py
zrok_api/models/update_access_request.py
zrok_api/models/update_frontend_request.py
zrok_api/models/update_share_request.py
zrok_api/models/verify200_response.py
zrok_api/models/verify_request.py
zrok_api/models/version_inventory200_response.py
zrok_api/py.typed
zrok_api/rest.py

View File

@ -0,0 +1 @@
7.7.0

View File

@ -1,32 +0,0 @@
# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
.travis.yml
git_push.sh
tox.ini
test-requirements.txt
test/
docs/
README.md
setup.py

View File

@ -1,21 +1,21 @@
# zrok_sdk
zrok client access
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
@ -24,7 +24,7 @@ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
Then import the package:
```python
import zrok_api
import zrok_api
```
### Setuptools
@ -41,104 +41,49 @@ Then import the package:
import zrok_api
```
### Tests
Execute `pytest` to run the tests.
## 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'
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# 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)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = '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)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.ChangePasswordRequest() # ChangePasswordRequest | (optional)
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegisterBody() # RegisterBody | (optional)
try:
api_instance.change_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->change_password: %s\n" % e)
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
@ -194,76 +139,69 @@ Class | Method | HTTP request | Description
*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)
- [Access201Response](docs/Access201Response.md)
- [AccessRequest](docs/AccessRequest.md)
- [AddOrganizationMemberRequest](docs/AddOrganizationMemberRequest.md)
- [AuthUser](docs/AuthUser.md)
- [ChangePasswordBody](docs/ChangePasswordBody.md)
- [ClientVersionCheckBody](docs/ClientVersionCheckBody.md)
- [ChangePasswordRequest](docs/ChangePasswordRequest.md)
- [ClientVersionCheckRequest](docs/ClientVersionCheckRequest.md)
- [Configuration](docs/Configuration.md)
- [DisableBody](docs/DisableBody.md)
- [EnableBody](docs/EnableBody.md)
- [CreateFrontend201Response](docs/CreateFrontend201Response.md)
- [CreateFrontendRequest](docs/CreateFrontendRequest.md)
- [CreateIdentity201Response](docs/CreateIdentity201Response.md)
- [CreateIdentityRequest](docs/CreateIdentityRequest.md)
- [CreateOrganization201Response](docs/CreateOrganization201Response.md)
- [CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
- [DisableRequest](docs/DisableRequest.md)
- [EnableRequest](docs/EnableRequest.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)
- [GetSparklines200Response](docs/GetSparklines200Response.md)
- [GetSparklinesRequest](docs/GetSparklinesRequest.md)
- [InviteRequest](docs/InviteRequest.md)
- [InviteTokenGenerateRequest](docs/InviteTokenGenerateRequest.md)
- [ListFrontends200ResponseInner](docs/ListFrontends200ResponseInner.md)
- [ListMemberships200Response](docs/ListMemberships200Response.md)
- [ListMemberships200ResponseMembershipsInner](docs/ListMemberships200ResponseMembershipsInner.md)
- [ListOrganizationMembers200Response](docs/ListOrganizationMembers200Response.md)
- [ListOrganizationMembers200ResponseMembersInner](docs/ListOrganizationMembers200ResponseMembersInner.md)
- [ListOrganizations200Response](docs/ListOrganizations200Response.md)
- [ListOrganizations200ResponseOrganizationsInner](docs/ListOrganizations200ResponseOrganizationsInner.md)
- [LoginRequest](docs/LoginRequest.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)
- [RegenerateAccountToken200Response](docs/RegenerateAccountToken200Response.md)
- [RegenerateAccountTokenRequest](docs/RegenerateAccountTokenRequest.md)
- [RegisterRequest](docs/RegisterRequest.md)
- [RemoveOrganizationMemberRequest](docs/RemoveOrganizationMemberRequest.md)
- [ResetPasswordRequest](docs/ResetPasswordRequest.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)
- [UnaccessRequest](docs/UnaccessRequest.md)
- [UnshareRequest](docs/UnshareRequest.md)
- [UpdateAccessRequest](docs/UpdateAccessRequest.md)
- [UpdateFrontendRequest](docs/UpdateFrontendRequest.md)
- [UpdateShareRequest](docs/UpdateShareRequest.md)
- [Verify200Response](docs/Verify200Response.md)
- [VerifyRequest](docs/VerifyRequest.md)
- [VersionInventory200Response](docs/VersionInventory200Response.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
## key
Authentication schemes defined for the API:
<a id="key"></a>
### key
- **Type**: API key
- **API key parameter name**: x-token
@ -273,3 +211,5 @@ Class | Method | HTTP request | Description
## Author

View File

@ -0,0 +1,30 @@
# Access201Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**backend_mode** | **str** | | [optional]
## Example
```python
from zrok_api.models.access201_response import Access201Response
# TODO update the JSON string below
json = "{}"
# create an instance of Access201Response from a JSON string
access201_response_instance = Access201Response.from_json(json)
# print the JSON string representation of the object
print(Access201Response.to_json())
# convert the object into a dict
access201_response_dict = access201_response_instance.to_dict()
# create an instance of Access201Response from a dict
access201_response_from_dict = Access201Response.from_dict(access201_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,32 @@
# AccessRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env_zid** | **str** | | [optional]
**share_token** | **str** | | [optional]
**bind_address** | **str** | | [optional]
**description** | **str** | | [optional]
## Example
```python
from zrok_api.models.access_request import AccessRequest
# TODO update the JSON string below
json = "{}"
# create an instance of AccessRequest from a JSON string
access_request_instance = AccessRequest.from_json(json)
# print the JSON string representation of the object
print(AccessRequest.to_json())
# convert the object into a dict
access_request_dict = access_request_instance.to_dict()
# create an instance of AccessRequest from a dict
access_request_from_dict = AccessRequest.from_dict(access_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -13,40 +13,59 @@ Method | HTTP request | Description
[**reset_password_request**](AccountApi.md#reset_password_request) | **POST** /resetPasswordRequest |
[**verify**](AccountApi.md#verify) | **POST** /verify |
# **change_password**
> change_password(body=body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.change_password_request import ChangePasswordRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ChangePasswordBody() # ChangePasswordBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.ChangePasswordRequest() # ChangePasswordRequest | (optional)
try:
api_instance.change_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->change_password: %s\n" % e)
try:
api_instance.change_password(body=body)
except Exception as e:
print("Exception when calling AccountApi->change_password: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ChangePasswordBody**](ChangePasswordBody.md)| | [optional]
**body** | [**ChangePasswordRequest**](ChangePasswordRequest.md)| | [optional]
### Return type
@ -61,6 +80,16 @@ void (empty response body)
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | password changed | - |
**400** | password not changed | - |
**401** | unauthorized | - |
**422** | password validation failure | - |
**500** | internal server error | - |
[[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**
@ -69,28 +98,41 @@ void (empty response body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.invite_request import InviteRequest
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)
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
try:
api_instance.invite(body=body)
except ApiException as e:
print("Exception when calling AccountApi->invite: %s\n" % e)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.InviteRequest() # InviteRequest | (optional)
try:
api_instance.invite(body=body)
except Exception as e:
print("Exception when calling AccountApi->invite: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**InviteBody**](InviteBody.md)| | [optional]
**body** | [**InviteRequest**](InviteRequest.md)| | [optional]
### Return type
@ -105,6 +147,15 @@ No authorization required
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | invitation created | - |
**400** | invitation not created (already exists) | - |
**401** | unauthorized | - |
**500** | internal server error | - |
[[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**
@ -113,29 +164,43 @@ No authorization required
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.login_request import LoginRequest
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)
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
try:
api_response = api_instance.login(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->login: %s\n" % e)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.LoginRequest() # LoginRequest | (optional)
try:
api_response = api_instance.login(body=body)
print("The response of AccountApi->login:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccountApi->login: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**LoginBody**](LoginBody.md)| | [optional]
**body** | [**LoginRequest**](LoginRequest.md)| | [optional]
### Return type
@ -150,47 +215,74 @@ No authorization required
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | login successful | - |
**401** | invalid login | - |
[[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)
> RegenerateAccountToken200Response regenerate_account_token(body=body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.regenerate_account_token200_response import RegenerateAccountToken200Response
from zrok_api.models.regenerate_account_token_request import RegenerateAccountTokenRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegenerateAccountTokenBody() # RegenerateAccountTokenBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.RegenerateAccountTokenRequest() # RegenerateAccountTokenRequest | (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)
try:
api_response = api_instance.regenerate_account_token(body=body)
print("The response of AccountApi->regenerate_account_token:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccountApi->regenerate_account_token: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**RegenerateAccountTokenBody**](RegenerateAccountTokenBody.md)| | [optional]
**body** | [**RegenerateAccountTokenRequest**](RegenerateAccountTokenRequest.md)| | [optional]
### Return type
[**InlineResponse200**](InlineResponse200.md)
[**RegenerateAccountToken200Response**](RegenerateAccountToken200Response.md)
### Authorization
@ -201,41 +293,64 @@ Name | Type | Description | Notes
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | regenerate account token | - |
**404** | account not found | - |
**500** | internal server error | - |
[[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)
> RegenerateAccountToken200Response register(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.regenerate_account_token200_response import RegenerateAccountToken200Response
from zrok_api.models.register_request import RegisterRequest
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)
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
try:
api_response = api_instance.register(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->register: %s\n" % e)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.RegisterRequest() # RegisterRequest | (optional)
try:
api_response = api_instance.register(body=body)
print("The response of AccountApi->register:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccountApi->register: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**RegisterBody**](RegisterBody.md)| | [optional]
**body** | [**RegisterRequest**](RegisterRequest.md)| | [optional]
### Return type
[**InlineResponse200**](InlineResponse200.md)
[**RegenerateAccountToken200Response**](RegenerateAccountToken200Response.md)
### Authorization
@ -246,6 +361,15 @@ No authorization required
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | account created | - |
**404** | request not found | - |
**422** | password validation failure | - |
**500** | internal server error | - |
[[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**
@ -254,28 +378,41 @@ No authorization required
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.reset_password_request import ResetPasswordRequest
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)
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
try:
api_instance.reset_password(body=body)
except ApiException as e:
print("Exception when calling AccountApi->reset_password: %s\n" % e)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.ResetPasswordRequest() # ResetPasswordRequest | (optional)
try:
api_instance.reset_password(body=body)
except Exception as e:
print("Exception when calling AccountApi->reset_password: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ResetPasswordBody**](ResetPasswordBody.md)| | [optional]
**body** | [**ResetPasswordRequest**](ResetPasswordRequest.md)| | [optional]
### Return type
@ -290,6 +427,15 @@ No authorization required
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | password reset | - |
**404** | request not found | - |
**422** | password validation failure | - |
**500** | internal server error | - |
[[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**
@ -298,28 +444,41 @@ No authorization required
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.regenerate_account_token_request import RegenerateAccountTokenRequest
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)
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
try:
api_instance.reset_password_request(body=body)
except ApiException as e:
print("Exception when calling AccountApi->reset_password_request: %s\n" % e)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.RegenerateAccountTokenRequest() # RegenerateAccountTokenRequest | (optional)
try:
api_instance.reset_password_request(body=body)
except Exception as e:
print("Exception when calling AccountApi->reset_password_request: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ResetPasswordRequestBody**](ResetPasswordRequestBody.md)| | [optional]
**body** | [**RegenerateAccountTokenRequest**](RegenerateAccountTokenRequest.md)| | [optional]
### Return type
@ -334,41 +493,64 @@ No authorization required
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | reset password request created | - |
**400** | reset password request not created | - |
**500** | internal server error | - |
[[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)
> Verify200Response verify(body=body)
### Example
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.verify200_response import Verify200Response
from zrok_api.models.verify_request import VerifyRequest
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)
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
try:
api_response = api_instance.verify(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->verify: %s\n" % e)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.AccountApi(api_client)
body = zrok_api.VerifyRequest() # VerifyRequest | (optional)
try:
api_response = api_instance.verify(body=body)
print("The response of AccountApi->verify:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccountApi->verify: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**VerifyBody**](VerifyBody.md)| | [optional]
**body** | [**VerifyRequest**](VerifyRequest.md)| | [optional]
### Return type
[**InlineResponse2001**](InlineResponse2001.md)
[**Verify200Response**](Verify200Response.md)
### Authorization
@ -379,5 +561,13 @@ No authorization required
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | registration token ready | - |
**404** | registration token not found | - |
**500** | internal server error | - |
[[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)

View File

@ -0,0 +1,31 @@
# AddOrganizationMemberRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**email** | **str** | | [optional]
**admin** | **bool** | | [optional]
## Example
```python
from zrok_api.models.add_organization_member_request import AddOrganizationMemberRequest
# TODO update the JSON string below
json = "{}"
# create an instance of AddOrganizationMemberRequest from a JSON string
add_organization_member_request_instance = AddOrganizationMemberRequest.from_json(json)
# print the JSON string representation of the object
print(AddOrganizationMemberRequest.to_json())
# convert the object into a dict
add_organization_member_request_dict = add_organization_member_request_instance.to_dict()
# create an instance of AddOrganizationMemberRequest from a dict
add_organization_member_request_from_dict = AddOrganizationMemberRequest.from_dict(add_organization_member_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,30 @@
# AuthUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **str** | | [optional]
**password** | **str** | | [optional]
## Example
```python
from zrok_api.models.auth_user import AuthUser
# TODO update the JSON string below
json = "{}"
# create an instance of AuthUser from a JSON string
auth_user_instance = AuthUser.from_json(json)
# print the JSON string representation of the object
print(AuthUser.to_json())
# convert the object into a dict
auth_user_dict = auth_user_instance.to_dict()
# create an instance of AuthUser from a dict
auth_user_from_dict = AuthUser.from_dict(auth_user_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# ChangePasswordRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**old_password** | **str** | | [optional]
**new_password** | **str** | | [optional]
## Example
```python
from zrok_api.models.change_password_request import ChangePasswordRequest
# TODO update the JSON string below
json = "{}"
# create an instance of ChangePasswordRequest from a JSON string
change_password_request_instance = ChangePasswordRequest.from_json(json)
# print the JSON string representation of the object
print(ChangePasswordRequest.to_json())
# convert the object into a dict
change_password_request_dict = change_password_request_instance.to_dict()
# create an instance of ChangePasswordRequest from a dict
change_password_request_from_dict = ChangePasswordRequest.from_dict(change_password_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# ClientVersionCheckRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_version** | **str** | | [optional]
## Example
```python
from zrok_api.models.client_version_check_request import ClientVersionCheckRequest
# TODO update the JSON string below
json = "{}"
# create an instance of ClientVersionCheckRequest from a JSON string
client_version_check_request_instance = ClientVersionCheckRequest.from_json(json)
# print the JSON string representation of the object
print(ClientVersionCheckRequest.to_json())
# convert the object into a dict
client_version_check_request_dict = client_version_check_request_instance.to_dict()
# create an instance of ClientVersionCheckRequest from a dict
client_version_check_request_from_dict = ClientVersionCheckRequest.from_dict(client_version_check_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,6 +1,8 @@
# Configuration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | | [optional]
@ -9,5 +11,23 @@ Name | Type | Description | Notes
**requires_invite_token** | **bool** | | [optional]
**invite_token_contact** | **str** | | [optional]
## Example
```python
from zrok_api.models.configuration import Configuration
# TODO update the JSON string below
json = "{}"
# create an instance of Configuration from a JSON string
configuration_instance = Configuration.from_json(json)
# print the JSON string representation of the object
print(Configuration.to_json())
# convert the object into a dict
configuration_dict = configuration_instance.to_dict()
# create an instance of Configuration from a dict
configuration_from_dict = Configuration.from_dict(configuration_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# CreateFrontend201Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.create_frontend201_response import CreateFrontend201Response
# TODO update the JSON string below
json = "{}"
# create an instance of CreateFrontend201Response from a JSON string
create_frontend201_response_instance = CreateFrontend201Response.from_json(json)
# print the JSON string representation of the object
print(CreateFrontend201Response.to_json())
# convert the object into a dict
create_frontend201_response_dict = create_frontend201_response_instance.to_dict()
# create an instance of CreateFrontend201Response from a dict
create_frontend201_response_from_dict = CreateFrontend201Response.from_dict(create_frontend201_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,32 @@
# CreateFrontendRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**z_id** | **str** | | [optional]
**url_template** | **str** | | [optional]
**public_name** | **str** | | [optional]
**permission_mode** | **str** | | [optional]
## Example
```python
from zrok_api.models.create_frontend_request import CreateFrontendRequest
# TODO update the JSON string below
json = "{}"
# create an instance of CreateFrontendRequest from a JSON string
create_frontend_request_instance = CreateFrontendRequest.from_json(json)
# print the JSON string representation of the object
print(CreateFrontendRequest.to_json())
# convert the object into a dict
create_frontend_request_dict = create_frontend_request_instance.to_dict()
# create an instance of CreateFrontendRequest from a dict
create_frontend_request_from_dict = CreateFrontendRequest.from_dict(create_frontend_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# CreateIdentity201Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | **str** | | [optional]
**cfg** | **str** | | [optional]
## Example
```python
from zrok_api.models.create_identity201_response import CreateIdentity201Response
# TODO update the JSON string below
json = "{}"
# create an instance of CreateIdentity201Response from a JSON string
create_identity201_response_instance = CreateIdentity201Response.from_json(json)
# print the JSON string representation of the object
print(CreateIdentity201Response.to_json())
# convert the object into a dict
create_identity201_response_dict = create_identity201_response_instance.to_dict()
# create an instance of CreateIdentity201Response from a dict
create_identity201_response_from_dict = CreateIdentity201Response.from_dict(create_identity201_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# CreateIdentityRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
## Example
```python
from zrok_api.models.create_identity_request import CreateIdentityRequest
# TODO update the JSON string below
json = "{}"
# create an instance of CreateIdentityRequest from a JSON string
create_identity_request_instance = CreateIdentityRequest.from_json(json)
# print the JSON string representation of the object
print(CreateIdentityRequest.to_json())
# convert the object into a dict
create_identity_request_dict = create_identity_request_instance.to_dict()
# create an instance of CreateIdentityRequest from a dict
create_identity_request_from_dict = CreateIdentityRequest.from_dict(create_identity_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# CreateOrganization201Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.create_organization201_response import CreateOrganization201Response
# TODO update the JSON string below
json = "{}"
# create an instance of CreateOrganization201Response from a JSON string
create_organization201_response_instance = CreateOrganization201Response.from_json(json)
# print the JSON string representation of the object
print(CreateOrganization201Response.to_json())
# convert the object into a dict
create_organization201_response_dict = create_organization201_response_instance.to_dict()
# create an instance of CreateOrganization201Response from a dict
create_organization201_response_from_dict = CreateOrganization201Response.from_dict(create_organization201_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# CreateOrganizationRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
## Example
```python
from zrok_api.models.create_organization_request import CreateOrganizationRequest
# TODO update the JSON string below
json = "{}"
# create an instance of CreateOrganizationRequest from a JSON string
create_organization_request_instance = CreateOrganizationRequest.from_json(json)
# print the JSON string representation of the object
print(CreateOrganizationRequest.to_json())
# convert the object into a dict
create_organization_request_dict = create_organization_request_instance.to_dict()
# create an instance of CreateOrganizationRequest from a dict
create_organization_request_from_dict = CreateOrganizationRequest.from_dict(create_organization_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# DisableRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | **str** | | [optional]
## Example
```python
from zrok_api.models.disable_request import DisableRequest
# TODO update the JSON string below
json = "{}"
# create an instance of DisableRequest from a JSON string
disable_request_instance = DisableRequest.from_json(json)
# print the JSON string representation of the object
print(DisableRequest.to_json())
# convert the object into a dict
disable_request_dict = disable_request_instance.to_dict()
# create an instance of DisableRequest from a dict
disable_request_from_dict = DisableRequest.from_dict(disable_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# EnableRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**host** | **str** | | [optional]
## Example
```python
from zrok_api.models.enable_request import EnableRequest
# TODO update the JSON string below
json = "{}"
# create an instance of EnableRequest from a JSON string
enable_request_instance = EnableRequest.from_json(json)
# print the JSON string representation of the object
print(EnableRequest.to_json())
# convert the object into a dict
enable_request_dict = enable_request_instance.to_dict()
# create an instance of EnableRequest from a dict
enable_request_from_dict = EnableRequest.from_dict(enable_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,16 +1,36 @@
# Environment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**host** | **str** | | [optional]
**address** | **str** | | [optional]
**z_id** | **str** | | [optional]
**activity** | [**SparkData**](SparkData.md) | | [optional]
**activity** | [**List[SparkDataSample]**](SparkDataSample.md) | | [optional]
**limited** | **bool** | | [optional]
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
## Example
```python
from zrok_api.models.environment import Environment
# TODO update the JSON string below
json = "{}"
# create an instance of Environment from a JSON string
environment_instance = Environment.from_json(json)
# print the JSON string representation of the object
print(Environment.to_json())
# convert the object into a dict
environment_dict = environment_instance.to_dict()
# create an instance of Environment from a dict
environment_from_dict = Environment.from_dict(environment_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,11 +1,31 @@
# EnvironmentAndResources
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**environment** | [**Environment**](Environment.md) | | [optional]
**frontends** | [**Frontends**](Frontends.md) | | [optional]
**shares** | [**Shares**](Shares.md) | | [optional]
**frontends** | [**List[Frontend]**](Frontend.md) | | [optional]
**shares** | [**List[Share]**](Share.md) | | [optional]
## Example
```python
from zrok_api.models.environment_and_resources import EnvironmentAndResources
# TODO update the JSON string below
json = "{}"
# create an instance of EnvironmentAndResources from a JSON string
environment_and_resources_instance = EnvironmentAndResources.from_json(json)
# print the JSON string representation of the object
print(EnvironmentAndResources.to_json())
# convert the object into a dict
environment_and_resources_dict = environment_and_resources_instance.to_dict()
# create an instance of EnvironmentAndResources from a dict
environment_and_resources_from_dict = EnvironmentAndResources.from_dict(environment_and_resources_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -7,40 +7,59 @@ Method | HTTP request | Description
[**disable**](EnvironmentApi.md#disable) | **POST** /disable |
[**enable**](EnvironmentApi.md#enable) | **POST** /enable |
# **disable**
> disable(body=body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.disable_request import DisableRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.EnvironmentApi(zrok_api.ApiClient(configuration))
body = zrok_api.DisableBody() # DisableBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.EnvironmentApi(api_client)
body = zrok_api.DisableRequest() # DisableRequest | (optional)
try:
api_instance.disable(body=body)
except ApiException as e:
print("Exception when calling EnvironmentApi->disable: %s\n" % e)
try:
api_instance.disable(body=body)
except Exception as e:
print("Exception when calling EnvironmentApi->disable: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DisableBody**](DisableBody.md)| | [optional]
**body** | [**DisableRequest**](DisableRequest.md)| | [optional]
### Return type
@ -55,47 +74,75 @@ void (empty response body)
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | environment disabled | - |
**401** | invalid environment | - |
**500** | internal server error | - |
[[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)
> CreateIdentity201Response enable(body=body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.create_identity201_response import CreateIdentity201Response
from zrok_api.models.enable_request import EnableRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.EnvironmentApi(zrok_api.ApiClient(configuration))
body = zrok_api.EnableBody() # EnableBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.EnvironmentApi(api_client)
body = zrok_api.EnableRequest() # EnableRequest | (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)
try:
api_response = api_instance.enable(body=body)
print("The response of EnvironmentApi->enable:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling EnvironmentApi->enable: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**EnableBody**](EnableBody.md)| | [optional]
**body** | [**EnableRequest**](EnableRequest.md)| | [optional]
### Return type
[**InlineResponse2011**](InlineResponse2011.md)
[**CreateIdentity201Response**](CreateIdentity201Response.md)
### Authorization
@ -106,5 +153,14 @@ Name | Type | Description | Notes
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | environment enabled | - |
**401** | unauthorized | - |
**404** | account not found | - |
**500** | internal server error | - |
[[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)

View File

@ -1,6 +1,8 @@
# Frontend
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
@ -13,5 +15,23 @@ Name | Type | Description | Notes
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
## Example
```python
from zrok_api.models.frontend import Frontend
# TODO update the JSON string below
json = "{}"
# create an instance of Frontend from a JSON string
frontend_instance = Frontend.from_json(json)
# print the JSON string representation of the object
print(Frontend.to_json())
# convert the object into a dict
frontend_dict = frontend_instance.to_dict()
# create an instance of Frontend from a dict
frontend_from_dict = Frontend.from_dict(frontend_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# GetSparklines200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sparklines** | [**List[Metrics]**](Metrics.md) | | [optional]
## Example
```python
from zrok_api.models.get_sparklines200_response import GetSparklines200Response
# TODO update the JSON string below
json = "{}"
# create an instance of GetSparklines200Response from a JSON string
get_sparklines200_response_instance = GetSparklines200Response.from_json(json)
# print the JSON string representation of the object
print(GetSparklines200Response.to_json())
# convert the object into a dict
get_sparklines200_response_dict = get_sparklines200_response_instance.to_dict()
# create an instance of GetSparklines200Response from a dict
get_sparklines200_response_from_dict = GetSparklines200Response.from_dict(get_sparklines200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# GetSparklinesRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account** | **bool** | | [optional]
**environments** | **List[str]** | | [optional]
**shares** | **List[str]** | | [optional]
## Example
```python
from zrok_api.models.get_sparklines_request import GetSparklinesRequest
# TODO update the JSON string below
json = "{}"
# create an instance of GetSparklinesRequest from a JSON string
get_sparklines_request_instance = GetSparklinesRequest.from_json(json)
# print the JSON string representation of the object
print(GetSparklinesRequest.to_json())
# convert the object into a dict
get_sparklines_request_dict = get_sparklines_request_instance.to_dict()
# create an instance of GetSparklinesRequest from a dict
get_sparklines_request_from_dict = GetSparklinesRequest.from_dict(get_sparklines_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# InviteRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**invite_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.invite_request import InviteRequest
# TODO update the JSON string below
json = "{}"
# create an instance of InviteRequest from a JSON string
invite_request_instance = InviteRequest.from_json(json)
# print the JSON string representation of the object
print(InviteRequest.to_json())
# convert the object into a dict
invite_request_dict = invite_request_instance.to_dict()
# create an instance of InviteRequest from a dict
invite_request_from_dict = InviteRequest.from_dict(invite_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# InviteTokenGenerateRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**invite_tokens** | **List[str]** | | [optional]
## Example
```python
from zrok_api.models.invite_token_generate_request import InviteTokenGenerateRequest
# TODO update the JSON string below
json = "{}"
# create an instance of InviteTokenGenerateRequest from a JSON string
invite_token_generate_request_instance = InviteTokenGenerateRequest.from_json(json)
# print the JSON string representation of the object
print(InviteTokenGenerateRequest.to_json())
# convert the object into a dict
invite_token_generate_request_dict = invite_token_generate_request_instance.to_dict()
# create an instance of InviteTokenGenerateRequest from a dict
invite_token_generate_request_from_dict = InviteTokenGenerateRequest.from_dict(invite_token_generate_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,34 @@
# ListFrontends200ResponseInner
## 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]
## Example
```python
from zrok_api.models.list_frontends200_response_inner import ListFrontends200ResponseInner
# TODO update the JSON string below
json = "{}"
# create an instance of ListFrontends200ResponseInner from a JSON string
list_frontends200_response_inner_instance = ListFrontends200ResponseInner.from_json(json)
# print the JSON string representation of the object
print(ListFrontends200ResponseInner.to_json())
# convert the object into a dict
list_frontends200_response_inner_dict = list_frontends200_response_inner_instance.to_dict()
# create an instance of ListFrontends200ResponseInner from a dict
list_frontends200_response_inner_from_dict = ListFrontends200ResponseInner.from_dict(list_frontends200_response_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# ListMemberships200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memberships** | [**List[ListMemberships200ResponseMembershipsInner]**](ListMemberships200ResponseMembershipsInner.md) | | [optional]
## Example
```python
from zrok_api.models.list_memberships200_response import ListMemberships200Response
# TODO update the JSON string below
json = "{}"
# create an instance of ListMemberships200Response from a JSON string
list_memberships200_response_instance = ListMemberships200Response.from_json(json)
# print the JSON string representation of the object
print(ListMemberships200Response.to_json())
# convert the object into a dict
list_memberships200_response_dict = list_memberships200_response_instance.to_dict()
# create an instance of ListMemberships200Response from a dict
list_memberships200_response_from_dict = ListMemberships200Response.from_dict(list_memberships200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# ListMemberships200ResponseMembershipsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**description** | **str** | | [optional]
**admin** | **bool** | | [optional]
## Example
```python
from zrok_api.models.list_memberships200_response_memberships_inner import ListMemberships200ResponseMembershipsInner
# TODO update the JSON string below
json = "{}"
# create an instance of ListMemberships200ResponseMembershipsInner from a JSON string
list_memberships200_response_memberships_inner_instance = ListMemberships200ResponseMembershipsInner.from_json(json)
# print the JSON string representation of the object
print(ListMemberships200ResponseMembershipsInner.to_json())
# convert the object into a dict
list_memberships200_response_memberships_inner_dict = list_memberships200_response_memberships_inner_instance.to_dict()
# create an instance of ListMemberships200ResponseMembershipsInner from a dict
list_memberships200_response_memberships_inner_from_dict = ListMemberships200ResponseMembershipsInner.from_dict(list_memberships200_response_memberships_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# ListOrganizationMembers200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**members** | [**List[ListOrganizationMembers200ResponseMembersInner]**](ListOrganizationMembers200ResponseMembersInner.md) | | [optional]
## Example
```python
from zrok_api.models.list_organization_members200_response import ListOrganizationMembers200Response
# TODO update the JSON string below
json = "{}"
# create an instance of ListOrganizationMembers200Response from a JSON string
list_organization_members200_response_instance = ListOrganizationMembers200Response.from_json(json)
# print the JSON string representation of the object
print(ListOrganizationMembers200Response.to_json())
# convert the object into a dict
list_organization_members200_response_dict = list_organization_members200_response_instance.to_dict()
# create an instance of ListOrganizationMembers200Response from a dict
list_organization_members200_response_from_dict = ListOrganizationMembers200Response.from_dict(list_organization_members200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# ListOrganizationMembers200ResponseMembersInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**admin** | **bool** | | [optional]
## Example
```python
from zrok_api.models.list_organization_members200_response_members_inner import ListOrganizationMembers200ResponseMembersInner
# TODO update the JSON string below
json = "{}"
# create an instance of ListOrganizationMembers200ResponseMembersInner from a JSON string
list_organization_members200_response_members_inner_instance = ListOrganizationMembers200ResponseMembersInner.from_json(json)
# print the JSON string representation of the object
print(ListOrganizationMembers200ResponseMembersInner.to_json())
# convert the object into a dict
list_organization_members200_response_members_inner_dict = list_organization_members200_response_members_inner_instance.to_dict()
# create an instance of ListOrganizationMembers200ResponseMembersInner from a dict
list_organization_members200_response_members_inner_from_dict = ListOrganizationMembers200ResponseMembersInner.from_dict(list_organization_members200_response_members_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# ListOrganizations200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organizations** | [**List[ListOrganizations200ResponseOrganizationsInner]**](ListOrganizations200ResponseOrganizationsInner.md) | | [optional]
## Example
```python
from zrok_api.models.list_organizations200_response import ListOrganizations200Response
# TODO update the JSON string below
json = "{}"
# create an instance of ListOrganizations200Response from a JSON string
list_organizations200_response_instance = ListOrganizations200Response.from_json(json)
# print the JSON string representation of the object
print(ListOrganizations200Response.to_json())
# convert the object into a dict
list_organizations200_response_dict = list_organizations200_response_instance.to_dict()
# create an instance of ListOrganizations200Response from a dict
list_organizations200_response_from_dict = ListOrganizations200Response.from_dict(list_organizations200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# ListOrganizations200ResponseOrganizationsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**description** | **str** | | [optional]
## Example
```python
from zrok_api.models.list_organizations200_response_organizations_inner import ListOrganizations200ResponseOrganizationsInner
# TODO update the JSON string below
json = "{}"
# create an instance of ListOrganizations200ResponseOrganizationsInner from a JSON string
list_organizations200_response_organizations_inner_instance = ListOrganizations200ResponseOrganizationsInner.from_json(json)
# print the JSON string representation of the object
print(ListOrganizations200ResponseOrganizationsInner.to_json())
# convert the object into a dict
list_organizations200_response_organizations_inner_dict = list_organizations200_response_organizations_inner_instance.to_dict()
# create an instance of ListOrganizations200ResponseOrganizationsInner from a dict
list_organizations200_response_organizations_inner_from_dict = ListOrganizations200ResponseOrganizationsInner.from_dict(list_organizations200_response_organizations_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# LoginRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
**password** | **str** | | [optional]
## Example
```python
from zrok_api.models.login_request import LoginRequest
# TODO update the JSON string below
json = "{}"
# create an instance of LoginRequest from a JSON string
login_request_instance = LoginRequest.from_json(json)
# print the JSON string representation of the object
print(LoginRequest.to_json())
# convert the object into a dict
login_request_dict = login_request_instance.to_dict()
# create an instance of LoginRequest from a dict
login_request_from_dict = LoginRequest.from_dict(login_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

File diff suppressed because it is too large Load Diff

View File

@ -1,12 +1,32 @@
# Metrics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scope** | **str** | | [optional]
**id** | **str** | | [optional]
**period** | **float** | | [optional]
**samples** | [**list[MetricsSample]**](MetricsSample.md) | | [optional]
**samples** | [**List[MetricsSample]**](MetricsSample.md) | | [optional]
## Example
```python
from zrok_api.models.metrics import Metrics
# TODO update the JSON string below
json = "{}"
# create an instance of Metrics from a JSON string
metrics_instance = Metrics.from_json(json)
# print the JSON string representation of the object
print(Metrics.to_json())
# convert the object into a dict
metrics_dict = metrics_instance.to_dict()
# create an instance of Metrics from a dict
metrics_from_dict = Metrics.from_dict(metrics_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,11 +1,31 @@
# MetricsSample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rx** | **float** | | [optional]
**tx** | **float** | | [optional]
**timestamp** | **float** | | [optional]
## Example
```python
from zrok_api.models.metrics_sample import MetricsSample
# TODO update the JSON string below
json = "{}"
# create an instance of MetricsSample from a JSON string
metrics_sample_instance = MetricsSample.from_json(json)
# print the JSON string representation of the object
print(MetricsSample.to_json())
# convert the object into a dict
metrics_sample_dict = metrics_sample_instance.to_dict()
# create an instance of MetricsSample from a dict
metrics_sample_from_dict = MetricsSample.from_dict(metrics_sample_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,10 +1,30 @@
# Overview
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_limited** | **bool** | | [optional]
**environments** | [**list[EnvironmentAndResources]**](EnvironmentAndResources.md) | | [optional]
**environments** | [**List[EnvironmentAndResources]**](EnvironmentAndResources.md) | | [optional]
## Example
```python
from zrok_api.models.overview import Overview
# TODO update the JSON string below
json = "{}"
# create an instance of Overview from a JSON string
overview_instance = Overview.from_json(json)
# print the JSON string representation of the object
print(Overview.to_json())
# convert the object into a dict
overview_dict = overview_instance.to_dict()
# create an instance of Overview from a dict
overview_from_dict = Overview.from_dict(overview_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,6 +1,8 @@
# Principal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
@ -9,5 +11,23 @@ Name | Type | Description | Notes
**limitless** | **bool** | | [optional]
**admin** | **bool** | | [optional]
## Example
```python
from zrok_api.models.principal import Principal
# TODO update the JSON string below
json = "{}"
# create an instance of Principal from a JSON string
principal_instance = Principal.from_json(json)
# print the JSON string representation of the object
print(Principal.to_json())
# convert the object into a dict
principal_dict = principal_instance.to_dict()
# create an instance of Principal from a dict
principal_from_dict = Principal.from_dict(principal_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# RegenerateAccountToken200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.regenerate_account_token200_response import RegenerateAccountToken200Response
# TODO update the JSON string below
json = "{}"
# create an instance of RegenerateAccountToken200Response from a JSON string
regenerate_account_token200_response_instance = RegenerateAccountToken200Response.from_json(json)
# print the JSON string representation of the object
print(RegenerateAccountToken200Response.to_json())
# convert the object into a dict
regenerate_account_token200_response_dict = regenerate_account_token200_response_instance.to_dict()
# create an instance of RegenerateAccountToken200Response from a dict
regenerate_account_token200_response_from_dict = RegenerateAccountToken200Response.from_dict(regenerate_account_token200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# RegenerateAccountTokenRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email_address** | **str** | | [optional]
## Example
```python
from zrok_api.models.regenerate_account_token_request import RegenerateAccountTokenRequest
# TODO update the JSON string below
json = "{}"
# create an instance of RegenerateAccountTokenRequest from a JSON string
regenerate_account_token_request_instance = RegenerateAccountTokenRequest.from_json(json)
# print the JSON string representation of the object
print(RegenerateAccountTokenRequest.to_json())
# convert the object into a dict
regenerate_account_token_request_dict = regenerate_account_token_request_instance.to_dict()
# create an instance of RegenerateAccountTokenRequest from a dict
regenerate_account_token_request_from_dict = RegenerateAccountTokenRequest.from_dict(regenerate_account_token_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# RegisterRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**register_token** | **str** | | [optional]
**password** | **str** | | [optional]
## Example
```python
from zrok_api.models.register_request import RegisterRequest
# TODO update the JSON string below
json = "{}"
# create an instance of RegisterRequest from a JSON string
register_request_instance = RegisterRequest.from_json(json)
# print the JSON string representation of the object
print(RegisterRequest.to_json())
# convert the object into a dict
register_request_dict = register_request_instance.to_dict()
# create an instance of RegisterRequest from a dict
register_request_from_dict = RegisterRequest.from_dict(register_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# RemoveOrganizationMemberRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization_token** | **str** | | [optional]
**email** | **str** | | [optional]
## Example
```python
from zrok_api.models.remove_organization_member_request import RemoveOrganizationMemberRequest
# TODO update the JSON string below
json = "{}"
# create an instance of RemoveOrganizationMemberRequest from a JSON string
remove_organization_member_request_instance = RemoveOrganizationMemberRequest.from_json(json)
# print the JSON string representation of the object
print(RemoveOrganizationMemberRequest.to_json())
# convert the object into a dict
remove_organization_member_request_dict = remove_organization_member_request_instance.to_dict()
# create an instance of RemoveOrganizationMemberRequest from a dict
remove_organization_member_request_from_dict = RemoveOrganizationMemberRequest.from_dict(remove_organization_member_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# ResetPasswordRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reset_token** | **str** | | [optional]
**password** | **str** | | [optional]
## Example
```python
from zrok_api.models.reset_password_request import ResetPasswordRequest
# TODO update the JSON string below
json = "{}"
# create an instance of ResetPasswordRequest from a JSON string
reset_password_request_instance = ResetPasswordRequest.from_json(json)
# print the JSON string representation of the object
print(ResetPasswordRequest.to_json())
# convert the object into a dict
reset_password_request_dict = reset_password_request_instance.to_dict()
# create an instance of ResetPasswordRequest from a dict
reset_password_request_from_dict = ResetPasswordRequest.from_dict(reset_password_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,6 +1,8 @@
# Share
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**share_token** | **str** | | [optional]
@ -11,10 +13,28 @@ Name | Type | Description | Notes
**frontend_endpoint** | **str** | | [optional]
**backend_proxy_endpoint** | **str** | | [optional]
**reserved** | **bool** | | [optional]
**activity** | [**SparkData**](SparkData.md) | | [optional]
**activity** | [**List[SparkDataSample]**](SparkDataSample.md) | | [optional]
**limited** | **bool** | | [optional]
**created_at** | **int** | | [optional]
**updated_at** | **int** | | [optional]
## Example
```python
from zrok_api.models.share import Share
# TODO update the JSON string below
json = "{}"
# create an instance of Share from a JSON string
share_instance = Share.from_json(json)
# print the JSON string representation of the object
print(Share.to_json())
# convert the object into a dict
share_dict = share_instance.to_dict()
# create an instance of Share from a dict
share_from_dict = Share.from_dict(share_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -11,45 +11,66 @@ Method | HTTP request | Description
[**update_access**](ShareApi.md#update_access) | **PATCH** /access |
[**update_share**](ShareApi.md#update_share) | **PATCH** /share |
# **access**
> InlineResponse2013 access(body=body)
> Access201Response access(body=body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.access201_response import Access201Response
from zrok_api.models.access_request import AccessRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.AccessBody() # AccessBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.ShareApi(api_client)
body = zrok_api.AccessRequest() # AccessRequest | (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)
try:
api_response = api_instance.access(body=body)
print("The response of ShareApi->access:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ShareApi->access: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AccessBody**](AccessBody.md)| | [optional]
**body** | [**AccessRequest**](AccessRequest.md)| | [optional]
### Return type
[**InlineResponse2013**](InlineResponse2013.md)
[**Access201Response**](Access201Response.md)
### Authorization
@ -60,6 +81,15 @@ Name | Type | Description | Notes
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | access created | - |
**401** | unauthorized | - |
**404** | not found | - |
**500** | internal server error | - |
[[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**
@ -68,32 +98,52 @@ Name | Type | Description | Notes
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.share_request import ShareRequest
from zrok_api.models.share_response import ShareResponse
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.ShareRequest() # ShareRequest | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.ShareApi(api_client)
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)
try:
api_response = api_instance.share(body=body)
print("The response of ShareApi->share:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ShareApi->share: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ShareRequest**](ShareRequest.md)| | [optional]
@ -111,6 +161,17 @@ Name | Type | Description | Notes
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | share created | - |
**401** | unauthorized | - |
**404** | not found | - |
**409** | conflict | - |
**422** | unprocessable | - |
**500** | internal server error | - |
[[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**
@ -119,34 +180,52 @@ Name | Type | Description | Notes
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.unaccess_request import UnaccessRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.UnaccessBody() # UnaccessBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.ShareApi(api_client)
body = zrok_api.UnaccessRequest() # UnaccessRequest | (optional)
try:
api_instance.unaccess(body=body)
except ApiException as e:
print("Exception when calling ShareApi->unaccess: %s\n" % e)
try:
api_instance.unaccess(body=body)
except Exception as e:
print("Exception when calling ShareApi->unaccess: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**UnaccessBody**](UnaccessBody.md)| | [optional]
**body** | [**UnaccessRequest**](UnaccessRequest.md)| | [optional]
### Return type
@ -161,6 +240,15 @@ void (empty response body)
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | access removed | - |
**401** | unauthorized | - |
**404** | not found | - |
**500** | internal server error | - |
[[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**
@ -169,34 +257,52 @@ void (empty response body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.unshare_request import UnshareRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.UnshareBody() # UnshareBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.ShareApi(api_client)
body = zrok_api.UnshareRequest() # UnshareRequest | (optional)
try:
api_instance.unshare(body=body)
except ApiException as e:
print("Exception when calling ShareApi->unshare: %s\n" % e)
try:
api_instance.unshare(body=body)
except Exception as e:
print("Exception when calling ShareApi->unshare: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**UnshareBody**](UnshareBody.md)| | [optional]
**body** | [**UnshareRequest**](UnshareRequest.md)| | [optional]
### Return type
@ -211,6 +317,15 @@ void (empty response body)
- **Content-Type**: application/zrok.v1+json
- **Accept**: application/zrok.v1+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | share removed | - |
**401** | unauthorized | - |
**404** | not found | - |
**500** | internal server error | - |
[[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**
@ -219,34 +334,52 @@ void (empty response body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.update_access_request import UpdateAccessRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.AccessBody1() # AccessBody1 | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.ShareApi(api_client)
body = zrok_api.UpdateAccessRequest() # UpdateAccessRequest | (optional)
try:
api_instance.update_access(body=body)
except ApiException as e:
print("Exception when calling ShareApi->update_access: %s\n" % e)
try:
api_instance.update_access(body=body)
except Exception as e:
print("Exception when calling ShareApi->update_access: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AccessBody1**](AccessBody1.md)| | [optional]
**body** | [**UpdateAccessRequest**](UpdateAccessRequest.md)| | [optional]
### Return type
@ -261,6 +394,15 @@ void (empty response body)
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | access updated | - |
**401** | unauthorized | - |
**404** | not found | - |
**500** | internal server error | - |
[[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**
@ -269,34 +411,52 @@ void (empty response body)
### Example
* Api Key Authentication (key):
```python
from __future__ import print_function
import time
import zrok_api
from zrok_api.models.update_share_request import UpdateShareRequest
from zrok_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
configuration.api_key['key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'
# configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = zrok_api.ShareApi(zrok_api.ApiClient(configuration))
body = zrok_api.ShareBody() # ShareBody | (optional)
# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = zrok_api.ShareApi(api_client)
body = zrok_api.UpdateShareRequest() # UpdateShareRequest | (optional)
try:
api_instance.update_share(body=body)
except ApiException as e:
print("Exception when calling ShareApi->update_share: %s\n" % e)
try:
api_instance.update_share(body=body)
except Exception as e:
print("Exception when calling ShareApi->update_share: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ShareBody**](ShareBody.md)| | [optional]
**body** | [**UpdateShareRequest**](UpdateShareRequest.md)| | [optional]
### Return type
@ -311,5 +471,15 @@ void (empty response body)
- **Content-Type**: application/zrok.v1+json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | share updated | - |
**400** | bad request | - |
**401** | unauthorized | - |
**404** | not found | - |
**500** | internal server error | - |
[[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)

View File

@ -1,22 +1,42 @@
# ShareRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env_zid** | **str** | | [optional]
**share_mode** | **str** | | [optional]
**frontend_selection** | **list[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]
**auth_users** | [**List[AuthUser]**](AuthUser.md) | | [optional]
**oauth_provider** | **str** | | [optional]
**oauth_email_domains** | **list[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]
**access_grants** | **List[str]** | | [optional]
**unique_name** | **str** | | [optional]
## Example
```python
from zrok_api.models.share_request import ShareRequest
# TODO update the JSON string below
json = "{}"
# create an instance of ShareRequest from a JSON string
share_request_instance = ShareRequest.from_json(json)
# print the JSON string representation of the object
print(ShareRequest.to_json())
# convert the object into a dict
share_request_dict = share_request_instance.to_dict()
# create an instance of ShareRequest from a dict
share_request_from_dict = ShareRequest.from_dict(share_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,10 +1,30 @@
# ShareResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_proxy_endpoints** | **list[str]** | | [optional]
**frontend_proxy_endpoints** | **List[str]** | | [optional]
**share_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.share_response import ShareResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ShareResponse from a JSON string
share_response_instance = ShareResponse.from_json(json)
# print the JSON string representation of the object
print(ShareResponse.to_json())
# convert the object into a dict
share_response_dict = share_response_instance.to_dict()
# create an instance of ShareResponse from a dict
share_response_from_dict = ShareResponse.from_dict(share_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,10 +1,30 @@
# SparkDataSample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rx** | **float** | | [optional]
**tx** | **float** | | [optional]
## Example
```python
from zrok_api.models.spark_data_sample import SparkDataSample
# TODO update the JSON string below
json = "{}"
# create an instance of SparkDataSample from a JSON string
spark_data_sample_instance = SparkDataSample.from_json(json)
# print the JSON string representation of the object
print(SparkDataSample.to_json())
# convert the object into a dict
spark_data_sample_dict = spark_data_sample_instance.to_dict()
# create an instance of SparkDataSample from a dict
spark_data_sample_from_dict = SparkDataSample.from_dict(spark_data_sample_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# UnaccessRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**env_zid** | **str** | | [optional]
**share_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.unaccess_request import UnaccessRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UnaccessRequest from a JSON string
unaccess_request_instance = UnaccessRequest.from_json(json)
# print the JSON string representation of the object
print(UnaccessRequest.to_json())
# convert the object into a dict
unaccess_request_dict = unaccess_request_instance.to_dict()
# create an instance of UnaccessRequest from a dict
unaccess_request_from_dict = UnaccessRequest.from_dict(unaccess_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# UnshareRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env_zid** | **str** | | [optional]
**share_token** | **str** | | [optional]
**reserved** | **bool** | | [optional]
## Example
```python
from zrok_api.models.unshare_request import UnshareRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UnshareRequest from a JSON string
unshare_request_instance = UnshareRequest.from_json(json)
# print the JSON string representation of the object
print(UnshareRequest.to_json())
# convert the object into a dict
unshare_request_dict = unshare_request_instance.to_dict()
# create an instance of UnshareRequest from a dict
unshare_request_from_dict = UnshareRequest.from_dict(unshare_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# UpdateAccessRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**bind_address** | **str** | | [optional]
**description** | **str** | | [optional]
## Example
```python
from zrok_api.models.update_access_request import UpdateAccessRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UpdateAccessRequest from a JSON string
update_access_request_instance = UpdateAccessRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateAccessRequest.to_json())
# convert the object into a dict
update_access_request_dict = update_access_request_instance.to_dict()
# create an instance of UpdateAccessRequest from a dict
update_access_request_from_dict = UpdateAccessRequest.from_dict(update_access_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,31 @@
# UpdateFrontendRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frontend_token** | **str** | | [optional]
**public_name** | **str** | | [optional]
**url_template** | **str** | | [optional]
## Example
```python
from zrok_api.models.update_frontend_request import UpdateFrontendRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UpdateFrontendRequest from a JSON string
update_frontend_request_instance = UpdateFrontendRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateFrontendRequest.to_json())
# convert the object into a dict
update_frontend_request_dict = update_frontend_request_instance.to_dict()
# create an instance of UpdateFrontendRequest from a dict
update_frontend_request_from_dict = UpdateFrontendRequest.from_dict(update_frontend_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,32 @@
# UpdateShareRequest
## 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]
## Example
```python
from zrok_api.models.update_share_request import UpdateShareRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UpdateShareRequest from a JSON string
update_share_request_instance = UpdateShareRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateShareRequest.to_json())
# convert the object into a dict
update_share_request_dict = update_share_request_instance.to_dict()
# create an instance of UpdateShareRequest from a dict
update_share_request_from_dict = UpdateShareRequest.from_dict(update_share_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# Verify200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | | [optional]
## Example
```python
from zrok_api.models.verify200_response import Verify200Response
# TODO update the JSON string below
json = "{}"
# create an instance of Verify200Response from a JSON string
verify200_response_instance = Verify200Response.from_json(json)
# print the JSON string representation of the object
print(Verify200Response.to_json())
# convert the object into a dict
verify200_response_dict = verify200_response_instance.to_dict()
# create an instance of Verify200Response from a dict
verify200_response_from_dict = Verify200Response.from_dict(verify200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# VerifyRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**register_token** | **str** | | [optional]
## Example
```python
from zrok_api.models.verify_request import VerifyRequest
# TODO update the JSON string below
json = "{}"
# create an instance of VerifyRequest from a JSON string
verify_request_instance = VerifyRequest.from_json(json)
# print the JSON string representation of the object
print(VerifyRequest.to_json())
# convert the object into a dict
verify_request_dict = verify_request_instance.to_dict()
# create an instance of VerifyRequest from a dict
verify_request_from_dict = VerifyRequest.from_dict(verify_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,29 @@
# VersionInventory200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**controller_version** | **str** | | [optional]
## Example
```python
from zrok_api.models.version_inventory200_response import VersionInventory200Response
# TODO update the JSON string below
json = "{}"
# create an instance of VersionInventory200Response from a JSON string
version_inventory200_response_instance = VersionInventory200Response.from_json(json)
# print the JSON string representation of the object
print(VersionInventory200Response.to_json())
# convert the object into a dict
version_inventory200_response_dict = version_inventory200_response_instance.to_dict()
# create an instance of VersionInventory200Response from a dict
version_inventory200_response_from_dict = VersionInventory200Response.from_dict(version_inventory200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,5 +1,5 @@
certifi >= 14.05.14
six >= 1.10
python_dateutil >= 2.5.3
setuptools >= 21.0.0
urllib3 >= 1.15.1
urllib3 >= 1.25.3, < 2.1.0
pydantic >= 2
typing-extensions >= 4.7.1

View File

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

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.access201_response import Access201Response
class TestAccess201Response(unittest.TestCase):
"""Access201Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> Access201Response:
"""Test Access201Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `Access201Response`
"""
model = Access201Response()
if include_optional:
return Access201Response(
frontend_token = '',
backend_mode = ''
)
else:
return Access201Response(
)
"""
def testAccess201Response(self):
"""Test Access201Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,54 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.access_request import AccessRequest
class TestAccessRequest(unittest.TestCase):
"""AccessRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> AccessRequest:
"""Test AccessRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `AccessRequest`
"""
model = AccessRequest()
if include_optional:
return AccessRequest(
env_zid = '',
share_token = '',
bind_address = '',
description = ''
)
else:
return AccessRequest(
)
"""
def testAccessRequest(self):
"""Test AccessRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.add_organization_member_request import AddOrganizationMemberRequest
class TestAddOrganizationMemberRequest(unittest.TestCase):
"""AddOrganizationMemberRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> AddOrganizationMemberRequest:
"""Test AddOrganizationMemberRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `AddOrganizationMemberRequest`
"""
model = AddOrganizationMemberRequest()
if include_optional:
return AddOrganizationMemberRequest(
organization_token = '',
email = '',
admin = True
)
else:
return AddOrganizationMemberRequest(
)
"""
def testAddOrganizationMemberRequest(self):
"""Test AddOrganizationMemberRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.change_password_request import ChangePasswordRequest
class TestChangePasswordRequest(unittest.TestCase):
"""ChangePasswordRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ChangePasswordRequest:
"""Test ChangePasswordRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ChangePasswordRequest`
"""
model = ChangePasswordRequest()
if include_optional:
return ChangePasswordRequest(
email = '',
old_password = '',
new_password = ''
)
else:
return ChangePasswordRequest(
)
"""
def testChangePasswordRequest(self):
"""Test ChangePasswordRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.client_version_check_request import ClientVersionCheckRequest
class TestClientVersionCheckRequest(unittest.TestCase):
"""ClientVersionCheckRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ClientVersionCheckRequest:
"""Test ClientVersionCheckRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ClientVersionCheckRequest`
"""
model = ClientVersionCheckRequest()
if include_optional:
return ClientVersionCheckRequest(
client_version = ''
)
else:
return ClientVersionCheckRequest(
)
"""
def testClientVersionCheckRequest(self):
"""Test ClientVersionCheckRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.create_frontend201_response import CreateFrontend201Response
class TestCreateFrontend201Response(unittest.TestCase):
"""CreateFrontend201Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> CreateFrontend201Response:
"""Test CreateFrontend201Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `CreateFrontend201Response`
"""
model = CreateFrontend201Response()
if include_optional:
return CreateFrontend201Response(
frontend_token = ''
)
else:
return CreateFrontend201Response(
)
"""
def testCreateFrontend201Response(self):
"""Test CreateFrontend201Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,54 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.create_frontend_request import CreateFrontendRequest
class TestCreateFrontendRequest(unittest.TestCase):
"""CreateFrontendRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> CreateFrontendRequest:
"""Test CreateFrontendRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `CreateFrontendRequest`
"""
model = CreateFrontendRequest()
if include_optional:
return CreateFrontendRequest(
z_id = '',
url_template = '',
public_name = '',
permission_mode = 'open'
)
else:
return CreateFrontendRequest(
)
"""
def testCreateFrontendRequest(self):
"""Test CreateFrontendRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.create_identity201_response import CreateIdentity201Response
class TestCreateIdentity201Response(unittest.TestCase):
"""CreateIdentity201Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> CreateIdentity201Response:
"""Test CreateIdentity201Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `CreateIdentity201Response`
"""
model = CreateIdentity201Response()
if include_optional:
return CreateIdentity201Response(
identity = '',
cfg = ''
)
else:
return CreateIdentity201Response(
)
"""
def testCreateIdentity201Response(self):
"""Test CreateIdentity201Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.create_identity_request import CreateIdentityRequest
class TestCreateIdentityRequest(unittest.TestCase):
"""CreateIdentityRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> CreateIdentityRequest:
"""Test CreateIdentityRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `CreateIdentityRequest`
"""
model = CreateIdentityRequest()
if include_optional:
return CreateIdentityRequest(
name = ''
)
else:
return CreateIdentityRequest(
)
"""
def testCreateIdentityRequest(self):
"""Test CreateIdentityRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.create_organization201_response import CreateOrganization201Response
class TestCreateOrganization201Response(unittest.TestCase):
"""CreateOrganization201Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> CreateOrganization201Response:
"""Test CreateOrganization201Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `CreateOrganization201Response`
"""
model = CreateOrganization201Response()
if include_optional:
return CreateOrganization201Response(
organization_token = ''
)
else:
return CreateOrganization201Response(
)
"""
def testCreateOrganization201Response(self):
"""Test CreateOrganization201Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.create_organization_request import CreateOrganizationRequest
class TestCreateOrganizationRequest(unittest.TestCase):
"""CreateOrganizationRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> CreateOrganizationRequest:
"""Test CreateOrganizationRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `CreateOrganizationRequest`
"""
model = CreateOrganizationRequest()
if include_optional:
return CreateOrganizationRequest(
description = ''
)
else:
return CreateOrganizationRequest(
)
"""
def testCreateOrganizationRequest(self):
"""Test CreateOrganizationRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.disable_request import DisableRequest
class TestDisableRequest(unittest.TestCase):
"""DisableRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> DisableRequest:
"""Test DisableRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `DisableRequest`
"""
model = DisableRequest()
if include_optional:
return DisableRequest(
identity = ''
)
else:
return DisableRequest(
)
"""
def testDisableRequest(self):
"""Test DisableRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.enable_request import EnableRequest
class TestEnableRequest(unittest.TestCase):
"""EnableRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> EnableRequest:
"""Test EnableRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `EnableRequest`
"""
model = EnableRequest()
if include_optional:
return EnableRequest(
description = '',
host = ''
)
else:
return EnableRequest(
)
"""
def testEnableRequest(self):
"""Test EnableRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -15,7 +15,7 @@ from __future__ import absolute_import
import unittest
import zrok_api
from zrok_api.models.frontends import Frontends # noqa: E501
from zrok_api.models.list_frontends200_response_inner import ListFrontends200ResponseInner # noqa: E501
from zrok_api.rest import ApiException

View File

@ -0,0 +1,62 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.get_sparklines200_response import GetSparklines200Response
class TestGetSparklines200Response(unittest.TestCase):
"""GetSparklines200Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> GetSparklines200Response:
"""Test GetSparklines200Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `GetSparklines200Response`
"""
model = GetSparklines200Response()
if include_optional:
return GetSparklines200Response(
sparklines = [
zrok_api.models.metrics.metrics(
scope = '',
id = '',
period = 1.337,
samples = [
zrok_api.models.metrics_sample.metricsSample(
rx = 1.337,
tx = 1.337,
timestamp = 1.337, )
], )
]
)
else:
return GetSparklines200Response(
)
"""
def testGetSparklines200Response(self):
"""Test GetSparklines200Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,57 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.get_sparklines_request import GetSparklinesRequest
class TestGetSparklinesRequest(unittest.TestCase):
"""GetSparklinesRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> GetSparklinesRequest:
"""Test GetSparklinesRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `GetSparklinesRequest`
"""
model = GetSparklinesRequest()
if include_optional:
return GetSparklinesRequest(
account = True,
environments = [
''
],
shares = [
''
]
)
else:
return GetSparklinesRequest(
)
"""
def testGetSparklinesRequest(self):
"""Test GetSparklinesRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.invite_request import InviteRequest
class TestInviteRequest(unittest.TestCase):
"""InviteRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> InviteRequest:
"""Test InviteRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `InviteRequest`
"""
model = InviteRequest()
if include_optional:
return InviteRequest(
email = '',
invite_token = ''
)
else:
return InviteRequest(
)
"""
def testInviteRequest(self):
"""Test InviteRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.invite_token_generate_request import InviteTokenGenerateRequest
class TestInviteTokenGenerateRequest(unittest.TestCase):
"""InviteTokenGenerateRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> InviteTokenGenerateRequest:
"""Test InviteTokenGenerateRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `InviteTokenGenerateRequest`
"""
model = InviteTokenGenerateRequest()
if include_optional:
return InviteTokenGenerateRequest(
invite_tokens = [
''
]
)
else:
return InviteTokenGenerateRequest(
)
"""
def testInviteTokenGenerateRequest(self):
"""Test InviteTokenGenerateRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,56 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_frontends200_response_inner import ListFrontends200ResponseInner
class TestListFrontends200ResponseInner(unittest.TestCase):
"""ListFrontends200ResponseInner unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListFrontends200ResponseInner:
"""Test ListFrontends200ResponseInner
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListFrontends200ResponseInner`
"""
model = ListFrontends200ResponseInner()
if include_optional:
return ListFrontends200ResponseInner(
frontend_token = '',
z_id = '',
url_template = '',
public_name = '',
created_at = 56,
updated_at = 56
)
else:
return ListFrontends200ResponseInner(
)
"""
def testListFrontends200ResponseInner(self):
"""Test ListFrontends200ResponseInner"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,56 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_memberships200_response import ListMemberships200Response
class TestListMemberships200Response(unittest.TestCase):
"""ListMemberships200Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListMemberships200Response:
"""Test ListMemberships200Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListMemberships200Response`
"""
model = ListMemberships200Response()
if include_optional:
return ListMemberships200Response(
memberships = [
zrok_api.models.list_memberships_200_response_memberships_inner.listMemberships_200_response_memberships_inner(
organization_token = '',
description = '',
admin = True, )
]
)
else:
return ListMemberships200Response(
)
"""
def testListMemberships200Response(self):
"""Test ListMemberships200Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_memberships200_response_memberships_inner import ListMemberships200ResponseMembershipsInner
class TestListMemberships200ResponseMembershipsInner(unittest.TestCase):
"""ListMemberships200ResponseMembershipsInner unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListMemberships200ResponseMembershipsInner:
"""Test ListMemberships200ResponseMembershipsInner
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListMemberships200ResponseMembershipsInner`
"""
model = ListMemberships200ResponseMembershipsInner()
if include_optional:
return ListMemberships200ResponseMembershipsInner(
organization_token = '',
description = '',
admin = True
)
else:
return ListMemberships200ResponseMembershipsInner(
)
"""
def testListMemberships200ResponseMembershipsInner(self):
"""Test ListMemberships200ResponseMembershipsInner"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,55 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_organization_members200_response import ListOrganizationMembers200Response
class TestListOrganizationMembers200Response(unittest.TestCase):
"""ListOrganizationMembers200Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListOrganizationMembers200Response:
"""Test ListOrganizationMembers200Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListOrganizationMembers200Response`
"""
model = ListOrganizationMembers200Response()
if include_optional:
return ListOrganizationMembers200Response(
members = [
zrok_api.models.list_organization_members_200_response_members_inner.listOrganizationMembers_200_response_members_inner(
email = '',
admin = True, )
]
)
else:
return ListOrganizationMembers200Response(
)
"""
def testListOrganizationMembers200Response(self):
"""Test ListOrganizationMembers200Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_organization_members200_response_members_inner import ListOrganizationMembers200ResponseMembersInner
class TestListOrganizationMembers200ResponseMembersInner(unittest.TestCase):
"""ListOrganizationMembers200ResponseMembersInner unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListOrganizationMembers200ResponseMembersInner:
"""Test ListOrganizationMembers200ResponseMembersInner
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListOrganizationMembers200ResponseMembersInner`
"""
model = ListOrganizationMembers200ResponseMembersInner()
if include_optional:
return ListOrganizationMembers200ResponseMembersInner(
email = '',
admin = True
)
else:
return ListOrganizationMembers200ResponseMembersInner(
)
"""
def testListOrganizationMembers200ResponseMembersInner(self):
"""Test ListOrganizationMembers200ResponseMembersInner"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,55 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_organizations200_response import ListOrganizations200Response
class TestListOrganizations200Response(unittest.TestCase):
"""ListOrganizations200Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListOrganizations200Response:
"""Test ListOrganizations200Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListOrganizations200Response`
"""
model = ListOrganizations200Response()
if include_optional:
return ListOrganizations200Response(
organizations = [
zrok_api.models.list_organizations_200_response_organizations_inner.listOrganizations_200_response_organizations_inner(
organization_token = '',
description = '', )
]
)
else:
return ListOrganizations200Response(
)
"""
def testListOrganizations200Response(self):
"""Test ListOrganizations200Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.list_organizations200_response_organizations_inner import ListOrganizations200ResponseOrganizationsInner
class TestListOrganizations200ResponseOrganizationsInner(unittest.TestCase):
"""ListOrganizations200ResponseOrganizationsInner unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ListOrganizations200ResponseOrganizationsInner:
"""Test ListOrganizations200ResponseOrganizationsInner
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ListOrganizations200ResponseOrganizationsInner`
"""
model = ListOrganizations200ResponseOrganizationsInner()
if include_optional:
return ListOrganizations200ResponseOrganizationsInner(
organization_token = '',
description = ''
)
else:
return ListOrganizations200ResponseOrganizationsInner(
)
"""
def testListOrganizations200ResponseOrganizationsInner(self):
"""Test ListOrganizations200ResponseOrganizationsInner"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.login_request import LoginRequest
class TestLoginRequest(unittest.TestCase):
"""LoginRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> LoginRequest:
"""Test LoginRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `LoginRequest`
"""
model = LoginRequest()
if include_optional:
return LoginRequest(
email = '',
password = ''
)
else:
return LoginRequest(
)
"""
def testLoginRequest(self):
"""Test LoginRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.regenerate_account_token200_response import RegenerateAccountToken200Response
class TestRegenerateAccountToken200Response(unittest.TestCase):
"""RegenerateAccountToken200Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> RegenerateAccountToken200Response:
"""Test RegenerateAccountToken200Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `RegenerateAccountToken200Response`
"""
model = RegenerateAccountToken200Response()
if include_optional:
return RegenerateAccountToken200Response(
account_token = ''
)
else:
return RegenerateAccountToken200Response(
)
"""
def testRegenerateAccountToken200Response(self):
"""Test RegenerateAccountToken200Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.regenerate_account_token_request import RegenerateAccountTokenRequest
class TestRegenerateAccountTokenRequest(unittest.TestCase):
"""RegenerateAccountTokenRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> RegenerateAccountTokenRequest:
"""Test RegenerateAccountTokenRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `RegenerateAccountTokenRequest`
"""
model = RegenerateAccountTokenRequest()
if include_optional:
return RegenerateAccountTokenRequest(
email_address = ''
)
else:
return RegenerateAccountTokenRequest(
)
"""
def testRegenerateAccountTokenRequest(self):
"""Test RegenerateAccountTokenRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.register_request import RegisterRequest
class TestRegisterRequest(unittest.TestCase):
"""RegisterRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> RegisterRequest:
"""Test RegisterRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `RegisterRequest`
"""
model = RegisterRequest()
if include_optional:
return RegisterRequest(
register_token = '',
password = ''
)
else:
return RegisterRequest(
)
"""
def testRegisterRequest(self):
"""Test RegisterRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.remove_organization_member_request import RemoveOrganizationMemberRequest
class TestRemoveOrganizationMemberRequest(unittest.TestCase):
"""RemoveOrganizationMemberRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> RemoveOrganizationMemberRequest:
"""Test RemoveOrganizationMemberRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `RemoveOrganizationMemberRequest`
"""
model = RemoveOrganizationMemberRequest()
if include_optional:
return RemoveOrganizationMemberRequest(
organization_token = '',
email = ''
)
else:
return RemoveOrganizationMemberRequest(
)
"""
def testRemoveOrganizationMemberRequest(self):
"""Test RemoveOrganizationMemberRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,52 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.reset_password_request import ResetPasswordRequest
class TestResetPasswordRequest(unittest.TestCase):
"""ResetPasswordRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> ResetPasswordRequest:
"""Test ResetPasswordRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `ResetPasswordRequest`
"""
model = ResetPasswordRequest()
if include_optional:
return ResetPasswordRequest(
reset_token = '',
password = ''
)
else:
return ResetPasswordRequest(
)
"""
def testResetPasswordRequest(self):
"""Test ResetPasswordRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.unaccess_request import UnaccessRequest
class TestUnaccessRequest(unittest.TestCase):
"""UnaccessRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> UnaccessRequest:
"""Test UnaccessRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `UnaccessRequest`
"""
model = UnaccessRequest()
if include_optional:
return UnaccessRequest(
frontend_token = '',
env_zid = '',
share_token = ''
)
else:
return UnaccessRequest(
)
"""
def testUnaccessRequest(self):
"""Test UnaccessRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.unshare_request import UnshareRequest
class TestUnshareRequest(unittest.TestCase):
"""UnshareRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> UnshareRequest:
"""Test UnshareRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `UnshareRequest`
"""
model = UnshareRequest()
if include_optional:
return UnshareRequest(
env_zid = '',
share_token = '',
reserved = True
)
else:
return UnshareRequest(
)
"""
def testUnshareRequest(self):
"""Test UnshareRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.update_access_request import UpdateAccessRequest
class TestUpdateAccessRequest(unittest.TestCase):
"""UpdateAccessRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> UpdateAccessRequest:
"""Test UpdateAccessRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `UpdateAccessRequest`
"""
model = UpdateAccessRequest()
if include_optional:
return UpdateAccessRequest(
frontend_token = '',
bind_address = '',
description = ''
)
else:
return UpdateAccessRequest(
)
"""
def testUpdateAccessRequest(self):
"""Test UpdateAccessRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,53 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.update_frontend_request import UpdateFrontendRequest
class TestUpdateFrontendRequest(unittest.TestCase):
"""UpdateFrontendRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> UpdateFrontendRequest:
"""Test UpdateFrontendRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `UpdateFrontendRequest`
"""
model = UpdateFrontendRequest()
if include_optional:
return UpdateFrontendRequest(
frontend_token = '',
public_name = '',
url_template = ''
)
else:
return UpdateFrontendRequest(
)
"""
def testUpdateFrontendRequest(self):
"""Test UpdateFrontendRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,58 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.update_share_request import UpdateShareRequest
class TestUpdateShareRequest(unittest.TestCase):
"""UpdateShareRequest unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> UpdateShareRequest:
"""Test UpdateShareRequest
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `UpdateShareRequest`
"""
model = UpdateShareRequest()
if include_optional:
return UpdateShareRequest(
share_token = '',
backend_proxy_endpoint = '',
add_access_grants = [
''
],
remove_access_grants = [
''
]
)
else:
return UpdateShareRequest(
)
"""
def testUpdateShareRequest(self):
"""Test UpdateShareRequest"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

View File

@ -0,0 +1,51 @@
# coding: utf-8
"""
zrok
zrok client access
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import unittest
from zrok_api.models.verify200_response import Verify200Response
class TestVerify200Response(unittest.TestCase):
"""Verify200Response unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def make_instance(self, include_optional) -> Verify200Response:
"""Test Verify200Response
include_optional is a boolean, when False only required
params are included, when True both required and
optional params are included """
# uncomment below to create an instance of `Verify200Response`
"""
model = Verify200Response()
if include_optional:
return Verify200Response(
email = ''
)
else:
return Verify200Response(
)
"""
def testVerify200Response(self):
"""Test Verify200Response"""
# inst_req_only = self.make_instance(include_optional=False)
# inst_req_and_optional = self.make_instance(include_optional=True)
if __name__ == '__main__':
unittest.main()

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