extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-03-27 14:46:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

remove password requirements (#834); deep regeneration of nodejs and python zrok clients

Browse Source
This commit is contained in:
Michael Quigley 2025-02-04 11:17:01 -05:00
parent 835171056c
commit 5821280dff
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
263 changed files with 5915 additions and 14037 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -16,6 +16,8 @@ FEATURE `zrok access private` supports a new `--auto` mode, which can automatica
CHANGE: Refactored API implementation. Cleanup, lint removal, additional data elements added, unused data removed (https://github.com/openziti/zrok/issues/834)
CHANGE: Deprecated the `passwords` configuration stanza. The zrok controller and API console now use a hard-coded set of (what we believe to be) reasonable assumptions about password quality (https://github.com/openziti/zrok/issues/834)
## v0.4.47
CHANGE: the Docker instance will wait for the ziti container healthy status (contribution from Ben Wong @bwong365 - https://github.com/openziti/zrok/pull/790)

16
controller/config/config.go
View File

@ -28,7 +28,6 @@ type Config struct {
Limits *limits.Config
Maintenance *MaintenanceConfig
Metrics *metrics.Config
Passwords *PasswordsConfig
Registration *RegistrationConfig
ResetPassword *ResetPasswordConfig
Store *store.Config
@ -58,14 +57,6 @@ type MaintenanceConfig struct {
Registration *RegistrationMaintenanceConfig
}
type PasswordsConfig struct {
Length int
RequireCapital bool
RequireNumeric bool
RequireSpecial bool
ValidSpecialCharacters string
}
type RegistrationConfig struct {
RegistrationUrlTemplate string
}
@ -106,13 +97,6 @@ func DefaultConfig() *Config {
BatchLimit: 500,
},
},
Passwords: &PasswordsConfig{
Length: 8,
RequireCapital: true,
RequireNumeric: true,
RequireSpecial: true,
ValidSpecialCharacters: `!@$&*_-., "#%'()+/:;<=>?[\]^{|}~`,
},
}
}

9
controller/configuration.go
View File

@ -30,14 +30,5 @@ func (ch *configurationHandler) Handle(_ metadata.ConfigurationParams) middlewar
if cfg.Invites != nil {
data.InviteTokenContact = cfg.Invites.TokenContact
}
if cfg.Passwords != nil {
data.PasswordRequirements = &rest_model_zrok.PasswordRequirements{
Length: int64(cfg.Passwords.Length),
RequireCapital: cfg.Passwords.RequireCapital,
RequireNumeric: cfg.Passwords.RequireNumeric,
RequireSpecial: cfg.Passwords.RequireSpecial,
ValidSpecialCharacters: cfg.Passwords.ValidSpecialCharacters,
}
}
return metadata.NewConfigurationOK().WithPayload(data)
}

22
controller/util.go
View File

@ -92,23 +92,17 @@ func proxyUrl(shrToken, template string) string {
}
func validatePassword(cfg *config.Config, password string) error {
if cfg.Passwords.Length > len(password) {
return fmt.Errorf("password length: expected (%d), got (%d)", cfg.Passwords.Length, len(password))
if len(password) < 8 {
return fmt.Errorf("password length: expected (8), got (%d)", len(password))
}
if cfg.Passwords.RequireCapital {
if !hasCapital(password) {
return fmt.Errorf("password requires capital, found none")
}
if !hasCapital(password) {
return fmt.Errorf("password requires capital, found none")
}
if cfg.Passwords.RequireNumeric {
if !hasNumeric(password) {
return fmt.Errorf("password requires numeric, found none")
}
if !hasNumeric(password) {
return fmt.Errorf("password requires numeric, found none")
}
if cfg.Passwords.RequireSpecial {
if !strings.ContainsAny(password, cfg.Passwords.ValidSpecialCharacters) {
return fmt.Errorf("password requires special character, found none")
}
if !strings.ContainsAny(password, "!@#$%^&*()_+-=[]{};':\"\\|,.<>") {
return fmt.Errorf("password requires special character, found none")
}
return nil
}

10
etc/ctrl.yml
View File

@ -131,16 +131,6 @@ metrics:
org: zrok
token: "<INFLUX TOKEN>"
# Configure password requirements for user accounts.
#
#passwords:
# length: 8
# require_capital: true
# require_numeric: true
# require_special: true
# # Denote which characters satisfy the `require_special` requirement. Note the need to escape specific characters.
# valid_special_characters: "\"\\`'~!@#$%^&*()[],./"
# Configure the generated URL for the registration email. The registration token will be appended to this URL.
#
registration:

64
rest_model_zrok/configuration.go
View File

@ -8,7 +8,6 @@ package rest_model_zrok
import (
"context"
"github.com/go-openapi/errors"
"github.com/go-openapi/strfmt"
"github.com/go-openapi/swag"
)
@ -24,9 +23,6 @@ type Configuration struct {
// invites open
InvitesOpen bool `json:"invitesOpen,omitempty"`
// password requirements
PasswordRequirements *PasswordRequirements `json:"passwordRequirements,omitempty"`
// requires invite token
RequiresInviteToken bool `json:"requiresInviteToken,omitempty"`
@ -39,69 +35,11 @@ type Configuration struct {
// Validate validates this configuration
func (m *Configuration) Validate(formats strfmt.Registry) error {
var res []error
if err := m.validatePasswordRequirements(formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *Configuration) validatePasswordRequirements(formats strfmt.Registry) error {
if swag.IsZero(m.PasswordRequirements) { // not required
return nil
}
if m.PasswordRequirements != nil {
if err := m.PasswordRequirements.Validate(formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("passwordRequirements")
} else if ce, ok := err.(*errors.CompositeError); ok {
return ce.ValidateName("passwordRequirements")
}
return err
}
}
return nil
}
// ContextValidate validate this configuration based on the context it is used
// ContextValidate validates this configuration based on context it is used
func (m *Configuration) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
var res []error
if err := m.contextValidatePasswordRequirements(ctx, formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *Configuration) contextValidatePasswordRequirements(ctx context.Context, formats strfmt.Registry) error {
if m.PasswordRequirements != nil {
if swag.IsZero(m.PasswordRequirements) { // not required
return nil
}
if err := m.PasswordRequirements.ContextValidate(ctx, formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("passwordRequirements")
} else if ce, ok := err.(*errors.CompositeError); ok {
return ce.ValidateName("passwordRequirements")
}
return err
}
}
return nil
}

46
rest_server_zrok/embedded_spec.go
View File

@ -1883,9 +1883,6 @@ func init() {
"invitesOpen": {
"type": "boolean"
},
"passwordRequirements": {
"$ref": "#/definitions/passwordRequirements"
},
"requiresInviteToken": {
"type": "boolean"
},
@ -2026,26 +2023,6 @@ func init() {
}
}
},
"passwordRequirements": {
"type": "object",
"properties": {
"length": {
"type": "integer"
},
"requireCapital": {
"type": "boolean"
},
"requireNumeric": {
"type": "boolean"
},
"requireSpecial": {
"type": "boolean"
},
"validSpecialCharacters": {
"type": "string"
}
}
},
"principal": {
"type": "object",
"properties": {
@ -4108,9 +4085,6 @@ func init() {
"invitesOpen": {
"type": "boolean"
},
"passwordRequirements": {
"$ref": "#/definitions/passwordRequirements"
},
"requiresInviteToken": {
"type": "boolean"
},
@ -4251,26 +4225,6 @@ func init() {
}
}
},
"passwordRequirements": {
"type": "object",
"properties": {
"length": {
"type": "integer"
},
"requireCapital": {
"type": "boolean"
},
"requireNumeric": {
"type": "boolean"
},
"requireSpecial": {
"type": "boolean"
},
"validSpecialCharacters": {
"type": "string"
}
}
},
"principal": {
"type": "object",
"properties": {

1
sdk/nodejs/sdk/src/zrok/api/.openapi-generator-ignore
View File

@ -21,4 +21,3 @@
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
git_push.sh

2
sdk/nodejs/sdk/src/zrok/api/.openapi-generator/FILES
View File

@ -6,6 +6,7 @@ api/apis.ts
api/environmentApi.ts
api/metadataApi.ts
api/shareApi.ts
git_push.sh
model/access201Response.ts
model/accessRequest.ts
model/addOrganizationMemberRequest.ts
@ -38,7 +39,6 @@ model/metrics.ts
model/metricsSample.ts
model/models.ts
model/overview.ts
model/passwordRequirements.ts
model/principal.ts
model/regenerateToken200Response.ts
model/regenerateTokenRequest.ts

238
sdk/nodejs/sdk/src/zrok/api/apis/AccountApi.ts
View File

@ -1,238 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type {
InviteRequest,
LoginRequest,
RegisterRequest,
RegisterResponse,
ResetPasswordRequest,
ResetPasswordRequestRequest,
VerifyRequest,
VerifyResponse,
} from '../models/index';
import {
InviteRequestFromJSON,
InviteRequestToJSON,
LoginRequestFromJSON,
LoginRequestToJSON,
RegisterRequestFromJSON,
RegisterRequestToJSON,
RegisterResponseFromJSON,
RegisterResponseToJSON,
ResetPasswordRequestFromJSON,
ResetPasswordRequestToJSON,
ResetPasswordRequestRequestFromJSON,
ResetPasswordRequestRequestToJSON,
VerifyRequestFromJSON,
VerifyRequestToJSON,
VerifyResponseFromJSON,
VerifyResponseToJSON,
} from '../models/index';
export interface InviteOperationRequest {
body?: InviteRequest;
}
export interface LoginOperationRequest {
body?: LoginRequest;
}
export interface RegisterOperationRequest {
body?: RegisterRequest;
}
export interface ResetPasswordOperationRequest {
body?: ResetPasswordRequest;
}
export interface ResetPasswordRequestOperationRequest {
body?: ResetPasswordRequestRequest;
}
export interface VerifyOperationRequest {
body?: VerifyRequest;
}
/**
*
*/
export class AccountApi extends runtime.BaseAPI {
/**
*/
async inviteRaw(requestParameters: InviteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
const response = await this.request({
path: `/invite`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: InviteRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async invite(requestParameters: InviteOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.inviteRaw(requestParameters, initOverrides);
}
/**
*/
async loginRaw(requestParameters: LoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
const response = await this.request({
path: `/login`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: LoginRequestToJSON(requestParameters.body),
}, initOverrides);
if (this.isJsonMime(response.headers.get('content-type'))) {
return new runtime.JSONApiResponse<string>(response);
} else {
return new runtime.TextApiResponse(response) as any;
}
}
/**
*/
async login(requestParameters: LoginOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
const response = await this.loginRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async registerRaw(requestParameters: RegisterOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RegisterResponse>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
const response = await this.request({
path: `/register`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: RegisterRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => RegisterResponseFromJSON(jsonValue));
}
/**
*/
async register(requestParameters: RegisterOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RegisterResponse> {
const response = await this.registerRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async resetPasswordRaw(requestParameters: ResetPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
const response = await this.request({
path: `/resetPassword`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: ResetPasswordRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async resetPassword(requestParameters: ResetPasswordOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.resetPasswordRaw(requestParameters, initOverrides);
}
/**
*/
async resetPasswordRequestRaw(requestParameters: ResetPasswordRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
const response = await this.request({
path: `/resetPasswordRequest`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: ResetPasswordRequestRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async resetPasswordRequest(requestParameters: ResetPasswordRequestOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.resetPasswordRequestRaw(requestParameters, initOverrides);
}
/**
*/
async verifyRaw(requestParameters: VerifyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerifyResponse>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
const response = await this.request({
path: `/verify`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: VerifyRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VerifyResponseFromJSON(jsonValue));
}
/**
*/
async verify(requestParameters: VerifyOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerifyResponse> {
const response = await this.verifyRaw(requestParameters, initOverrides);
return await response.value();
}
}

251
sdk/nodejs/sdk/src/zrok/api/apis/AdminApi.ts
View File

@ -1,251 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type {
CreateFrontendRequest,
CreateFrontendResponse,
CreateIdentity201Response,
CreateIdentityRequest,
DeleteFrontendRequest,
InviteTokenGenerateRequest,
PublicFrontend,
UpdateFrontendRequest,
} from '../models/index';
import {
CreateFrontendRequestFromJSON,
CreateFrontendRequestToJSON,
CreateFrontendResponseFromJSON,
CreateFrontendResponseToJSON,
CreateIdentity201ResponseFromJSON,
CreateIdentity201ResponseToJSON,
CreateIdentityRequestFromJSON,
CreateIdentityRequestToJSON,
DeleteFrontendRequestFromJSON,
DeleteFrontendRequestToJSON,
InviteTokenGenerateRequestFromJSON,
InviteTokenGenerateRequestToJSON,
PublicFrontendFromJSON,
PublicFrontendToJSON,
UpdateFrontendRequestFromJSON,
UpdateFrontendRequestToJSON,
} from '../models/index';
export interface CreateFrontendOperationRequest {
body?: CreateFrontendRequest;
}
export interface CreateIdentityOperationRequest {
body?: CreateIdentityRequest;
}
export interface DeleteFrontendOperationRequest {
body?: DeleteFrontendRequest;
}
export interface InviteTokenGenerateOperationRequest {
body?: InviteTokenGenerateRequest;
}
export interface UpdateFrontendOperationRequest {
body?: UpdateFrontendRequest;
}
/**
*
*/
export class AdminApi extends runtime.BaseAPI {
/**
*/
async createFrontendRaw(requestParameters: CreateFrontendOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateFrontendResponse>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/frontend`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: CreateFrontendRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => CreateFrontendResponseFromJSON(jsonValue));
}
/**
*/
async createFrontend(requestParameters: CreateFrontendOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateFrontendResponse> {
const response = await this.createFrontendRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async createIdentityRaw(requestParameters: CreateIdentityOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateIdentity201Response>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/identity`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: CreateIdentityRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => CreateIdentity201ResponseFromJSON(jsonValue));
}
/**
*/
async createIdentity(requestParameters: CreateIdentityOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateIdentity201Response> {
const response = await this.createIdentityRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async deleteFrontendRaw(requestParameters: DeleteFrontendOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/frontend`,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: DeleteFrontendRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteFrontend(requestParameters: DeleteFrontendOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.deleteFrontendRaw(requestParameters, initOverrides);
}
/**
*/
async inviteTokenGenerateRaw(requestParameters: InviteTokenGenerateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/invite/token/generate`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: InviteTokenGenerateRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async inviteTokenGenerate(requestParameters: InviteTokenGenerateOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.inviteTokenGenerateRaw(requestParameters, initOverrides);
}
/**
*/
async listFrontendsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PublicFrontend>>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/frontends`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(PublicFrontendFromJSON));
}
/**
*/
async listFrontends(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PublicFrontend>> {
const response = await this.listFrontendsRaw(initOverrides);
return await response.value();
}
/**
*/
async updateFrontendRaw(requestParameters: UpdateFrontendOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/frontend`,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: UpdateFrontendRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async updateFrontend(requestParameters: UpdateFrontendOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.updateFrontendRaw(requestParameters, initOverrides);
}
}

105
sdk/nodejs/sdk/src/zrok/api/apis/EnvironmentApi.ts
View File

@ -1,105 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type {
DisableRequest,
EnableRequest,
EnableResponse,
} from '../models/index';
import {
DisableRequestFromJSON,
DisableRequestToJSON,
EnableRequestFromJSON,
EnableRequestToJSON,
EnableResponseFromJSON,
EnableResponseToJSON,
} from '../models/index';
export interface DisableOperationRequest {
body?: DisableRequest;
}
export interface EnableOperationRequest {
body?: EnableRequest;
}
/**
*
*/
export class EnvironmentApi extends runtime.BaseAPI {
/**
*/
async disableRaw(requestParameters: DisableOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/disable`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: DisableRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async disable(requestParameters: DisableOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.disableRaw(requestParameters, initOverrides);
}
/**
*/
async enableRaw(requestParameters: EnableOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnableResponse>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/enable`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: EnableRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => EnableResponseFromJSON(jsonValue));
}
/**
*/
async enable(requestParameters: EnableOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnableResponse> {
const response = await this.enableRaw(requestParameters, initOverrides);
return await response.value();
}
}

382
sdk/nodejs/sdk/src/zrok/api/apis/MetadataApi.ts
View File

@ -1,382 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type {
Environment,
EnvironmentAndResources,
Frontend,
Metrics,
ModelConfiguration,
Overview,
Share,
} from '../models/index';
import {
EnvironmentFromJSON,
EnvironmentToJSON,
EnvironmentAndResourcesFromJSON,
EnvironmentAndResourcesToJSON,
FrontendFromJSON,
FrontendToJSON,
MetricsFromJSON,
MetricsToJSON,
ModelConfigurationFromJSON,
ModelConfigurationToJSON,
OverviewFromJSON,
OverviewToJSON,
ShareFromJSON,
ShareToJSON,
} from '../models/index';
export interface GetAccountMetricsRequest {
duration?: string;
}
export interface GetEnvironmentDetailRequest {
envZId: string;
}
export interface GetEnvironmentMetricsRequest {
envId: string;
duration?: string;
}
export interface GetFrontendDetailRequest {
feId: number;
}
export interface GetShareDetailRequest {
shrToken: string;
}
export interface GetShareMetricsRequest {
shrToken: string;
duration?: string;
}
/**
*
*/
export class MetadataApi extends runtime.BaseAPI {
/**
*/
async _configurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelConfiguration>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
const response = await this.request({
path: `/configuration`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => ModelConfigurationFromJSON(jsonValue));
}
/**
*/
async _configuration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelConfiguration> {
const response = await this._configurationRaw(initOverrides);
return await response.value();
}
/**
*/
async getAccountDetailRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Environment>>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/detail/account`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(EnvironmentFromJSON));
}
/**
*/
async getAccountDetail(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Environment>> {
const response = await this.getAccountDetailRaw(initOverrides);
return await response.value();
}
/**
*/
async getAccountMetricsRaw(requestParameters: GetAccountMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Metrics>> {
const queryParameters: any = {};
if (requestParameters.duration !== undefined) {
queryParameters['duration'] = requestParameters.duration;
}
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/metrics/account`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => MetricsFromJSON(jsonValue));
}
/**
*/
async getAccountMetrics(requestParameters: GetAccountMetricsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Metrics> {
const response = await this.getAccountMetricsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getEnvironmentDetailRaw(requestParameters: GetEnvironmentDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentAndResources>> {
if (requestParameters.envZId === null || requestParameters.envZId === undefined) {
throw new runtime.RequiredError('envZId','Required parameter requestParameters.envZId was null or undefined when calling getEnvironmentDetail.');
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/detail/environment/{envZId}`.replace(`{${"envZId"}}`, encodeURIComponent(String(requestParameters.envZId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => EnvironmentAndResourcesFromJSON(jsonValue));
}
/**
*/
async getEnvironmentDetail(requestParameters: GetEnvironmentDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentAndResources> {
const response = await this.getEnvironmentDetailRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getEnvironmentMetricsRaw(requestParameters: GetEnvironmentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Metrics>> {
if (requestParameters.envId === null || requestParameters.envId === undefined) {
throw new runtime.RequiredError('envId','Required parameter requestParameters.envId was null or undefined when calling getEnvironmentMetrics.');
}
const queryParameters: any = {};
if (requestParameters.duration !== undefined) {
queryParameters['duration'] = requestParameters.duration;
}
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/metrics/environment/{envId}`.replace(`{${"envId"}}`, encodeURIComponent(String(requestParameters.envId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => MetricsFromJSON(jsonValue));
}
/**
*/
async getEnvironmentMetrics(requestParameters: GetEnvironmentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Metrics> {
const response = await this.getEnvironmentMetricsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getFrontendDetailRaw(requestParameters: GetFrontendDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Frontend>> {
if (requestParameters.feId === null || requestParameters.feId === undefined) {
throw new runtime.RequiredError('feId','Required parameter requestParameters.feId was null or undefined when calling getFrontendDetail.');
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/detail/frontend/{feId}`.replace(`{${"feId"}}`, encodeURIComponent(String(requestParameters.feId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => FrontendFromJSON(jsonValue));
}
/**
*/
async getFrontendDetail(requestParameters: GetFrontendDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Frontend> {
const response = await this.getFrontendDetailRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getShareDetailRaw(requestParameters: GetShareDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Share>> {
if (requestParameters.shrToken === null || requestParameters.shrToken === undefined) {
throw new runtime.RequiredError('shrToken','Required parameter requestParameters.shrToken was null or undefined when calling getShareDetail.');
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/detail/share/{shrToken}`.replace(`{${"shrToken"}}`, encodeURIComponent(String(requestParameters.shrToken))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => ShareFromJSON(jsonValue));
}
/**
*/
async getShareDetail(requestParameters: GetShareDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Share> {
const response = await this.getShareDetailRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getShareMetricsRaw(requestParameters: GetShareMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Metrics>> {
if (requestParameters.shrToken === null || requestParameters.shrToken === undefined) {
throw new runtime.RequiredError('shrToken','Required parameter requestParameters.shrToken was null or undefined when calling getShareMetrics.');
}
const queryParameters: any = {};
if (requestParameters.duration !== undefined) {
queryParameters['duration'] = requestParameters.duration;
}
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/metrics/share/{shrToken}`.replace(`{${"shrToken"}}`, encodeURIComponent(String(requestParameters.shrToken))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => MetricsFromJSON(jsonValue));
}
/**
*/
async getShareMetrics(requestParameters: GetShareMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Metrics> {
const response = await this.getShareMetricsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async overviewRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Overview>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/overview`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => OverviewFromJSON(jsonValue));
}
/**
*/
async overview(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Overview> {
const response = await this.overviewRaw(initOverrides);
return await response.value();
}
/**
*/
async versionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
const response = await this.request({
path: `/version`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
if (this.isJsonMime(response.headers.get('content-type'))) {
return new runtime.JSONApiResponse<string>(response);
} else {
return new runtime.TextApiResponse(response) as any;
}
}
/**
*/
async version(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
const response = await this.versionRaw(initOverrides);
return await response.value();
}
}

220
sdk/nodejs/sdk/src/zrok/api/apis/ShareApi.ts
View File

@ -1,220 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type {
AccessRequest,
AccessResponse,
ShareRequest,
ShareResponse,
UnaccessRequest,
UnshareRequest,
UpdateShareRequest,
} from '../models/index';
import {
AccessRequestFromJSON,
AccessRequestToJSON,
AccessResponseFromJSON,
AccessResponseToJSON,
ShareRequestFromJSON,
ShareRequestToJSON,
ShareResponseFromJSON,
ShareResponseToJSON,
UnaccessRequestFromJSON,
UnaccessRequestToJSON,
UnshareRequestFromJSON,
UnshareRequestToJSON,
UpdateShareRequestFromJSON,
UpdateShareRequestToJSON,
} from '../models/index';
export interface AccessOperationRequest {
body?: AccessRequest;
}
export interface ShareOperationRequest {
body?: ShareRequest;
}
export interface UnaccessOperationRequest {
body?: UnaccessRequest;
}
export interface UnshareOperationRequest {
body?: UnshareRequest;
}
export interface UpdateShareOperationRequest {
body?: UpdateShareRequest;
}
/**
*
*/
export class ShareApi extends runtime.BaseAPI {
/**
*/
async accessRaw(requestParameters: AccessOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessResponse>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/access`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: AccessRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => AccessResponseFromJSON(jsonValue));
}
/**
*/
async access(requestParameters: AccessOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessResponse> {
const response = await this.accessRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async shareRaw(requestParameters: ShareOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShareResponse>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/share`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: ShareRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => ShareResponseFromJSON(jsonValue));
}
/**
*/
async share(requestParameters: ShareOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShareResponse> {
const response = await this.shareRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async unaccessRaw(requestParameters: UnaccessOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/unaccess`,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: UnaccessRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async unaccess(requestParameters: UnaccessOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.unaccessRaw(requestParameters, initOverrides);
}
/**
*/
async unshareRaw(requestParameters: UnshareOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/unshare`,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: UnshareRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async unshare(requestParameters: UnshareOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.unshareRaw(requestParameters, initOverrides);
}
/**
*/
async updateShareRaw(requestParameters: UpdateShareOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/zrok.v1+json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-token"] = this.configuration.apiKey("x-token"); // key authentication
}
const response = await this.request({
path: `/share`,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: UpdateShareRequestToJSON(requestParameters.body),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async updateShare(requestParameters: UpdateShareOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.updateShareRaw(requestParameters, initOverrides);
}
}

7
sdk/nodejs/sdk/src/zrok/api/apis/index.ts
View File

@ -1,7 +0,0 @@
/* tslint:disable */
/* eslint-disable */
export * from './AccountApi';
export * from './AdminApi';
export * from './EnvironmentApi';
export * from './MetadataApi';
export * from './ShareApi';

57
sdk/nodejs/sdk/src/zrok/api/git_push.sh Normal file
View File

@ -0,0 +1,57 @@
#!/bin/sh
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
#
# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
git_user_id=$1
git_repo_id=$2
release_note=$3
git_host=$4
if [ "$git_host" = "" ]; then
git_host="github.com"
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
fi
if [ "$git_user_id" = "" ]; then
git_user_id="GIT_USER_ID"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi
if [ "$git_repo_id" = "" ]; then
git_repo_id="GIT_REPO_ID"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi
if [ "$release_note" = "" ]; then
release_note="Minor update"
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
fi
# Initialize the local directory as a Git repository
git init
# Adds the files in the local repository and stages them for commit.
git add .
# Commits the tracked changes and prepares them to be pushed to a remote repository.
git commit -m "$release_note"
# Sets the new remote
git_remote=$(git remote)
if [ "$git_remote" = "" ]; then # git remote not defined
if [ "$GIT_TOKEN" = "" ]; then
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
else
git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
fi
fi
git pull origin master
# Pushes (Forces) the changes in the local repository up to the remote repository
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
git push origin master 2>&1 | grep -v 'To https'

5
sdk/nodejs/sdk/src/zrok/api/index.ts
View File

@ -1,5 +0,0 @@
/* tslint:disable */
/* eslint-disable */
export * from './runtime';
export * from './apis/index';
export * from './models/index';

37
sdk/nodejs/sdk/src/zrok/api/model/accessResponse.ts
View File

@ -1,37 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class AccessResponse {
'frontendToken'?: string;
'backendMode'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "frontendToken",
"baseName": "frontendToken",
"type": "string"
},
{
"name": "backendMode",
"baseName": "backendMode",
"type": "string"
} ];
static getAttributeTypeMap() {
return AccessResponse.attributeTypeMap;
}
}

7
sdk/nodejs/sdk/src/zrok/api/model/configuration.ts
View File

@ -11,7 +11,6 @@
*/
import { RequestFile } from './models';
import { PasswordRequirements } from './passwordRequirements';
export class Configuration {
'version'?: string;
@ -19,7 +18,6 @@ export class Configuration {
'invitesOpen'?: boolean;
'requiresInviteToken'?: boolean;
'inviteTokenContact'?: string;
'passwordRequirements'?: PasswordRequirements;
static discriminator: string | undefined = undefined;
@ -48,11 +46,6 @@ export class Configuration {
"name": "inviteTokenContact",
"baseName": "inviteTokenContact",
"type": "string"
},
{
"name": "passwordRequirements",
"baseName": "passwordRequirements",
"type": "PasswordRequirements"
} ];
static getAttributeTypeMap() {

37
sdk/nodejs/sdk/src/zrok/api/model/createAccountRequest.ts
View File

@ -1,37 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class CreateAccountRequest {
'email'?: string;
'password'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "email",
"baseName": "email",
"type": "string"
},
{
"name": "password",
"baseName": "password",
"type": "string"
} ];
static getAttributeTypeMap() {
return CreateAccountRequest.attributeTypeMap;
}
}

31
sdk/nodejs/sdk/src/zrok/api/model/createFrontendResponse.ts
View File

@ -1,31 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class CreateFrontendResponse {
'token'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "token",
"baseName": "token",
"type": "string"
} ];
static getAttributeTypeMap() {
return CreateFrontendResponse.attributeTypeMap;
}
}

37
sdk/nodejs/sdk/src/zrok/api/model/enableResponse.ts
View File

@ -1,37 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class EnableResponse {
'identity'?: string;
'cfg'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "identity",
"baseName": "identity",
"type": "string"
},
{
"name": "cfg",
"baseName": "cfg",
"type": "string"
} ];
static getAttributeTypeMap() {
return EnableResponse.attributeTypeMap;
}
}

31
sdk/nodejs/sdk/src/zrok/api/model/grantsRequest.ts
View File

@ -1,31 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class GrantsRequest {
'email'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "email",
"baseName": "email",
"type": "string"
} ];
static getAttributeTypeMap() {
return GrantsRequest.attributeTypeMap;
}
}

3
sdk/nodejs/sdk/src/zrok/api/model/models.ts
View File

@ -31,7 +31,6 @@ export * from './loginRequest';
export * from './metrics';
export * from './metricsSample';
export * from './overview';
export * from './passwordRequirements';
export * from './principal';
export * from './regenerateToken200Response';
export * from './regenerateTokenRequest';
@ -91,7 +90,6 @@ import { LoginRequest } from './loginRequest';
import { Metrics } from './metrics';
import { MetricsSample } from './metricsSample';
import { Overview } from './overview';
import { PasswordRequirements } from './passwordRequirements';
import { Principal } from './principal';
import { RegenerateToken200Response } from './regenerateToken200Response';
import { RegenerateTokenRequest } from './regenerateTokenRequest';
@ -159,7 +157,6 @@ let typeMap: {[index: string]: any} = {
"Metrics": Metrics,
"MetricsSample": MetricsSample,
"Overview": Overview,
"PasswordRequirements": PasswordRequirements,
"Principal": Principal,
"RegenerateToken200Response": RegenerateToken200Response,
"RegenerateTokenRequest": RegenerateTokenRequest,

55
sdk/nodejs/sdk/src/zrok/api/model/passwordRequirements.ts
View File

@ -1,55 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class PasswordRequirements {
'length'?: number;
'requireCapital'?: boolean;
'requireNumeric'?: boolean;
'requireSpecial'?: boolean;
'validSpecialCharacters'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "length",
"baseName": "length",
"type": "number"
},
{
"name": "requireCapital",
"baseName": "requireCapital",
"type": "boolean"
},
{
"name": "requireNumeric",
"baseName": "requireNumeric",
"type": "boolean"
},
{
"name": "requireSpecial",
"baseName": "requireSpecial",
"type": "boolean"
},
{
"name": "validSpecialCharacters",
"baseName": "validSpecialCharacters",
"type": "string"
} ];
static getAttributeTypeMap() {
return PasswordRequirements.attributeTypeMap;
}
}

61
sdk/nodejs/sdk/src/zrok/api/model/publicFrontend.ts
View File

@ -1,61 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class PublicFrontend {
'token'?: string;
'zId'?: string;
'urlTemplate'?: string;
'publicName'?: string;
'createdAt'?: number;
'updatedAt'?: number;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "token",
"baseName": "token",
"type": "string"
},
{
"name": "zId",
"baseName": "zId",
"type": "string"
},
{
"name": "urlTemplate",
"baseName": "urlTemplate",
"type": "string"
},
{
"name": "publicName",
"baseName": "publicName",
"type": "string"
},
{
"name": "createdAt",
"baseName": "createdAt",
"type": "number"
},
{
"name": "updatedAt",
"baseName": "updatedAt",
"type": "number"
} ];
static getAttributeTypeMap() {
return PublicFrontend.attributeTypeMap;
}
}

31
sdk/nodejs/sdk/src/zrok/api/model/registerResponse.ts
View File

@ -1,31 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class RegisterResponse {
'token'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "token",
"baseName": "token",
"type": "string"
} ];
static getAttributeTypeMap() {
return RegisterResponse.attributeTypeMap;
}
}

37
sdk/nodejs/sdk/src/zrok/api/model/removeOrganizationMemberRequestOrganizationsInner.ts
View File

@ -1,37 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class RemoveOrganizationMemberRequestOrganizationsInner {
'token'?: string;
'email'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "token",
"baseName": "token",
"type": "string"
},
{
"name": "email",
"baseName": "email",
"type": "string"
} ];
static getAttributeTypeMap() {
return RemoveOrganizationMemberRequestOrganizationsInner.attributeTypeMap;
}
}

37
sdk/nodejs/sdk/src/zrok/api/model/resetPasswordRequest.ts
View File

@ -1,37 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class ResetPasswordRequest {
'token'?: string;
'password'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "token",
"baseName": "token",
"type": "string"
},
{
"name": "password",
"baseName": "password",
"type": "string"
} ];
static getAttributeTypeMap() {
return ResetPasswordRequest.attributeTypeMap;
}
}

31
sdk/nodejs/sdk/src/zrok/api/model/resetPasswordRequestRequest.ts
View File

@ -1,31 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class ResetPasswordRequestRequest {
'emailAddress'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "emailAddress",
"baseName": "emailAddress",
"type": "string"
} ];
static getAttributeTypeMap() {
return ResetPasswordRequestRequest.attributeTypeMap;
}
}

31
sdk/nodejs/sdk/src/zrok/api/model/verifyRequest.ts
View File

@ -1,31 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class VerifyRequest {
'token'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "token",
"baseName": "token",
"type": "string"
} ];
static getAttributeTypeMap() {
return VerifyRequest.attributeTypeMap;
}
}

31
sdk/nodejs/sdk/src/zrok/api/model/verifyResponse.ts
View File

@ -1,31 +0,0 @@
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { RequestFile } from './models';
export class VerifyResponse {
'email'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "email",
"baseName": "email",
"type": "string"
} ];
static getAttributeTypeMap() {
return VerifyResponse.attributeTypeMap;
}
}

73
sdk/nodejs/sdk/src/zrok/api/models/AccessRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface AccessRequest
*/
export interface AccessRequest {
/**
*
* @type {string}
* @memberof AccessRequest
*/
envZId?: string;
/**
*
* @type {string}
* @memberof AccessRequest
*/
shrToken?: string;
}
/**
* Check if a given object implements the AccessRequest interface.
*/
export function instanceOfAccessRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function AccessRequestFromJSON(json: any): AccessRequest {
return AccessRequestFromJSONTyped(json, false);
}
export function AccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'envZId': !exists(json, 'envZId') ? undefined : json['envZId'],
'shrToken': !exists(json, 'shrToken') ? undefined : json['shrToken'],
};
}
export function AccessRequestToJSON(value?: AccessRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'envZId': value.envZId,
'shrToken': value.shrToken,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/AccessResponse.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface AccessResponse
*/
export interface AccessResponse {
/**
*
* @type {string}
* @memberof AccessResponse
*/
frontendToken?: string;
/**
*
* @type {string}
* @memberof AccessResponse
*/
backendMode?: string;
}
/**
* Check if a given object implements the AccessResponse interface.
*/
export function instanceOfAccessResponse(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function AccessResponseFromJSON(json: any): AccessResponse {
return AccessResponseFromJSONTyped(json, false);
}
export function AccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessResponse {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'frontendToken': !exists(json, 'frontendToken') ? undefined : json['frontendToken'],
'backendMode': !exists(json, 'backendMode') ? undefined : json['backendMode'],
};
}
export function AccessResponseToJSON(value?: AccessResponse | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'frontendToken': value.frontendToken,
'backendMode': value.backendMode,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/AuthUser.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface AuthUser
*/
export interface AuthUser {
/**
*
* @type {string}
* @memberof AuthUser
*/
username?: string;
/**
*
* @type {string}
* @memberof AuthUser
*/
password?: string;
}
/**
* Check if a given object implements the AuthUser interface.
*/
export function instanceOfAuthUser(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function AuthUserFromJSON(json: any): AuthUser {
return AuthUserFromJSONTyped(json, false);
}
export function AuthUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthUser {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'username': !exists(json, 'username') ? undefined : json['username'],
'password': !exists(json, 'password') ? undefined : json['password'],
};
}
export function AuthUserToJSON(value?: AuthUser | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'username': value.username,
'password': value.password,
};
}

81
sdk/nodejs/sdk/src/zrok/api/models/CreateFrontendRequest.ts
View File

@ -1,81 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface CreateFrontendRequest
*/
export interface CreateFrontendRequest {
/**
*
* @type {string}
* @memberof CreateFrontendRequest
*/
zId?: string;
/**
*
* @type {string}
* @memberof CreateFrontendRequest
*/
urlTemplate?: string;
/**
*
* @type {string}
* @memberof CreateFrontendRequest
*/
publicName?: string;
}
/**
* Check if a given object implements the CreateFrontendRequest interface.
*/
export function instanceOfCreateFrontendRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function CreateFrontendRequestFromJSON(json: any): CreateFrontendRequest {
return CreateFrontendRequestFromJSONTyped(json, false);
}
export function CreateFrontendRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFrontendRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'zId': !exists(json, 'zId') ? undefined : json['zId'],
'urlTemplate': !exists(json, 'url_template') ? undefined : json['url_template'],
'publicName': !exists(json, 'public_name') ? undefined : json['public_name'],
};
}
export function CreateFrontendRequestToJSON(value?: CreateFrontendRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'zId': value.zId,
'url_template': value.urlTemplate,
'public_name': value.publicName,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/CreateFrontendResponse.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface CreateFrontendResponse
*/
export interface CreateFrontendResponse {
/**
*
* @type {string}
* @memberof CreateFrontendResponse
*/
token?: string;
}
/**
* Check if a given object implements the CreateFrontendResponse interface.
*/
export function instanceOfCreateFrontendResponse(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function CreateFrontendResponseFromJSON(json: any): CreateFrontendResponse {
return CreateFrontendResponseFromJSONTyped(json, false);
}
export function CreateFrontendResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFrontendResponse {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
};
}
export function CreateFrontendResponseToJSON(value?: CreateFrontendResponse | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/CreateIdentity201Response.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface CreateIdentity201Response
*/
export interface CreateIdentity201Response {
/**
*
* @type {string}
* @memberof CreateIdentity201Response
*/
identity?: string;
/**
*
* @type {string}
* @memberof CreateIdentity201Response
*/
cfg?: string;
}
/**
* Check if a given object implements the CreateIdentity201Response interface.
*/
export function instanceOfCreateIdentity201Response(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function CreateIdentity201ResponseFromJSON(json: any): CreateIdentity201Response {
return CreateIdentity201ResponseFromJSONTyped(json, false);
}
export function CreateIdentity201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateIdentity201Response {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'identity': !exists(json, 'identity') ? undefined : json['identity'],
'cfg': !exists(json, 'cfg') ? undefined : json['cfg'],
};
}
export function CreateIdentity201ResponseToJSON(value?: CreateIdentity201Response | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'identity': value.identity,
'cfg': value.cfg,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/CreateIdentityRequest.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface CreateIdentityRequest
*/
export interface CreateIdentityRequest {
/**
*
* @type {string}
* @memberof CreateIdentityRequest
*/
name?: string;
}
/**
* Check if a given object implements the CreateIdentityRequest interface.
*/
export function instanceOfCreateIdentityRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function CreateIdentityRequestFromJSON(json: any): CreateIdentityRequest {
return CreateIdentityRequestFromJSONTyped(json, false);
}
export function CreateIdentityRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateIdentityRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'name': !exists(json, 'name') ? undefined : json['name'],
};
}
export function CreateIdentityRequestToJSON(value?: CreateIdentityRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'name': value.name,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/DeleteFrontendRequest.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface DeleteFrontendRequest
*/
export interface DeleteFrontendRequest {
/**
*
* @type {string}
* @memberof DeleteFrontendRequest
*/
frontendToken?: string;
}
/**
* Check if a given object implements the DeleteFrontendRequest interface.
*/
export function instanceOfDeleteFrontendRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function DeleteFrontendRequestFromJSON(json: any): DeleteFrontendRequest {
return DeleteFrontendRequestFromJSONTyped(json, false);
}
export function DeleteFrontendRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteFrontendRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'frontendToken': !exists(json, 'frontendToken') ? undefined : json['frontendToken'],
};
}
export function DeleteFrontendRequestToJSON(value?: DeleteFrontendRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'frontendToken': value.frontendToken,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/DisableRequest.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface DisableRequest
*/
export interface DisableRequest {
/**
*
* @type {string}
* @memberof DisableRequest
*/
identity?: string;
}
/**
* Check if a given object implements the DisableRequest interface.
*/
export function instanceOfDisableRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function DisableRequestFromJSON(json: any): DisableRequest {
return DisableRequestFromJSONTyped(json, false);
}
export function DisableRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DisableRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'identity': !exists(json, 'identity') ? undefined : json['identity'],
};
}
export function DisableRequestToJSON(value?: DisableRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'identity': value.identity,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/EnableRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface EnableRequest
*/
export interface EnableRequest {
/**
*
* @type {string}
* @memberof EnableRequest
*/
description?: string;
/**
*
* @type {string}
* @memberof EnableRequest
*/
host?: string;
}
/**
* Check if a given object implements the EnableRequest interface.
*/
export function instanceOfEnableRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function EnableRequestFromJSON(json: any): EnableRequest {
return EnableRequestFromJSONTyped(json, false);
}
export function EnableRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnableRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'description': !exists(json, 'description') ? undefined : json['description'],
'host': !exists(json, 'host') ? undefined : json['host'],
};
}
export function EnableRequestToJSON(value?: EnableRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'description': value.description,
'host': value.host,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/EnableResponse.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface EnableResponse
*/
export interface EnableResponse {
/**
*
* @type {string}
* @memberof EnableResponse
*/
identity?: string;
/**
*
* @type {string}
* @memberof EnableResponse
*/
cfg?: string;
}
/**
* Check if a given object implements the EnableResponse interface.
*/
export function instanceOfEnableResponse(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function EnableResponseFromJSON(json: any): EnableResponse {
return EnableResponseFromJSONTyped(json, false);
}
export function EnableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnableResponse {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'identity': !exists(json, 'identity') ? undefined : json['identity'],
'cfg': !exists(json, 'cfg') ? undefined : json['cfg'],
};
}
export function EnableResponseToJSON(value?: EnableResponse | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'identity': value.identity,
'cfg': value.cfg,
};
}

128
sdk/nodejs/sdk/src/zrok/api/models/Environment.ts
View File

@ -1,128 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { SparkDataSample } from './SparkDataSample';
import {
SparkDataSampleFromJSON,
SparkDataSampleFromJSONTyped,
SparkDataSampleToJSON,
} from './SparkDataSample';
/**
*
* @export
* @interface Environment
*/
export interface Environment {
/**
*
* @type {string}
* @memberof Environment
*/
description?: string;
/**
*
* @type {string}
* @memberof Environment
*/
host?: string;
/**
*
* @type {string}
* @memberof Environment
*/
address?: string;
/**
*
* @type {string}
* @memberof Environment
*/
zId?: string;
/**
*
* @type {Array<SparkDataSample>}
* @memberof Environment
*/
activity?: Array<SparkDataSample>;
/**
*
* @type {boolean}
* @memberof Environment
*/
limited?: boolean;
/**
*
* @type {number}
* @memberof Environment
*/
createdAt?: number;
/**
*
* @type {number}
* @memberof Environment
*/
updatedAt?: number;
}
/**
* Check if a given object implements the Environment interface.
*/
export function instanceOfEnvironment(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function EnvironmentFromJSON(json: any): Environment {
return EnvironmentFromJSONTyped(json, false);
}
export function EnvironmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): Environment {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'description': !exists(json, 'description') ? undefined : json['description'],
'host': !exists(json, 'host') ? undefined : json['host'],
'address': !exists(json, 'address') ? undefined : json['address'],
'zId': !exists(json, 'zId') ? undefined : json['zId'],
'activity': !exists(json, 'activity') ? undefined : ((json['activity'] as Array<any>).map(SparkDataSampleFromJSON)),
'limited': !exists(json, 'limited') ? undefined : json['limited'],
'createdAt': !exists(json, 'createdAt') ? undefined : json['createdAt'],
'updatedAt': !exists(json, 'updatedAt') ? undefined : json['updatedAt'],
};
}
export function EnvironmentToJSON(value?: Environment | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'description': value.description,
'host': value.host,
'address': value.address,
'zId': value.zId,
'activity': value.activity === undefined ? undefined : ((value.activity as Array<any>).map(SparkDataSampleToJSON)),
'limited': value.limited,
'createdAt': value.createdAt,
'updatedAt': value.updatedAt,
};
}

100
sdk/nodejs/sdk/src/zrok/api/models/EnvironmentAndResources.ts
View File

@ -1,100 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { Environment } from './Environment';
import {
EnvironmentFromJSON,
EnvironmentFromJSONTyped,
EnvironmentToJSON,
} from './Environment';
import type { Frontend } from './Frontend';
import {
FrontendFromJSON,
FrontendFromJSONTyped,
FrontendToJSON,
} from './Frontend';
import type { Share } from './Share';
import {
ShareFromJSON,
ShareFromJSONTyped,
ShareToJSON,
} from './Share';
/**
*
* @export
* @interface EnvironmentAndResources
*/
export interface EnvironmentAndResources {
/**
*
* @type {Environment}
* @memberof EnvironmentAndResources
*/
environment?: Environment;
/**
*
* @type {Array<Frontend>}
* @memberof EnvironmentAndResources
*/
frontends?: Array<Frontend>;
/**
*
* @type {Array<Share>}
* @memberof EnvironmentAndResources
*/
shares?: Array<Share>;
}
/**
* Check if a given object implements the EnvironmentAndResources interface.
*/
export function instanceOfEnvironmentAndResources(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function EnvironmentAndResourcesFromJSON(json: any): EnvironmentAndResources {
return EnvironmentAndResourcesFromJSONTyped(json, false);
}
export function EnvironmentAndResourcesFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentAndResources {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'environment': !exists(json, 'environment') ? undefined : EnvironmentFromJSON(json['environment']),
'frontends': !exists(json, 'frontends') ? undefined : ((json['frontends'] as Array<any>).map(FrontendFromJSON)),
'shares': !exists(json, 'shares') ? undefined : ((json['shares'] as Array<any>).map(ShareFromJSON)),
};
}
export function EnvironmentAndResourcesToJSON(value?: EnvironmentAndResources | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'environment': EnvironmentToJSON(value.environment),
'frontends': value.frontends === undefined ? undefined : ((value.frontends as Array<any>).map(FrontendToJSON)),
'shares': value.shares === undefined ? undefined : ((value.shares as Array<any>).map(ShareToJSON)),
};
}

97
sdk/nodejs/sdk/src/zrok/api/models/Frontend.ts
View File

@ -1,97 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface Frontend
*/
export interface Frontend {
/**
*
* @type {number}
* @memberof Frontend
*/
id?: number;
/**
*
* @type {string}
* @memberof Frontend
*/
shrToken?: string;
/**
*
* @type {string}
* @memberof Frontend
*/
zId?: string;
/**
*
* @type {number}
* @memberof Frontend
*/
createdAt?: number;
/**
*
* @type {number}
* @memberof Frontend
*/
updatedAt?: number;
}
/**
* Check if a given object implements the Frontend interface.
*/
export function instanceOfFrontend(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function FrontendFromJSON(json: any): Frontend {
return FrontendFromJSONTyped(json, false);
}
export function FrontendFromJSONTyped(json: any, ignoreDiscriminator: boolean): Frontend {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'id': !exists(json, 'id') ? undefined : json['id'],
'shrToken': !exists(json, 'shrToken') ? undefined : json['shrToken'],
'zId': !exists(json, 'zId') ? undefined : json['zId'],
'createdAt': !exists(json, 'createdAt') ? undefined : json['createdAt'],
'updatedAt': !exists(json, 'updatedAt') ? undefined : json['updatedAt'],
};
}
export function FrontendToJSON(value?: Frontend | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'id': value.id,
'shrToken': value.shrToken,
'zId': value.zId,
'createdAt': value.createdAt,
'updatedAt': value.updatedAt,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/InviteRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface InviteRequest
*/
export interface InviteRequest {
/**
*
* @type {string}
* @memberof InviteRequest
*/
email?: string;
/**
*
* @type {string}
* @memberof InviteRequest
*/
token?: string;
}
/**
* Check if a given object implements the InviteRequest interface.
*/
export function instanceOfInviteRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function InviteRequestFromJSON(json: any): InviteRequest {
return InviteRequestFromJSONTyped(json, false);
}
export function InviteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'email': !exists(json, 'email') ? undefined : json['email'],
'token': !exists(json, 'token') ? undefined : json['token'],
};
}
export function InviteRequestToJSON(value?: InviteRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'email': value.email,
'token': value.token,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/InviteTokenGenerateRequest.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface InviteTokenGenerateRequest
*/
export interface InviteTokenGenerateRequest {
/**
*
* @type {Array<string>}
* @memberof InviteTokenGenerateRequest
*/
tokens?: Array<string>;
}
/**
* Check if a given object implements the InviteTokenGenerateRequest interface.
*/
export function instanceOfInviteTokenGenerateRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function InviteTokenGenerateRequestFromJSON(json: any): InviteTokenGenerateRequest {
return InviteTokenGenerateRequestFromJSONTyped(json, false);
}
export function InviteTokenGenerateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteTokenGenerateRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'tokens': !exists(json, 'tokens') ? undefined : json['tokens'],
};
}
export function InviteTokenGenerateRequestToJSON(value?: InviteTokenGenerateRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'tokens': value.tokens,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/LoginRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface LoginRequest
*/
export interface LoginRequest {
/**
*
* @type {string}
* @memberof LoginRequest
*/
email?: string;
/**
*
* @type {string}
* @memberof LoginRequest
*/
password?: string;
}
/**
* Check if a given object implements the LoginRequest interface.
*/
export function instanceOfLoginRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function LoginRequestFromJSON(json: any): LoginRequest {
return LoginRequestFromJSONTyped(json, false);
}
export function LoginRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): LoginRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'email': !exists(json, 'email') ? undefined : json['email'],
'password': !exists(json, 'password') ? undefined : json['password'],
};
}
export function LoginRequestToJSON(value?: LoginRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'email': value.email,
'password': value.password,
};
}

96
sdk/nodejs/sdk/src/zrok/api/models/Metrics.ts
View File

@ -1,96 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { MetricsSample } from './MetricsSample';
import {
MetricsSampleFromJSON,
MetricsSampleFromJSONTyped,
MetricsSampleToJSON,
} from './MetricsSample';
/**
*
* @export
* @interface Metrics
*/
export interface Metrics {
/**
*
* @type {string}
* @memberof Metrics
*/
scope?: string;
/**
*
* @type {string}
* @memberof Metrics
*/
id?: string;
/**
*
* @type {number}
* @memberof Metrics
*/
period?: number;
/**
*
* @type {Array<MetricsSample>}
* @memberof Metrics
*/
samples?: Array<MetricsSample>;
}
/**
* Check if a given object implements the Metrics interface.
*/
export function instanceOfMetrics(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function MetricsFromJSON(json: any): Metrics {
return MetricsFromJSONTyped(json, false);
}
export function MetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Metrics {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'scope': !exists(json, 'scope') ? undefined : json['scope'],
'id': !exists(json, 'id') ? undefined : json['id'],
'period': !exists(json, 'period') ? undefined : json['period'],
'samples': !exists(json, 'samples') ? undefined : ((json['samples'] as Array<any>).map(MetricsSampleFromJSON)),
};
}
export function MetricsToJSON(value?: Metrics | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'scope': value.scope,
'id': value.id,
'period': value.period,
'samples': value.samples === undefined ? undefined : ((value.samples as Array<any>).map(MetricsSampleToJSON)),
};
}

81
sdk/nodejs/sdk/src/zrok/api/models/MetricsSample.ts
View File

@ -1,81 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface MetricsSample
*/
export interface MetricsSample {
/**
*
* @type {number}
* @memberof MetricsSample
*/
rx?: number;
/**
*
* @type {number}
* @memberof MetricsSample
*/
tx?: number;
/**
*
* @type {number}
* @memberof MetricsSample
*/
timestamp?: number;
}
/**
* Check if a given object implements the MetricsSample interface.
*/
export function instanceOfMetricsSample(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function MetricsSampleFromJSON(json: any): MetricsSample {
return MetricsSampleFromJSONTyped(json, false);
}
export function MetricsSampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricsSample {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'rx': !exists(json, 'rx') ? undefined : json['rx'],
'tx': !exists(json, 'tx') ? undefined : json['tx'],
'timestamp': !exists(json, 'timestamp') ? undefined : json['timestamp'],
};
}
export function MetricsSampleToJSON(value?: MetricsSample | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'rx': value.rx,
'tx': value.tx,
'timestamp': value.timestamp,
};
}

112
sdk/nodejs/sdk/src/zrok/api/models/ModelConfiguration.ts
View File

@ -1,112 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { PasswordRequirements } from './PasswordRequirements';
import {
PasswordRequirementsFromJSON,
PasswordRequirementsFromJSONTyped,
PasswordRequirementsToJSON,
} from './PasswordRequirements';
/**
*
* @export
* @interface ModelConfiguration
*/
export interface ModelConfiguration {
/**
*
* @type {string}
* @memberof ModelConfiguration
*/
version?: string;
/**
*
* @type {string}
* @memberof ModelConfiguration
*/
touLink?: string;
/**
*
* @type {boolean}
* @memberof ModelConfiguration
*/
invitesOpen?: boolean;
/**
*
* @type {boolean}
* @memberof ModelConfiguration
*/
requiresInviteToken?: boolean;
/**
*
* @type {string}
* @memberof ModelConfiguration
*/
inviteTokenContact?: string;
/**
*
* @type {PasswordRequirements}
* @memberof ModelConfiguration
*/
passwordRequirements?: PasswordRequirements;
}
/**
* Check if a given object implements the ModelConfiguration interface.
*/
export function instanceOfModelConfiguration(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function ModelConfigurationFromJSON(json: any): ModelConfiguration {
return ModelConfigurationFromJSONTyped(json, false);
}
export function ModelConfigurationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelConfiguration {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'version': !exists(json, 'version') ? undefined : json['version'],
'touLink': !exists(json, 'touLink') ? undefined : json['touLink'],
'invitesOpen': !exists(json, 'invitesOpen') ? undefined : json['invitesOpen'],
'requiresInviteToken': !exists(json, 'requiresInviteToken') ? undefined : json['requiresInviteToken'],
'inviteTokenContact': !exists(json, 'inviteTokenContact') ? undefined : json['inviteTokenContact'],
'passwordRequirements': !exists(json, 'passwordRequirements') ? undefined : PasswordRequirementsFromJSON(json['passwordRequirements']),
};
}
export function ModelConfigurationToJSON(value?: ModelConfiguration | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'version': value.version,
'touLink': value.touLink,
'invitesOpen': value.invitesOpen,
'requiresInviteToken': value.requiresInviteToken,
'inviteTokenContact': value.inviteTokenContact,
'passwordRequirements': PasswordRequirementsToJSON(value.passwordRequirements),
};
}

80
sdk/nodejs/sdk/src/zrok/api/models/Overview.ts
View File

@ -1,80 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { EnvironmentAndResources } from './EnvironmentAndResources';
import {
EnvironmentAndResourcesFromJSON,
EnvironmentAndResourcesFromJSONTyped,
EnvironmentAndResourcesToJSON,
} from './EnvironmentAndResources';
/**
*
* @export
* @interface Overview
*/
export interface Overview {
/**
*
* @type {boolean}
* @memberof Overview
*/
accountLimited?: boolean;
/**
*
* @type {Array<EnvironmentAndResources>}
* @memberof Overview
*/
environments?: Array<EnvironmentAndResources>;
}
/**
* Check if a given object implements the Overview interface.
*/
export function instanceOfOverview(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function OverviewFromJSON(json: any): Overview {
return OverviewFromJSONTyped(json, false);
}
export function OverviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): Overview {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'accountLimited': !exists(json, 'accountLimited') ? undefined : json['accountLimited'],
'environments': !exists(json, 'environments') ? undefined : ((json['environments'] as Array<any>).map(EnvironmentAndResourcesFromJSON)),
};
}
export function OverviewToJSON(value?: Overview | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'accountLimited': value.accountLimited,
'environments': value.environments === undefined ? undefined : ((value.environments as Array<any>).map(EnvironmentAndResourcesToJSON)),
};
}

97
sdk/nodejs/sdk/src/zrok/api/models/PasswordRequirements.ts
View File

@ -1,97 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface PasswordRequirements
*/
export interface PasswordRequirements {
/**
*
* @type {number}
* @memberof PasswordRequirements
*/
length?: number;
/**
*
* @type {boolean}
* @memberof PasswordRequirements
*/
requireCapital?: boolean;
/**
*
* @type {boolean}
* @memberof PasswordRequirements
*/
requireNumeric?: boolean;
/**
*
* @type {boolean}
* @memberof PasswordRequirements
*/
requireSpecial?: boolean;
/**
*
* @type {string}
* @memberof PasswordRequirements
*/
validSpecialCharacters?: string;
}
/**
* Check if a given object implements the PasswordRequirements interface.
*/
export function instanceOfPasswordRequirements(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function PasswordRequirementsFromJSON(json: any): PasswordRequirements {
return PasswordRequirementsFromJSONTyped(json, false);
}
export function PasswordRequirementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PasswordRequirements {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'length': !exists(json, 'length') ? undefined : json['length'],
'requireCapital': !exists(json, 'requireCapital') ? undefined : json['requireCapital'],
'requireNumeric': !exists(json, 'requireNumeric') ? undefined : json['requireNumeric'],
'requireSpecial': !exists(json, 'requireSpecial') ? undefined : json['requireSpecial'],
'validSpecialCharacters': !exists(json, 'validSpecialCharacters') ? undefined : json['validSpecialCharacters'],
};
}
export function PasswordRequirementsToJSON(value?: PasswordRequirements | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'length': value.length,
'requireCapital': value.requireCapital,
'requireNumeric': value.requireNumeric,
'requireSpecial': value.requireSpecial,
'validSpecialCharacters': value.validSpecialCharacters,
};
}

97
sdk/nodejs/sdk/src/zrok/api/models/Principal.ts
View File

@ -1,97 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface Principal
*/
export interface Principal {
/**
*
* @type {number}
* @memberof Principal
*/
id?: number;
/**
*
* @type {string}
* @memberof Principal
*/
email?: string;
/**
*
* @type {string}
* @memberof Principal
*/
token?: string;
/**
*
* @type {boolean}
* @memberof Principal
*/
limitless?: boolean;
/**
*
* @type {boolean}
* @memberof Principal
*/
admin?: boolean;
}
/**
* Check if a given object implements the Principal interface.
*/
export function instanceOfPrincipal(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function PrincipalFromJSON(json: any): Principal {
return PrincipalFromJSONTyped(json, false);
}
export function PrincipalFromJSONTyped(json: any, ignoreDiscriminator: boolean): Principal {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'id': !exists(json, 'id') ? undefined : json['id'],
'email': !exists(json, 'email') ? undefined : json['email'],
'token': !exists(json, 'token') ? undefined : json['token'],
'limitless': !exists(json, 'limitless') ? undefined : json['limitless'],
'admin': !exists(json, 'admin') ? undefined : json['admin'],
};
}
export function PrincipalToJSON(value?: Principal | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'id': value.id,
'email': value.email,
'token': value.token,
'limitless': value.limitless,
'admin': value.admin,
};
}

105
sdk/nodejs/sdk/src/zrok/api/models/PublicFrontend.ts
View File

@ -1,105 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface PublicFrontend
*/
export interface PublicFrontend {
/**
*
* @type {string}
* @memberof PublicFrontend
*/
token?: string;
/**
*
* @type {string}
* @memberof PublicFrontend
*/
zId?: string;
/**
*
* @type {string}
* @memberof PublicFrontend
*/
urlTemplate?: string;
/**
*
* @type {string}
* @memberof PublicFrontend
*/
publicName?: string;
/**
*
* @type {number}
* @memberof PublicFrontend
*/
createdAt?: number;
/**
*
* @type {number}
* @memberof PublicFrontend
*/
updatedAt?: number;
}
/**
* Check if a given object implements the PublicFrontend interface.
*/
export function instanceOfPublicFrontend(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function PublicFrontendFromJSON(json: any): PublicFrontend {
return PublicFrontendFromJSONTyped(json, false);
}
export function PublicFrontendFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicFrontend {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
'zId': !exists(json, 'zId') ? undefined : json['zId'],
'urlTemplate': !exists(json, 'urlTemplate') ? undefined : json['urlTemplate'],
'publicName': !exists(json, 'publicName') ? undefined : json['publicName'],
'createdAt': !exists(json, 'createdAt') ? undefined : json['createdAt'],
'updatedAt': !exists(json, 'updatedAt') ? undefined : json['updatedAt'],
};
}
export function PublicFrontendToJSON(value?: PublicFrontend | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
'zId': value.zId,
'urlTemplate': value.urlTemplate,
'publicName': value.publicName,
'createdAt': value.createdAt,
'updatedAt': value.updatedAt,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/RegisterRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface RegisterRequest
*/
export interface RegisterRequest {
/**
*
* @type {string}
* @memberof RegisterRequest
*/
token?: string;
/**
*
* @type {string}
* @memberof RegisterRequest
*/
password?: string;
}
/**
* Check if a given object implements the RegisterRequest interface.
*/
export function instanceOfRegisterRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function RegisterRequestFromJSON(json: any): RegisterRequest {
return RegisterRequestFromJSONTyped(json, false);
}
export function RegisterRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
'password': !exists(json, 'password') ? undefined : json['password'],
};
}
export function RegisterRequestToJSON(value?: RegisterRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
'password': value.password,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/RegisterResponse.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface RegisterResponse
*/
export interface RegisterResponse {
/**
*
* @type {string}
* @memberof RegisterResponse
*/
token?: string;
}
/**
* Check if a given object implements the RegisterResponse interface.
*/
export function instanceOfRegisterResponse(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function RegisterResponseFromJSON(json: any): RegisterResponse {
return RegisterResponseFromJSONTyped(json, false);
}
export function RegisterResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterResponse {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
};
}
export function RegisterResponseToJSON(value?: RegisterResponse | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/ResetPasswordRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface ResetPasswordRequest
*/
export interface ResetPasswordRequest {
/**
*
* @type {string}
* @memberof ResetPasswordRequest
*/
token?: string;
/**
*
* @type {string}
* @memberof ResetPasswordRequest
*/
password?: string;
}
/**
* Check if a given object implements the ResetPasswordRequest interface.
*/
export function instanceOfResetPasswordRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function ResetPasswordRequestFromJSON(json: any): ResetPasswordRequest {
return ResetPasswordRequestFromJSONTyped(json, false);
}
export function ResetPasswordRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResetPasswordRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
'password': !exists(json, 'password') ? undefined : json['password'],
};
}
export function ResetPasswordRequestToJSON(value?: ResetPasswordRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
'password': value.password,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/ResetPasswordRequestRequest.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface ResetPasswordRequestRequest
*/
export interface ResetPasswordRequestRequest {
/**
*
* @type {string}
* @memberof ResetPasswordRequestRequest
*/
emailAddress?: string;
}
/**
* Check if a given object implements the ResetPasswordRequestRequest interface.
*/
export function instanceOfResetPasswordRequestRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function ResetPasswordRequestRequestFromJSON(json: any): ResetPasswordRequestRequest {
return ResetPasswordRequestRequestFromJSONTyped(json, false);
}
export function ResetPasswordRequestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResetPasswordRequestRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'emailAddress': !exists(json, 'emailAddress') ? undefined : json['emailAddress'],
};
}
export function ResetPasswordRequestRequestToJSON(value?: ResetPasswordRequestRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'emailAddress': value.emailAddress,
};
}

160
sdk/nodejs/sdk/src/zrok/api/models/Share.ts
View File

@ -1,160 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { SparkDataSample } from './SparkDataSample';
import {
SparkDataSampleFromJSON,
SparkDataSampleFromJSONTyped,
SparkDataSampleToJSON,
} from './SparkDataSample';
/**
*
* @export
* @interface Share
*/
export interface Share {
/**
*
* @type {string}
* @memberof Share
*/
token?: string;
/**
*
* @type {string}
* @memberof Share
*/
zId?: string;
/**
*
* @type {string}
* @memberof Share
*/
shareMode?: string;
/**
*
* @type {string}
* @memberof Share
*/
backendMode?: string;
/**
*
* @type {string}
* @memberof Share
*/
frontendSelection?: string;
/**
*
* @type {string}
* @memberof Share
*/
frontendEndpoint?: string;
/**
*
* @type {string}
* @memberof Share
*/
backendProxyEndpoint?: string;
/**
*
* @type {boolean}
* @memberof Share
*/
reserved?: boolean;
/**
*
* @type {Array<SparkDataSample>}
* @memberof Share
*/
activity?: Array<SparkDataSample>;
/**
*
* @type {boolean}
* @memberof Share
*/
limited?: boolean;
/**
*
* @type {number}
* @memberof Share
*/
createdAt?: number;
/**
*
* @type {number}
* @memberof Share
*/
updatedAt?: number;
}
/**
* Check if a given object implements the Share interface.
*/
export function instanceOfShare(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function ShareFromJSON(json: any): Share {
return ShareFromJSONTyped(json, false);
}
export function ShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
'zId': !exists(json, 'zId') ? undefined : json['zId'],
'shareMode': !exists(json, 'shareMode') ? undefined : json['shareMode'],
'backendMode': !exists(json, 'backendMode') ? undefined : json['backendMode'],
'frontendSelection': !exists(json, 'frontendSelection') ? undefined : json['frontendSelection'],
'frontendEndpoint': !exists(json, 'frontendEndpoint') ? undefined : json['frontendEndpoint'],
'backendProxyEndpoint': !exists(json, 'backendProxyEndpoint') ? undefined : json['backendProxyEndpoint'],
'reserved': !exists(json, 'reserved') ? undefined : json['reserved'],
'activity': !exists(json, 'activity') ? undefined : ((json['activity'] as Array<any>).map(SparkDataSampleFromJSON)),
'limited': !exists(json, 'limited') ? undefined : json['limited'],
'createdAt': !exists(json, 'createdAt') ? undefined : json['createdAt'],
'updatedAt': !exists(json, 'updatedAt') ? undefined : json['updatedAt'],
};
}
export function ShareToJSON(value?: Share | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
'zId': value.zId,
'shareMode': value.shareMode,
'backendMode': value.backendMode,
'frontendSelection': value.frontendSelection,
'frontendEndpoint': value.frontendEndpoint,
'backendProxyEndpoint': value.backendProxyEndpoint,
'reserved': value.reserved,
'activity': value.activity === undefined ? undefined : ((value.activity as Array<any>).map(SparkDataSampleToJSON)),
'limited': value.limited,
'createdAt': value.createdAt,
'updatedAt': value.updatedAt,
};
}

184
sdk/nodejs/sdk/src/zrok/api/models/ShareRequest.ts
View File

@ -1,184 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
import type { AuthUser } from './AuthUser';
import {
AuthUserFromJSON,
AuthUserFromJSONTyped,
AuthUserToJSON,
} from './AuthUser';
/**
*
* @export
* @interface ShareRequest
*/
export interface ShareRequest {
/**
*
* @type {string}
* @memberof ShareRequest
*/
envZId?: string;
/**
*
* @type {string}
* @memberof ShareRequest
*/
shareMode?: ShareRequestShareModeEnum;
/**
*
* @type {Array<string>}
* @memberof ShareRequest
*/
frontendSelection?: Array<string>;
/**
*
* @type {string}
* @memberof ShareRequest
*/
backendMode?: ShareRequestBackendModeEnum;
/**
*
* @type {string}
* @memberof ShareRequest
*/
backendProxyEndpoint?: string;
/**
*
* @type {string}
* @memberof ShareRequest
*/
authScheme?: string;
/**
*
* @type {Array<AuthUser>}
* @memberof ShareRequest
*/
authUsers?: Array<AuthUser>;
/**
*
* @type {string}
* @memberof ShareRequest
*/
oauthProvider?: ShareRequestOauthProviderEnum;
/**
*
* @type {Array<string>}
* @memberof ShareRequest
*/
oauthEmailDomains?: Array<string>;
/**
*
* @type {string}
* @memberof ShareRequest
*/
oauthAuthorizationCheckInterval?: string;
/**
*
* @type {boolean}
* @memberof ShareRequest
*/
reserved?: boolean;
}
/**
* @export
*/
export const ShareRequestShareModeEnum = {
Public: 'public',
Private: 'private'
} as const;
export type ShareRequestShareModeEnum = typeof ShareRequestShareModeEnum[keyof typeof ShareRequestShareModeEnum];
/**
* @export
*/
export const ShareRequestBackendModeEnum = {
Proxy: 'proxy',
Web: 'web',
TcpTunnel: 'tcpTunnel',
UdpTunnel: 'udpTunnel',
Caddy: 'caddy'
} as const;
export type ShareRequestBackendModeEnum = typeof ShareRequestBackendModeEnum[keyof typeof ShareRequestBackendModeEnum];
/**
* @export
*/
export const ShareRequestOauthProviderEnum = {
Github: 'github',
Google: 'google'
} as const;
export type ShareRequestOauthProviderEnum = typeof ShareRequestOauthProviderEnum[keyof typeof ShareRequestOauthProviderEnum];
/**
* Check if a given object implements the ShareRequest interface.
*/
export function instanceOfShareRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function ShareRequestFromJSON(json: any): ShareRequest {
return ShareRequestFromJSONTyped(json, false);
}
export function ShareRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'envZId': !exists(json, 'envZId') ? undefined : json['envZId'],
'shareMode': !exists(json, 'shareMode') ? undefined : json['shareMode'],
'frontendSelection': !exists(json, 'frontendSelection') ? undefined : json['frontendSelection'],
'backendMode': !exists(json, 'backendMode') ? undefined : json['backendMode'],
'backendProxyEndpoint': !exists(json, 'backendProxyEndpoint') ? undefined : json['backendProxyEndpoint'],
'authScheme': !exists(json, 'authScheme') ? undefined : json['authScheme'],
'authUsers': !exists(json, 'authUsers') ? undefined : ((json['authUsers'] as Array<any>).map(AuthUserFromJSON)),
'oauthProvider': !exists(json, 'oauthProvider') ? undefined : json['oauthProvider'],
'oauthEmailDomains': !exists(json, 'oauthEmailDomains') ? undefined : json['oauthEmailDomains'],
'oauthAuthorizationCheckInterval': !exists(json, 'oauthAuthorizationCheckInterval') ? undefined : json['oauthAuthorizationCheckInterval'],
'reserved': !exists(json, 'reserved') ? undefined : json['reserved'],
};
}
export function ShareRequestToJSON(value?: ShareRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'envZId': value.envZId,
'shareMode': value.shareMode,
'frontendSelection': value.frontendSelection,
'backendMode': value.backendMode,
'backendProxyEndpoint': value.backendProxyEndpoint,
'authScheme': value.authScheme,
'authUsers': value.authUsers === undefined ? undefined : ((value.authUsers as Array<any>).map(AuthUserToJSON)),
'oauthProvider': value.oauthProvider,
'oauthEmailDomains': value.oauthEmailDomains,
'oauthAuthorizationCheckInterval': value.oauthAuthorizationCheckInterval,
'reserved': value.reserved,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/ShareResponse.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface ShareResponse
*/
export interface ShareResponse {
/**
*
* @type {Array<string>}
* @memberof ShareResponse
*/
frontendProxyEndpoints?: Array<string>;
/**
*
* @type {string}
* @memberof ShareResponse
*/
shrToken?: string;
}
/**
* Check if a given object implements the ShareResponse interface.
*/
export function instanceOfShareResponse(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function ShareResponseFromJSON(json: any): ShareResponse {
return ShareResponseFromJSONTyped(json, false);
}
export function ShareResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareResponse {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'frontendProxyEndpoints': !exists(json, 'frontendProxyEndpoints') ? undefined : json['frontendProxyEndpoints'],
'shrToken': !exists(json, 'shrToken') ? undefined : json['shrToken'],
};
}
export function ShareResponseToJSON(value?: ShareResponse | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'frontendProxyEndpoints': value.frontendProxyEndpoints,
'shrToken': value.shrToken,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/SparkDataSample.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface SparkDataSample
*/
export interface SparkDataSample {
/**
*
* @type {number}
* @memberof SparkDataSample
*/
rx?: number;
/**
*
* @type {number}
* @memberof SparkDataSample
*/
tx?: number;
}
/**
* Check if a given object implements the SparkDataSample interface.
*/
export function instanceOfSparkDataSample(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function SparkDataSampleFromJSON(json: any): SparkDataSample {
return SparkDataSampleFromJSONTyped(json, false);
}
export function SparkDataSampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SparkDataSample {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'rx': !exists(json, 'rx') ? undefined : json['rx'],
'tx': !exists(json, 'tx') ? undefined : json['tx'],
};
}
export function SparkDataSampleToJSON(value?: SparkDataSample | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'rx': value.rx,
'tx': value.tx,
};
}

81
sdk/nodejs/sdk/src/zrok/api/models/UnaccessRequest.ts
View File

@ -1,81 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface UnaccessRequest
*/
export interface UnaccessRequest {
/**
*
* @type {string}
* @memberof UnaccessRequest
*/
frontendToken?: string;
/**
*
* @type {string}
* @memberof UnaccessRequest
*/
envZId?: string;
/**
*
* @type {string}
* @memberof UnaccessRequest
*/
shrToken?: string;
}
/**
* Check if a given object implements the UnaccessRequest interface.
*/
export function instanceOfUnaccessRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function UnaccessRequestFromJSON(json: any): UnaccessRequest {
return UnaccessRequestFromJSONTyped(json, false);
}
export function UnaccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnaccessRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'frontendToken': !exists(json, 'frontendToken') ? undefined : json['frontendToken'],
'envZId': !exists(json, 'envZId') ? undefined : json['envZId'],
'shrToken': !exists(json, 'shrToken') ? undefined : json['shrToken'],
};
}
export function UnaccessRequestToJSON(value?: UnaccessRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'frontendToken': value.frontendToken,
'envZId': value.envZId,
'shrToken': value.shrToken,
};
}

81
sdk/nodejs/sdk/src/zrok/api/models/UnshareRequest.ts
View File

@ -1,81 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface UnshareRequest
*/
export interface UnshareRequest {
/**
*
* @type {string}
* @memberof UnshareRequest
*/
envZId?: string;
/**
*
* @type {string}
* @memberof UnshareRequest
*/
shrToken?: string;
/**
*
* @type {boolean}
* @memberof UnshareRequest
*/
reserved?: boolean;
}
/**
* Check if a given object implements the UnshareRequest interface.
*/
export function instanceOfUnshareRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function UnshareRequestFromJSON(json: any): UnshareRequest {
return UnshareRequestFromJSONTyped(json, false);
}
export function UnshareRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnshareRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'envZId': !exists(json, 'envZId') ? undefined : json['envZId'],
'shrToken': !exists(json, 'shrToken') ? undefined : json['shrToken'],
'reserved': !exists(json, 'reserved') ? undefined : json['reserved'],
};
}
export function UnshareRequestToJSON(value?: UnshareRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'envZId': value.envZId,
'shrToken': value.shrToken,
'reserved': value.reserved,
};
}

81
sdk/nodejs/sdk/src/zrok/api/models/UpdateFrontendRequest.ts
View File

@ -1,81 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface UpdateFrontendRequest
*/
export interface UpdateFrontendRequest {
/**
*
* @type {string}
* @memberof UpdateFrontendRequest
*/
frontendToken?: string;
/**
*
* @type {string}
* @memberof UpdateFrontendRequest
*/
publicName?: string;
/**
*
* @type {string}
* @memberof UpdateFrontendRequest
*/
urlTemplate?: string;
}
/**
* Check if a given object implements the UpdateFrontendRequest interface.
*/
export function instanceOfUpdateFrontendRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function UpdateFrontendRequestFromJSON(json: any): UpdateFrontendRequest {
return UpdateFrontendRequestFromJSONTyped(json, false);
}
export function UpdateFrontendRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateFrontendRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'frontendToken': !exists(json, 'frontendToken') ? undefined : json['frontendToken'],
'publicName': !exists(json, 'publicName') ? undefined : json['publicName'],
'urlTemplate': !exists(json, 'urlTemplate') ? undefined : json['urlTemplate'],
};
}
export function UpdateFrontendRequestToJSON(value?: UpdateFrontendRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'frontendToken': value.frontendToken,
'publicName': value.publicName,
'urlTemplate': value.urlTemplate,
};
}

73
sdk/nodejs/sdk/src/zrok/api/models/UpdateShareRequest.ts
View File

@ -1,73 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface UpdateShareRequest
*/
export interface UpdateShareRequest {
/**
*
* @type {string}
* @memberof UpdateShareRequest
*/
shrToken?: string;
/**
*
* @type {string}
* @memberof UpdateShareRequest
*/
backendProxyEndpoint?: string;
}
/**
* Check if a given object implements the UpdateShareRequest interface.
*/
export function instanceOfUpdateShareRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function UpdateShareRequestFromJSON(json: any): UpdateShareRequest {
return UpdateShareRequestFromJSONTyped(json, false);
}
export function UpdateShareRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShareRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'shrToken': !exists(json, 'shrToken') ? undefined : json['shrToken'],
'backendProxyEndpoint': !exists(json, 'backendProxyEndpoint') ? undefined : json['backendProxyEndpoint'],
};
}
export function UpdateShareRequestToJSON(value?: UpdateShareRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'shrToken': value.shrToken,
'backendProxyEndpoint': value.backendProxyEndpoint,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/VerifyRequest.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface VerifyRequest
*/
export interface VerifyRequest {
/**
*
* @type {string}
* @memberof VerifyRequest
*/
token?: string;
}
/**
* Check if a given object implements the VerifyRequest interface.
*/
export function instanceOfVerifyRequest(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function VerifyRequestFromJSON(json: any): VerifyRequest {
return VerifyRequestFromJSONTyped(json, false);
}
export function VerifyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerifyRequest {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'token': !exists(json, 'token') ? undefined : json['token'],
};
}
export function VerifyRequestToJSON(value?: VerifyRequest | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'token': value.token,
};
}

65
sdk/nodejs/sdk/src/zrok/api/models/VerifyResponse.ts
View File

@ -1,65 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { exists, mapValues } from '../runtime';
/**
*
* @export
* @interface VerifyResponse
*/
export interface VerifyResponse {
/**
*
* @type {string}
* @memberof VerifyResponse
*/
email?: string;
}
/**
* Check if a given object implements the VerifyResponse interface.
*/
export function instanceOfVerifyResponse(value: object): boolean {
let isInstance = true;
return isInstance;
}
export function VerifyResponseFromJSON(json: any): VerifyResponse {
return VerifyResponseFromJSONTyped(json, false);
}
export function VerifyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerifyResponse {
if ((json === undefined) || (json === null)) {
return json;
}
return {
'email': !exists(json, 'email') ? undefined : json['email'],
};
}
export function VerifyResponseToJSON(value?: VerifyResponse | null): any {
if (value === undefined) {
return undefined;
}
if (value === null) {
return null;
}
return {
'email': value.email,
};
}

40
sdk/nodejs/sdk/src/zrok/api/models/index.ts
View File

@ -1,40 +0,0 @@
/* tslint:disable */
/* eslint-disable */
export * from './AccessRequest';
export * from './AccessResponse';
export * from './AuthUser';
export * from './CreateFrontendRequest';
export * from './CreateFrontendResponse';
export * from './CreateIdentity201Response';
export * from './CreateIdentityRequest';
export * from './DeleteFrontendRequest';
export * from './DisableRequest';
export * from './EnableRequest';
export * from './EnableResponse';
export * from './Environment';
export * from './EnvironmentAndResources';
export * from './Frontend';
export * from './InviteRequest';
export * from './InviteTokenGenerateRequest';
export * from './LoginRequest';
export * from './Metrics';
export * from './MetricsSample';
export * from './ModelConfiguration';
export * from './Overview';
export * from './PasswordRequirements';
export * from './Principal';
export * from './PublicFrontend';
export * from './RegisterRequest';
export * from './RegisterResponse';
export * from './ResetPasswordRequest';
export * from './ResetPasswordRequestRequest';
export * from './Share';
export * from './ShareRequest';
export * from './ShareResponse';
export * from './SparkDataSample';
export * from './UnaccessRequest';
export * from './UnshareRequest';
export * from './UpdateFrontendRequest';
export * from './UpdateShareRequest';
export * from './VerifyRequest';
export * from './VerifyResponse';

431
sdk/nodejs/sdk/src/zrok/api/runtime.ts
View File

@ -1,431 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* zrok
* zrok client access
*
* The version of the OpenAPI document: 0.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export const BASE_PATH = "/api/v1".replace(/\/+$/, "");
export interface ConfigurationParameters {
basePath?: string; // override base path
fetchApi?: FetchAPI; // override for fetch implementation
middleware?: Middleware[]; // middleware to apply before/after fetch requests
queryParamsStringify?: (params: HTTPQuery) => string; // stringify function for query strings
username?: string; // parameter for basic security
password?: string; // parameter for basic security
apiKey?: string | ((name: string) => string); // parameter for apiKey security
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>); // parameter for oauth2 security
headers?: HTTPHeaders; //header params we want to use on every request
credentials?: RequestCredentials; //value for the credentials param we want to use on each request
}
export class Configuration {
constructor(private configuration: ConfigurationParameters = {}) {}
set config(configuration: Configuration) {
this.configuration = configuration;
}
get basePath(): string {
return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
}
get fetchApi(): FetchAPI | undefined {
return this.configuration.fetchApi;
}
get middleware(): Middleware[] {
return this.configuration.middleware || [];
}
get queryParamsStringify(): (params: HTTPQuery) => string {
return this.configuration.queryParamsStringify || querystring;
}
get username(): string | undefined {
return this.configuration.username;
}
get password(): string | undefined {
return this.configuration.password;
}
get apiKey(): ((name: string) => string) | undefined {
const apiKey = this.configuration.apiKey;
if (apiKey) {
return typeof apiKey === 'function' ? apiKey : () => apiKey;
}
return undefined;
}
get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined {
const accessToken = this.configuration.accessToken;
if (accessToken) {
return typeof accessToken === 'function' ? accessToken : async () => accessToken;
}
return undefined;
}
get headers(): HTTPHeaders | undefined {
return this.configuration.headers;
}
get credentials(): RequestCredentials | undefined {
return this.configuration.credentials;
}
}
export const DefaultConfig = new Configuration();
/**
* This is the base class for all generated API classes.
*/
export class BaseAPI {
private static readonly jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
private middleware: Middleware[];
constructor(protected configuration = DefaultConfig) {
this.middleware = configuration.middleware;
}
withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]) {
const next = this.clone<T>();
next.middleware = next.middleware.concat(...middlewares);
return next;
}
withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>) {
const middlewares = preMiddlewares.map((pre) => ({ pre }));
return this.withMiddleware<T>(...middlewares);
}
withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>) {
const middlewares = postMiddlewares.map((post) => ({ post }));
return this.withMiddleware<T>(...middlewares);
}
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
protected isJsonMime(mime: string | null | undefined): boolean {
if (!mime) {
return false;
}
return BaseAPI.jsonRegex.test(mime);
}
protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response> {
const { url, init } = await this.createFetchParams(context, initOverrides);
const response = await this.fetchApi(url, init);
if (response && (response.status >= 200 && response.status < 300)) {
return response;
}
throw new ResponseError(response, 'Response returned an error code');
}
private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction) {
let url = this.configuration.basePath + context.path;
if (context.query !== undefined && Object.keys(context.query).length !== 0) {
// only add the querystring to the URL if there are query parameters.
// this is done to avoid urls ending with a "?" character which buggy webservers
// do not handle correctly sometimes.
url += '?' + this.configuration.queryParamsStringify(context.query);
}
const headers = Object.assign({}, this.configuration.headers, context.headers);
Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
const initOverrideFn =
typeof initOverrides === "function"
? initOverrides
: async () => initOverrides;
const initParams = {
method: context.method,
headers,
body: context.body,
credentials: this.configuration.credentials,
};
const overriddenInit: RequestInit = {
...initParams,
...(await initOverrideFn({
init: initParams,
context,
}))
};
let body: any;
if (isFormData(overriddenInit.body)
|| (overriddenInit.body instanceof URLSearchParams)
|| isBlob(overriddenInit.body)) {
body = overriddenInit.body;
} else if (this.isJsonMime(headers['Content-Type'])) {
body = JSON.stringify(overriddenInit.body);
} else {
body = overriddenInit.body;
}
const init: RequestInit = {
...overriddenInit,
body
};
return { url, init };
}
private fetchApi = async (url: string, init: RequestInit) => {
let fetchParams = { url, init };
for (const middleware of this.middleware) {
if (middleware.pre) {
fetchParams = await middleware.pre({
fetch: this.fetchApi,
...fetchParams,
}) || fetchParams;
}
}
let response: Response | undefined = undefined;
try {
response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
} catch (e) {
for (const middleware of this.middleware) {
if (middleware.onError) {
response = await middleware.onError({
fetch: this.fetchApi,
url: fetchParams.url,
init: fetchParams.init,
error: e,
response: response ? response.clone() : undefined,
}) || response;
}
}
if (response === undefined) {
if (e instanceof Error) {
throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
} else {
throw e;
}
}
}
for (const middleware of this.middleware) {
if (middleware.post) {
response = await middleware.post({
fetch: this.fetchApi,
url: fetchParams.url,
init: fetchParams.init,
response: response.clone(),
}) || response;
}
}
return response;
}
/**
* Create a shallow clone of `this` by constructing a new instance
* and then shallow cloning data members.
*/
private clone<T extends BaseAPI>(this: T): T {
const constructor = this.constructor as any;
const next = new constructor(this.configuration);
next.middleware = this.middleware.slice();
return next;
}
};
function isBlob(value: any): value is Blob {
return typeof Blob !== 'undefined' && value instanceof Blob;
}
function isFormData(value: any): value is FormData {
return typeof FormData !== "undefined" && value instanceof FormData;
}
export class ResponseError extends Error {
override name: "ResponseError" = "ResponseError";
constructor(public response: Response, msg?: string) {
super(msg);
}
}
export class FetchError extends Error {
override name: "FetchError" = "FetchError";
constructor(public cause: Error, msg?: string) {
super(msg);
}
}
export class RequiredError extends Error {
override name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
super(msg);
}
}
export const COLLECTION_FORMATS = {
csv: ",",
ssv: " ",
tsv: "\t",
pipes: "|",
};
export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
export type Json = any;
export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
export type HTTPHeaders = { [key: string]: string };
export type HTTPQuery = { [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery };
export type HTTPBody = Json | FormData | URLSearchParams;
export type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody };
export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
export type InitOverrideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
export interface FetchParams {
url: string;
init: RequestInit;
}
export interface RequestOpts {
path: string;
method: HTTPMethod;
headers: HTTPHeaders;
query?: HTTPQuery;
body?: HTTPBody;
}
export function exists(json: any, key: string) {
const value = json[key];
return value !== null && value !== undefined;
}
export function querystring(params: HTTPQuery, prefix: string = ''): string {
return Object.keys(params)
.map(key => querystringSingleKey(key, params[key], prefix))
.filter(part => part.length > 0)
.join('&');
}
function querystringSingleKey(key: string, value: string | number | null | undefined | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
if (value instanceof Array) {
const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
.join(`&${encodeURIComponent(fullKey)}=`);
return `${encodeURIComponent(fullKey)}=${multiValue}`;
}
if (value instanceof Set) {
const valueAsArray = Array.from(value);
return querystringSingleKey(key, valueAsArray, keyPrefix);
}
if (value instanceof Date) {
return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
}
if (value instanceof Object) {
return querystring(value as HTTPQuery, fullKey);
}
return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
}
export function mapValues(data: any, fn: (item: any) => any) {
return Object.keys(data).reduce(
(acc, key) => ({ ...acc, [key]: fn(data[key]) }),
{}
);
}
export function canConsumeForm(consumes: Consume[]): boolean {
for (const consume of consumes) {
if ('multipart/form-data' === consume.contentType) {
return true;
}
}
return false;
}
export interface Consume {
contentType: string;
}
export interface RequestContext {
fetch: FetchAPI;
url: string;
init: RequestInit;
}
export interface ResponseContext {
fetch: FetchAPI;
url: string;
init: RequestInit;
response: Response;
}
export interface ErrorContext {
fetch: FetchAPI;
url: string;
init: RequestInit;
error: unknown;
response?: Response;
}
export interface Middleware {
pre?(context: RequestContext): Promise<FetchParams | void>;
post?(context: ResponseContext): Promise<Response | void>;
onError?(context: ErrorContext): Promise<Response | void>;
}
export interface ApiResponse<T> {
raw: Response;
value(): Promise<T>;
}
export interface ResponseTransformer<T> {
(json: any): T;
}
export class JSONApiResponse<T> {
constructor(public raw: Response, private transformer: ResponseTransformer<T> = (jsonValue: any) => jsonValue) {}
async value(): Promise<T> {
return this.transformer(await this.raw.json());
}
}
export class VoidApiResponse {
constructor(public raw: Response) {}
async value(): Promise<void> {
return undefined;
}
}
export class BlobApiResponse {
constructor(public raw: Response) {}
async value(): Promise<Blob> {
return await this.raw.blob();
};
}
export class TextApiResponse {
constructor(public raw: Response) {}
async value(): Promise<string> {
return await this.raw.text();
};
}

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

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

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

@ -21,12 +21,3 @@
#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

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

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

266
sdk/python/sdk/zrok/README.md Normal file
View File

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

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

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

10
sdk/python/sdk/zrok/docs/AccessBody.md Normal file
View File

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

14
sdk/python/sdk/zrok/docs/Frontend.md Normal file
View File

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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